Make README diagrams vertical and clickable

This commit is contained in:
Mateusz Suski
2026-05-06 06:46:27 +00:00
parent 8cc19a0442
commit d1b9cabe5c
31 changed files with 92 additions and 158 deletions
+6 -6
View File
@@ -6,12 +6,12 @@
```mermaid
flowchart TD
A["infra-run"] --> B["ansible"]
A --> C["docs"]
A --> D["runbooks"]
A --> E["scripts"]
E --> E1["bash"]
E --> E2["python"]
A["infra-run"] --> B["ansible"] --> C["docs"] --> D["runbooks"] --> E["scripts"]
click A href "./" "infra-run"
click B href "./ansible/" "ansible"
click C href "./docs/" "docs"
click D href "./runbooks/" "runbooks"
click E href "./scripts/" "scripts"
```
## Scope
+7 -7
View File
@@ -6,13 +6,13 @@ This directory reserves the Ansible automation area for future infrastructure-as
```mermaid
flowchart TD
A["ansible"] --> B["collections"]
A --> C["inventory"]
A --> D["playbooks"]
A --> E["roles"]
A --> F["tests"]
C --> C1["group_vars"]
C --> C2["host_vars"]
A["ansible"] --> B["collections"] --> C["inventory"] --> D["playbooks"] --> E["roles"] --> F["tests"]
click A href "./" "ansible"
click B href "./collections/" "collections"
click C href "./inventory/" "inventory"
click D href "./playbooks/" "playbooks"
click E href "./roles/" "roles"
click F href "./tests/" "tests"
```
## Scope
+2 -4
View File
@@ -6,10 +6,8 @@ This folder is reserved for Ansible collections used by the `infra-run` automati
```mermaid
flowchart TD
A["collections"] --> B["External or custom collections"]
B --> C["Modules"]
B --> D["Plugins"]
B --> E["Roles integration"]
A["collections"]
click A href "./" "collections"
```
## Scope
+4 -4
View File
@@ -6,10 +6,10 @@ This directory is intended for Ansible inventory definitions. It separates share
```mermaid
flowchart TD
A["inventory"] --> B["group_vars"]
A --> C["host_vars"]
B --> D["Shared environment variables"]
C --> E["Per-host overrides"]
A["inventory"] --> B["group_vars"] --> C["host_vars"]
click A href "./" "inventory"
click B href "./group_vars/" "group_vars"
click C href "./host_vars/" "host_vars"
```
## Scope
@@ -6,9 +6,8 @@ This folder is reserved for shared Ansible variables applied to inventory groups
```mermaid
flowchart TD
A["group_vars"] --> B["Environment defaults"]
A --> C["Role parameters"]
A --> D["Shared operational values"]
A["group_vars"]
click A href "./" "group_vars"
```
## Notes
@@ -6,9 +6,8 @@ This folder is intended for host-specific Ansible variables. It complements `gro
```mermaid
flowchart TD
A["host_vars"] --> B["Host A overrides"]
A --> C["Host B overrides"]
A --> D["Per-node secrets or tuning"]
A["host_vars"]
click A href "./" "host_vars"
```
## Notes
+2 -4
View File
@@ -6,10 +6,8 @@ This directory is intended for executable Ansible playbooks that coordinate role
```mermaid
flowchart TD
A["playbooks"] --> B["Provisioning flows"]
A --> C["Hardening flows"]
A --> D["Patch workflows"]
A --> E["Decommission workflows"]
A["playbooks"]
click A href "./" "playbooks"
```
## Notes
+2 -4
View File
@@ -6,10 +6,8 @@ This folder is reserved for reusable Ansible roles. Roles make it possible to or
```mermaid
flowchart TD
A["roles"] --> B["common"]
A --> C["monitoring"]
A --> D["storage"]
A --> E["security"]
A["roles"]
click A href "./" "roles"
```
## Notes
+2 -3
View File
@@ -6,9 +6,8 @@ This directory is reserved for validation of Ansible content. It represents the
```mermaid
flowchart TD
A["tests"] --> B["Syntax checks"]
A --> C["Molecule or scenario tests"]
A --> D["Post-run validation"]
A["tests"]
click A href "./" "tests"
```
## Notes
+2 -3
View File
@@ -6,9 +6,8 @@ This directory is intended for supporting technical documentation tied to the op
```mermaid
flowchart TD
A["docs"] --> B["Architecture notes"]
A --> C["Operational references"]
A --> D["Change preparation notes"]
A["docs"]
click A href "./" "docs"
```
## Notes
+2 -4
View File
@@ -6,10 +6,8 @@ This directory is reserved for runbook-style procedures that describe how to per
```mermaid
flowchart TD
A["runbooks"] --> B["Pre-check"]
A --> C["Change execution"]
A --> D["Post-check"]
A --> E["Rollback or escalation"]
A["runbooks"]
click A href "./" "runbooks"
```
## Notes
+4 -4
View File
@@ -6,10 +6,10 @@ This directory groups executable tooling used across the `infra-run` project. It
```mermaid
flowchart TD
A["scripts"] --> B["bash"]
A --> C["python"]
B --> D["Operational toolkits"]
C --> E["Future helper utilities"]
A["scripts"] --> B["bash"] --> C["python"]
click A href "./" "scripts"
click B href "./bash/" "bash"
click C href "./python/" "python"
```
## Scope
+6 -8
View File
@@ -6,14 +6,12 @@ Small, practical Bash scripts for Linux operations checks and incident triage. T
```mermaid
flowchart TD
A["bash"] --> B["os-healthcheck"]
A --> C["disk-full"]
A --> D["veritas"]
A --> E["gpfs"]
B --> B1["Host diagnostics"]
C --> C1["Incident workflow"]
D --> D1["VxVM and VCS change flow"]
E --> E1["Spectrum Scale expansion flow"]
A["bash"] --> B["os-healthcheck"] --> C["disk-full"] --> D["veritas"] --> E["gpfs"]
click A href "./" "bash"
click B href "./os-healthcheck/" "os-healthcheck"
click C href "./disk-full/" "disk-full"
click D href "./veritas/" "veritas"
click E href "./gpfs/" "gpfs"
```
## Scripts
+2 -8
View File
@@ -6,14 +6,8 @@ Production-style Bash toolkit for diagnosing and handling a disk full incident o
```mermaid
flowchart TD
A["disk-full"] --> B["01_disk_overview.sh"]
A --> C["02_find_big_files.sh"]
A --> D["03_deleted_open_files.sh"]
A --> E["04_top_dirs.sh"]
A --> F["05_log_cleanup.sh"]
A --> G["06_quick_fix.sh"]
A --> H["07_postcheck.sh"]
A --> I["disk_full_runbook.sh"]
A["disk-full"]
click A href "./" "disk-full"
```
## Why Disk Full Incidents Happen
+2 -9
View File
@@ -8,15 +8,8 @@ These scripts are examples. Exact GPFS commands, flags, quorum practices, failur
```mermaid
flowchart TD
A["gpfs"] --> B["01_cluster_overview.sh"]
A --> C["02_precheck_gpfs.sh"]
A --> D["03_detect_new_disks.sh"]
A --> E["04_create_nsd_stanza.sh"]
A --> F["05_add_nsd_to_filesystem.sh"]
A --> G["06_rebalance_filesystem.sh"]
A --> H["07_postcheck_gpfs.sh"]
A --> I["08_generate_report.sh"]
A --> J["gpfs_extend_runbook.sh"]
A["gpfs"]
click A href "./" "gpfs"
```
## Concepts
@@ -6,11 +6,8 @@ This directory contains first-pass Linux diagnostics for common host checks. The
```mermaid
flowchart TD
A["os-healthcheck"] --> B["healthcheck.sh"]
A --> C["disk_check.sh"]
A --> D["service_check.sh"]
A --> E["system_report.sh"]
A --> F["network_troubleshoot.sh"]
A["os-healthcheck"]
click A href "./" "os-healthcheck"
```
## Scripts
+2 -9
View File
@@ -6,15 +6,8 @@ Production-style Bash examples for expanding storage in a Veritas environment. T
```mermaid
flowchart TD
A["veritas"] --> B["01_detect_new_luns.sh"]
A --> C["02_precheck_vcs_vxvm.sh"]
A --> D["03_freeze_vcs_group.sh"]
A --> E["04_init_vxvm_disks.sh"]
A --> F["05_extend_diskgroup.sh"]
A --> G["06_extend_volume_fs.sh"]
A --> H["07_postcheck_vcs_vxvm.sh"]
A --> I["08_unfreeze_vcs_group.sh"]
A --> J["veritas_extend_runbook.sh"]
A["veritas"]
click A href "./" "veritas"
```
## VxVM vs VCS
+2 -3
View File
@@ -6,9 +6,8 @@ This directory is reserved for Python helpers that may later complement the Bash
```mermaid
flowchart TD
A["python"] --> B["Future reporting utilities"]
A --> C["Parsers"]
A --> D["Automation helpers"]
A["python"]
click A href "./" "python"
```
## Notes