|
1 | | -# OCI artifact project proposal |
| 1 | +# OCI Artifacts Project Proposal |
2 | 2 |
|
3 | 3 | ## Abstract |
4 | | -Container registries, implementing the [distribution-spec][distribution-spec], provide reliable, highly scalable, secured storage services for container images. Customers either use a cloud provider implementation, vendor implementations, or instance the open source implementation of distribution. They configure security and networking to assure the images in the registry are locked down and accessible by the resources required. Cloud providers and vendors often provide additional values atop their registry implementations from security to productivity features. |
5 | 4 |
|
6 | | -Applications and services typically require additional artifacts to deploy and manage, including [helm](https://helm.sh) for deployment and [Open Policy Agent (OPA)](https://github.com/open-policy-agent/opa/issues/1413) for policy enforcement. |
| 5 | +Container registries, implementing the [OCI distribution-spec][distribution-spec], provide reliable, highly scalable, secured storage services for container images. Customers use cloud provider implementations, vendor implementations, and instances of the open source implementation of docker distribution. They configure security and networking to assure the images in the registry are locked down and accessible by the resources required. Cloud providers and vendors often provide additional value atop their registry implementations from security to productivity features. |
7 | 6 |
|
8 | | -Utilizing the [manifest][image-manifest] and [index][image-index] definitions, new artifacts can be stored and served using the [distribution-spec][distribution-spec] without changing the actual distribution spec. This repository will provide a reference for artifact authors and registry implementors for supporting new artifact types with the existing implementations of distribution. |
| 7 | +Applications and services typically require additional artifacts to deploy and manage container images, including [helm](https://helm.sh) charts for deployment and [Open Policy Agent (OPA) bundles](https://github.com/open-policy-agent/opa/issues/1413) for policy enforcement. |
9 | 8 |
|
10 | | -By providing an OCI artifact definition, the community can continue to innovate, focusing on new artifact types without having to build yet another storage solution (YASS). |
| 9 | +Utilizing the [OCI manifest][image-manifest] and [OCI index][image-index] definitions, new artifact types can be stored and served using the [OCI distribution-spec][distribution-spec] without changing the actual distribution spec. This repository will provide a reference for artifact authors and registry implementors for supporting these new artifact types themselves with the existing implementations of distribution. |
| 10 | + |
| 11 | +By providing support for OCI artifact types over OCI distributions, the community can continue to innovate, focusing on new artifact types without having to build yet another storage solution (YASS). |
11 | 12 |
|
12 | 13 | ## Proposal |
13 | | -Under the http://github.com/opencontainers organization: |
14 | 14 |
|
15 | | -- Create a new **artifacts** repository, named http://github.com/opencontainers/artifacts |
16 | | -- Update [distribution][distribution-spec] to generically reference [manifest][image-manifest] and [index][image-index], with image as one of many artifact types it can store. |
| 15 | +Under the [github.com/opencontainers](http://github.com/opencontainers) organization: |
| 16 | + |
| 17 | +- Create a new **artifacts** repository, named [github.com/opencontainers/artifacts](http://github.com/opencontainers/artifacts) |
| 18 | +- Update the [OCI distribution-spec][distribution-spec] to generically reference [OCI manifest][image-manifest] and [OCI index][image-index], with [OCI Image][image-spec] as one of many artifact types it can store. |
| 19 | +- Update the [OCI image-spec][image-spec] to reference images as an implementation of artifacts, using [OCI manifest][image-manifest] and [OCI index][image-index] |
17 | 20 |
|
18 | 21 | ## Contents |
19 | 22 |
|
20 | | -The repository will serve 2 primary goals: |
| 23 | +The repository will serve 3 primary goals: |
21 | 24 |
|
22 | 25 | 1. **artifact authors** - guidance for authoring new artifact types. Including a clearing house for well known artifact types. |
23 | 26 | 1. **registry operators and vendors** - guidance for how operators and vendors can support new artifact types, including how they can opt-in or out of well known artifact types. Registry operators that already implement `media-type` filtering will not have to change. The artifact repo will provide context on how new `media-type`s can be used, and how `media-type`s can be associated with a type of artifact. |
| 27 | +1. **clearing house for well known artifacts** - artifact authors can submit their artifact definitions, providing registry operators a list by which they can easily support. |
| 28 | + |
| 29 | +### Process for Approving New Artifact Definitions |
| 30 | + |
| 31 | +1. Proposals for new artifact types should be opened as pull requests on the artifact repository |
| 32 | +1. The artifact project maintainers will review new proposals, ask clarifying questions, and choose or not to accept the suggested artifact type |
| 33 | +1. Acceptance requires at least 2 +1s from the maintainers (currently 3 maintainers) |
| 34 | +1. Where the submitter disagrees strongly with the decision they can bring to the issue to the TOB for a vote, under the current voting rules. |
24 | 35 |
|
25 | 36 | ### Initial Maintainers |
| 37 | + |
26 | 38 | Initial maintainers of the artifacts project would be : |
27 | | -* Steve Lasker < [email protected]> ( @stevelasker) |
28 | | -* Derek McGowan < [email protected]> @derekmcgowan |
29 | | -* Mike Brown <[email protected]> @mikebrow |
| 39 | + |
| 40 | +- Steve Lasker < [email protected]> ( @stevelasker) |
| 41 | +- Derek McGowan < [email protected]> ( @derekmcgowan) |
| 42 | +- Mike Brown <[email protected]> ( @mikebrow) |
| 43 | +- Stephen Day <[email protected]> ( @stevvooe) |
30 | 44 |
|
31 | 45 | ### Code of Conduct |
32 | | -This project would incorporate (by reference) the OCI [Code of Conduct][code-of-conduct]. |
| 46 | + |
| 47 | +This project would incorporate (by reference) the [OCI Code of Conduct][code-of-conduct]. |
33 | 48 |
|
34 | 49 | ### Governance and Releases |
35 | | -This project would incorporate the Governance and Releases processes from the OCI project template: https://github.com/opencontainers/project-template. |
| 50 | + |
| 51 | +This project would further incorporate the Governance and Releases processes from the OCI project template: [github.com/opencontainers/project-template](https://github.com/opencontainers/project-template). |
36 | 52 |
|
37 | 53 | ### Project Communications |
38 | | -Both of the proposed projects would continue to use existing channels in use by the OCI developer community for communication including: |
39 | | -* GitHub for issues and pull requests |
40 | | -* The [email protected] email list |
41 | | -* The weekly OCI developer community conference call |
42 | | -* The #OpenContainers IRC channel |
| 54 | + |
| 55 | +This project would continue to use existing channels in use by the [OCI developer community for communication](https://github.com/opencontainers/org#communications) |
43 | 56 |
|
44 | 57 | ### Versioning / Roadmap |
| 58 | + |
45 | 59 | This repository will not be versioned, but will be continuously updated with a list of versioned types with historical references. This repository will not have releases. |
46 | 60 |
|
47 | | -Artifacts will reference specific [distribution][distribution-spec], [index][image-index] and [manifest][image-manifest] versions in its examples and references for capabilities. |
| 61 | +Artifacts will reference specific [OCI distribution][distribution-spec], [OCI index][image-index] and [OCI manifest][image-manifest] versions in its examples and references for capabilities. |
48 | 62 |
|
49 | 63 | ## Frequently Asked Questions (FAQ) |
50 | 64 |
|
51 | 65 | **Q: Does this change the OCI Charter or Scope Table?** |
52 | 66 |
|
53 | | -A: No. Artifacts are a prescriptive means of storing [index][image-index] and [manifest][image-manifest] within [distribution][distribution-spec] implementations. |
| 67 | +A: No. Artifacts are a prescriptive means of storing [OCI index][image-index] and [OCI manifest][image-manifest] within [OCI distribution][distribution-spec] implementations. |
54 | 68 |
|
55 | 69 | [distribution-spec]: https://github.com/opencontainers/distribution-spec/ |
| 70 | +[image-spec]: https://github.com/opencontainers/image-spec/ |
56 | 71 | [code-of-conduct]: https://github.com/opencontainers/org/blob/master/CODE_OF_CONDUCT.md |
57 | 72 | [image-manifest]: https://github.com/opencontainers/image-spec/blob/master/manifest.md |
58 | | -[image-index]: https://github.com/opencontainers/image-spec/blob/master/image-index.md |
| 73 | +[image-index]: https://github.com/opencontainers/image-spec/blob/master/image-index.md |
0 commit comments