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

Commit cd5abdc

Browse files
committed
docs: update references from hetzner.env to hetzner-staging.env
Updates all documentation to reflect the provider configuration file rename: - Testing documentation: manual deployment and session guides - Scripts: manage-hetzner-dns.sh with staging-specific provider config - Template: hetzner.env.tpl with updated instructions - README: provider configuration documentation - Deployment guides: staging-specific references This maintains consistency between actual file naming and documentation for Issue #28 Phase 4.7 staging deployment testing.
1 parent 9075ed1 commit cd5abdc

File tree

10 files changed

+27
-25
lines changed

10 files changed

+27
-25
lines changed

docs/guides/deployment-guide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ make infra-destroy
9494

9595
```bash
9696
# Configure Hetzner provider with your API tokens first
97-
vim infrastructure/config/providers/hetzner.env
97+
vim infrastructure/config/providers/hetzner-staging.env
9898

9999
# Generate staging environment configuration
100100
make infra-config-staging PROVIDER=hetzner
@@ -893,7 +893,7 @@ TRACKER_ADMIN_TOKEN=MyAccessToken
893893
The deployment system uses a **two-file architecture** for maximum security and flexibility:
894894

895895
1. **Environment Files**: Environment-specific settings (staging-hetzner.env, production-hetzner.env)
896-
2. **Provider Files**: API tokens and provider configuration (hetzner.env)
896+
2. **Provider Files**: API tokens and provider configuration (hetzner-staging.env)
897897

898898
**Benefits**:
899899

@@ -912,7 +912,7 @@ Before creating environment configurations, you must configure the Hetzner provi
912912

913913
```bash
914914
# Edit the Hetzner provider configuration
915-
vim infrastructure/config/providers/hetzner.env
915+
vim infrastructure/config/providers/hetzner-staging.env
916916
```
917917

918918
**Required Changes**:

docs/guides/staging-deployment-testing-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ make install-deps
4444
make lint
4545

4646
# Check provider configuration
47-
cat infrastructure/config/providers/hetzner.env
47+
cat infrastructure/config/providers/hetzner-staging.env
4848

4949
# Verify environment templates exist
5050
ls infrastructure/config/environments/staging-hetzner.env.tpl
@@ -55,7 +55,7 @@ ls infrastructure/config/environments/staging-hetzner.env.tpl
5555
Ensure these are configured in your provider configuration:
5656

5757
```bash
58-
# From infrastructure/config/providers/hetzner.env
58+
# From infrastructure/config/providers/hetzner-staging.env
5959
HETZNER_API_TOKEN=your-cloud-api-token
6060
HETZNER_DNS_API_TOKEN=your-dns-api-token
6161
```

docs/issues/28-phase-4-hetzner-infrastructure-implementation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ production-ready cloud deployment system.
117117

118118
**Key Files Created**:
119119

120-
- `infrastructure/config/providers/hetzner.env` - Secure API token storage
120+
- `infrastructure/config/providers/hetzner-staging.env` - Secure API token storage
121121
- `docs/guides/providers/hetzner/hetzner-cloud-setup-guide.md` - Complete setup guide
122122
- Environment templates in `infrastructure/config/environments/`
123123

@@ -511,7 +511,7 @@ to Hetzner DNS servers before infrastructure deployment can proceed.
511511

512512
### API Token Management
513513

514-
- **Storage**: `infrastructure/config/providers/hetzner.env` (git-ignored)
514+
- **Storage**: `infrastructure/config/providers/hetzner-staging.env` (git-ignored)
515515
- **Cloud Token**: 64 characters, Read & Write permissions
516516
- **DNS Token**: 32 characters, Zone:Edit permissions
517517
- **Validation**: Both tokens tested and working
@@ -525,7 +525,7 @@ to Hetzner DNS servers before infrastructure deployment can proceed.
525525

526526
```bash
527527
# Always source the provider configuration first
528-
source infrastructure/config/providers/hetzner.env
528+
source infrastructure/config/providers/hetzner-staging.env
529529

530530
# Then use the correct variable names
531531
curl -H "Authorization: Bearer $HETZNER_API_TOKEN" https://api.hetzner.cloud/v1/...
@@ -579,7 +579,7 @@ The Hetzner implementation builds on the existing twelve-factor architecture:
579579
### File System Integration
580580

581581
```text
582-
✅ infrastructure/config/providers/hetzner.env - API tokens
582+
✅ infrastructure/config/providers/hetzner-staging.env - API tokens
583583
✅ infrastructure/config/environments/ - Environment templates
584584
✅ docs/guides/providers/hetzner/ - Provider documentation
585585
📝 infrastructure/terraform/providers/hetzner/ - Terraform modules

docs/testing/manual-sessions/2025-01-08-issue-28-phase-4-7-staging.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ workflow using real Hetzner Cloud infrastructure with the torrust-demo.dev domai
4747
**Configuration Files**:
4848

4949
- **Environment File**: `infrastructure/config/environments/staging-hetzner.env`
50-
- **Provider File**: `infrastructure/config/providers/hetzner.env`
50+
- **Provider File**: `infrastructure/config/providers/hetzner-staging.env`
5151
- **Templates**: All staging templates validated
5252

5353
**Prerequisites Required**:
@@ -83,7 +83,7 @@ workflow using real Hetzner Cloud infrastructure with the torrust-demo.dev domai
8383

8484
```bash
8585
# 1. Verify provider configuration
86-
cat infrastructure/config/providers/hetzner.env
86+
cat infrastructure/config/providers/hetzner-staging.env
8787

8888
# 2. Validate environment configuration
8989
make infra-config-validate ENVIRONMENT_TYPE=staging ENVIRONMENT_FILE=staging-hetzner
@@ -383,7 +383,7 @@ Upon successful completion of Phase 4.7, the project will be ready for:
383383

384384
### Immediate Actions Required
385385

386-
- [ ] Configure provider tokens in `infrastructure/config/providers/hetzner.env`
386+
- [ ] Configure provider tokens in `infrastructure/config/providers/hetzner-staging.env`
387387
- [ ] Validate DNS zone configuration for torrust-demo.dev
388388
- [ ] Ensure SSH key is properly configured
389389
- [ ] Begin Phase 1: Environment Preparation

docs/testing/manual-staging-deployment-testing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ virtualization, staging testing provides:
2929
### Configuration Files
3030

3131
- `infrastructure/config/environments/staging-hetzner.env`
32-
- `infrastructure/config/providers/hetzner.env`
32+
- `infrastructure/config/providers/hetzner-staging.env`
3333

3434
### Validation Commands
3535

@@ -38,7 +38,7 @@ virtualization, staging testing provides:
3838
ls -la infrastructure/config/environments/staging-hetzner.env
3939

4040
# Check provider configuration
41-
ls -la infrastructure/config/providers/hetzner.env
41+
ls -la infrastructure/config/providers/hetzner-staging.env
4242

4343
# Validate configuration syntax
4444
make infra-config-validate ENVIRONMENT_TYPE=staging ENVIRONMENT_FILE=staging-hetzner

infrastructure/config/providers/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ infrastructure/config/templates/providers/
2828
### Hetzner Cloud Provider (Production)
2929

3030
- **Template**: `infrastructure/config/templates/providers/hetzner.env.tpl`
31-
- **User File**: `hetzner.env` (create from template)
31+
- **User File**: `hetzner-staging.env` (create from template)
3232
- **Purpose**: Hetzner Cloud deployment for production environments
3333

3434
## Usage Instructions
@@ -54,7 +54,7 @@ can override provider defaults:
5454
#### Example Scenario
5555

5656
```bash
57-
# Provider config (hetzner.env) - defaults for ALL environments
57+
# Provider config (hetzner-staging.env) - defaults for ALL environments
5858
HETZNER_SERVER_TYPE=cpx31 # Default: 4 vCPU, 8GB RAM
5959
HETZNER_LOCATION=fsn1 # Default: Falkenstein datacenter
6060

@@ -72,7 +72,7 @@ HETZNER_LOCATION=fsn1 # Default: Falkenstein datacenter
7272
cp infrastructure/config/templates/providers/libvirt.env.tpl infrastructure/config/providers/libvirt.env
7373

7474
# For Hetzner Cloud
75-
cp infrastructure/config/templates/providers/hetzner.env.tpl infrastructure/config/providers/hetzner.env
75+
cp infrastructure/config/templates/providers/hetzner.env.tpl infrastructure/config/providers/hetzner-staging.env
7676
```
7777

7878
2. **Edit the copied file** with your actual values:

infrastructure/config/templates/providers/hetzner.env.tpl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Hetzner Cloud Provider Configuration Template
2-
# Copy this file to hetzner.env and replace placeholder values
3-
# Location: infrastructure/config/providers/hetzner.env
2+
# Copy this file to hetzner-staging.env and replace placeholder values
3+
# Location: infrastructure/config/providers/hetzner-staging.env
44

55
# === HETZNER CLOUD AUTHENTICATION ===
66
# Get your API token from: https://console.hetzner.cloud/

infrastructure/docs/configuration-architecture.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ and providers (libvirt, Hetzner Cloud).
2121

2222
**Location**: `infrastructure/config/providers/`
2323
**Purpose**: Provider-wide defaults and authentication
24-
**Examples**: `libvirt.env`, `hetzner.env`
24+
**Examples**: `libvirt.env`, `hetzner-staging.env`
2525

2626
## Loading Order and Override System
2727

@@ -32,7 +32,7 @@ During deployment, configurations are loaded in this specific order:
3232
source "infrastructure/config/environments/production-hetzner.env"
3333

3434
# 2. Provider configuration loaded second (can override environment values)
35-
source "infrastructure/config/providers/hetzner.env"
35+
source "infrastructure/config/providers/hetzner-staging.env"
3636
```
3737

3838
### Why This Order?

project-words.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ newtrackon
7777
nmap
7878
noatime
7979
NONCEREJECT
80+
noout
8081
NOPASSWD
8182
NOSLEEP
8283
nosniff
@@ -108,6 +109,7 @@ SAMEORIGIN
108109
secp
109110
selfsigned
110111
shellcheck
112+
showcerts
111113
somaxconn
112114
sshpass
113115
Taplo

scripts/manage-hetzner-dns.sh

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,13 +61,13 @@ load_token() {
6161
log_info "Loading Hetzner DNS API token from provider configuration..."
6262

6363
# Load provider configuration
64-
local provider_config="${PROJECT_ROOT}/infrastructure/config/providers/hetzner.env"
64+
local provider_config="${PROJECT_ROOT}/infrastructure/config/providers/hetzner-staging.env"
6565

6666
if [[ ! -f "$provider_config" ]]; then
6767
log_error "Provider configuration not found at: $provider_config"
6868
log_error ""
6969
log_error "Please create the configuration file from template:"
70-
log_error " cp infrastructure/config/templates/providers/hetzner.env.tpl infrastructure/config/providers/hetzner.env"
70+
log_error " cp infrastructure/config/templates/providers/hetzner.env.tpl infrastructure/config/providers/hetzner-staging.env"
7171
log_error " # Edit the file and set HETZNER_DNS_API_TOKEN"
7272
exit 1
7373
fi
@@ -331,11 +331,11 @@ Examples:
331331
$0 check-propagation grafana
332332
333333
Prerequisites:
334-
- API token configured in infrastructure/config/providers/hetzner.env
334+
- API token configured in infrastructure/config/providers/hetzner-staging.env
335335
- curl and jq installed
336336
337337
Setup:
338-
1. Copy template: cp infrastructure/config/templates/providers/hetzner.env.tpl infrastructure/config/providers/hetzner.env
338+
1. Copy template: cp infrastructure/config/templates/providers/hetzner.env.tpl infrastructure/config/providers/hetzner-staging.env
339339
2. Edit file and set: HETZNER_DNS_API_TOKEN=your_dns_api_token_here
340340
3. Get token from: https://dns.hetzner.com/
341341

0 commit comments

Comments
 (0)