mirrors/khuedoan-homelab
1
0
Fork 0
mirror of https://github.com/khuedoan/homelab.git synced 2025-01-03 13:30:57 +07:00
Code Issues Packages Projects Releases Wiki Activity

docs: update external resources instruction

Browse Source
This commit is contained in:
Khue Doan 2022-06-04 14:25:55 +07:00
parent f434953d37
commit 5dc905be86
2 changed files with 38 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/src/deployment/dns.md
View File

@ -1,15 +1,21 @@
# DNS setup
Before you can access the home page at <https://home.example.com>, you'll need to update your DNS config.
Because everyone DNS setup are different, DNS automation is not in the scope of the project.
Some options for DNS config (choose one):
- Change the DNS config at your domain registrar (easy to automate)
- Change the DNS config in your router (also works with the [`home.arpa`](https://datatracker.ietf.org/doc/html/rfc8375) domain)
- Use [nip.io](https://nip.io) (suitable for a test environment)
- Change the DNS config in your router
- Change the DNS config at your domain registrar (doesn't work with the [`home.arpa`](https://datatracker.ietf.org/doc/html/rfc8375) domain)
Before continuing to the next section for some examples, run this command to get a list of subdomain and its address:
## At your domain registrar (recommended)
I'm using Cloudflare for DNS, continue to the next section for more information.
## In your router
You can add each subdomain one by one, or use a wildcard `*.example.com` and point it to the IP address of the load balancer.
To acquire a list of subdomains and their addresses, use this command:
```sh
./scripts/get-dns-config
@ -18,11 +24,3 @@ Before continuing to the next section for some examples, run this command to get
## Use nip.io
Preconfigured in the `dev` branch.
## In your router
You can add each subdomain one by one like the previous method, or use a wildcard `*.example.com` and point it to the IP address of the load blancer (from the output of the previous command)
## At your domain registrar
I'm using Cloudflare for DNS, continue to the next section for more information.

46
external/README.md
View File

@ -13,6 +13,8 @@ Below is a list of external resources and why we need them (also see some [alter
- DNS
- DNS-01 challenge for Let's Encrypt
- Tunnel to public services to the internet without port-forwarding
- Minio:
- S3 compatible storage for onsite backup
- AWS:
- S3 Glacier for offsite backup
@ -25,45 +27,53 @@ This layer will:
### Create Terraform workspace
Terraform is stateful, which means it needs somewhere to store it's state. The Terraform Cloud is one option for a state backend with a generous free tier perfect for a homelab.
Terraform is stateful, which means it needs somewhere to store its state. Terraform Cloud is one option for a state backend with a generous free tier, perfect for a homelab.
1. Sign up for a [Terraform Cloud](https://cloud.hashicorp.com/products/terraform)
1. Sign up for a [Terraform Cloud](https://cloud.hashicorp.com/products/terraform) account
2. Create a workspace named `homelab-external`, this is the workspace where your homelab state will be stored.
3. Change the "Execution Mode" from "Remote" to "Local". This will ensure your local machine, which can access your lab, is the one executing the terraform plan rather than the cloud runners.
If you decide to use a different terraform backend, you'll need to edit the [external/versions.tf](./versions.tf) file as required.
If you decide to use a [different Terraform backend](https://www.terraform.io/language/settings/backends#available-backends), you'll need to edit the `external/versions.tf` file as required.
### Create Cloudflare API token
### Cloudflare
<https://dash.cloudflare.com/profile/api-tokens>
- Buy a domain and [transfer it to Cloudflare](https://developers.cloudflare.com/registrar/get-started/transfer-domain-to-cloudflare) if you haven't already
- Get Cloudflare email and account ID
- Global API key: <https://dash.cloudflare.com/profile/api-tokens>
Terraform API token summary:
<!-- TODO switch to API token instead of API key? -->
<!-- Terraform API token summary: -->
```
This API token will affect the below accounts and zones, along with their respective permissions
<!-- ``` -->
<!-- This API token will affect the below accounts and zones, along with their respective permissions -->
└── Khue Doan - Argo Tunnel:Edit, Account Settings:Read
└── khuedoan.com - Zone:Read, DNS:Edit
<!-- └── Khue Doan - Argo Tunnel:Edit, Account Settings:Read -->
<!-- └── khuedoan.com - Zone:Read, DNS:Edit -->
Client IP Address Filtering
<!-- Client IP Address Filtering -->
└── Is in - 117.xxx.xxx.xxx, 2402:xxx:xxx:xxx:xxx:xxx:xxx:xxx
```
<!-- └── Is in - 117.xxx.xxx.xxx, 2402:xxx:xxx:xxx:xxx:xxx:xxx:xxx -->
<!-- ``` -->
### Create Minio keys
TODO: skip this for now
### Create AWS API key
TODO
TODO: skip this for now
## Deploy
Apply Terraform (you will be prompted to login to Terraform Cloud and enter API keys from the previous steps):
Apply Terraform (you will be prompted to log in to Terraform Cloud and enter API keys from the previous steps):
```sh
make
# From the project root
make external
```
## Alternatives
- Terraform Cloud: any other [Terraform backends](https://www.terraform.io/language/settings/backends)
- Cloudflare Tunnel: you can build a small VPS in the cloud and route traffic via it using Wireguard and HAProxy.
- S3 Glacier: any S3 compatible object storage, such as Backblaze B2, Minio...
- Cloudflare Tunnel: you can create a small VPS in the cloud and utilize Wireguard and HAProxy to route traffic via it, or just use simple port-forwarding if it's available (see also [awesome tunneling](https://github.com/anderspitman/awesome-tunneling))
- Minio and S3 Glacier: any S3 compatible object storage, such as Backblaze B2, Minio...