Skip to content

docs: Add CLAUDE.md and AAP OpenShift DR architecture documentation#38

Merged
chadmf merged 2 commits into
mainfrom
update-diagram
Apr 6, 2026
Merged

docs: Add CLAUDE.md and AAP OpenShift DR architecture documentation#38
chadmf merged 2 commits into
mainfrom
update-diagram

Conversation

@chadmf

@chadmf chadmf commented Apr 6, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Add comprehensive CLAUDE.md file to guide future Claude Code instances working in this repository
  • Add AAP OpenShift DR architecture documentation (docs/aap-openshift-dr-architecture.md)
  • Update HAProxy configuration details in containerized enterprise DR architecture

Changes Made

CLAUDE.md

  • Project overview and architecture context
  • Repository structure guide
  • Development commands (pre-commit, testing, DR testing, cluster management)
  • Code standards and conventions (shell scripts, YAML, documentation)
  • Platform-specific context (OpenShift AAP 2.6 operator, CloudNativePG, RHEL/TPA)
  • Ansible best practices (redhat-cop conventions)
  • DR testing workflow and common tasks
  • Quick reference links to key documentation

docs/aap-openshift-dr-architecture.md

  • AAP 2.6 OpenShift deployment architecture documentation
  • External PostgreSQL configuration patterns
  • Component overview and deployment topology
  • Multi-datacenter DR capabilities

docs/aap-containerized-enterprise-dr-architecture.md

  • Updated HAProxy configuration details for accuracy

Test Plan

  • Pre-commit hooks passed
  • CLAUDE.md validated for completeness and accuracy
  • Documentation cross-references verified
  • Markdown syntax validated

🤖 Generated with Claude Code

chadmf and others added 2 commits April 6, 2026 17:05
…HAProxy configuration changes

Revises the HAProxy load balancer setup in the AAP containerized enterprise disaster recovery architecture documentation. The changes include:
- Streamlined HAProxy configuration for both active and standby datacenters.
- Updated network topology to enhance clarity on the AAP component layer and its interaction with HAProxy.
- Improved visual representation of the architecture to better illustrate the load balancing and database routing.

These updates ensure the documentation aligns with the latest architectural decisions and best practices for AAP deployments.
Added comprehensive CLAUDE.md to provide guidance for future Claude Code
instances working in this repository, including architecture context,
development commands, code standards, and common tasks.

Added docs/aap-openshift-dr-architecture.md documenting the AAP 2.6
OpenShift deployment architecture with external PostgreSQL.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@chadmf chadmf merged commit 47adc6e into main Apr 6, 2026
8 checks passed
chadmf added a commit that referenced this pull request Apr 9, 2026
Added entries for:
- PR #39: Documentation cleanup and standardization (16 files, 100+ terminology fixes)
- PR #38: CLAUDE.md and AAP OpenShift DR architecture documentation

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@chadmf chadmf deleted the update-diagram branch April 9, 2026 12:40
chadmf added a commit that referenced this pull request Apr 17, 2026
* docs: Standardize terminology and add code block language tags

Phase 2 & 3 of documentation cleanup plan - improved consistency,
readability, and syntax highlighting across 16 documentation files.

**Phase 2 - Terminology Standardization:**
- Replaced 100+ instances of "Postgres" with "PostgreSQL" for brand consistency
- Preserved "Trusted Postgres Architect" (official product name)
- Preserved lowercase "postgres" in technical contexts (users, namespaces, commands)
- Standardized "datacenter" (one word) throughout
- Ensured consistent DC1/DC2 capitalization
- Expanded first AAP mentions to "Ansible Automation Platform (AAP)"

**Phase 3 - Code Block Language Tags:**
- Added language tags to 40+ code blocks for proper syntax highlighting
- Tagged shell commands with ```bash
- Tagged output examples with ```text
- Tagged configuration files with ```ini, ```properties
- Tagged diagrams with ```text

**Files modified (16):**
- User-facing: quick-start-guide.md, troubleshooting.md
- Operational: dr-testing-guide.md, scripts-guide.md, manual-scripts-doc.md
- Deployment: install-kubernetes-manual.md, install-tpa.md, install-rhel-manual.md
- Architecture: architecture.md, aap-openshift-dr-architecture.md
- Reference: aap-components-reference.md, aap-containerized-*.md
- Validation: dr-replication-validation-report.md, split-brain-prevention.md
- Testing: openshift-edb-operator-smoke-test.md, haproxy-pgbouncer-*.md

**Quality improvements:**
- Removed emoji/checkmarks from tables for better accessibility
- Improved professional presentation
- Enhanced searchability with consistent terminology
- Better syntax highlighting for code examples

**Excluded (as requested):**
- docs/aap-containerized-enterprise-dr-architecture.md (not modified)

Standards compliance: CONTRIBUTING.md, CLAUDE.md

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

* docs: Update CHANGELOG.md with recent documentation improvements

Added entries for:
- PR #39: Documentation cleanup and standardization (16 files, 100+ terminology fixes)
- PR #38: CLAUDE.md and AAP OpenShift DR architecture documentation

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

* docs: Complete cleanup batches 5 & 6 - validation, architecture, and reference docs

Extended Phase 2 & 3 cleanup to 15 additional documentation files,
completing the comprehensive documentation standardization initiative.

**Batch 5 - Validation Reports & Architecture (6 files):**
- aap-architecture-validation-report.md
- aap-deployment-validation-crc.md
- dr-architecture-validation-report.md
- openshift-aap-architecture.md
- rhel-aap-architecture.md
- component-testing-results.md

**Batch 6 - Implementation, Reference & Navigation (9 files):**
- dr-replication-implementation-status.md
- dr-scenarios.md
- dr-testing-implementation-summary.md
- enterprisefailovermanager.md
- scripts-hooks-and-cicd.md
- scripts-library-reference.md
- cicd-pipeline.md
- documentation-audit-report.md
- INDEX.md (central documentation navigation hub)

**Phase 2 - Terminology Standardization:**
- Additional PostgreSQL terminology fixes across validation reports
- Standardized datacenter/DC1/DC2 references
- Consistent AAP expansion in reference documentation

**Phase 3 - Code Block Language Tags:**
- Added text tags to test outputs and validation results
- Tagged configuration examples with ini/properties
- Improved syntax highlighting for all code examples

**INDEX.md Special Improvements:**
- Removed excessive bold formatting for better readability
- Standardized terminology throughout navigation
- Enhanced cross-reference formatting
- Improved table readability and scannability

**Cumulative Progress:**
- 31 of 33 documentation files cleaned (94%)
- 200+ terminology standardizations
- 80+ code blocks properly tagged
- 1 file excluded as requested

Standards compliance: CONTRIBUTING.md, CLAUDE.md

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

* feat: Add Copilot skills for AAP 2.6 and Ansible best practices

- Create .copilot/skills/aap-openshift-2-6 with SKILL.md and reference.md
- Create .copilot/skills/ansible-redhat-cop-practices with SKILL.md and reference.md
- Mirror Cursor skills structure for Copilot CLI compatibility

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant