✏️ Map Out Current CI/CD Pipeline Architecture

jasonBirchall commented 3 months ago

User Need

As a Platform Engineer
I want to create or update a clear diagram of our current CI/CD pipeline
so that all stakeholders understand the flow from code commit to deployment.

Functional Requirements (What):

[x] Identify all existing CI/CD steps (build, test, deploy, etc.) across relevant services or microservices.
[x] Document the tools and infrastructure components (e.g., Argo, GitHub Actions, container registry, etc.).
[x] Include details of parallel tasks, triggers, and dependencies in the pipeline (e.g., code scanning, integration tests).
[x] Store the final diagram and notes in a central repository (e.g., Google Docs) for easy reference.

Non-Functional Requirements (How):

[ ] Ensure the diagram is kept up-to-date and easy to read (use consistent notation, versioning, etc.).
[x] Ensure the diagram can be viewed quickly (e.g., minimal load time, exported formats like PNG/PDF for offline access).

Acceptance Criteria:

[x] A single, clearly labelled diagram exists showing end-to-end CI/CD flow.
[x] All relevant artefact repositories, triggers, and parallel processes are visible in the diagram.
[x] Stakeholders (platform engineers, developers) confirm that the diagram accurately reflects the current architecture.
[ ] Present this to the GOV.UK Tech Fortnightly community

Notes:

This diagram will be referenced in future design and troubleshooting sessions.
May require input from multiple teams if our CI/CD pipeline is distributed or multi-service.

jasonBirchall commented 1 month ago

[stand up] Diagram is here if folks want to have a look: https://drive.google.com/drive/u/0/folders/1pRinYPSsf-fQZfauOGnJ1E4-BPEt5QSO

jasonBirchall commented 1 month ago

[stand up] @samsimpson1 will ask in slack when he needs a volunteer for review.

MuriloDalRi commented 1 month ago

Nice diagram, it makes it all seem almost... simple?

samsimpson1 commented 1 month ago

A diagram has been created which documents the steps for both manual and automatic deploys using our CD pipelines

https://drive.google.com/file/d/1jdaw-vc683zexsXRgGibLvakPSzpki0T/view?usp=drive_link

alphagov / govuk-infrastructure

✏️ Map Out Current CI/CD Pipeline Architecture #2012