From 574e5cfa18acaacf3b7dc8316a1e5c5348bcbb22 Mon Sep 17 00:00:00 2001 From: Alex Collins Date: Thu, 19 Sep 2019 17:36:12 -0700 Subject: [PATCH] Contributing (#116) --- .github/pull_request_template.md | 21 +++-------- CONTRIBUTING.md | 61 ++++++++++++++++++++++++++++++++ OWNERS | 3 +- README.md | 14 +------- charts/argo-cd/README.md | 4 +-- charts/argo-ci/README.md | 3 ++ charts/argo-events/README.md | 5 +-- charts/argo/README.md | 6 ++-- 8 files changed, 79 insertions(+), 38 deletions(-) create mode 100644 CONTRIBUTING.md create mode 100644 charts/argo-ci/README.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index eb14440e6..f3d086a0c 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,18 +1,5 @@ -* [ ] I have update the chart version in `Chart.yaml` following Semantic Versioning. -* [ ] All new values are backwards compatible and/or have sensible default. -* [ ] I have installed the chart myself and it works. - -E.g. for Argo Workflows: - -``` -helm install charts/argo -argo version -``` +Checklist: -E.g. for Argo CD: - -``` -helm install charts/argo-cd --namespace argocd -kubectl port-forward svc/argocd-server -n argocd 8080:443 & -argocd version -``` +* [ ] I have update the chart version in `Chart.yaml` following Semantic Versioning. +* [ ] Any new values are backwards compatible and/or have sensible default. +* [ ] I have followed the testing instructions in the [contributing guide](https://github.com/argoproj/argo-helm/blob/master/CONTRIBUTING.md). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..e6370aeb8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,61 @@ +# Contributing + +Argo Helm is a collection of **community maintained** charts. Therefore we rely on you to test your changes sufficiently. + +## Testing Argo Workflows Changes + +Minimally: + +``` +helm install charts/argo -n argo +argo version +``` + +Follow this instructions for running a hello world workflow. + +## Testing Argo CD Changes + +Clean-up: + +``` +helm delete argo-cd --purge +kubectl delete crd -l app.kubernetes.io/part-of=argo-cd +``` + +Minimally: + +``` +helm install charts/argo-cd --namespace argocd -n argo-cd +kubectl port-forward svc/argocd-server -n argocd 8080:443 +``` + +In a new terminal: + +``` +argocd version +# reset password to 'Password1!' +kubectl -n argocd patch secret argocd-secret \ + -p '{"stringData": { + "admin.password": "$2a$10$hDj12Tw9xVmvybSahN1Y0.f9DZixxN8oybyA32Uy/eqWklFU4Mo8O", + "admin.passwordMtime": "'$(date +%FT%T%Z)'" + }}' +argocd login localhost:8080 --username admin --password 'Password1!' +``` + +Create and sync app: + +``` +argocd app create guestbook --dest-namespace default --dest-server https://kubernetes.default.svc --path guestbook --project default --repo https://github.com/argoproj/argocd-example-apps.git +argocd app sync guestbook +``` + +## 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 3328be91c..e393c5ba6 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 c058c3c13..871c0cabb 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 171f589ff..c182ffa2c 100644 --- a/charts/argo-cd/README.md +++ b/charts/argo-cd/README.md @@ -1,6 +1,6 @@ -# argo-cd +# Argo CD Chart -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 000000000..28231e8ce --- /dev/null +++ b/charts/argo-ci/README.md @@ -0,0 +1,3 @@ +# Argo CI Chart + +This is a **community maintained** chart. diff --git a/charts/argo-events/README.md b/charts/argo-events/README.md index d09f9e8a5..dee9b291e 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: +# Argo-Events Chart + +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 e0c749485..ac2c234dd 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 Chart + +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. -