Skip to content

Commit

Permalink
Add sequence diagram.
Browse files Browse the repository at this point in the history
I added a sequence diagram describing the flow from Jenkins job right through to pushing the images to registry.

Signed-off-by: Gavin Didrichsen <[email protected]>
  • Loading branch information
gavindidrichsen committed May 23, 2024
1 parent ba400c9 commit c0ccab9
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,36 @@ pushes all commits and tags back to this repo.
Finally, Docker Hub is configured to watch the this repo and build/tag new images
automatically based on the branch or tag that received new commits.

In summary:

```mermaid
sequenceDiagram
box Grey On Jenkins
participant J as pdk-docker-promote<br/>jenkins job
participant p as pdk-docker<br/>(local workspace)
end
participant g as pdk-docker<br/>(github.com)
participant d as Docker Hub
participant ecr as Elastic Container Registry<br/>(AWS)
J ->>+ p: clone pdk-docker
p ->>+ p: update-pdk-release-file.rb
p ->>+ p: Has pdk-release.env changed?
note right of p: "i.e., is there a new<br/>version of pdk?"
alt no
else yes
p ->> g: commit update to main
g ->> g: Trigger the "image-push"<br/>github action
g ->> d: push to registry
g ->> ecr: push to registry
end
p ->> J: finish
```

## How to use the Image

Download a release from Docker Hub as detailed above. e.g.

```
```bash
docker pull puppet/pdk:latest
```

Expand Down

0 comments on commit c0ccab9

Please sign in to comment.