Skip to content

Commit

Permalink
Merge branch 'update-docs-gen-script' into 970-all-nodes
Browse files Browse the repository at this point in the history
* update-docs-gen-script:
  update doc-gen output_dir
  chore: update arch diagrams (#1120)
  chore: bump aks sku from free to standard to address API server perfo… (#1121)
  • Loading branch information
catsby committed Dec 13, 2024
2 parents 514e255 + e1e9885 commit 1db8e59
Show file tree
Hide file tree
Showing 7 changed files with 34 additions and 10 deletions.
6 changes: 3 additions & 3 deletions .github/test-infra/azure/aks/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ variable "dns_prefix" {
}

variable "sku_tier" {
description = "(Optional) The SKU Tier that should be used for this Kubernetes Cluster. Possible values are Free and Paid (which includes the Uptime SLA). Defaults to Free."
default = "Free"
description = "(Optional) The SKU Tier that should be used for this Kubernetes Cluster. Possible values are Free and Standard (which includes the Uptime SLA), and Premium. Defaults to Free."
default = "Standard"
type = string

validation {
condition = contains(["Free", "Paid"], var.sku_tier)
condition = contains(["Free", "Standard", "Premium"], var.sku_tier)
error_message = "The sku tier is invalid."
}
}
Expand Down
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 are 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 files, 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 contributions to [uds-core](https://github.com/defenseunicorns/uds-core).
3 changes: 1 addition & 2 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.
3 changes: 1 addition & 2 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.
3 changes: 1 addition & 2 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: 1 addition & 1 deletion src/pepr/docs-gen/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import * as path from "path";
const INDENT_SIZE = 20;
const MAX_HEADER_LEVEL = 6;
const MAX_DEPTH = 10;
const OUTPUT_DIR = "./docs/reference/configuration/custom-resources/";
const OUTPUT_DIR = "./docs/reference/configuration/custom resources/";
const TABLE_STYLE = 'style="width: 100%; table-layout: fixed;"';

// Utility to capitalize the first letter of a string
Expand Down

0 comments on commit 1db8e59

Please sign in to comment.