feat: Add image content section to images page #46440
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
k8s-ci-robot
added
sig/docs
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
sftim
requested changes
Jun 1, 2024
| @@ -10,7 +10,7 @@ hide_summary: true # Listed separately in section index | |||
|
|
|||
| <!-- overview --> | |||
|
|
|||
| A container image represents binary data that encapsulates an application and all its | |||
| A container image is an OCI artifact that that encapsulates an application and all its | |||
There was a problem hiding this comment.
This does need either a glossary tooltip or a plain hyperlink. Without it, we're making the page more confusing, not less.
| @@ -63,6 +63,21 @@ Some image name examples that Kubernetes can use are: | |||
| - `registry.k8s.io/pause@sha256:1ff6c18fbef2045af6b9c16bf034cc421a29027b800e4f9b68ae9b1cb3e9ae07` - Image name with digest. | |||
| - `registry.k8s.io/pause:3.5@sha256:1ff6c18fbef2045af6b9c16bf034cc421a29027b800e4f9b68ae9b1cb3e9ae07` - Image name with tag and digest. Only digest will be used for pulling. | |||
|
|
|||
| ## Image content | |||
|
|
|||
| OCI images are composed of layers. Each layer is a set of files that are added to the image. | |||
There was a problem hiding this comment.
Suggested change
| OCI images are composed of layers. Each layer is a set of files that are added to the image. | |
| Container images are composed of _layers_. Each layer is a set of files that are added to the image. |
Docker-format images have layers too. It'd be wrong to imply that only OCI images have layers.
Comment on lines
+76
to
+79
| {{< note >}} | ||
| Other types of artifacts that are OCI compliant but not container images | ||
| cannot be used by Kubernetes as images. You can read more about them in the [OCI Manifest Spec](https://github.com/opencontainers/image-spec/blob/main/manifest.md). | ||
| {{< /note >}} |
There was a problem hiding this comment.
Why is this important to mention? I wouldn't use a note callout here.
Try this:
Suggested change
| {{< note >}} | |
| Other types of artifacts that are OCI compliant but not container images | |
| cannot be used by Kubernetes as images. You can read more about them in the [OCI Manifest Spec](https://github.com/opencontainers/image-spec/blob/main/manifest.md). | |
| {{< /note >}} | |
| ### Artifacts that are _not_ images {#other-oci-artifacts} | |
| Container images are only one kind of OCI artifact. You can read more about them in the [OCI Manifest Spec](https://github.com/opencontainers/image-spec/blob/main/manifest.md). Types of artifacts that are OCI compliant but not container images cannot be used by Kubernetes as container images. |
| OCI images are composed of layers. Each layer is a set of files that are added to the image. | ||
| Each layer and final image are identified by a digest. The digest of layer is a hash of the layer's content. | ||
|
|
||
| OCI Container images can be created using various tools and techniques. |
There was a problem hiding this comment.
Suggested change
| OCI Container images can be created using various tools and techniques. | |
| Container images can be created using various tools and techniques. |
| Each layer and final image are identified by a digest. The digest of layer is a hash of the layer's content. | ||
|
|
||
| OCI Container images can be created using various tools and techniques. | ||
| Some examples are: Docker, Buildah, Kaniko, and Buildpacks. |
There was a problem hiding this comment.
- Alphabetical order please
- And use a shortcode marker - see https://kubernetes.io/docs/contribute/style/hugo-shortcodes/#third-party-content-item
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello! This PR is aiming to solve the remaining items in #4502 especially addressing #4502 (comment)