Skip to content

Commit

Permalink
docs: render image-scanner PlantUML diagram (#26)
Browse files Browse the repository at this point in the history
Co-authored-by: Erik Godding Boye <[email protected]>
  • Loading branch information
mikaelol and erikgb authored Jan 11, 2023
1 parent 280b3a1 commit 90fd0e8
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 20 deletions.
21 changes: 1 addition & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -225,26 +225,7 @@ Using a simple `Pod`, with a single container, as an example:
3. When a scan `Job` is completed, read the scan result from pod log of the scan `Job`,
and update the `ContainerImageScan` status.

```plantuml
@startuml
cloud "Kubernetes API server" {
() Pod as pod
() ContainerImageScan as cis
() Job as job
}
package "Image Scanner Operator" {
[Workload controller] ..> pod : watch
[Workload controller] --> cis : create
[CIS controller] ..> cis : watch
[CIS controller] --> job : create
[Scan Job controller] ..> job : watch
[Scan Job controller] --> cis : update status
}
@enduml
```
![Image scanner architecture](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/statnett/image-scanner-operator/main/docs/architecture.puml)

## License

Expand Down
18 changes: 18 additions & 0 deletions docs/architecture.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
@startuml Image Scanner architecture

cloud "Kubernetes API server" {
() Pod as pod
() ContainerImageScan as cis
() Job as job
}

package "Image Scanner Operator" {
[Workload controller] ..> pod : watch
[Workload controller] --> cis : create
[CIS controller] ..> cis : watch
[CIS controller] --> job : create
[Scan Job controller] ..> job : watch
[Scan Job controller] --> cis : update status
}

@enduml

0 comments on commit 90fd0e8

Please sign in to comment.