Skip to content

Commit

Permalink
Merge pull request #1 from jpower432/docs/c4-diagrams
Browse files Browse the repository at this point in the history
docs: adds c4 architecture drawing for context,containers, and component
  • Loading branch information
Alex Flom authored Jul 24, 2023
2 parents 8bb28ec + 535ae6b commit edbe145
Show file tree
Hide file tree
Showing 3 changed files with 72 additions and 0 deletions.
72 changes: 72 additions & 0 deletions docs/diagrams/architecture/c4.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
## Context

```mermaid
graph LR
subgraph External
User
end
subgraph Container
ContainerImage("Container Image")
TrestlebotContainer("Trestlebot Container")
end
subgraph GitHub
OSCALRepo("OSCAL Content Repository")
GithubActions("GitHub Actions")
CustomAction("Custom GitHub Action")
end
User -- Uses --> OSCALRepo
GithubActions -- Triggers --> CustomAction
CustomAction -- Builds --> ContainerImage
ContainerImage -- Runs --> TrestlebotContainer
OSCALRepo -- Uses --> GithubActions
User -- Uses --> GithubActions
```

## Container

```mermaid
graph LR
subgraph Container
ContainerImage("Container Image")
TrestlebotCLI("Trestlebot CLI")
end
subgraph GitHub
GithubActions("GitHub Actions")
CustomAction("Custom GitHub Action")
end
GithubActions -- Triggers --> CustomAction
CustomAction -- Builds --> ContainerImage
ContainerImage -- Distributes --> TrestlebotCLI
```

## Component

```mermaid
graph TD
subgraph Container
TrestlebotCLI("Trestlebot CLI")
Entrypoint("Entrypoint script")
end
subgraph Runtime
EnvironmentVariables("Environment Variables")
GitRepo("Git Local Repository")
end
subgraph GitHub
GitHubAction("GitHub Action")
GitHubAPI("GitHub API")
end
GitHubAction -- Sets --> EnvironmentVariables
GitHubAction -- Uses --> Entrypoint
TrestlebotCLI -- Reads content --> GitRepo
Entrypoint -- Runs --> TrestlebotCLI
Entrypoint -- Reads --> EnvironmentVariables
TrestlebotCLI -- Update content --> GitHubAPI
```
File renamed without changes.
File renamed without changes.

0 comments on commit edbe145

Please sign in to comment.