docs: add how to manage DNS records with terraform #79

Merged
teutat3s merged 1 commit from docs-terraform-dns into main 2023-12-08 15:35:55 +00:00
2 changed files with 39 additions and 3 deletions

View file

@ -1,17 +1,44 @@
# Changing DNS entries # Changing DNS entries
Our current DNS provider is [namecheap](https://www.namecheap.com/).
We use [Terraform](https://www.terraform.io) to declaratively manage our pub.solar DNS records.
### Initial setup ### Initial setup
Change into the terraform directory and initialize the terraform providers. Skip this step if you already have a `triton` profile setup.
```
triton profile create
```
Please follow https://docs.greenbaum.cloud/en/devops/triton-cli.html for the details.
You will need to setup the following [namecheap API credentials](https://www.namecheap.com/support/api/intro),
look for "namecheap API key" in the pub.solar Keepass database.
```
NAMECHEAP_API_KEY
NAMECHEAP_API_USER
NAMECHEAP_USER_NAME
```
You will probably also need to add your external IP to the [API allow list](https://ap.www.namecheap.com/settings/tools/apiaccess/whitelisted-ips).
```
dig -4 ip @dns.toys
```
Now, change into the terraform directory and initialize the terraform providers.
``` ```
cd terraform cd terraform
cat ~/.config/triton/profiles.d/lev-1-pub_solar.json | grep keyId export TRITON_KEY_ID=$(cat ~/.config/triton/profiles.d/lev-1-pub_solar.json | jq --raw-output .keyId)
export TRITON_KEY_ID=
terraform init terraform init
``` ```
Make your changes, e.g. in `dns.tf`.
```
$EDITOR dns.tf
```
Plan your changes using: Plan your changes using:
``` ```
terraform plan -out pub-solar-infra.plan terraform plan -out pub-solar-infra.plan
@ -21,3 +48,11 @@ After verification, apply your changes with:
``` ```
terraform apply "pub-solar-infra.plan" terraform apply "pub-solar-infra.plan"
``` ```
### Useful links
We use the Manta remote backend to save the terraform state for collaboration.
- https://www.terraform.io/language/v1.2.x/settings/backends/manta
Namecheap Terraform provider docs:
- https://registry.terraform.io/providers/namecheap/namecheap/latest/docs

View file

@ -72,6 +72,7 @@
treefmt treefmt
nixos-generators nixos-generators
inputs.nixpkgs-2205.legacyPackages.${system}.terraform inputs.nixpkgs-2205.legacyPackages.${system}.terraform
jq
]; ];
}; };
}; };