Skip to content

Commit 20afd81

Browse files
committed
docs: [#220] update run command documentation
- Updated to reflect validation of ALL configured HTTP trackers, not just first - Added note about port 0 (dynamic assignment) not being supported - Enhanced health check details to clarify multiple HTTP tracker validation - Added link to ADR for port zero restriction - Clarified that HTTP tracker checks are optional (warn only) while API check is required
1 parent fbb300b commit 20afd81

1 file changed

Lines changed: 16 additions & 10 deletions

File tree

  • docs/user-guide/commands

docs/user-guide/commands/run.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,11 @@ When you run an environment:
3636

3737
1. **Starts Docker Compose services** - Brings up tracker container (`docker compose up -d`)
3838
2. **Validates services are running** - Checks Docker Compose status
39-
3. **Validates external accessibility** - Verifies tracker API responds from outside VM
40-
- Tracker API health check (port 1212)
41-
- HTTP Tracker health check (port 7070) - optional
39+
3. **Validates external accessibility** - Verifies tracker services respond from outside VM
40+
- Tracker API health check (port 1212) - **required**
41+
- HTTP Tracker health checks (all configured HTTP tracker ports) - **optional**
42+
43+
**Note**: All tracker ports must be explicitly configured (port 0 for dynamic assignment is not supported). See [ADR: Port Zero Not Supported](../../decisions/port-zero-not-supported.md) for details.
4244

4345
## Services Started
4446

@@ -255,13 +257,14 @@ The `run` command performs external health checks to validate deployment:
255257
2. **Tracker API Health Check** (external, direct HTTP)
256258

257259
- Tests `http://<vm-ip>:1212/api/health_check`
258-
- **Required check** - fails if not accessible
260+
- **Required check** - deployment fails if not accessible
259261
- Validates both service functionality AND firewall rules
260262

261-
3. **HTTP Tracker Health Check** (external, direct HTTP)
262-
- Tests `http://<vm-ip>:7070/api/health_check`
263-
- **Optional check** - warns if not accessible
264-
- Some tracker versions may not have health endpoint
263+
3. **HTTP Tracker Health Checks** (external, direct HTTP)
264+
- Tests `http://<vm-ip>:<port>/api/health_check` for **all configured HTTP trackers**
265+
- **Optional checks** - logs warnings if not accessible, but doesn't fail deployment
266+
- Some tracker versions may not have health endpoints
267+
- If you configure multiple HTTP trackers (e.g., ports 7070, 7071, 7072), all will be validated
265268

266269
If external checks fail but Docker shows services running, it indicates a firewall or network configuration issue.
267270

@@ -320,11 +323,14 @@ The run command executes these steps in order:
320323
1. **Start services** (`StartServicesStep`) - Runs `docker compose up -d` via Ansible
321324
2. **Validate running services** (`RunningServicesValidator`)
322325
- Checks Docker Compose status (via SSH)
323-
- Checks external tracker API accessibility (direct HTTP)
324-
- Checks external HTTP tracker accessibility (direct HTTP, optional)
326+
- Checks external tracker API accessibility (direct HTTP - **required**)
327+
- Checks external HTTP tracker accessibility for **all configured HTTP trackers** (direct HTTP - **optional**)
325328

326329
The validation ensures:
327330

328331
- Services are actually running inside the VM
329332
- Firewall rules allow external access
330333
- Tracker API responds to health checks
334+
- All HTTP tracker instances (if configured) are accessible externally
335+
336+
**Port Configuration Note**: Dynamic port assignment (port 0) is not supported. All tracker ports must be explicitly specified in the environment configuration. This ensures deterministic deployment and reliable firewall configuration.

0 commit comments

Comments
 (0)