Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[KEP-4639] Update CRI API and workflow #4751

Merged
merged 2 commits into from
Jul 18, 2024

Conversation

saschagrunert
Copy link
Member

Updating the KEP after the merge of: kubernetes/kubernetes#125659

This reflects the current state of the enhancement.

Refers to #4639

PTAL @haircommander @mikebrow @mrunalp

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/kep Categorizes KEP tracking issues and PRs modifying the KEP directory sig/node Categorizes an issue or PR as relevant to SIG Node. labels Jul 4, 2024
@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jul 4, 2024
@toVersus
Copy link

toVersus commented Jul 4, 2024

Can you fix typo in this example as well? s/oci.image/oci.reference/g

oci:
image: "example.com/my-image:latest"

@saschagrunert
Copy link
Member Author

@toVersus sure, fixed as suggested 👍

Copy link
Member

@mikebrow mikebrow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seeing the move to reference in the pod spec.. Was the desire to move to using reference across the board as a more general term for these .. vs. ImageSpec image? If so maybe consider creating a ReferenceSpec type that is an ImageSpec type.. and using ReferenceSpec and reference in the message Mount{}. Later we can add additional fields to specify the params for artifact types, etc.

@saschagrunert
Copy link
Member Author

Seeing the move to reference in the pod spec.. Was the desire to move to using reference across the board as a more general term for these .. vs. ImageSpec image? If so maybe consider creating a ReferenceSpec type that is an ImageSpec type.. and using ReferenceSpec and reference in the message Mount{}. Later we can add additional fields to specify the params for artifact types, etc.

Goal for this PR is to reflect the current as-is implementation per https://github.com/kubernetes/cri-api/blob/a17496fa80c15a582444f49c77d019fced169e77/pkg/apis/runtime/v1/api.proto#L247-L255, we can add future enhancements on top of that later on, sure.

@mikebrow
Copy link
Member

mikebrow commented Jul 9, 2024

Seeing the move to reference in the pod spec.. Was the desire to move to using reference across the board as a more general term for these .. vs. ImageSpec image? If so maybe consider creating a ReferenceSpec type that is an ImageSpec type.. and using ReferenceSpec and reference in the message Mount{}. Later we can add additional fields to specify the params for artifact types, etc.

Goal for this PR is to reflect the current as-is implementation per https://github.com/kubernetes/cri-api/blob/a17496fa80c15a582444f49c77d019fced169e77/pkg/apis/runtime/v1/api.proto#L247-L255, we can add future enhancements on top of that later on, sure.

ok

Copy link
Member

@mikebrow mikebrow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can/should we normalize the terminology used? The terminology used varies from OCI reference as an "image or artifact", OCI "object(s)", OCI "image", and OCI "artifact."

It's not clear if we are removing artifacts for this cycle and only implementing OCI image as is (including platform index selected images).. or keeping artifact typed OCI mages as a stretch goal ...

IOW when we just say OCI image do we mean "image or artifact" and when we say OCI object do we mean "one conceptual piece of content stored as blobs with an accompanying manifest, where manifest is a JSON document uploaded via the manifests endpoint." Object being the broadest term implying any manifest type. Image or Artifact implying an image manifest (selected or not from a platform index) or "content other than OCI container images .. packaged using the image manifest."

@saschagrunert
Copy link
Member Author

can/should we normalize the terminology used? The terminology used varies from OCI reference as an "image or artifact", OCI "object(s)", OCI "image", and OCI "artifact."

It's not clear if we are removing artifacts for this cycle and only implementing OCI image as is (including platform index selected images).. or keeping artifact typed OCI mages as a stretch goal ...

IOW when we just say OCI image do we mean "image or artifact" and when we say OCI object do we mean "one conceptual piece of content stored as blobs with an accompanying manifest, where manifest is a JSON document uploaded via the manifests endpoint." Object being the broadest term implying any manifest type. Image or Artifact implying an image manifest (selected or not from a platform index) or "content other than OCI container images .. packaged using the image manifest."

The KEP should follow the proposed vocabulary:

### Vocabulary: OCI Images, Artifacts, and Objects
**OCI Image ([spec](https://github.com/opencontainers/image-spec/blob/main/spec.md)):**
- A container image that conforms to the Open Container Initiative (OCI) Image Specification.
It includes a filesystem bundle and metadata required to run a container.
- Consists of multiple layers (each layer being a tarball), a manifest (which lists the layers), and a config file
(which provides configuration data such as environment variables, entry points, etc.).
- **Use Case:** Used primarily for packaging and distributing containerized applications.
**OCI Artifact ([guidance](https://github.com/opencontainers/image-spec/blob/main/artifacts-guidance.md)):**
- An artifact describes any content that is stored and distributed using the OCI image format.
It includes not just container images but also other types of content like Helm charts, WASM modules, machine learning models, etc.
- Artifacts use the same image manifest and layer structure but may contain different types of data
within those layers. The artifact manifest can have media types that differ from those in standard container images.
- **Use Case:** Allows the distribution of non-container content using the same infrastructure and tools developed for OCI images.
**OCI Object:**
- Umbrella term encompassing both OCI images and OCI artifacts. It represents
any object that conforms to the OCI specifications for storage and
distribution and can be represented as file or filesystem by an OCI container runtime.

Means that "OCI images and/or artifacts" are "OCI objects", while "OCI images" alone mostly refer to the existing implementation.

Updating the KEP after the merge of:
kubernetes/kubernetes#125659

This reflects the current state of the enhancement.

Signed-off-by: Sascha Grunert <sgrunert@redhat.com>
Copy link
Member

@mikebrow mikebrow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Signed-off-by: Sascha Grunert <sgrunert@redhat.com>
Copy link
Contributor

@mrunalp mrunalp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 18, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mikebrow, mrunalp, saschagrunert

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 18, 2024
@k8s-ci-robot k8s-ci-robot merged commit 0f070f9 into kubernetes:master Jul 18, 2024
4 checks passed
@k8s-ci-robot k8s-ci-robot added this to the v1.31 milestone Jul 18, 2024
@saschagrunert saschagrunert deleted the oci-volume-cri branch July 18, 2024 18:43
@saschagrunert saschagrunert changed the title KEP-4639: Update CRI API and workflow [KEP-4639]: Update CRI API and workflow Jul 23, 2024
@saschagrunert saschagrunert changed the title [KEP-4639]: Update CRI API and workflow [KEP-4639] Update CRI API and workflow Jul 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/kep Categorizes KEP tracking issues and PRs modifying the KEP directory lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/node Categorizes an issue or PR as relevant to SIG Node. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
Development

Successfully merging this pull request may close these issues.

None yet

5 participants