Skip to content

Commit

Permalink
chore: update diagrams and add diagram docs
Browse files Browse the repository at this point in the history
  • Loading branch information
UnicornChance committed Dec 13, 2024
1 parent a28264c commit b691768
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 3 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,3 +113,8 @@ uds run test-single-layer --set LAYER=identity-authorization
```

Note you can specify the `--set FLAVOR=registry1` flag to test using Iron Bank images instead of the upstream images.

## UDS Core Architecture Overview
![UDS Core Architecture Diagram](https://github.com/defenseunicorns/uds-core/blob/main/docs/.images/uds-core-arch-overview.svg?raw=true)

Diagrams are located in `/docs/.images`. See the [diagram README](./docs/.images/README.md) for an explanation and help customizing.
22 changes: 22 additions & 0 deletions docs/.images/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# UDS Core Diagrams

## Diagram Explanations
At this time there is three layers to our diagram that visually explain the following:

1. `Overview`, basic view of what applications are present and what other services/applications they are communicating with.

2. `Traffic Direction`, similar to `Overview` layer with the addition of directional arrows to represent the flow of traffic in cluster.

3. `Ports and Protocols`, similar to `Traffic Direction` layer with the addition of ports and protocols.

## How to Customize
To customize the diagram, download the svg and in [draw.io](https://draw.io) create a new diagram and load in the svg.

To download the [svg from github](https://github.com/defenseunicorns/uds-core/tree/main/docs/.images), select one of the svg, then select the download button in the top right of the `Preview` view.

Alternatively you can also download the svg from the [uds.defenseunicorns.com](https://uds.defenseunicorns.com/reference/uds-core/overview/) docsite by right clicking and selecting the `Save image as` option.

It doesn't matter which svg you download, they all contain the metadata for the other layers mentioned above ( you may need to enable the layers pop up in [draw.io](https://draw.io) to change your layer ).


#### If you have suggestions for the diagrams, we welcome issues or pull requests contributes to [uds-core](https://github.com/defenseunicorns/uds-core).
2 changes: 1 addition & 1 deletion docs/.images/uds-core-arch-ingress-egress.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/.images/uds-core-arch-overview.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/.images/uds-core-arch-ports-protocols.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b691768

Please sign in to comment.