diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..0e483c31 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,15 @@ +# Contributing + +Argo Helm is a collection of **community maintained** charts. Therefore we rely on you to test your changes correctly + + +## Publishing Changes + +To push changes use following script: + +``` +GIT_PUSH=true ./scripts/publish.sh +``` + +Script generates tar file for each chart in `charts` directory and push changes to `gh-pages` branch. +Write access to https://github.com/argoproj/argo-helm.git is required to publish changes. diff --git a/OWNERS b/OWNERS index 3328be91..e393c5ba 100644 --- a/OWNERS +++ b/OWNERS @@ -1,8 +1,9 @@ owners: +- alexec - alexmt - jessesuen approvers: +- alexec - alexmt - jessesuen -- merenbach diff --git a/README.md b/README.md index c058c3c1..871c0cab 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,7 @@ # Argo Helm Charts -Repository contains helm charts for http://argoproj.io/ projects. Helm charts repository is hosted using Github pages -and can be added using following command: +Argo Helm is a collection of **community maintained** charts for http://argoproj.io/ projects. the charts can be added using following command: ``` helm repo add argo https://argoproj.github.io/argo-helm ``` - -## Publishing changes - -To push changes use following script: - -``` -GIT_PUSH=true ./scripts/publish.sh -``` - -Script generates tar file for each chart in `charts` directory and push changes to `gh-pages` branch. -Write access to https://github.com/argoproj/argo-helm.git is required to publish changes. diff --git a/charts/argo-cd/README.md b/charts/argo-cd/README.md index 171f589f..1232b623 100644 --- a/charts/argo-cd/README.md +++ b/charts/argo-cd/README.md @@ -1,6 +1,6 @@ -# argo-cd +# Argo CD -This chart installs [argo-cd](https://argoproj.github.io/argo-cd/), a declarative, GitOps continuous delivery tool for Kubernetes. +This is a **community maintained** chart. This chart installs [argo-cd](https://argoproj.github.io/argo-cd/), a declarative, GitOps continuous delivery tool for Kubernetes. The default installation is intended to be similar to the provided ArgoCD [releases](https://github.com/argoproj/argo-cd/releases). diff --git a/charts/argo-ci/README.md b/charts/argo-ci/README.md new file mode 100644 index 00000000..6b5490d8 --- /dev/null +++ b/charts/argo-ci/README.md @@ -0,0 +1,3 @@ +# Argo CI Helm Chart + +This is a **community maintained** chart. diff --git a/charts/argo-events/README.md b/charts/argo-events/README.md index d09f9e8a..97beb7dc 100644 --- a/charts/argo-events/README.md +++ b/charts/argo-events/README.md @@ -1,5 +1,6 @@ # Argo-Events Helm Chart -This helm chart installs the [argo-events](https://github.com/argoproj/argo-events) application. This application comes packaged with: + +This is a **community maintained** chart. It installs the [argo-events](https://github.com/argoproj/argo-events) application. This application comes packaged with: - Sensor Custom Resource Definition - Gateway Custom Resource Definition - Sensor Controller Deployment diff --git a/charts/argo/README.md b/charts/argo/README.md index e0c74948..a204cc10 100644 --- a/charts/argo/README.md +++ b/charts/argo/README.md @@ -1,5 +1,6 @@ -## Argo Chart -This chart is used to set up argo and it's needed dependencies through one command. This is used in conjunction with [helm](https://github.com/kubernetes/helm). +## Argo workflows + +This is a **community maintained** chart. It is used to set up argo and it's needed dependencies through one command. This is used in conjunction with [helm](https://github.com/kubernetes/helm). If you want your deployment of this helm chart to most closely match the [argo CLI](https://github.com/argoproj/argo), you should deploy it in the `kube-system` namespace. @@ -24,4 +25,3 @@ Fields to note: * `controller.workflowNamespaces`: This is a list of namespaces where workflows will be ran * `minio.install`: If this is true, we'll install [minio](https://github.com/kubernetes/charts/tree/master/stable/minio) and build out the artifactRepository section in workflow controller config map. * `artifactRepository.s3.accessKeySecret` and `artifactRepository.s3.secretKeySecret` These by default link to minio default credentials stored in the secret deployed by the minio chart. -