Skip to content

Adding ACE to PEP documentation#81

Merged
susan-pgedge merged 4 commits into
mainfrom
ACE_PEP_Installation
May 12, 2026
Merged

Adding ACE to PEP documentation#81
susan-pgedge merged 4 commits into
mainfrom
ACE_PEP_Installation

Conversation

@susan-pgedge
Copy link
Copy Markdown
Member

@susan-pgedge susan-pgedge commented May 7, 2026

Summary by CodeRabbit

Release Notes

  • Documentation
    • Added ACE (Active Consistency Engine) installation and configuration guides for Debian/Ubuntu and RHEL/CentOS/Rocky Linux platforms. Documentation covers package installation, initialization, configuration file setup, systemd service management, verification procedures, logging inspection, and comprehensive troubleshooting sections for common issues including missing dependencies and replication streaming scenarios.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 7, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 9cf012fa-abb6-4325-9b6a-2a22b96bd40d

📥 Commits

Reviewing files that changed from the base of the PR and between 6b3f87c and 53489db.

📒 Files selected for processing (5)
  • docs/enterprise/debian/components/ace.md
  • docs/enterprise/debian/components/components.md
  • docs/enterprise/el/components/ace.md
  • docs/enterprise/el/components/components.md
  • mkdocs.yml

Walkthrough

This PR adds comprehensive operational documentation for ACE (Active Consistency Engine) covering installation, initialization, configuration, service management, verification, and troubleshooting across two Linux distributions: Debian/Ubuntu and RHEL/CentOS/Rocky. It updates component indexes and site navigation to expose the new documentation.

Changes

ACE Documentation for Debian and Enterprise Linux

Layer / File(s) Summary
Debian ACE installation and initialization
docs/enterprise/debian/components/ace.md (lines 1–51)
Introduces ACE with supported Debian/Ubuntu targets, pgedge-ace package installation, and files created by the package. Includes initialization commands (ace cluster init, ace config init) to generate pg_service.conf and ace.yaml.
Debian ACE configuration and service operations
docs/enterprise/debian/components/ace.md (lines 52–126)
Explains pg_service.conf cluster/node configuration structure and ace.yaml runtime settings with examples. Documents how to enable, start, check status, and tail logs of the pgedge-ace systemd service.
Debian ACE verification, troubleshooting, and resources
docs/enterprise/debian/components/ace.md (lines 127–200)
Provides ace table-diff verification, troubleshooting for common failures (missing ace.yaml, missing pgcrypto, commit timestamp retrieval, subscription streaming conflicts), and links to ACE GitHub, docs, and release notes.
RHEL/CentOS/Rocky ACE installation and initialization
docs/enterprise/el/components/ace.md (lines 1–49)
Introduces ACE with supported RHEL/CentOS/Rocky 9/10 targets, dnf install pgedge-ace command, and files created by the package. Includes initialization commands and generated file descriptions.
RHEL/CentOS/Rocky ACE configuration and service operations
docs/enterprise/el/components/ace.md (lines 50–124)
Explains pg_service.conf cluster/node configuration structure and ace.yaml runtime settings with examples. Documents how to enable, start, check status, and tail logs of the pgedge-ace systemd service.
RHEL/CentOS/Rocky ACE verification, troubleshooting, and resources
docs/enterprise/el/components/ace.md (lines 125–197)
Provides ace table-diff verification, troubleshooting for common failures (missing ace.yaml, missing pgcrypto, commit timestamp retrieval, subscription streaming conflicts with SQL remediation), and links to ACE GitHub, docs, and release notes.
Component index and navigation integration
docs/enterprise/debian/components/components.md, docs/enterprise/el/components/components.md, mkdocs.yml
Adds ACE component entries to both Debian and Enterprise Linux component tables, and registers "Configuring ACE" navigation links in mkdocs for both distribution sections.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • pgEdge/pgedge-docs#70: Both PRs modify the enterprise "components" documentation (components.md and mkdocs.yml) to add or reorganize component entries.
  • pgEdge/pgedge-docs#74: Both PRs modify the mkdocs navigation for the ACE documentation to expand or add ACE-related site entries.
  • pgEdge/pgedge-docs#36: Both PRs modify the site navigation and components docs by adding new menu entries and component-package guidance.

Suggested reviewers

  • dpage
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch ACE_PEP_Installation

Comment @coderabbitai help to get the list of available commands and usage tips.

@codacy-production
Copy link
Copy Markdown

codacy-production Bot commented May 7, 2026

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented May 7, 2026

Deploying pgedge-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 5186422
Status: ✅  Deploy successful!
Preview URL: https://7ce2d848.pgedge-docs.pages.dev
Branch Preview URL: https://ace-pep-installation.pgedge-docs.pages.dev

View logs

Susan Douglas and others added 3 commits May 7, 2026 12:14
Removed redundant installation details for ACE on Debian.
Removed outdated installation instructions for ACE on RHEL-based platforms.
@susan-pgedge susan-pgedge marked this pull request as ready for review May 12, 2026 11:55
@susan-pgedge susan-pgedge merged commit 057d8e3 into main May 12, 2026
3 of 4 checks passed
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