Updates docs to clearly indicate these are community maintained.

This commit is contained in:
Alex Collins 2019-09-19 16:57:59 -07:00
parent c78f70e82d
commit 4d33029318
7 changed files with 28 additions and 20 deletions

15
CONTRIBUTING.md Normal file
View file

@ -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.

3
OWNERS
View file

@ -1,8 +1,9 @@
owners: owners:
- alexec
- alexmt - alexmt
- jessesuen - jessesuen
approvers: approvers:
- alexec
- alexmt - alexmt
- jessesuen - jessesuen
- merenbach

View file

@ -1,19 +1,7 @@
# Argo Helm Charts # Argo Helm Charts
Repository contains helm charts for http://argoproj.io/ projects. Helm charts repository is hosted using Github pages Argo Helm is a collection of **community maintained** charts for http://argoproj.io/ projects. the charts can be added using following command:
and can be added using following command:
``` ```
helm repo add argo https://argoproj.github.io/argo-helm 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.

View file

@ -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). The default installation is intended to be similar to the provided ArgoCD [releases](https://github.com/argoproj/argo-cd/releases).

3
charts/argo-ci/README.md Normal file
View file

@ -0,0 +1,3 @@
# Argo CI Helm Chart
This is a **community maintained** chart.

View file

@ -1,5 +1,6 @@
# Argo-Events Helm Chart # 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 - Sensor Custom Resource Definition
- Gateway Custom Resource Definition - Gateway Custom Resource Definition
- Sensor Controller Deployment - Sensor Controller Deployment

View file

@ -1,5 +1,6 @@
## Argo Chart ## Argo workflows
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).
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. 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 * `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. * `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. * `artifactRepository.s3.accessKeySecret` and `artifactRepository.s3.secretKeySecret` These by default link to minio default credentials stored in the secret deployed by the minio chart.