08ad7eace5
Signed-off-by: Cintia Sanchez Garcia <cynthiasg@icloud.com> |
||
|---|---|---|
| .github | ||
| .gitpod | ||
| charts/artifact-hub | ||
| cmd | ||
| configs | ||
| database | ||
| docs | ||
| internal | ||
| scripts | ||
| web | ||
| .ct.yaml | ||
| .dockerignore | ||
| .gitattributes | ||
| .gitignore | ||
| .gitpod.yml | ||
| .golangci.yml | ||
| .ignore | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| OWNERS | ||
| README.md | ||
| SECURITY.md | ||
| code-of-conduct.md | ||
| go.mod | ||
| go.sum | ||
README.md
Artifact Hub
Artifact Hub is a web-based application that enables finding, installing, and publishing packages and configurations for CNCF projects. For example, this could include Helm charts and plugins, Falco configurations, Open Policy Agent (OPA) policies, OLM operators, Tinkerbell actions, kubectl plugins and Tekton tasks.
Discovering artifacts to use with CNCF projects can be difficult. If every CNCF project that needs to share artifacts creates its own Hub this creates a fair amount of repeat work for each project and a fractured experience for those trying to find the artifacts to consume. The Artifact Hub attempts to solve that by providing a single experience for consumers that any CNCF project can leverage.
The project, accessible at https://artifacthub.io, is currently in development in a beta state. Support for Helm charts and plugins, Falco configurations, OPA policies, OLM operators, Tinkerbell actions, kubectl plugins and Tekton tasks is in development with plans to support more projects to follow. Pull requests, especially those to support other CNCF projects, are welcome. Please see CONTRIBUTING.md and dev.md for more details.
Feel free to ask any questions on the #artifact-hub channel in the CNCF Slack. To get an invite please visit http://slack.cncf.io/.
 |
 |
 |
 |
 |
 |
Getting started
Artifact Hub allows publishers to list their content in an automated way. Please check out the repositories guide for more details about how to add your repositories.
If you want to run your own Artifact Hub instance in your Kubernetes cluster, the easiest way is by deploying the Helm chart provided. For more details, please see the Helm chart README file.
Community
The Artifact Hub is an open source project. Aside from contributing code and feature suggestions you can also engage via:
- Attending a meeting. Meetings are on the 2nd Tuesday of the month at 10:30am PT / 1:30pm ET. Meeting minutes and agenda are in Google Docs.
- Joining CNCF slack (join link) and joining the room #artifact-hub.
Process
Artifact Hub is a CNCF Sandbox Project.
We're envisioning that Artifact Hub will have three main components:
- The software, consisting of frontend code using React, backend written in Go, and Postgres with a number of stored procedures
- A process by which new artifacts get added to Artifact Hub, updated, and removed. The documentation for this process is just beginning, but it needs to be publicly documented, transparent, and robust. In particular, edge cases need to be able to be reviewed by the project maintainers, with an appeal path to SIG Apps and the TOC
- Operational responsibilities. A number of organizations are likely to depend on Artifact Hub not to “break the build” and so the maintainers will need to provide a high level of uptime, with CNCF funding the hosting and related systems
Code of Conduct
This project follows the CNCF Code of Conduct.
Security
To report a security problem in Artifact Hub, please contact the Maintainers Team at cncf-artifacthub-maintainers@lists.cncf.io. Please see SECURITY.md for more details.
License
Artifact Hub is an Open Source project licensed under the Apache License 2.0.