Skip to content

Commit

Permalink
Update requirements for stable charts (helm#149)
Browse files Browse the repository at this point in the history
* Add requirement that stable charts include NOTES.txt

* Consolidate technical requirements for stable charts
  • Loading branch information
Vic Iglesias authored Oct 26, 2016
1 parent ba659fd commit 61e2d0d
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,13 @@ This repository is used by Chart developers for maintaining the official charts
* Use Deployments in favor of ReplicationControllers
* Should follow Kubernetes best practices
* Include Health Checks wherever practical
* Allow configurable [resource requests and limits](http://kubernetes.io/docs/user-guide/compute-resources/#resource-requests-and-limits-of-pod-and-container)
* Provide a method for data persistence (if applicable)
* Support application upgrades
* Allow customization of the application configuration
* Provide a secure default configuration
* Do not leverage alpha features of Kubernetes
* Includes a [NOTES.txt](https://github.com/kubernetes/helm/blob/master/docs/charts.md#chart-license-readme-and-notes) explaining how to use the application after install

#### Documentation requirements

Expand Down
10 changes: 2 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,9 @@ The Charts in this repository are organized into two folders:
* stable
* incubator

Stable Charts:
Stable Charts meet the criteria in the [technical requirements](CONTRIBUTING.md#technical-requirements).

1. Provide a method for data persistence (if applicable)
2. Support application upgrades
3. Allow customization of the application configuration
4. Provide a secure default configuration
5. 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. The charts in the `incubator/` directory can be found in the [`gs://kubernetes-charts-incubator` Google Storage Bucket](https://console.cloud.google.com/storage/browser/kubernetes-charts-incubator).
Incubator Charts are those that do not meet these criteria. Having the incubator folder allows charts to be shared and improved on until they are ready to be moved into the stable folder. The charts in the `incubator/` directory can be found in the [`gs://kubernetes-charts-incubator` Google Storage Bucket](https://console.cloud.google.com/storage/browser/kubernetes-charts-incubator).

In order to get a Chart from incubator to stable, Chart maintainers should open a pull request that moves the chart folder.

Expand Down

0 comments on commit 61e2d0d

Please sign in to comment.