Skip to content

Commit

Permalink
docs: Use 'depends' instead of 'dependencies' in examples (#6166)
Browse files Browse the repository at this point in the history
Signed-off-by: Simon Behar <[email protected]>
  • Loading branch information
simster7 authored Jun 17, 2021
1 parent 95ad561 commit dd19e49
Show file tree
Hide file tree
Showing 26 changed files with 79 additions and 92 deletions.
6 changes: 2 additions & 4 deletions examples/buildkit-template.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,7 @@ spec:
parameters:
- name: path
value: "{{workflow.parameters.path}}"
dependencies:
- clone
depends: "clone"
- name: image
template: image
arguments:
Expand All @@ -78,8 +77,7 @@ spec:
value: "{{workflow.parameters.path}}"
- name: image
value: "{{workflow.parameters.image}}"
dependencies:
- build
depends: "build"
- name: clone
inputs:
parameters:
Expand Down
6 changes: 3 additions & 3 deletions examples/cluster-workflow-template/cluster-wftmpl-dag.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ spec:
- name: message
value: A
- name: B
dependencies: [A]
depends: "A"
templateRef:
name: cluster-workflow-template-whalesay-template
template: whalesay-template
Expand All @@ -35,13 +35,13 @@ spec:
- name: message
value: B
- name: C
dependencies: [A]
depends: "A"
templateRef:
name: cluster-workflow-template-inner-dag
template: inner-diamond
clusterScope: true
- name: D
dependencies: [B, C]
depends: "B && C"
templateRef:
name: cluster-workflow-template-whalesay-template
template: whalesay-template
Expand Down
6 changes: 3 additions & 3 deletions examples/cluster-workflow-template/clustertemplates.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -106,21 +106,21 @@ spec:
- name: message
value: inner-A
- name: inner-B
dependencies: [inner-A]
depends: "inner-A"
template: whalesay-template
arguments:
parameters:
- name: message
value: inner-B
- name: inner-C
dependencies: [inner-A]
depends: "inner-A"
template: whalesay-template
arguments:
parameters:
- name: message
value: inner-C
- name: inner-D
dependencies: [inner-B, inner-C]
depends: "inner-B && inner-C"
templateRef:
name: cluster-workflow-template-whalesay-template
template: whalesay-template
Expand Down
10 changes: 3 additions & 7 deletions examples/container-set-template/graph-workflow.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,10 @@ spec:
image: argoproj/argosay:v2
- name: b
image: argoproj/argosay:v2
dependencies:
- a
depends: "a"
- name: c
image: argoproj/argosay:v2
dependencies:
- a
depends: "a"
- name: d
image: argoproj/argosay:v2
dependencies:
- b
- c
depends: "b && c"
3 changes: 1 addition & 2 deletions examples/container-set-template/outputs-result-workflow.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,7 @@ spec:
parameters:
- name: x
value: "{{tasks.a.outputs.result}}"
dependencies:
- a
depends: "a"

- name: group
containerSet:
Expand Down
6 changes: 2 additions & 4 deletions examples/container-set-template/sequence-workflow.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,7 @@ spec:
image: argoproj/argosay:v2
- name: b
image: argoproj/argosay:v2
dependencies:
- a
depends: "a"
- name: c
image: argoproj/argosay:v2
dependencies:
- b
depends: "b"
6 changes: 3 additions & 3 deletions examples/dag-coinflip.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ spec:
- name: A
template: coinflip
- name: B
dependencies: [A]
depends: "A"
template: coinflip
- name: C
dependencies: [A]
depends: "A"
template: coinflip
- name: D
dependencies: [B, C]
depends: "B && C"
template: coinflip

- name: coinflip
Expand Down
12 changes: 6 additions & 6 deletions examples/dag-continue-on-fail.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,24 +11,24 @@ spec:
- name: A
template: whalesay
- name: B
dependencies: [A]
depends: "A"
template: intentional-fail
continueOn:
failed: true
- name: C
dependencies: [A]
depends: "A"
template: whalesay
- name: D
dependencies: [B, C]
depends: "B && C"
template: whalesay
- name: E
dependencies: [A]
depends: "A"
template: intentional-fail
- name: F
dependencies: [A]
depends: "A"
template: whalesay
- name: G
dependencies: [E, F]
depends: "E && F"
template: whalesay

- name: whalesay
Expand Down
10 changes: 5 additions & 5 deletions examples/dag-daemon-task.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,37 +16,37 @@ spec:

- name: init-database
template: influxdb-client
dependencies: [influx]
depends: "influx"
arguments:
parameters:
- name: cmd
value: curl -XPOST 'http://{{tasks.influx.ip}}:8086/query' --data-urlencode "q=CREATE DATABASE mydb"

- name: producer-1
template: influxdb-client
dependencies: [init-database]
depends: "init-database"
arguments:
parameters:
- name: cmd
value: for i in $(seq 1 20); do curl -XPOST 'http://{{tasks.influx.ip}}:8086/write?db=mydb' -d "cpu,host=server01,region=uswest load=$i" ; sleep .5 ; done
- name: producer-2
template: influxdb-client
dependencies: [init-database]
depends: "init-database"
arguments:
parameters:
- name: cmd
value: for i in $(seq 1 20); do curl -XPOST 'http://{{tasks.influx.ip}}:8086/write?db=mydb' -d "cpu,host=server02,region=uswest load=$((RANDOM % 100))" ; sleep .5 ; done
- name: producer-3
template: influxdb-client
dependencies: [init-database]
depends: "init-database"
arguments:
parameters:
- name: cmd
value: curl -XPOST 'http://{{tasks.influx.ip}}:8086/write?db=mydb' -d 'cpu,host=server03,region=useast load=15.4'

- name: consumer
template: influxdb-client
dependencies: [producer-1, producer-2, producer-3]
depends: "producer-1 && producer-2 && producer-3"
arguments:
parameters:
- name: cmd
Expand Down
6 changes: 3 additions & 3 deletions examples/dag-diamond-steps.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -53,17 +53,17 @@ spec:
arguments:
parameters: [{name: message, value: A}]
- name: B
dependencies: [A]
depends: "A"
template: echo-thrice
arguments:
parameters: [{name: message, value: B}]
- name: C
dependencies: [A]
depends: "A"
template: echo-thrice
arguments:
parameters: [{name: message, value: C}]
- name: D
dependencies: [B, C]
depends: "B && C"
template: echo-thrice
arguments:
parameters: [{name: message, value: D}]
6 changes: 3 additions & 3 deletions examples/dag-diamond.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,17 @@ spec:
arguments:
parameters: [{name: message, value: A}]
- name: B
dependencies: [A]
depends: "A"
template: echo
arguments:
parameters: [{name: message, value: B}]
- name: C
dependencies: [A]
depends: "A"
template: echo
arguments:
parameters: [{name: message, value: C}]
- name: D
dependencies: [B, C]
depends: "B && C"
template: echo
arguments:
parameters: [{name: message, value: D}]
Expand Down
8 changes: 4 additions & 4 deletions examples/dag-disable-failFast.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,14 @@ spec:
- name: A
template: a
- name: B
dependencies: [A]
depends: "A"
template: b
- name: C
dependencies: [A]
depends: "A"
template: c
- name: D
dependencies: [B]
depends: "B"
template: d
- name: E
dependencies: [D]
depends: "D"
template: d
5 changes: 2 additions & 3 deletions examples/dag-multiroot.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,17 +25,16 @@ spec:
arguments:
parameters: [{name: message, value: A}]
- name: B
dependencies: []
template: echo
arguments:
parameters: [{name: message, value: B}]
- name: C
dependencies: [A]
depends: "A"
template: echo
arguments:
parameters: [{name: message, value: C}]
- name: D
dependencies: [A, B]
depends: "A && B"
template: echo
arguments:
parameters: [{name: message, value: D}]
12 changes: 6 additions & 6 deletions examples/dag-nested.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,17 @@ spec:
arguments:
parameters: [{name: message, value: A}]
- name: B
dependencies: [A]
depends: "A"
template: nested-diamond
arguments:
parameters: [{name: message, value: B}]
- name: C
dependencies: [A]
depends: "A"
template: nested-diamond
arguments:
parameters: [{name: message, value: C}]
- name: D
dependencies: [B, C]
depends: "B && C"
template: nested-diamond
arguments:
parameters: [{name: message, value: D}]
Expand All @@ -45,17 +45,17 @@ spec:
arguments:
parameters: [{name: message, value: "{{inputs.parameters.message}}A"}]
- name: B
dependencies: [A]
depends: "A"
template: echo
arguments:
parameters: [{name: message, value: "{{inputs.parameters.message}}B"}]
- name: C
dependencies: [A]
depends: "A"
template: echo
arguments:
parameters: [{name: message, value: "{{inputs.parameters.message}}C"}]
- name: D
dependencies: [B, C]
depends: "B && C"
template: echo
arguments:
parameters: [{name: message, value: "{{inputs.parameters.message}}D"}]
8 changes: 4 additions & 4 deletions examples/dag-targets.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -38,22 +38,22 @@ spec:
arguments:
parameters: [{name: message, value: A}]
- name: B
dependencies: [A]
depends: "A"
template: echo
arguments:
parameters: [{name: message, value: B}]
- name: C
dependencies: [A]
depends: "A"
template: echo
arguments:
parameters: [{name: message, value: C}]
- name: D
dependencies: [B, C]
depends: "B && C"
template: echo
arguments:
parameters: [{name: message, value: D}]
- name: E
dependencies: [C]
depends: "C"
template: echo
arguments:
parameters: [{name: message, value: E}]
Expand Down
4 changes: 2 additions & 2 deletions examples/dag-task-level-timeout.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ spec:
arguments:
parameters: [{name: timeout, value: "20s"}]
- name: B
dependencies: [A]
depends: "A"
template: echo
arguments:
parameters: [{name: timeout, value: "10s"}]
- name: C
dependencies: [A]
depends: "A"
template: echo
arguments:
parameters: [{name: timeout, value: "20s"}]
Expand Down
6 changes: 3 additions & 3 deletions examples/exit-handler-dag-level.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,19 @@ spec:
arguments:
parameters: [{name: message, value: A}]
- name: B
dependencies: [A]
depends: "A"
onExit: exit
template: echo
arguments:
parameters: [{name: message, value: B}]
- name: C
dependencies: [A]
depends: "A"
onExit: exit
template: echo
arguments:
parameters: [{name: message, value: C}]
- name: D
dependencies: [B, C]
depends: "B && C"
onExit: exit
template: echo
arguments:
Expand Down
Loading

0 comments on commit dd19e49

Please sign in to comment.