Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: ConfigMap syntax #2889

Merged
merged 1 commit into from
Apr 29, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
42 changes: 20 additions & 22 deletions docs/configure-artifact-repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,20 +199,19 @@ Example:
$ kubectl edit configmap workflow-controller-configmap -n argo # assumes argo was installed in the argo namespace
...
data:
config: |
artifactRepository:
s3:
bucket: my-bucket
keyPrefix: prefix/in/bucket #optional
endpoint: my-minio-endpoint.default:9000 #AWS => s3.amazonaws.com; GCS => storage.googleapis.com
insecure: true #omit for S3/GCS. Needed when minio runs without TLS
accessKeySecret: #omit if accessing via AWS IAM
name: my-minio-cred
key: accessKey
secretKeySecret: #omit if accessing via AWS IAM
name: my-minio-cred
key: secretKey
useSDKCreds: true #tells argo to use AWS SDK's default provider chain, enable for things like IRSA support
artifactRepository: |
s3:
bucket: my-bucket
keyPrefix: prefix/in/bucket #optional
endpoint: my-minio-endpoint.default:9000 #AWS => s3.amazonaws.com; GCS => storage.googleapis.com
insecure: true #omit for S3/GCS. Needed when minio runs without TLS
accessKeySecret: #omit if accessing via AWS IAM
name: my-minio-cred
key: accessKey
secretKeySecret: #omit if accessing via AWS IAM
name: my-minio-cred
key: secretKey
useSDKCreds: true #tells argo to use AWS SDK's default provider chain, enable for things like IRSA support
```

The secrets are retrieved from the namespace you use to run your workflows. Note
Expand All @@ -231,14 +230,13 @@ Example:
$ kubectl edit configmap workflow-controller-configmap -n argo # assumes argo was installed in the argo namespace
...
data:
config: |
artifactRepository:
gcs:
bucket: my-bucket
keyFormat: prefix/in/bucket #optional, it could reference workflow variables, such as "{{workflow.name}}/{{pod.name}}"
serviceAccountKeySecret:
name: my-gcs-credentials
key: serviceAccountKey
artifactRepository: |
gcs:
bucket: my-bucket
keyFormat: prefix/in/bucket #optional, it could reference workflow variables, such as "{{workflow.name}}/{{pod.name}}"
serviceAccountKeySecret:
name: my-gcs-credentials
key: serviceAccountKey
```

# Accessing Non-Default Artifact Repositories
Expand Down
28 changes: 13 additions & 15 deletions docs/default-workflow-specs.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,18 +40,16 @@ kind: ConfigMap
metadata:
name: workflow-controller-configmap
data:
config: |

# Default values that will apply to all Workflows from this controller, unless overridden on the Workflow-level
workflowDefaults:
metadata:
annotations:
argo: workflows
labels:
foo: bar
spec:
ttlStrategy:
secondsAfterSuccess: 5
parallelism: 3

```
# Default values that will apply to all Workflows from this controller, unless overridden on the Workflow-level
workflowDefaults: |
metadata:
annotations:
argo: workflows
labels:
foo: bar
spec:
ttlStrategy:
secondsAfterSuccess: 5
parallelism: 3

```
6 changes: 3 additions & 3 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ kubectl create namespace argo
kubectl apply -n argo -f https://raw.githubusercontent.com/argoproj/argo/stable/manifests/install.yaml
```

Namespaced installs as well as installs with MinIO and/or a database built in [are also available](https://github.com/argoproj/argo/tree/stable/manifests).
Namespaced installs as well as installs with MinIO and/or a database built in [are also available](https://github.com/argoproj/argo/tree/stable/manifests).

Examples below will assume you've installed argo in the `argo` namespace. If you have not, adjust
Examples below will assume you've installed argo in the `argo` namespace. If you have not, adjust
the commands accordingly.

NOTE: On GKE, you may need to grant your account the ability to create new `clusterrole`s
Expand Down Expand Up @@ -128,7 +128,7 @@ kubectl edit cm -n argo workflow-controller-configmap
Add the following:
```yaml
data:
artifactRepository:
artifactRepository: |
s3:
bucket: my-bucket
endpoint: argo-artifacts.default:9000
Expand Down
6 changes: 3 additions & 3 deletions docs/workflow-controller-configmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The Workflow Controller Configmap is used to set controller-wide settings.

For a detailed example, please see [`workflow-controller-configmap.yaml`](./workflow-controller-configmap.yaml).

## Setting the Configmap
## Setting the Configmap

The configmap should be saved as a K8s Configmap on the cluster in the same namespace as the `workflow-controller`.
It should then be referenced by the `workflow-controller` as an command argument:
Expand Down Expand Up @@ -69,7 +69,7 @@ data:
```

In version 2.7+, the `config: |` key is optional. However, if the `config: |` key is not used, all nested maps under top level
keys should be strings. This makes it easier to generate the map with some configuration management tools like Kustomize.
keys should be strings. This makes it easier to generate the map with some configuration management tools like Kustomize.

```yaml
# This file describes the config settings available in the workflow controller configmap
Expand All @@ -91,5 +91,5 @@ data: # "config: |" key is optional in 2.7+!
key: accessKey
secretKeySecret:
name: my-s3-credentials
key: secretKey
key: secretKey
```