This repository has been archived by the owner on Jul 18, 2023. It is now read-only.
generated from opencontainers/project-template
-
Notifications
You must be signed in to change notification settings - Fork 54
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from SteveLasker/initial-artifact-content
initial artifacts content
- Loading branch information
Showing
2 changed files
with
46 additions
and
12 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,4 @@ | ||
| This meta-project is maintained by the union of MAINTAINERS for all OCI Projects [1]. | ||
|
|
||
| Other OCI Projects should list one maintainer per line, with a name, email address, and GitHub username: | ||
|
|
||
| Random J Developer <[email protected]> (@RandomJDeveloperExample) | ||
| A. U. Thor <[email protected]> (@AUThorExample) | ||
|
|
||
| [1]: https://github.com/opencontainers/ | ||
| - Steve Lasker <[email protected]> (@stevelasker) | ||
| - Derek McGowan <[email protected]> (@derekmcgowan) | ||
| - Mike Brown <[email protected]> (@mikebrow) | ||
| - Stephen Day <[email protected]> (@stevvooe) |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,49 @@ | ||
| # OCI Project Template | ||
| # OCI Artifacts | ||
|
|
||
| Useful boilerplate and organizational information for all OCI projects. | ||
| 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][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. | ||
|
|
||
| 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. | ||
|
|
||
| Utilizing the [manifest][image-manifest] and [index][image-index] definitions, new artifacts, such as the [Singularity project][singularity], can be stored and served using the [distribution-spec][distribution-spec]. | ||
|
|
||
| This repository provides a reference for artifact authors and registry implementors for supporting new artifact types with the existing implementations of distribution. | ||
|
|
||
| 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). | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| * README (this file) | ||
| * [The Apache License, Version 2.0](LICENSE) | ||
| * [A list of maintainers](MAINTAINERS) | ||
| * [Maintainers](MAINTAINERS) | ||
| * [Maintainer guidelines](MAINTAINERS_GUIDE.md) | ||
| * [Contributor guidelines](CONTRIBUTING.md) | ||
| * [Project governance](GOVERNANCE.md) | ||
| * [Release procedures](RELEASES.md) | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| This project incorporates (by reference) the OCI [Code of Conduct][code-of-conduct]. | ||
|
|
||
| ## Governance and Releases | ||
|
|
||
| This project incorporates the Governance and Releases processes from the OCI project template: https://github.com/opencontainers/project-template. | ||
|
|
||
| ## Project Communications | ||
|
|
||
| This project would continue to use existing channels in use by the [OCI developer community for communication](https://github.com/opencontainers/org#communications) | ||
|
|
||
| ### Versioning / Roadmap | ||
|
|
||
| Artifacts will reference specific [distribution][distribution-spec], [index][image-index] and [manifest][image-manifest] versions in its examples, identifying any dependencies required. | ||
|
|
||
| ## Frequently Asked Questions (FAQ) | ||
|
|
||
| **Q: Does this change the OCI Charter or Scope Table?** | ||
|
|
||
| A: No. Artifacts are a prescriptive means of storing [index][image-index] and [manifest][image-manifest] within [distribution][distribution-spec] implementations. | ||
|
|
||
| [distribution-spec]: https://github.com/opencontainers/distribution-spec/ | ||
| [code-of-conduct]: https://github.com/opencontainers/org/blob/master/CODE_OF_CONDUCT.md | ||
| [image-manifest]: https://github.com/opencontainers/image-spec/blob/master/manifest.md | ||
| [image-index]: https://github.com/opencontainers/image-spec/blob/master/image-index.md | ||
| [distribution]: https://github.com/docker/distribution | ||
| [singularity]: https://github.com/sylabs/singularity |