Skip to content

Commit

Permalink
docs: Add notes to params from configmap examples (#6894)
Browse files Browse the repository at this point in the history
Signed-off-by: Yuan Tang <terrytangyuan@gmail.com>
  • Loading branch information
terrytangyuan authored and tczhao committed Apr 26, 2022
1 parent 7935263 commit 3ae8f7e
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 2 deletions.
2 changes: 2 additions & 0 deletions examples/arguments-parameters-from-configmap.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ metadata:
annotations:
workflows.argoproj.io/description: |
This example demonstrates loading parameter values from configmap.
Note that the "simple-parameters" ConfigMap (defined in examples/configmaps/simple-parameters-configmap.yaml)
needs to be created first before submitting this workflow.
workflows.argoproj.io/verify.py: |
assert status["phase"] == "Succeeded"
spec:
Expand Down
2 changes: 1 addition & 1 deletion examples/configmaps/simple-parameters-configmap.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ apiVersion: v1
kind: ConfigMap
metadata:
name: simple-parameters
namespace: argo
labels:
# Note that this label is required for the informer to detect this ConfigMap.
workflows.argoproj.io/configmap-type: Parameter
data:
msg: 'hello world'
2 changes: 2 additions & 0 deletions examples/global-parameters-from-configmap.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ metadata:
annotations:
workflows.argoproj.io/description: |
This example demonstrates loading global parameter values from configmap.
Note that the "simple-parameters" ConfigMap (defined in examples/configmaps/simple-parameters-configmap.yaml)
needs to be created first before submitting this workflow.
workflows.argoproj.io/verify.py: |
assert status["phase"] == "Succeeded"
spec:
Expand Down
2 changes: 1 addition & 1 deletion hack/test-examples.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ set -eu -o pipefail
./dist/argo delete -l workflows.argoproj.io/test

# Load the configmaps that contains the parameter values used for certain examples.
kubectl apply -f examples/configmaps/simple-parameters-configmap.yaml
kubectl create -n argo -f examples/configmaps/simple-parameters-configmap.yaml

grep -lR 'workflows.argoproj.io/test' examples/* | while read f ; do
./dist/argo submit --watch --verify $f
Expand Down

0 comments on commit 3ae8f7e

Please sign in to comment.