Skip to content

Commit c0ccab9

Browse files
Add sequence diagram.
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]>
1 parent ba400c9 commit c0ccab9

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

README.md

+26-1
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,36 @@ pushes all commits and tags back to this repo.
4646
Finally, Docker Hub is configured to watch the this repo and build/tag new images
4747
automatically based on the branch or tag that received new commits.
4848

49+
In summary:
50+
51+
```mermaid
52+
sequenceDiagram
53+
box Grey On Jenkins
54+
participant J as pdk-docker-promote<br/>jenkins job
55+
participant p as pdk-docker<br/>(local workspace)
56+
end
57+
participant g as pdk-docker<br/>(github.com)
58+
participant d as Docker Hub
59+
participant ecr as Elastic Container Registry<br/>(AWS)
60+
J ->>+ p: clone pdk-docker
61+
p ->>+ p: update-pdk-release-file.rb
62+
p ->>+ p: Has pdk-release.env changed?
63+
note right of p: "i.e., is there a new<br/>version of pdk?"
64+
alt no
65+
else yes
66+
p ->> g: commit update to main
67+
g ->> g: Trigger the "image-push"<br/>github action
68+
g ->> d: push to registry
69+
g ->> ecr: push to registry
70+
end
71+
p ->> J: finish
72+
```
73+
4974
## How to use the Image
5075

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

53-
```
78+
```bash
5479
docker pull puppet/pdk:latest
5580
```
5681

0 commit comments

Comments
 (0)