Skip to content
This repository was archived by the owner on Jan 13, 2025. It is now read-only.

Commit 91f1b3c

Browse files
committed
docs: add variable documentation to readme
1 parent 4ba122f commit 91f1b3c

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.md

+25-1
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,41 @@ They are defined in independent directories, as follows:
1313
- `applications`: Terraform modules for configuring specific application of the infrastructure, such as Authentik for
1414
the SSO page and authentication providers, and Hashicorp Vault for the reader device PKI exchange. Delivered
1515
automatically using GitHub Actions from the `production` branch, triggered by ArgoCD after deployments.
16+
- `dockerfiles`: Dockerfiles for the applications that are deployed on the cluster. These are built and pushed to the
17+
GitHub Container Registry using GitHub Actions. The images are then deployed using ArgoCD. The `production` branch
18+
is the one that is packaged.
1619

1720
## Variables and secrets
1821

22+
#### Infrastructure
23+
1924
The infrastructure depends on several variables and secrets that are stored in the context for GitHub Actions.
2025
You'll find below a list of them and their purpose.
2126

2227
| Name | Description |
23-
|--------------|-----------------------------------------------------------|
28+
| ------------ | --------------------------------------------------------- |
2429
| `AWS_REGION` | The AWS region where the infrastructure will be deployed. |
2530
| `AWS_ARN` | The ARN that should be assumed when deploying changes. |
2631

32+
| Variable | Description |
33+
| -------------------- | --------------------------------------------------------- |
34+
| `aws_region` | The AWS region where the infrastructure will be deployed. |
35+
| `aws_arn` | The ARN that should be assumed when deploying changes. |
36+
| `cloudflare_api_key` | The Cloudflare API key for changes |
37+
| `dkim_public_key` | The public key for the mail DKIM signature |
38+
| `dkim_private_key` | The private key for the mail DKIM signature |
39+
40+
#### Applications
41+
42+
The applications context depends on several variables and secrets that are stored in the context for GitHub Actions.
43+
44+
| Variable | Description |
45+
| -------------------------- | ---------------------------------------------------- |
46+
| `authentik_url` | The URL of the Authentik instance to configure |
47+
| `authentik_api_key` | The API key for Authentik |
48+
| `vault_oidc_client_id` | The client ID for the OIDC proxy to GitHub OAuth |
49+
| `vault_oidc_client_secret` | The client secret for the OIDC proxy to GitHub OAuth |
50+
2751
## Continuous Delivery
2852

2953
The infrastructure is deployed using GitHub Actions. The workflow is defined in `.github/workflows/terraform-apply.yml`.

0 commit comments

Comments
 (0)