From 544ca360a0bfa4b2d501c0006497407309509342 Mon Sep 17 00:00:00 2001 From: Vic Iglesias Date: Tue, 23 Aug 2016 14:38:32 -0700 Subject: [PATCH 1/6] Create stable and incubator directories --- incubator/.gitkeep | 0 {mariadb => stable/mariadb}/.helmignore | 0 {mariadb => stable/mariadb}/Chart.yaml | 0 {mariadb => stable/mariadb}/README.md | 0 {mariadb => stable/mariadb}/templates/_helpers.tpl | 0 {mariadb => stable/mariadb}/templates/deployment.yaml | 0 {mariadb => stable/mariadb}/templates/secrets.yaml | 0 {mariadb => stable/mariadb}/templates/svc.yaml | 0 {mariadb => stable/mariadb}/values.yaml | 0 9 files changed, 0 insertions(+), 0 deletions(-) create mode 100644 incubator/.gitkeep rename {mariadb => stable/mariadb}/.helmignore (100%) rename {mariadb => stable/mariadb}/Chart.yaml (100%) rename {mariadb => stable/mariadb}/README.md (100%) rename {mariadb => stable/mariadb}/templates/_helpers.tpl (100%) rename {mariadb => stable/mariadb}/templates/deployment.yaml (100%) rename {mariadb => stable/mariadb}/templates/secrets.yaml (100%) rename {mariadb => stable/mariadb}/templates/svc.yaml (100%) rename {mariadb => stable/mariadb}/values.yaml (100%) 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 From 91e80df0945edbfb5a08f545a1a316fecbbc50e7 Mon Sep 17 00:00:00 2001 From: Vic Iglesias Date: Tue, 23 Aug 2016 15:07:18 -0700 Subject: [PATCH 2/6] Add repo structure info to CONTRIBUTING --- CONTRIBUTING.md | 25 ++++++++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0f7e1024f6..27d61039c3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,12 +19,31 @@ Follow either of the two links above to access the appropriate CLA and instructi This repository is used by Chart developers for maintaining the official charts for Kubernetes Helm. If your issue is in the Helm tool itself, please use the issue tracker in the [kubernetes/helm](https://github.com/kubernetes/helm) repository. +### Repository Structure + +The Charts in this repository are organized into two folders: +* stable +* incubator + +Stable Charts: + +1. Provide a method for data persistence +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. 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. + ### 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 From f3dd89d71b5f5e9a0476ad213ce836a90ad34928 Mon Sep 17 00:00:00 2001 From: Vic Iglesias Date: Thu, 25 Aug 2016 11:46:45 -0700 Subject: [PATCH 3/6] Move structure details to README --- CONTRIBUTING.md | 18 ------------------ README.md | 16 ++++++++++++++++ 2 files changed, 16 insertions(+), 18 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 27d61039c3..56ca6fce3d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,24 +19,6 @@ Follow either of the two links above to access the appropriate CLA and instructi This repository is used by Chart developers for maintaining the official charts for Kubernetes Helm. If your issue is in the Helm tool itself, please use the issue tracker in the [kubernetes/helm](https://github.com/kubernetes/helm) repository. -### Repository Structure - -The Charts in this repository are organized into two folders: -* stable -* incubator - -Stable Charts: - -1. Provide a method for data persistence -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. 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. - ### How to contribute a Chart 1. If you haven't already done so, sign a Contributor License Agreement (see details above). diff --git a/README.md b/README.md index 3653805b41..e530946328 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 +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. 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. From be595f9f29284911f749a8efe1573f90976bac16 Mon Sep 17 00:00:00 2001 From: Vic Iglesias Date: Thu, 25 Aug 2016 13:09:31 -0700 Subject: [PATCH 4/6] Remove technical requirement to not use alpha features --- CONTRIBUTING.md | 1 - 1 file changed, 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 56ca6fce3d..acdf3e46b1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -37,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 From ad3495850f1b0c7633832822c3f885a4e0b5aa5b Mon Sep 17 00:00:00 2001 From: Vic Iglesias Date: Thu, 25 Aug 2016 13:11:17 -0700 Subject: [PATCH 5/6] Incubator charts must meet tech requirements --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e530946328..1a60fd56c5 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ Stable Charts: 1. Provide a secure default configuration 1. Do not leverage alpha features of Kubernetes -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. +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. From 603414b0f10b100beec6ff58498784f98389a7f8 Mon Sep 17 00:00:00 2001 From: Vic Iglesias Date: Thu, 25 Aug 2016 13:12:05 -0700 Subject: [PATCH 6/6] Add (if applicable) to persistence requirement --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1a60fd56c5..8614373971 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ The Charts in this repository are organized into two folders: Stable Charts: -1. Provide a method for data persistence +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