From 9781fd4caa126576d83a74d970f38f94f68cee83 Mon Sep 17 00:00:00 2001 From: Chad Ferman Date: Fri, 10 Apr 2026 09:23:18 -0500 Subject: [PATCH 1/2] docs: Relocate reports to reports/ directory and update all references Move all report files from docs/ to reports/ directory for better organization: - aap-architecture-validation-report.md - documentation-audit-report.md - dr-architecture-validation-report.md - dr-replication-validation-report.md Update all references across documentation: - CONTRIBUTING.md - docs/INDEX.md (8 references updated) - docs/aap-containerized-enterprise-dr-architecture.md - docs/aap-containerized-growth-dr-architecture.md - docs/aap-containerized-quickstart.md - docs/dr-replication-implementation-status.md - docs/dr-testing-guide.md - reports/documentation-audit-report.md All paths updated to maintain proper linking between documents. Co-Authored-By: Claude Sonnet 4.5 --- CONTRIBUTING.md | 2 +- docs/INDEX.md | 14 +++++++------- ...aap-containerized-enterprise-dr-architecture.md | 2 +- docs/aap-containerized-growth-dr-architecture.md | 2 +- docs/aap-containerized-quickstart.md | 2 +- docs/dr-replication-implementation-status.md | 4 ++-- docs/dr-testing-guide.md | 2 +- .../aap-architecture-validation-report.md | 0 {docs => reports}/documentation-audit-report.md | 2 +- .../dr-architecture-validation-report.md | 0 .../dr-replication-validation-report.md | 0 11 files changed, 15 insertions(+), 15 deletions(-) rename {docs => reports}/aap-architecture-validation-report.md (100%) rename {docs => reports}/documentation-audit-report.md (99%) rename {docs => reports}/dr-architecture-validation-report.md (100%) rename {docs => reports}/dr-replication-validation-report.md (100%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 59a2cd8..f2009bd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -608,7 +608,7 @@ See [LICENSE](LICENSE) for details. Your contributions help improve this project for everyone. We appreciate your time and effort! **Additional Resources:** -- [Documentation Audit Report](docs/documentation-audit-report.md) - Current documentation status +- [Documentation Audit Report](reports/documentation-audit-report.md) - Current documentation status - [DR Testing Guide](docs/dr-testing-guide.md) - Comprehensive DR testing framework - [CI/CD Pipeline](docs/cicd-pipeline.md) - Automated workflows - [Architecture](README.md#architecture) - System design diff --git a/docs/INDEX.md b/docs/INDEX.md index 5a40ee1..d6650ba 100644 --- a/docs/INDEX.md +++ b/docs/INDEX.md @@ -62,7 +62,7 @@ | **[Main README Architecture](../README.md#architecture)** | High-level overview with diagram | 5 min | | **[AAP Containerized Growth DR](aap-containerized-growth-dr-architecture.md)** ⭐ **NEW** | 3-node multi-DC deployment (cost-optimized) | 25 min | | **[AAP Containerized Enterprise DR](aap-containerized-enterprise-dr-architecture.md)** ⭐ **NEW** | 8-node multi-DC deployment (production-grade) | 30 min | -| **[Architecture Validation Report](aap-architecture-validation-report.md)** | Validation vs Red Hat AAP 2.6 tested models | 15 min | +| **[Architecture Validation Report](../reports/aap-architecture-validation-report.md)** | Validation vs Red Hat AAP 2.6 tested models | 15 min | | **[RHEL AAP Architecture](rhel-aap-architecture.md)** | AAP on RHEL with systemd services | 10 min | | **[OpenShift AAP Architecture](openshift-aap-architecture.md)** | AAP on OpenShift with operator | 10 min | @@ -105,7 +105,7 @@ Choose based on your requirements: | **[EDB Failover Manager](enterprisefailovermanager.md)** | EFM integration and configuration | 20 min | **DR Validation Reports:** -- [DR Replication Validation](dr-replication-validation-report.md) - Architecture assessment (Score: 7.1/10) +- [DR Replication Validation](../reports/dr-replication-validation-report.md) - Architecture assessment (Score: 7.1/10) - [DR Replication Implementation Status](dr-replication-implementation-status.md) - Gap tracking - [Component Testing Results](component-testing-results.md) - Script validation on macOS/CRC - [AAP Deployment Validation (CRC)](aap-deployment-validation-crc.md) - Local OpenShift testing @@ -165,7 +165,7 @@ Choose based on your requirements: - **[CI/CD Pipeline](cicd-pipeline.md)** - GitHub Actions workflows (6,500 words) - **[Scripts Hooks and CI/CD](scripts-hooks-and-cicd.md)** ⭐ **NEW** - Pre-commit hooks, CI checks, and quality automation - **[Pre-commit Hooks](../.pre-commit-config.yaml)** - Local validation before commit -- **CONTRIBUTING.md** - _Coming soon_ (see [Documentation Audit](documentation-audit-report.md)) +- **CONTRIBUTING.md** - _Coming soon_ (see [Documentation Audit](../reports/documentation-audit-report.md)) **GitHub Actions Workflows:** - `.github/workflows/yaml-validation.yml` - Kubernetes manifest validation @@ -188,7 +188,7 @@ Choose based on your requirements: - [Split-Brain Prevention](split-brain-prevention.md#monitoring) - Database role monitoring **Planned Documentation:** -- Monitoring and Alerting Guide (see [Documentation Audit](documentation-audit-report.md#gap-analysis)) +- Monitoring and Alerting Guide (see [Documentation Audit](../reports/documentation-audit-report.md#gap-analysis)) - Grafana Dashboard Setup - PagerDuty Integration @@ -203,7 +203,7 @@ Choose based on your requirements: - [EFM Security](enterprisefailovermanager.md#security) - EFM permissions and VIP management **Planned Documentation:** -- Security Hardening Guide (see [Documentation Audit](documentation-audit-report.md#gap-analysis)) +- Security Hardening Guide (see [Documentation Audit](../reports/documentation-audit-report.md#gap-analysis)) - TLS/SSL Configuration - Secrets Management (Vault, Sealed Secrets) @@ -213,7 +213,7 @@ Choose based on your requirements: **Additional resources:** -- **[Documentation Audit Report](documentation-audit-report.md)** - Comprehensive documentation assessment +- **[Documentation Audit Report](../reports/documentation-audit-report.md)** - Comprehensive documentation assessment - **[Glossary](GLOSSARY.md)** - _Coming soon_ - Terminology and abbreviations - **[FAQ](FAQ.md)** - _Coming soon_ - Frequently asked questions - **[LICENSE](../LICENSE)** - Copyright and licensing @@ -324,7 +324,7 @@ Choose based on your requirements: 3. Backup and Restore Guide (Week 4) 4. GLOSSARY.md (Month 2) -See [Documentation Audit Report](documentation-audit-report.md) for complete roadmap. +See [Documentation Audit Report](../reports/documentation-audit-report.md) for complete roadmap. --- diff --git a/docs/aap-containerized-enterprise-dr-architecture.md b/docs/aap-containerized-enterprise-dr-architecture.md index 5700cb1..400c670 100644 --- a/docs/aap-containerized-enterprise-dr-architecture.md +++ b/docs/aap-containerized-enterprise-dr-architecture.md @@ -1386,7 +1386,7 @@ echo 'set server aap_backend/aap-node1 state ready' | socat stdio /var/lib/hapro ## Related Documentation -- **[Architecture Validation Report](aap-architecture-validation-report.md)** ⭐ - Validation against Red Hat AAP 2.6 tested models +- **[Architecture Validation Report](../reports/aap-architecture-validation-report.md)** ⭐ - Validation against Red Hat AAP 2.6 tested models - **[HAProxy vs pgBouncer Analysis](haproxy-pgbouncer-architectural-analysis.md)** ⭐ - Architecture Decision Record for HAProxy implementation - [Main Architecture](architecture.md) - Comprehensive architecture documentation - [RHEL AAP Architecture](rhel-aap-architecture.md) - Alternative RHEL deployment diff --git a/docs/aap-containerized-growth-dr-architecture.md b/docs/aap-containerized-growth-dr-architecture.md index a8a3720..5068663 100644 --- a/docs/aap-containerized-growth-dr-architecture.md +++ b/docs/aap-containerized-growth-dr-architecture.md @@ -765,7 +765,7 @@ backend aap_backend ## Related Documentation - **[AAP Containerized Enterprise DR Architecture](aap-containerized-enterprise-dr-architecture.md)** - 8-node dedicated component design -- **[Architecture Validation Report](aap-architecture-validation-report.md)** - Validation vs Red Hat tested models +- **[Architecture Validation Report](../reports/aap-architecture-validation-report.md)** - Validation vs Red Hat tested models - [Main Architecture](architecture.md) - Comprehensive architecture documentation - [EDB Failover Manager](enterprisefailovermanager.md) - EFM integration guide - [DR Testing Guide](dr-testing-guide.md) - Testing framework diff --git a/docs/aap-containerized-quickstart.md b/docs/aap-containerized-quickstart.md index 5bc2ab0..5eb9aeb 100644 --- a/docs/aap-containerized-quickstart.md +++ b/docs/aap-containerized-quickstart.md @@ -612,7 +612,7 @@ done **Full Documentation:** - **Growth (16 VMs):** [aap-containerized-growth-dr-architecture.md](aap-containerized-growth-dr-architecture.md) - **Enterprise (26 VMs):** [aap-containerized-enterprise-dr-architecture.md](aap-containerized-enterprise-dr-architecture.md) -- **Validation Report:** [aap-architecture-validation-report.md](aap-architecture-validation-report.md) +- **Validation Report:** [aap-architecture-validation-report.md](../reports/aap-architecture-validation-report.md) --- diff --git a/docs/dr-replication-implementation-status.md b/docs/dr-replication-implementation-status.md index 0762e99..ac79b67 100644 --- a/docs/dr-replication-implementation-status.md +++ b/docs/dr-replication-implementation-status.md @@ -2,7 +2,7 @@ **Version:** 1.0 **Date:** 2026-03-30 -**Baseline Report:** `/docs/dr-replication-validation-report.md` +**Baseline Report:** `/reports/dr-replication-validation-report.md` --- @@ -411,7 +411,7 @@ spec: ## References -- **Baseline Validation:** `/docs/dr-replication-validation-report.md` +- **Baseline Validation:** `/reports/dr-replication-validation-report.md` - **Split-Brain Documentation:** `/docs/split-brain-prevention.md` - **Scale AAP Script:** `/scripts/scale-aap-up.sh` - **Test Script:** `/scripts/test-split-brain-prevention.sh` diff --git a/docs/dr-testing-guide.md b/docs/dr-testing-guide.md index 3a380e3..966ebbf 100644 --- a/docs/dr-testing-guide.md +++ b/docs/dr-testing-guide.md @@ -782,7 +782,7 @@ A: Yes - highly recommended to validate procedures before production testing. - **Split-Brain Prevention:** [/docs/split-brain-prevention.md](/docs/split-brain-prevention.md) - **DR Scenarios:** [/docs/dr-scenarios.md](/docs/dr-scenarios.md) -- **Replication Validation:** [/docs/dr-replication-validation-report.md](/docs/dr-replication-validation-report.md) +- **Replication Validation:** [/reports/dr-replication-validation-report.md](/reports/dr-replication-validation-report.md) - **EFM Integration:** [/docs/enterprisefailovermanager.md](/docs/enterprisefailovermanager.md) --- diff --git a/docs/aap-architecture-validation-report.md b/reports/aap-architecture-validation-report.md similarity index 100% rename from docs/aap-architecture-validation-report.md rename to reports/aap-architecture-validation-report.md diff --git a/docs/documentation-audit-report.md b/reports/documentation-audit-report.md similarity index 99% rename from docs/documentation-audit-report.md rename to reports/documentation-audit-report.md index f66e494..4da252e 100644 --- a/docs/documentation-audit-report.md +++ b/reports/documentation-audit-report.md @@ -62,7 +62,7 @@ The EDB_Testing repository contains **comprehensive and high-quality documentati - `dr-testing-implementation-summary.md` (Implementation details) - `component-testing-results.md` (Component test results) - `aap-deployment-validation-crc.md` (CRC validation report) -- `dr-replication-validation-report.md` (Replication validation) +- `reports/dr-replication-validation-report.md` (Replication validation) - `dr-replication-implementation-status.md` (Gap tracking) **Development (2 files):** diff --git a/docs/dr-architecture-validation-report.md b/reports/dr-architecture-validation-report.md similarity index 100% rename from docs/dr-architecture-validation-report.md rename to reports/dr-architecture-validation-report.md diff --git a/docs/dr-replication-validation-report.md b/reports/dr-replication-validation-report.md similarity index 100% rename from docs/dr-replication-validation-report.md rename to reports/dr-replication-validation-report.md From 78a970f2939f19bdc21b43f2bffda4f0016eb8d5 Mon Sep 17 00:00:00 2001 From: Chad Ferman Date: Fri, 10 Apr 2026 09:32:25 -0500 Subject: [PATCH 2/2] docs: Update RHEL version requirements for AAP 2.6 compatibility Ensure all documentation correctly specifies RHEL 9.4+ for AAP 2.6: - README.md: Update platform prerequisites from "RHEL 8+" to "RHEL 9.4+" - scripts-guide.md: Update RHEL scripts requirements to "RHEL 9.4+ with AAP 2.6" - install-rhel-manual.md: Update PostgreSQL prerequisites to "RHEL 9+" with note about AAP 2.6 requiring 9.4+ AAP 2.6 requires RHEL 9.4+ per Red Hat documentation. This change aligns all documentation with the correct platform requirements. Co-Authored-By: Claude Sonnet 4.5 --- README.md | 2 +- docs/install-rhel-manual.md | 2 +- docs/scripts-guide.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ae71ca9..1416167 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ datacenters. Before getting started, ensure you have: -- **Platform**: OpenShift 4.12+ OR RHEL 8+ with root access +- **Platform**: OpenShift 4.12+ OR RHEL 9.4+ with root access - **Database**: EnterpriseDB subscription for EDB Postgres Advanced Server - **Storage**: S3-compatible storage for WAL archiving and backups - **Network**: Network connectivity between datacenters (for replication) diff --git a/docs/install-rhel-manual.md b/docs/install-rhel-manual.md index 1edfb3e..6ea9a42 100644 --- a/docs/install-rhel-manual.md +++ b/docs/install-rhel-manual.md @@ -6,7 +6,7 @@ This guide covers installing EDB PostgreSQL on RHEL manually (repository, packag ## Prerequisites -- **RHEL 8 or 9** system with root or sudo access +- **RHEL 9.4+** system with root or sudo access (required for AAP 2.6) - **EDB Repository Access**: Valid EDB subscription credentials - **Network Access**: Connection to EDB repositories - **Minimum Resources**: diff --git a/docs/scripts-guide.md b/docs/scripts-guide.md index 1b2ec2e..2a1ba46 100644 --- a/docs/scripts-guide.md +++ b/docs/scripts-guide.md @@ -163,7 +163,7 @@ sudo journalctl -u aap-cluster.service -f ### RHEL Scripts -- RHEL 8 or 9 with AAP installed +- RHEL 9.4+ with AAP 2.6 installed - Root or sudo access - AAP installed via standard installer - Systemd services properly configured