diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0f7e1024f6..acdf3e46b1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,9 +22,10 @@ This repository is used by Chart developers for maintaining the official charts ### How to contribute a Chart 1. If you haven't already done so, sign a Contributor License Agreement (see details above). -2. Fork this repository, develop and test your Chart. -3. Ensure your Chart follows the technical and documentation guidelines, described below. -4. Submit a pull request. +1. Fork this repository, develop and test your Chart. +1. Choose the correct folder for your chart based on the information in the [Repository Structure](#repository-structure) section +1. Ensure your Chart follows the [technical](#technical-requirements) and [documentation](#documentation-requirements) guidelines, described below. +1. Submit a pull request. #### Technical requirements @@ -36,7 +37,6 @@ This repository is used by Chart developers for maintaining the official charts * Must include source GitHub repositories for images used in the Chart * Images should not have any major security vulnerabilities * Must be up-to-date with the latest stable Helm/Kubernetes features - * Don't use alpha Kubernetes features * Use Deployments in favor of ReplicationControllers * Should follow Kubernetes best practices * Include Health Checks wherever practical diff --git a/README.md b/README.md index 3653805b41..8614373971 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,22 @@ The Charts in the master branch of this repository match the latest packaged Cha The purpose of this repository is to provide a place for maintaining and contributing official Charts, with CI processes in place for managing the releasing of Charts into the Chart Repository. +The Charts in this repository are organized into two folders: +* stable +* incubator + +Stable Charts: + +1. Provide a method for data persistence (if applicable) +1. Support application upgrades +1. Allow customization of the application configuration +1. Provide a secure default configuration +1. Do not leverage alpha features of Kubernetes + +Incubator Charts are those that do not meet these criteria, but still meet the technical and documentation requirements described in CONTRIBUTING.md. Having the incubator folder allows charts to be shared and improved on until they are ready to be moved into the stable folder. + +In order to get a Chart from incubator to stable, Chart maintainers should open a pull request that moves the chart folder. + ## Contributing a Chart We'd love for you to contribute a Chart that provides a useful application or service for Kubernetes. Please read our [Contribution Guide](CONTRIBUTING.md) for more information on how you can contribute Charts. diff --git a/incubator/.gitkeep b/incubator/.gitkeep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/mariadb/.helmignore b/stable/mariadb/.helmignore similarity index 100% rename from mariadb/.helmignore rename to stable/mariadb/.helmignore diff --git a/mariadb/Chart.yaml b/stable/mariadb/Chart.yaml similarity index 100% rename from mariadb/Chart.yaml rename to stable/mariadb/Chart.yaml diff --git a/mariadb/README.md b/stable/mariadb/README.md similarity index 100% rename from mariadb/README.md rename to stable/mariadb/README.md diff --git a/mariadb/templates/_helpers.tpl b/stable/mariadb/templates/_helpers.tpl similarity index 100% rename from mariadb/templates/_helpers.tpl rename to stable/mariadb/templates/_helpers.tpl diff --git a/mariadb/templates/deployment.yaml b/stable/mariadb/templates/deployment.yaml similarity index 100% rename from mariadb/templates/deployment.yaml rename to stable/mariadb/templates/deployment.yaml diff --git a/mariadb/templates/secrets.yaml b/stable/mariadb/templates/secrets.yaml similarity index 100% rename from mariadb/templates/secrets.yaml rename to stable/mariadb/templates/secrets.yaml diff --git a/mariadb/templates/svc.yaml b/stable/mariadb/templates/svc.yaml similarity index 100% rename from mariadb/templates/svc.yaml rename to stable/mariadb/templates/svc.yaml diff --git a/mariadb/values.yaml b/stable/mariadb/values.yaml similarity index 100% rename from mariadb/values.yaml rename to stable/mariadb/values.yaml