docs: Modify example for intermediate parameters

Signed-off-by: toyamagu-2021 <toyamagu2021@gmail.com>
argoproj · Aug 6, 2023 · f455363 · f455363
1 parent 4087b98
commit f455363
Show file tree

Hide file tree

Showing 2 changed files with 142 additions and 89 deletions.
diff --git a/docs/intermediate-inputs.md b/docs/intermediate-inputs.md
@@ -27,40 +27,46 @@ The workflow will pause at a `Suspend` node, and user will be able to update par
 [![Approval Example Demo](https://img.youtube.com/vi/eyeZ2oddwWE/0.jpg)](https://youtu.be/eyeZ2oddwWE)
 
 ```yaml
-
-entrypoint: cicd-pipeline
-templates:
-   - name: cicd-pipeline
-     steps:
-        - - name: deploy-pre-prod
-            template: deploy
-        - - name: approval
-            template: approval
-        - - name: deploy-prod
-            template: deploy
-            when: '{{steps.approval.outputs.parameters.approve}} == YES'
-   - name: approval
-     suspend: {}
-     inputs:
-        parameters:
-           - name: approve
-             default: 'NO'
-             enum:
-                - 'YES'
-                - 'NO'
-     outputs:
-        parameters:
-           - name: approve
-             valueFrom:
-                supplied: {}
-   - name: deploy
-     container:
-        image: 'argoproj/argosay:v2'
-        command:
-           - /argosay
-        args:
-           - echo
-           - deploying
+apiVersion: argoproj.io/v1alpha1
+kind: Workflow
+metadata:
+  generateName: intermediate-parameters-cicd
+spec:
+  entrypoint: cicd-pipeline
+  templates:
+    - name: cicd-pipeline
+      steps:
+          - - name: deploy-pre-prod
+              template: deploy
+          - - name: approval
+              template: approval
+          - - name: deploy-prod
+              template: deploy
+              when: '{{steps.approval.outputs.parameters.approve}} == YES'
+    - name: approval
+      suspend: {}
+      inputs:
+          parameters:
+            - name: approve
+              default: 'NO'
+              enum:
+                  - 'YES'
+                  - 'NO'
+              description: >-
+                Choose YES to continue workflow and deploy to production
+      outputs:
+          parameters:
+            - name: approve
+              valueFrom:
+                  supplied: {}
+    - name: deploy
+      container:
+          image: 'argoproj/argosay:v2'
+          command:
+            - /argosay
+          args:
+            - echo
+            - deploying
 ```
 
 ## Intermediate Parameters DB Schema Update Example
@@ -74,61 +80,68 @@ templates:
 [![DB Schema Update Example Demo](https://img.youtube.com/vi/QgE-1782YJc/0.jpg)](https://youtu.be/QgE-1782YJc)
 
 ```yaml
-entrypoint: db-schema-update
-templates:
-    - name: db-schema-update
-      steps:
-        - - name: generate-db-list
-            template: generate-db-list
-        - - name: choose-db
-            template: choose-db
-            arguments:
-              parameters:
-                - name: db_name
-                  value: '{{steps.generate-db-list.outputs.parameters.db_list}}'
-        - - name: update-schema
-            template: update-schema
-            arguments:
-              parameters:
-                - name: db_name
-                  value: '{{steps.choose-db.outputs.parameters.db_name}}'
-    - name: generate-db-list
-      outputs:
-        parameters:
-          - name: db_list
-            valueFrom:
-              path: /tmp/db_list.txt
-      container:
-        name: main
-        image: 'argoproj/argosay:v2'
-        command:
-          - sh
-          - '-c'
-        args:
-          - >-
-            echo "{\"enum\": [\"db1\", \"db2\", \"db3\"]}" | tee /tmp/db_list.txt
-    - name: choose-db
-      inputs:
-        parameters:
-          - name: db_name
-      outputs:
-        parameters:
-          - name: db_name
-            valueFrom:
-              supplied: {}
-      suspend: {}
-    - name: update-schema
-      inputs:
-        parameters:
-          - name: db_name
-      container:
-        name: main
-        image: 'argoproj/argosay:v2'
-        command:
-          - sh
-          - '-c'
-        args:
-          - echo Updating DB {{inputs.parameters.db_name}}
+apiVersion: argoproj.io/v1alpha1
+kind: Workflow
+metadata:
+  generateName: intermediate-parameters-db-
+spec:
+  entrypoint: db-schema-update
+  templates:
+      - name: db-schema-update
+        steps:
+          - - name: generate-db-list
+              template: generate-db-list
+          - - name: choose-db
+              template: choose-db
+              arguments:
+                parameters:
+                  - name: db_name
+                    value: '{{steps.generate-db-list.outputs.parameters.db_list}}'
+          - - name: update-schema
+              template: update-schema
+              arguments:
+                parameters:
+                  - name: db_name
+                    value: '{{steps.choose-db.outputs.parameters.db_name}}'
+      - name: generate-db-list
+        outputs:
+          parameters:
+            - name: db_list
+              valueFrom:
+                path: /tmp/db_list.txt
+        container:
+          name: main
+          image: 'argoproj/argosay:v2'
+          command:
+            - sh
+            - '-c'
+          args:
+            - >-
+              echo "{\"enum\": [\"db1\", \"db2\", \"db3\"]}" | tee /tmp/db_list.txt
+      - name: choose-db
+        inputs:
+          parameters:
+            - name: db_name
+              description: >-
+                Choose DB to update a schema
+        outputs:
+          parameters:
+            - name: db_name
+              valueFrom:
+                supplied: {}
+        suspend: {}
+      - name: update-schema
+        inputs:
+          parameters:
+            - name: db_name
+        container:
+          name: main
+          image: 'argoproj/argosay:v2'
+          command:
+            - sh
+            - '-c'
+          args:
+            - echo Updating DB {{inputs.parameters.db_name}}
 ```
 
 ### Some Important Details

diff --git a/examples/Intermediate-parameters.yaml b/examples/Intermediate-parameters.yaml
@@ -0,0 +1,40 @@
+apiVersion: argoproj.io/v1alpha1
+kind: Workflow
+metadata:
+  generateName: intermediate-parameters-cicd-
+spec:
+  entrypoint: cicd-pipeline
+  templates:
+    - name: cicd-pipeline
+      steps:
+          - - name: deploy-pre-prod
+              template: deploy
+          - - name: approval
+              template: approval
+          - - name: deploy-prod
+              template: deploy
+              when: '{{steps.approval.outputs.parameters.approve}} == YES'
+    - name: approval
+      suspend: {}
+      inputs:
+          parameters:
+            - name: approve
+              default: 'NO'
+              enum:
+                  - 'YES'
+                  - 'NO'
+              description: >-
+                Choose YES to continue workflow and deploy to production
+      outputs:
+          parameters:
+            - name: approve
+              valueFrom:
+                  supplied: {}
+    - name: deploy
+      container:
+          image: 'argoproj/argosay:v2'
+          command:
+            - /argosay
+          args:
+            - echo
+            - deploying