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,26 @@
+# platform-projects
+
+This directory groups broader infrastructure themes that sit above individual scripts. It highlights larger platform domains such as storage, clustering, monitoring, virtualization, and log analysis.
+
+## Diagram
+
+```mermaid
+flowchart TD
+  A["platform-projects"] --> B["storage"]
+  A --> C["clustering"]
+  A --> D["monitoring-zabbix"]
+  A --> E["virtualization"]
+  A --> F["elk-log-analysis"]
+```
+
+## Scope
+
+- `storage` - storage engineering themes and patterns.
+- `clustering` - high availability and cluster operations topics.
+- `monitoring-zabbix` - observability and alerting direction.
+- `virtualization` - compute platform and hypervisor-related topics.
+- `elk-log-analysis` - log ingestion, search, and analysis concepts.
+
+## Notes
+
+- These folders are currently high-level placeholders for future platform case studies.
@@ -0,0 +1,18 @@
+# platform-projects/clustering
+
+This folder is reserved for clustering-focused platform work. It is meant for high-availability concepts, quorum behavior, failover patterns, and multi-node operational design.
+
+## Diagram
+
+```mermaid
+flowchart LR
+  A["clustering"] --> B["Quorum"]
+  A --> C["Failover"]
+  A --> D["Service groups"]
+  A --> E["Operational validation"]
+```
+
+## Notes
+
+- The directory is currently a placeholder.
+- Its theme aligns naturally with the Veritas and GPFS toolkits elsewhere in the repository.
@@ -0,0 +1,18 @@
+# platform-projects/elk-log-analysis
+
+This folder is intended for Elastic Stack style log-analysis work. It can hold examples around log pipelines, parsing, dashboards, and troubleshooting based on operational telemetry.
+
+## Diagram
+
+```mermaid
+flowchart LR
+  A["elk-log-analysis"] --> B["Ingest"]
+  A --> C["Parse"]
+  A --> D["Search"]
+  A --> E["Visualize"]
+```
+
+## Notes
+
+- The directory currently contains only a placeholder file.
+- It represents a future case-study area for observability and incident analysis patterns.
@@ -0,0 +1,18 @@
+# platform-projects/monitoring-zabbix
+
+This folder is reserved for monitoring and alerting work centered on Zabbix-style platform operations. It is a suitable place for host templates, dashboards, trigger design, and operational alert tuning examples.
+
+## Diagram
+
+```mermaid
+flowchart LR
+  A["monitoring-zabbix"] --> B["Hosts"]
+  A --> C["Templates"]
+  A --> D["Triggers"]
+  A --> E["Dashboards"]
+```
+
+## Notes
+
+- The directory is currently a placeholder.
+- It complements the healthcheck scripts by representing the monitoring side of infrastructure operations.
@@ -0,0 +1,18 @@
+# platform-projects/storage
+
+This folder is intended for storage-oriented platform topics. It can hold higher-level notes and case studies related to filesystem growth, block storage operations, multipath design, and capacity planning.
+
+## Diagram
+
+```mermaid
+flowchart LR
+  A["storage"] --> B["Capacity planning"]
+  A --> C["Filesystem expansion"]
+  A --> D["Block device management"]
+  A --> E["Operational safety"]
+```
+
+## Notes
+
+- The directory currently contains only a placeholder file.
+- It is closely related to the GPFS and Veritas operational toolkits under `infra-run/scripts/bash`.
@@ -0,0 +1,18 @@
+# platform-projects/virtualization
+
+This folder is reserved for virtualization platform topics. It is intended for work around hypervisors, guest lifecycle operations, capacity considerations, and infrastructure hosting patterns.
+
+## Diagram
+
+```mermaid
+flowchart LR
+  A["virtualization"] --> B["Hypervisors"]
+  A --> C["Guests"]
+  A --> D["Resource planning"]
+  A --> E["Operational maintenance"]
+```
+
+## Notes
+
+- The directory is currently a placeholder.
+- It represents a future area for platform-level case studies beyond the current script collection.