chore: spelling/grammar for readmes/docs
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
This commit is contained in:
Josh Soref
parent
9e6d1134e8
commit
56f7b4dbb0
10 changed files with 27 additions and 22 deletions
|
|
@ -1,6 +1,6 @@
|
|||
# Contributing
|
||||
|
||||
Argo Helm is a collection of **community maintained** charts. Therefore we rely on you to test your changes sufficiently.
|
||||
Argo Helm is a collection of **community-maintained** charts. Therefore we rely on you to test your changes sufficiently.
|
||||
|
||||
## Testing Argo Workflows Changes
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# Argo Helm Charts
|
||||
|
||||
Argo Helm is a collection of **community maintained** charts for http://argoproj.io/ projects. the charts 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:
|
||||
|
||||
```
|
||||
```sh
|
||||
helm repo add argo https://argoproj.github.io/argo-helm
|
||||
```
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ Source code can be found [here](https://argoproj.github.io/argo-cd/)
|
|||
|
||||
## Additional Information
|
||||
|
||||
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.
|
||||
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).
|
||||
|
||||
|
|
@ -307,7 +307,7 @@ Helm v3 has removed the `install-crds` hook so CRDs are now populated by files i
|
|||
|
||||
When Redis is completely disabled from the chart (`redis.enabled=false`) and
|
||||
an external Redis instance wants to be used or
|
||||
when Redis HA subcart is enabled (`redis.enabled=true and redis-ha.enabled=true`)
|
||||
when Redis HA subchart is enabled (`redis.enabled=true and redis-ha.enabled=true`)
|
||||
but HA proxy is disabled `redis-ha.haproxy.enabled=false` Redis flags need to be specified
|
||||
through `xxx.extraArgs`
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
apiVersion: v1
|
||||
description: A Helm chart for Argo-CI
|
||||
name: argo-ci
|
||||
version: 0.1.7
|
||||
version: 0.1.8
|
||||
icon: https://raw.githubusercontent.com/argoproj/argo/master/docs/assets/argo.png
|
||||
appVersion: v1.0.0-alpha2
|
||||
home: https://github.com/argoproj/argo-helm
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
# Argo CI Chart
|
||||
|
||||
This is a **community maintained** chart.
|
||||
This is a **community-maintained** chart.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
apiVersion: v1
|
||||
appVersion: "0.10.2"
|
||||
appVersion: "0.10.3"
|
||||
description: A Helm chart for Argo Rollouts
|
||||
name: argo-rollouts
|
||||
version: 0.4.3
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Argo Rollouts Chart
|
||||
=============
|
||||
===================
|
||||
A Helm chart for Argo Rollouts, progressive delivery for Kubernetes.
|
||||
|
||||
Current chart version is `0.4.0`
|
||||
|
|
@ -7,7 +7,7 @@ Current chart version is `0.4.0`
|
|||
Source code can be found [here](https://github.com/argoproj/argo-rollouts)
|
||||
|
||||
## Additional Information
|
||||
This is a **community maintained** chart. This chart installs [argo-rollouts](https://argoproj.github.io/argo-rollouts/), progressive delivery for Kubernetes.
|
||||
This is a **community-maintained** chart. This chart installs [argo-rollouts](https://argoproj.github.io/argo-rollouts/), progressive delivery for Kubernetes.
|
||||
|
||||
The default installation is intended to be similar to the provided Argo Rollouts [releases](https://github.com/argoproj/argo-rollouts/releases).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
## 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).
|
||||
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-workflows), you should deploy it in the `kube-system` namespace.
|
||||
|
||||
|
|
@ -8,20 +8,24 @@ If you want your deployment of this helm chart to most closely match the [argo C
|
|||
This chart uses an install hook to configure the CRD definition. Installation of CRDs is a somewhat privileged process in itself and in RBAC enabled clusters the `default` service account for namespaces does not typically have the ability to do create these.
|
||||
|
||||
A few options are:
|
||||
|
||||
- Setup the CRD yourself manually and use `--set installCRD=false` when installing the helm chart. Find the CRDs in the [argo codebase](https://github.com/argoproj/argo-workflows/tree/master/manifests/base/crds/full)
|
||||
- Manually create a ServiceAccount in the Namespace which your release will be deployed w/ appropriate bindings to perform this action and set the `init.serviceAccount` attribute
|
||||
- Augment the `default` ServiceAccount permissions in the Namespace in which your Release is deployed to have the appropriate permissions
|
||||
|
||||
## Usage Notes:
|
||||
## Usage Notes
|
||||
This chart defaults to setting the `controller.instanceID.enabled` to `false` now, which means the deployed controller will act upon any workflow deployed to the cluster. If you would like to limit the behavior and deploy multiple workflow controllers, please use the `controller.instanceID.enabled` attribute along with one of it's configuration options to set the `instanceID` of the workflow controller to be properly scoped for your needs.
|
||||
|
||||
## Values
|
||||
## Chart Values
|
||||
|
||||
The `values.yaml` contains items used to tweak a deployment of this chart.
|
||||
Fields to note:
|
||||
* `controller.instanceID.enabled`: If set to true, the Argo Controller will **ONLY** monitor Workflow submissions with a `--instanceid` attribute
|
||||
* `controller.instanceID.useReleaseName`: If set to true then chart set controller instance id to release name
|
||||
* `controller.instanceID.explicitID`: Allows customization of an instance id for the workflow controller to monitor
|
||||
* `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.
|
||||
|
||||
| Key | Type | Default | Description |
|
||||
|-----|------|---------|-------------|
|
||||
| controller.instanceID.enabled | bool | ? | If set to true, the Argo Controller will **ONLY** monitor Workflow submissions with a `--instanceid` attribute |
|
||||
| controller.instanceID.useReleaseName | bool | ? | If set to true then chart set controller instance id to release name |
|
||||
| controller.instanceID.explicitID | string | ? | Allows customization of an instance id for the workflow controller to monitor
|
||||
| controller.workflowNamespaces | string | ? | This is a list of namespaces where workflows will be ran
|
||||
| minio.install | bool | 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 | string | ? | Default link to minio default credentials stored in the secret deployed by the minio chart.
|
||||
| artifactRepository.s3.secretKeySecret | string | ? | Default link to minio default credentials stored in the secret deployed by the minio chart.
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ appVersion: 1.0.1
|
|||
description: A Helm chart for ArgoCD notifications, an add-on to ArgoCD.
|
||||
name: argocd-notifications
|
||||
type: application
|
||||
version: 1.0.14
|
||||
version: 1.0.15
|
||||
home: https://github.com/argoproj/argo-helm
|
||||
icon: https://raw.githubusercontent.com/argoproj/argo/master/docs/assets/argo.png
|
||||
keywords:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
## ArgoCD Notifications Chart
|
||||
|
||||
This is a **community maintained** chart. It installs the [argocd-notifications](https://github.com/argoproj-labs/argocd-notifications) application. This application comes packaged with:
|
||||
This is a **community-maintained** chart. It installs the [argocd-notifications](https://github.com/argoproj-labs/argocd-notifications) application. This application comes packaged with:
|
||||
|
||||
- Notifications Controller Deployment
|
||||
- Notifications Controller ConfigMap
|
||||
- Notifications Controller Secret
|
||||
|
|
|
|||
Loading…
Reference in a new issue