feat(2580): Managing child pipelines (#561)

screwdriver-cd · Jan 10, 2023 · 36a45a6 · 36a45a6
1 parent 7c14b34
commit 36a45a6
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 4 deletions.
diff --git a/docs/user-guide/assets/external-config-child-active.png b/docs/user-guide/assets/external-config-child-active.png
diff --git a/docs/user-guide/assets/external-config-child-inactive.png b/docs/user-guide/assets/external-config-child-inactive.png
diff --git a/docs/user-guide/assets/external-config-child-secrets.png b/docs/user-guide/assets/external-config-child-secrets.png
diff --git a/docs/user-guide/assets/external-config-child-state.png b/docs/user-guide/assets/external-config-child-state.png
diff --git a/docs/user-guide/assets/external-config-parent.png b/docs/user-guide/assets/external-config-parent.png
diff --git a/docs/user-guide/configuration/externalConfig.md b/docs/user-guide/configuration/externalConfig.md
@@ -10,6 +10,8 @@ toc:
       url: "#configure-external-config-in-parent-pipeline"
     - title: Parent and Child Relationship
       url: "#parent-and-child-relationship"
+    - title: Manage Child Pipelines
+      url: "#manage-child-pipelines"
     - title: User Interface
       url: "#user-interface"
 
@@ -49,11 +51,31 @@ jobs:
 
 Builds for child pipeline will have access to parent pipeline's repository at [`$SD_CONFIG_DIR`](../environment-variables#directories).
 
+## Manage Child Pipelines
+When a child pipeline SCM URL is added to the parent pipeline `screwdriver.yaml`, child pipeline gets created with `ACTIVE` state.
+
+When a child pipeline SCM URL is removed from the `screwdriver.yaml` of the parent pipeline, the child pipeline's state will be set to `INACTIVE`.
+Parent pipeline admins can review and take necessary action on these inactive child pipelines by either:
+* reactivating the pipeline by restoring the SCM URL in the `screwdriver.yaml` of the parent pipeline 
+* explicitly deleting the pipeline from the UI/API
+
+![External config child pipeline state](../assets/external-config-child-state.png)
+
 ## User Interface
-Parent pipeline UI:
-![External config parent](../assets/external-config.png)
+### Parent pipeline UI:
+![External config parent](../assets/external-config-parent.png)
+
+### Child pipeline UI:
+#### An active child pipeline:
+![External config active child pipeline](../assets/external-config-child-active.png)
+
+#### An inactive child pipeline:
+Operations on inactive child pipeline are limited.
+* New event/build cannot be created
+
+![External config inactive child pipeline](../assets/external-config-child-inactive.png)
 
-Child pipeline UI:
-![External config child pipeline ](../assets/external-config-child.png)
+#### Child pipeline inherits parent pipeline secrets:
+![External config child pipeline inheriting secrets](../assets/external-config-child-secrets.png)
 
 Example repo: <https://github.com/screwdriver-cd-test/external-config-example>