https://oras.land/assets/js/a51c00c8.93bd5ada.js

1"use strict";(globalThis.webpackChunkoras_www||=[]).push([[140],{57598(e,s,i){i.r(s),i.d(s,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>a,metadata:()=>n,toc:()=>l});const n=JSON.parse('{"id":"glossary","title":"Glossary","description":"Annotations","source":"@site/versioned_docs/version-1.1/glossary.mdx","sourceDirName":".","slug":"/glossary","permalink":"/docs/1.1/glossary","draft":false,"unlisted":false,"editUrl":"https://github.com/oras-project/oras-www/edit/main/versioned_docs/version-1.1/glossary.mdx","tags":[],"version":"1.1","sidebarPosition":80,"frontMatter":{"title":"Glossary","sidebar_position":80},"sidebar":"tutorialSidebar","previous":{"title":"Compatible OCI Registries","permalink":"/docs/1.1/compatible_oci_registries"}}');var t=i(74848),r=i(28453);const a={title:"Glossary",sidebar_position:80},o="Glossary",c={},l=[{value:"Annotations",id:"annotations",level:3},{value:"Artifacts",id:"artifacts",level:3},{value:"Blob",id:"blob",level:3},{value:"Config",id:"config",level:3},{value:"Container Images",id:"container-images",level:3},{value:"Content Descriptors",id:"content-descriptors",level:3},{value:"Digest",id:"digest",level:3},{value:"Distribution-spec",id:"distribution-spec",level:3},{value:"Extensions",id:"extensions",level:3},{value:"Image Layout",id:"image-layout",level:3},{value:"Image Manifests",id:"image-manifests",level:3},{value:"Image-spec",id:"image-spec",level:3},{value:"Image Index Specification",id:"image-index-specification",level:3},{value:"Local Registry",id:"local-registry",level:3},{value:"Manifest Referrers API",id:"manifest-referrers-api",level:3},{value:"Referrer API",id:"referrer-api",level:3},{value:"Referrer Tag Schema",id:"referrer-tag-schema",level:3},{value:"Registry",id:"registry",level:3},{value:"Remote Registry",id:"remote-registry",level:3},{value:"Software Bill of Materials",id:"software-bill-of-materials",level:3},{value:"Supply Chain Security",id:"supply-chain-security",level:3},{value:"Tags",id:"tags",level:3}];function d(e){const s={a:"a",code:"code",h1:"h1",h3:"h3",header:"header",p:"p",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.header,{children:(0,t.jsx)(s.h1,{id:"glossary",children:"Glossary"})}),"\n",(0,t.jsx)(s.h3,{id:"annotations",children:"Annotations"}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.a,{href:"https://github.com/opencontainers/image-spec/blob/main/annotations.md",children:"Annotations"})," are string key-value pairs similar to labels.\nAnnotations are supported by OCI Image Manifest and OCI Content Descriptors.\nYou can refer to our ",(0,t.jsx)(s.a,{href:"/docs/1.1/how_to_guides/manifest_annotations",children:"how-to guide"})," to understand how ORAS CLI could be used to add them."]}),"\n",(0,t.jsx)(s.h3,{id:"artifacts",children:"Artifacts"}),"\n",(0,t.jsxs)(s.p,{children:["Artifacts are a conceptual piece of content stored as ",(0,t.jsx)(s.a,{href:"#blob",children:"Blobs"})," with an accompanying Manifest containing a ",(0,t.jsx)(s.a,{href:"#config",children:"Config"}),".\nWe can ",(0,t.jsx)(s.a,{href:"/docs/1.1/commands/oras_push",children:"push"}),",\n",(0,t.jsx)(s.a,{href:"/docs/1.1/commands/oras_pull",children:"pull"}),",\n",(0,t.jsx)(s.a,{href:"/docs/1.1/commands/oras_attach",children:"attach"})," artifacts using the ORAS CLI.\nIn order to understand the usage better,\nyou may follow the steps in our ",(0,t.jsx)(s.a,{href:"/docs/1.1/quickstart",children:"quick start guide"}),"."]}),"\n",(0,t.jsx)(s.h3,{id:"blob",children:"Blob"}),"\n",(0,t.jsxs)(s.p,{children:["Blob (which stands for Binary Large Objects) is the content stored by a registry and is addressable by a Digest.\nORAS allows you to ",(0,t.jsx)(s.a,{href:"/docs/1.1/commands/oras_blob_fetch",children:"fetch"}),",\n",(0,t.jsx)(s.a,{href:"/docs/1.1/commands/oras_blob_delete",children:"delete"}),"\nand ",(0,t.jsx)(s.a,{href:"/docs/1.1/commands/oras_blob_push",children:"push"})," blobs."]}),"\n",(0,t.jsx)(s.h3,{id:"config",children:"Config"}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.a,{href:"https://github.com/opencontainers/image-spec/blob/main/config.md",children:"Config"})," is the JSON format describing images for use with a container runtime and execution tool and its relationship to filesystem changesets.\nYou may use ",(0,t.jsx)(s.a,{href:"/docs/1.1/commands/oras_manifest_fetch-config",children:(0,t.jsx)(s.code,{children:"oras manifest fetch-config"})})," to check out the config of your artifact."]}),"\n",(0,t.jsx)(s.h3,{id:"container-images",children:"Container Images"}),"\n",(0,t.jsxs)(s.p,{children:["A ",(0,t.jsx)(s.a,{href:"https://www.docker.com/resources/what-container/#:~:text=A%20Docker%20container%20image%2

10is,tools%2C%20system%20libraries%20and%20settings.",children:"container image"})," is a small, standalone,\nexecutable file that contains all the components required to run an application,\nincluding the code, runtime, system tools, system libraries, and settings."]}),"\n",(0,t.jsx)(s.h3,{id:"content-descriptors",children:"Content Descriptors"}),"\n",(0,t.jsxs)(s.p,{children:["A ",(0,t.jsx)(s.a,{href:"https://github.com/opencontainers/image-spec/blob/main/descriptor.md",children:"Content Descriptor"})," (or simply Descriptor) describes the disposition of the targeted content.\nIt includes the type of the content,\na content identifier (digest),\nand the byte-size of the raw content.\nOptionally, it includes the type of artifact it is describing."]}),"\n",(0,t.jsx)(s.h3,{id:"digest",children:"Digest"}),"\n",(0,t.jsxs)(s.p,{children:["A ",(0,t.jsx)(s.a,{href:"https://github.com/opencontainers/image-spec/blob/main/descriptor.md#digests",children:"digest"})," is a property of a Descriptor which uniquely identifies content by taking a collision-resistant hash of the bytes."]}),"\n",(0,t.jsx)(s.h3,{id:"distribution-spec",children:"Distribution-spec"}),"\n",(0,t.jsxs)(s.p,{children:["The ",(0,t.jsx)(s.a,{href:"https://github.com/opencontainers/distribution-spec/blob/main/spec.md",children:"OCI Distribution Spec"})," defines an API protocol to facilitate and standardize the distribution of content."]}),"\n",(0,t.jsx)(s.h3,{id:"extensions",children:"Extensions"}),"\n",(0,t.jsxs)(s.p,{children:["The Distribution Specification Project includes a process and API for prototyping and testing ",(0,t.jsx)(s.a,{href:"https://github.com/opencontainers/distribution-spec/blob/main/extensions/README.md",children:"extensions"})," to the Distribution API."]}),"\n",(0,t.jsx)(s.h3,{id:"image-layout",children:"Image Layout"}),"\n",(0,t.jsxs)(s.p,{children:["The ",(0,t.jsx)(s.a,{href:"https://github.com/opencontainers/image-spec/blob/main/image-layout.md",children:"OCI Image Layout"})," is the directory structure for OCI content-addressable blobs and location-addressable references (refs).\nIt must contain a ",(0,t.jsx)(s.code,{children:"blobs"})," directory, ",(0,t.jsx)(s.code,{children:"oci-layout"})," file and an ",(0,t.jsx)(s.code,{children:"index.json"})," file.\nTo learn more, check out the ",(0,t.jsx)(s.a,{href:"/docs/1.1/how_to_guides/distributing_oci_layouts",children:"how-to guide"})," on OCI Layouts."]}),"\n",(0,t.jsx)(s.h3,{id:"image-manifests",children:"Image Manifests"}),"\n",(0,t.jsxs)(s.p,{children:["An ",(0,t.jsx)(s.a,{href:"https://github.com/opencontainers/image-spec/blob/main/manifest.md#image-manifest",children:"image manifest"})," provides a configuration and set of layers for a single container image for a specific architecture and operating system."]}),"\n",(0,t.jsx)(s.h3,{id:"image-spec",children:"Image-spec"}),"\n",(0,t.jsxs)(s.p,{children:["The ",(0,t.jsx)(s.a,{href:"https://github.com/opencontainers/image-spec/blob/main/spec.md",children:"OCI Image Spec"})," defines an OCI Image,\nconsisting of an image manifest,\nan image index (optional),\na set of filesystem layers,\nand a configuration."]}),"\n",(0,t.jsx)(s.h3,{id:"image-index-specification",children:"Image Index Specification"}),"\n",(0,t.jsxs)(s.p,{children:["The ",(0,t.jsx)(s.a,{href:"https://github.com/opencontainers/image-spec/blob/main/image-index.md",children:"image index"})," is a higher-level manifest which points to specific image manifests, ideal for one or more platforms.\nIt is a multi-descriptor entry point."]}),"\n",(0,t.jsx)(s.h3,{id:"local-registry",children:"Local Registry"}),"\n",(0,t.jsxs)(s.p,{children:["A registry is a place where container images and artifacts can easily be stored and accessed.\nWhereas, a local registry (like ",(0,t.jsx)(s.a,{href:"https://zotregistry.dev/",children:"zot"}),") is a registry that is present on our local machine.\nYou can follow our ",(0,t.jsx)(s.a,{href:"/docs/1.1/quickstart",children:"quick start guide"})," if you would like to try using zot registry."]}),"\n",(0,t.jsx)(s.h3,{id:"manifest-referrers-api",children:"Manifest Referrers API"}),"\n",(0,t.jsxs)(s.p,{children:["Artifact-manifest provides the ability to reference artifacts to existing artifacts. Reference artifacts include signatures,\nSBoMs and many other types.\nThe ",(0,t.jsxs)(s.a,{href:"https://github.com/oras-project/artifacts-spec/blob/main/manifest-referrers-api.md",children:["manifest ",(0,t.jsx)(s.code,{children:"referrers"})," API"]})," returns all artifacts that have a ",(0,t.jsx)(s.code,{children:"subject"})," of the given manifest digest."]}),"\n",(0,t.jsx)(s.h3,{id:"referrer-api",children:"Referrer API"}),"\n",(0,t.jsxs)(s.p,{children:["The Referrers API returns a list of manifests that reference a blob.\nYou can understand how to use this API by referring to the ",(0,t.jsx)(s.a,{href:"https://github.com/opencontainers/distribution-s

1pec/blob/main/spec.md#listing-referrers",children:"details"})," given in the distribution spec."]}),"\n",(0,t.jsx)(s.h3,{id:"referrer-tag-schema",children:"Referrer Tag Schema"}),"\n",(0,t.jsx)(s.p,{children:"The Referrer Tag Schema helps to pull the current list of referrers based on different digest formats or tags."}),"\n",(0,t.jsx)(s.h3,{id:"registry",children:"Registry"}),"\n",(0,t.jsx)(s.p,{children:"A registry is like a central repository where you can store, share and manage container images and artifacts."}),"\n",(0,t.jsx)(s.h3,{id:"remote-registry",children:"Remote Registry"}),"\n",(0,t.jsxs)(s.p,{children:["A remote registry is when our registry is remotely available such as Docker Hub, ghcr.io, etc.\nWe can use ORAS CLI to perform many operations such as ",(0,t.jsx)(s.a,{href:"/docs/1.1/commands/oras_push",children:"pushing"}),",\n",(0,t.jsx)(s.a,{href:"/docs/1.1/commands/oras_pull",children:"pulling"}),",\n",(0,t.jsx)(s.a,{href:"/docs/1.1/commands/oras_attach",children:"attaching"})," artifacts."]}),"\n",(0,t.jsx)(s.h3,{id:"software-bill-of-materials",children:"Software Bill of Materials"}),"\n",(0,t.jsx)(s.p,{children:"A codebase's open source and third-party components are listed in a software Bill of Materials (SBOM).\nAdditionally, an SBOM provides the versions of the components used in the codebase,\ntheir patch status,\nand the licences that govern them."}),"\n",(0,t.jsx)(s.h3,{id:"supply-chain-security",children:"Supply Chain Security"}),"\n",(0,t.jsx)(s.p,{children:"Supply chain security emphasises risk management of outside vendors, suppliers, logistics, and transportation.\nIt recognises, assesses, and reduces risks related to collaborating with other organisations as a part of your supply chain."}),"\n",(0,t.jsx)(s.h3,{id:"tags",children:"Tags"}),"\n",(0,t.jsx)(s.p,{children:"Tags are used to\xa0define keys and values and associate them with resources by adding metadata to resources."})]})}function h(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},28453(e,s,i){i.d(s,{R:()=>a,x:()=>o});var n=i(96540);const t={},r=n.createContext(t);function a(e){const s=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:a(e.components),n.createElement(r.Provider,{value:s},e.children)}}}]);