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

Improve wording to name "what" is being pushed #244

Closed
Silvanoc opened this issue Mar 17, 2021 · 3 comments
Closed

Improve wording to name "what" is being pushed #244

Silvanoc opened this issue Mar 17, 2021 · 3 comments
Assignees
Labels
documentation Documentation related issues question Further information is requested stale Inactive issues or pull requests

Comments

@Silvanoc
Copy link

Silvanoc commented Mar 17, 2021

I haven't found any documentation about the name of the different elements being pushed to the registry:

A name for all the files composing the artifact (the payload), something like "artifact items" or simply "artifact files". What is called the "container image layers" in the case of container images.

IMO the right place for this documentation would be under docs and using those names in the README.md.

@Silvanoc Silvanoc changed the title Improve wording to name "what" is being pushed and how it's being "named" Improve wording to name "what" is being pushed and how it's being "invoked" Mar 17, 2021
@Silvanoc Silvanoc changed the title Improve wording to name "what" is being pushed and how it's being "invoked" Improve wording to name "what" is being pushed and how it's being "referenced" Mar 17, 2021
@Silvanoc
Copy link
Author

After reading more carefully the OCI Artifacts Specification I've realized that what I'm calling an "artifact set" in this issue is being called "artifact" (although no definition is clearly stating that).

I'm editing the issue description accordingly.

@Silvanoc Silvanoc changed the title Improve wording to name "what" is being pushed and how it's being "referenced" Improve wording to name "what" is being pushed Mar 17, 2021
@SteveLasker
Copy link
Contributor

Thanks @Silvanoc,
I think we're missing the generalization of what constitutes a layer in oci.image.manifest terminology.

  • In the OCI Artifacts terminology, a layer is persisted as a blob in a registry.
  • In the oci.image.manifest spec, the layers collection is ordinal, and overlay.
  • With OCI Artifacts, it makes no assumption about the contents of the blobs, or the ordinal nature. It's really up to the artifact author. We talk about this more at: OCI Artifacts: Defining Supported Layer Types

ORAS simply takes each reference to content and turns it into a blob. If you pass a single file, we currently place that file directly into the blob, and store an annotation indicating the filename, so it can be re-hydrated for oras pull
#178 talks to changing the default experience for the oras binary to treat all blobs as tars, as it enables the tar metadata to indicate the filename, allowing us to remove the annotation.

For instance, if you pass a directory reference to oras push, the contents of the directory is placed in a tarball and pushed as a single blob.

If that helps, we can add more details to ORAS and even the OCI Artifact docs, and add a definition & terms entry.

@shizhMSFT shizhMSFT added this to the future milestone May 7, 2022
@yizha1 yizha1 modified the milestones: future, v1.0.0 Aug 31, 2022
@shizhMSFT shizhMSFT added the duplicate This issue or pull request already exists label Nov 2, 2022
@shizhMSFT shizhMSFT added question Further information is requested documentation Documentation related issues and removed duplicate This issue or pull request already exists labels Jan 20, 2023
@shizhMSFT shizhMSFT removed this from the v1.0.0-rc.1 milestone Jan 20, 2023
@shizhMSFT shizhMSFT added the stale Inactive issues or pull requests label Mar 22, 2023
@shizhMSFT
Copy link
Contributor

Closing this issue due to inactivity. Please re-open if needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation related issues question Further information is requested stale Inactive issues or pull requests
Projects
No open projects
Status: No status
Development

No branches or pull requests

5 participants