You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Read-only preflight that validates the full deployment configuration
and prints a concrete fix command for every failure: required tools,
SSH key, Ansible collections, inventory.ini, instance.env plus live AWS
credentials, dev-scripts topology configs and pull secret, CI registry
auth cross-check with live CI token check, and the kcli pull secret.
Exits non-zero if and only if a check failed.
- 'make doctor' runs common checks plus every auto-detected section
- 'make doctor <cluster-type>' validates strictly for that deployment:
the method's section becomes mandatory and its method-specific
warnings are promoted to failures; cluster-type goals following
'doctor' are neutralized so they never trigger a deployment
- inventory.ini stays informational when absent (the AWS flow generates
it via 'make inventory'), but a present-but-unedited copy of the
sample fails, since that breaks deployment in confusing ways
- deploy-cluster.sh preflight error paths now point at 'make doctor'
Checks are ported from the validation steps in
.claude/commands/setup.md and the in-playbook preflight in
roles/dev-scripts/install-dev/tasks/config.yml.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LSBffYjh3rtLToAMR1pjQT
Copy file name to clipboardExpand all lines: README.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -79,6 +79,8 @@ If you're using [Claude Code](https://claude.ai/code), use the `/setup` command
79
79
- Validating your setup
80
80
81
81
Run `/setup` to begin, or `/setup <method>` to configure a specific deployment method (aws, external, kcli, dev-scripts).
82
+
83
+
If you are not using Claude Code, or want a quick non-interactive check, run `make doctor` from the `deploy/` directory. It validates required tools, SSH keys, Ansible collections, and configuration files, printing a fix command for every problem found. `make doctor <cluster-type>` (for example `make doctor arbiter-ipi`) validates strictly for one deployment type.
82
84
## Helpers
83
85
84
86
The [helpers/](helpers/) directory contains utilities for cluster operations including resource-agents patching, fencing validation, and containerized build validation. To quickly verify a resource-agents branch compiles on CentOS Stream 9 and 10:
Copy file name to clipboardExpand all lines: deploy/README.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,6 +40,8 @@ Additionally, if you're using Mac OS, you might not have `timeout`, so you might
40
40
41
41
## Configuration
42
42
43
+
Run `make doctor` at any time to validate your setup before deploying. It is a read-only preflight that checks required tools, SSH keys, Ansible collections, and every configuration file, and prints a concrete fix command for each problem it finds. Use `make doctor <cluster-type>` (for example `make doctor fencing-kcli`) to validate strictly for a specific deployment type: the checks specific to that deployment method become mandatory.
44
+
43
45
Before deployment, configure your environment by creating an `instance.env` file in the central [config/](../config/) folder. Copy `config/instance.env.template` to `config/instance.env` and set all variables to valid values for your user. Every `make` target syncs `config/` files to the locations the scripts read them from (`aws-hypervisor/instance.env` in this case); run `make sync-config` to sync explicitly. Editing `aws-hypervisor/instance.env` directly still works as before. See [config/README.md](../config/README.md) for all available configuration files.
0 commit comments