Add environments diagram

nhs-england-tools · Sep 12, 2023 · 8c7ca53 · 8c7ca53
1 parent 4759640
commit 8c7ca53
Showing 1 changed file with 53 additions and 21 deletions.
diff --git a/docs/developer-guides/CICD_pipeline.md b/docs/developer-guides/CICD_pipeline.md
@@ -2,14 +2,15 @@
 
 - [Developer Guide: CI/CD pipeline](#developer-guide-cicd-pipeline)
   - [The pipeline high-level workflow model](#the-pipeline-high-level-workflow-model)
-  - [Stage triggers](#stage-triggers)
   - [Workflow stages](#workflow-stages)
     - [End-to-end workflow stages](#end-to-end-workflow-stages)
+    - [Stage triggers](#stage-triggers)
     - [Branch review workflow](#branch-review-workflow)
     - [PR review workflow](#pr-review-workflow)
     - [Publish workflow](#publish-workflow)
     - [Deploy workflow](#deploy-workflow)
     - [Rollback workflow](#rollback-workflow)
+  - [Environments and artefact promotion](#environments-and-artefact-promotion)
   - [Resources](#resources)
 
 ## The pipeline high-level workflow model
@@ -21,26 +22,6 @@ flowchart LR
     Deploy --> Rollback
 ```
 
-## Stage triggers
-
-| Workflow | Stage                   |    `main` branch trigger    |  Task branch trigger   |
-|---------:|:------------------------|:---------------------------:|:----------------------:|
-|   Review | Commit (local githooks) |              -              |       on commit        |
-|   Review | Commit (remote)         |           on push           |        on push         |
-|   Review | Test                    |           on push           |        on push         |
-|   Review | Build                   |           on push           | on push, if PR is open |
-|   Review | Acceptance              |           on push           | on push, if PR is open |
-|  Publish | Publish                 |           on tag            |           -            |
-|   Deploy | Deploy                  |           on tag            |           -            |
-| Rollback | Rollback                | on demand or on healthcheck |           -            |
-
-- Publish:
-  - When merged, create snapshot release
-  - When tagged, crate Release Candidate
-- Deploy
-  - Only deploy RCs
-  - Deploy to specified environment
-
 ## Workflow stages
 
 ### End-to-end workflow stages
@@ -56,6 +37,26 @@ flowchart LR
     Deploy --> Rollback
 ```
 
+### Stage triggers
+
+| Workflow | Stage                   |    `main` branch trigger    |  Task branch trigger   |
+|---------:|:------------------------|:---------------------------:|:----------------------:|
+|   Review | Commit (local githooks) |              -              |       on commit        |
+|   Review | Commit (remote)         |          on merge           |        on push         |
+|   Review | Test                    |          on merge           |        on push         |
+|   Review | Build                   |          on merge           | on push, if PR is open |
+|   Review | Acceptance              |          on merge           | on push, if PR is open |
+|  Publish | Publish                 |           on tag            |           -            |
+|   Deploy | Deploy                  |           on tag            |           -            |
+| Rollback | Rollback                | on demand or on healthcheck |           -            |
+
+- Publish:
+  - When merged, create snapshot release
+  - When tagged, crate Release Candidate
+- Deploy
+  - Only deploy RCs
+  - Deploy to specified environment
+
 ### Branch review workflow
 
 ```mermaid
@@ -234,6 +235,37 @@ flowchart LR
     deploy["Deploy"] --> rollback
 ```
 
+## Environments and artefact promotion
+
+```mermaid
+flowchart LR
+    subgraph branch_review["Branch review"]
+        direction LR
+        bA("`**local**`")
+    end
+    subgraph pr_review["PR Review"]
+        direction LR
+        prA["`**ephemeral**
+        dev environments`"]
+        prB["`automated acceptance
+        **test** environments`"]
+        prA --> prB
+    end
+    subgraph deploy1["Deploy (high-instance)"]
+        direction LR
+        d1A["`**non-prod**
+        environments`"]
+    end
+    subgraph deploy2["Deploy (Live)"]
+        direction LR
+        d2A["`**prod**
+        environment`"]
+    end
+    branch_review --> pr_review
+    pr_review --> deploy1
+    deploy1 --> deploy2
+```
+
 ## Resources
 
 - Blog post [Going faster with continuous delivery](https://aws.amazon.com/builders-library/going-faster-with-continuous-delivery/)