Skip to content

Commit

Permalink
chore: architecture diagrams (#1024)
Browse files Browse the repository at this point in the history
## Description

Add diagrams to docs and in git.

1. UDS Core Architecture Overview
2. UDS Core Architecture Ingress Egress Layer ( overview + colored
traffic lines )
3. UDS Core Architecture Port and Protocols ( Overview + colored traffic
lines + ports and protocols )

## Related Issue

Fixes #919 
Relates to #754

## Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [x] Other (security config, docs update, etc)

## Checklist before merging

- [x] Test, docs, adr added or updated as needed
- [x] [Contributor
Guide](https://github.com/defenseunicorns/uds-template-capability/blob/main/CONTRIBUTING.md)
followed
  • Loading branch information
UnicornChance authored Nov 20, 2024
1 parent 871bdad commit d0bca43
Show file tree
Hide file tree
Showing 8 changed files with 19 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .codespellrc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Lint Codespell configurations
[codespell]
skip = .codespellrc,.git,node_modules,build,dist,*.zst,CHANGELOG.md,.playwright,.terraform
skip = .codespellrc,.git,node_modules,build,dist,*.zst,CHANGELOG.md,.playwright,.terraform,*.svg
ignore-words-list = NotIn,AKS,LICENS,aks,afterAll
enable-colors =
check-hidden =
1 change: 1 addition & 0 deletions .github/workflows/docs-shim.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ on:
- .vscode/**
- .gitignore
- renovate.json
- .codespellrc
- .release-please-config.json
- release-please-config.json
- CODEOWNERS
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/pull-request-conditionals.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ on:
- .gitignore
- renovate.json
- .release-please-config.json
- .codespellrc
- release-please-config.json
- CODEOWNERS
- LICENSE
Expand Down
4 changes: 4 additions & 0 deletions 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.
4 changes: 4 additions & 0 deletions 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.
4 changes: 4 additions & 0 deletions 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.
2 changes: 2 additions & 0 deletions docs/reference/UDS Core/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ UDS Core enables your team to:
- Leverage specific functional applications to deliver a versatile platform that caters to diverse mission objectives.
- Enhance the efficiency, security, and success of software delivery and operations process.

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

### Accomplishing Mission Objectives with Functional Applications

UDS leverages functional applications that are well-suited to perform the specific tasks required. These tools are carefully selected to ensure optimal performance and compatibility within the UDS landscape. By integrating functional tools into the platform, UDS ensures that Mission Heroes have access to cutting-edge technologies and best-in-class solutions for their missions.
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/configuration/ingress.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: Istio Ingress

UDS Core leverages Istio for ingress into the service mesh. This document provides an overview and examples of the Istio resources that UDS Core deploys to handle ingress.

![UDS Core Ingress / Egress](https://github.com/defenseunicorns/uds-core/blob/main/docs/.images/uds-core-arch-ports-protocols.svg?raw=true)

## Gateways

UDS Core provides a few Istio [Gateway](https://istio.io/latest/docs/reference/config/networking/gateway/) resources to allow ingress into the service mesh. Each one serves a different purpose and can be used to route traffic to different services.
Expand Down

0 comments on commit d0bca43

Please sign in to comment.