Add README files and diagrams across repository

2026-05-06 06:36:53 +00:00
parent c88428d092
commit 1e2db3e125
31 changed files with 616 additions and 0 deletions
@@ -0,0 +1,23 @@
+# infra-run/ansible/inventory
+
+This directory is intended for Ansible inventory definitions. It separates shared variables from host-specific values to support clean environment modeling and safer automation.
+
+## Diagram
+
+```mermaid
+flowchart TD
+  A["inventory"] --> B["group_vars"]
+  A --> C["host_vars"]
+  B --> D["Shared environment variables"]
+  C --> E["Per-host overrides"]
+```
+
+## Scope
+
+- `group_vars` - variables applied at group or environment level.
+- `host_vars` - variables tailored to individual nodes.
+
+## Notes
+
+- The structure is present even though the repository currently keeps this area sanitized and mostly empty.
+- This is the natural companion to future playbooks and roles under `infra-run/ansible`.
@@ -0,0 +1,17 @@
+# infra-run/ansible/inventory/group_vars
+
+This folder is reserved for shared Ansible variables applied to inventory groups. It is the right place for environment defaults, role inputs, and group-level operational settings.
+
+## Diagram
+
+```mermaid
+flowchart LR
+  A["group_vars"] --> B["Environment defaults"]
+  A --> C["Role parameters"]
+  A --> D["Shared operational values"]
+```
+
+## Notes
+
+- Use this layer when multiple hosts should inherit the same configuration.
+- The directory is currently a placeholder and does not expose environment-specific data.
@@ -0,0 +1,17 @@
+# infra-run/ansible/inventory/host_vars
+
+This folder is intended for host-specific Ansible variables. It complements `group_vars` by capturing node-level differences that should not be shared across an entire inventory group.
+
+## Diagram
+
+```mermaid
+flowchart LR
+  A["host_vars"] --> B["Host A overrides"]
+  A --> C["Host B overrides"]
+  A --> D["Per-node secrets or tuning"]
+```
+
+## Notes
+
+- Use this area when operational differences are specific to one server.
+- The directory is intentionally empty in the sanitized portfolio state.