fix(argo-workflows): Update outdated content on README (#1948)
fix(argo-workflows): Remove outdated content on README Signed-off-by: yu-croco <yu.croco@gmail.com>
This commit is contained in:
parent
7eafaa742e
commit
633954386f
3 changed files with 73 additions and 17 deletions
|
@ -3,7 +3,7 @@ appVersion: v3.4.6
|
||||||
name: argo-workflows
|
name: argo-workflows
|
||||||
description: A Helm chart for Argo Workflows
|
description: A Helm chart for Argo Workflows
|
||||||
type: application
|
type: application
|
||||||
version: 0.23.0
|
version: 0.23.1
|
||||||
icon: https://raw.githubusercontent.com/argoproj/argo-workflows/master/docs/assets/argo.png
|
icon: https://raw.githubusercontent.com/argoproj/argo-workflows/master/docs/assets/argo.png
|
||||||
home: https://github.com/argoproj/argo-helm
|
home: https://github.com/argoproj/argo-helm
|
||||||
sources:
|
sources:
|
||||||
|
@ -13,5 +13,5 @@ maintainers:
|
||||||
url: https://argoproj.github.io/
|
url: https://argoproj.github.io/
|
||||||
annotations:
|
annotations:
|
||||||
artifacthub.io/changes: |
|
artifacthub.io/changes: |
|
||||||
- kind: added
|
- kind: fixed
|
||||||
description: Added the ability to deploy init containers alongside the controller and server deployments.
|
description: Update outdated content on README.
|
||||||
|
|
|
@ -6,13 +6,6 @@ If you want your deployment of this helm chart to most closely match the [argo C
|
||||||
|
|
||||||
## Pre-Requisites
|
## Pre-Requisites
|
||||||
|
|
||||||
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 create these.
|
|
||||||
|
|
||||||
A few options are:
|
|
||||||
|
|
||||||
- Manually create a ServiceAccount in the Namespace in which your release will be deployed w/ appropriate bindings to perform this action and set the `serviceAccountName` field in the Workflow spec
|
|
||||||
- Augment the `default` ServiceAccount permissions in the Namespace in which your Release is deployed to have the appropriate permissions
|
|
||||||
|
|
||||||
### Custom resource definitions
|
### Custom resource definitions
|
||||||
|
|
||||||
Some users would prefer to install the CRDs _outside_ of the chart. You can disable the CRD installation of this chart by using `--set crds.install=false` when installing the chart.
|
Some users would prefer to install the CRDs _outside_ of the chart. You can disable the CRD installation of this chart by using `--set crds.install=false` when installing the chart.
|
||||||
|
@ -28,6 +21,41 @@ kubectl apply -k "https://github.com/argoproj/argo-workflows/manifests/base/crds
|
||||||
kubectl apply -k "https://github.com/argoproj/argo-workflows/manifests/base/crds/full?ref=v3.3.9"
|
kubectl apply -k "https://github.com/argoproj/argo-workflows/manifests/base/crds/full?ref=v3.3.9"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### ServiceAccount for Workflow Spec
|
||||||
|
In order for each Workflow run, you create ServiceAccount via `values.yaml` like below.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
workflow:
|
||||||
|
serviceAccount:
|
||||||
|
create: true
|
||||||
|
name: "argo-workflow"
|
||||||
|
rbac:
|
||||||
|
create: true
|
||||||
|
controller:
|
||||||
|
workflowNamespaces:
|
||||||
|
- default
|
||||||
|
- foo
|
||||||
|
- bar
|
||||||
|
```
|
||||||
|
|
||||||
|
Set ServiceAccount on Workflow.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
apiVersion: argoproj.io/v1alpha1
|
||||||
|
kind: Workflow
|
||||||
|
metadata:
|
||||||
|
generateName: hello-world-
|
||||||
|
spec:
|
||||||
|
entrypoint: whalesay
|
||||||
|
serviceAccountName: argo-workflow # Set ServiceAccount
|
||||||
|
templates:
|
||||||
|
- name: whalesay
|
||||||
|
container:
|
||||||
|
image: docker/whalesay
|
||||||
|
command: [ cowsay ]
|
||||||
|
args: [ "hello world" ]
|
||||||
|
```
|
||||||
|
|
||||||
## Installing the Chart
|
## Installing the Chart
|
||||||
|
|
||||||
To install the chart with the release name `my-release`:
|
To install the chart with the release name `my-release`:
|
||||||
|
|
|
@ -6,13 +6,6 @@ If you want your deployment of this helm chart to most closely match the [argo C
|
||||||
|
|
||||||
## Pre-Requisites
|
## Pre-Requisites
|
||||||
|
|
||||||
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 create these.
|
|
||||||
|
|
||||||
A few options are:
|
|
||||||
|
|
||||||
- Manually create a ServiceAccount in the Namespace in which your release will be deployed w/ appropriate bindings to perform this action and set the `serviceAccountName` field in the Workflow spec
|
|
||||||
- Augment the `default` ServiceAccount permissions in the Namespace in which your Release is deployed to have the appropriate permissions
|
|
||||||
|
|
||||||
### Custom resource definitions
|
### Custom resource definitions
|
||||||
|
|
||||||
Some users would prefer to install the CRDs _outside_ of the chart. You can disable the CRD installation of this chart by using `--set crds.install=false` when installing the chart.
|
Some users would prefer to install the CRDs _outside_ of the chart. You can disable the CRD installation of this chart by using `--set crds.install=false` when installing the chart.
|
||||||
|
@ -28,6 +21,41 @@ kubectl apply -k "https://github.com/argoproj/argo-workflows/manifests/base/crds
|
||||||
kubectl apply -k "https://github.com/argoproj/argo-workflows/manifests/base/crds/full?ref=v3.3.9"
|
kubectl apply -k "https://github.com/argoproj/argo-workflows/manifests/base/crds/full?ref=v3.3.9"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### ServiceAccount for Workflow Spec
|
||||||
|
In order for each Workflow run, you create ServiceAccount via `values.yaml` like below.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
workflow:
|
||||||
|
serviceAccount:
|
||||||
|
create: true
|
||||||
|
name: "argo-workflow"
|
||||||
|
rbac:
|
||||||
|
create: true
|
||||||
|
controller:
|
||||||
|
workflowNamespaces:
|
||||||
|
- default
|
||||||
|
- foo
|
||||||
|
- bar
|
||||||
|
```
|
||||||
|
|
||||||
|
Set ServiceAccount on Workflow.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
apiVersion: argoproj.io/v1alpha1
|
||||||
|
kind: Workflow
|
||||||
|
metadata:
|
||||||
|
generateName: hello-world-
|
||||||
|
spec:
|
||||||
|
entrypoint: whalesay
|
||||||
|
serviceAccountName: argo-workflow # Set ServiceAccount
|
||||||
|
templates:
|
||||||
|
- name: whalesay
|
||||||
|
container:
|
||||||
|
image: docker/whalesay
|
||||||
|
command: [ cowsay ]
|
||||||
|
args: [ "hello world" ]
|
||||||
|
```
|
||||||
|
|
||||||
## Installing the Chart
|
## Installing the Chart
|
||||||
|
|
||||||
To install the chart with the release name `my-release`:
|
To install the chart with the release name `my-release`:
|
||||||
|
|
Loading…
Reference in a new issue