This commit is contained in:
+11
-4
@@ -38,6 +38,14 @@ The goal is to show operational judgment, not to ship a universal automation pro
|
||||
- Disk-full read-only scripts can be run against local paths for basic behavior checks.
|
||||
- Ansible YAML and role structure can be linted locally.
|
||||
|
||||
## Running Safely
|
||||
|
||||
- Start with the relevant README or runbook before executing a script.
|
||||
- Prefer read-only discovery scripts before remediation scripts.
|
||||
- Use dry-run mode unless a script explicitly documents safe local behavior.
|
||||
- Only use `--execute` after reviewing inputs, affected systems, rollback options, and post-checks.
|
||||
- For Ansible, start with `--check --diff` against a lab inventory.
|
||||
|
||||
## Lab-Safe Examples
|
||||
|
||||
- Veritas and GPFS scripts default to dry-run behavior where they plan destructive or platform-changing operations.
|
||||
@@ -59,12 +67,10 @@ Short version:
|
||||
From the repository root:
|
||||
|
||||
```bash
|
||||
find infra-run/scripts/bash -name '*.sh' -print0 | xargs -0 shellcheck -x -P infra-run/scripts/bash/disk-full -P infra-run/scripts/bash/gpfs -P infra-run/scripts/bash/veritas
|
||||
yamllint .
|
||||
cd infra-run/ansible && ansible-lint playbooks roles
|
||||
./scripts/validate-repo.sh
|
||||
```
|
||||
|
||||
If `ansible-lint` reports collection-related issues, install the collections listed in [ansible/collections/requirements.yml](./ansible/collections/requirements.yml) and rerun it. Treat lint as a starting point; platform testing still requires actual target systems.
|
||||
Focused checks are available in `scripts/check-bash.sh`, `scripts/check-ansible.sh`, and `scripts/check-docs.sh`. If `ansible-lint` reports collection-related issues, install the collections listed in [ansible/collections/requirements.yml](./ansible/collections/requirements.yml) and rerun it. Treat lint as a starting point; platform testing still requires actual target systems.
|
||||
|
||||
## Supporting Notes
|
||||
|
||||
@@ -72,3 +78,4 @@ If `ansible-lint` reports collection-related issues, install the collections lis
|
||||
- [TESTED.md](./TESTED.md) lists what was checked locally and what was not.
|
||||
- [KNOWN_LIMITATIONS.md](./KNOWN_LIMITATIONS.md) documents technical limits and operational cautions.
|
||||
- [ROADMAP.md](./ROADMAP.md) tracks planned additions without presenting them as completed work.
|
||||
- [../AGENTS.md](../AGENTS.md) and [../docs/codex](../docs/codex/) document repository working rules and review expectations.
|
||||
|
||||
Reference in New Issue
Block a user