PCSM-235 Documented how to run PCSM in #18
Conversation
Docker
modified: docs/install/authentication.md
new file: docs/install/docker.md
modified: docs/install/usage.md
modified: docs/installation.md
modified: docs/system-requirements.md
modified: mkdocs-base.yml
nastena1606
force-pushed
the
PCSM-235-Doc-Docker
branch
from
70e825c to
2735767
Compare
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for running PCSM (Percona ClusterSync for MongoDB) in Docker containers. The changes provide a complete guide for users who want to containerize PCSM or use it with MongoDB clusters running in Docker.
- Added a new Docker installation guide with step-by-step instructions
- Updated documentation structure to include Docker as an installation option
- Enhanced system requirements with Docker-specific considerations
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs-base.yml | Added Docker installation guide to the documentation navigation menu |
| docs/system-requirements.md | Added Docker-specific resource and connectivity requirements |
| docs/installation.md | Added Docker as a new installation option alongside repositories and source builds |
| docs/install/usage.md | Fixed heading formatting (added missing # symbol) |
| docs/install/docker.md | New comprehensive guide covering Docker deployment, setup, and usage examples |
| docs/install/authentication.md | Changed code block language identifier from generic to text for better syntax highlighting |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| * Ensure the Docker container has sufficient resources allocated (at least 1GB RAM and 2 CPU cores) | ||
| * The container must have network connectivity to all MongoDB cluster nodes (source and target) | ||
| * If MongoDB clusters also run in Docker, use Docker networks or host networking to ensure connectivity | ||
| * See the [Run {{pcsm.short}} in Docker](install/docker.md) guide for steps |
There was a problem hiding this comment.
Inconsistent use of product name abbreviations. The link text uses {{pcsm.short}} while other references in the same section use {{plm.short}}. Verify which abbreviation should be used consistently throughout this section.
| * See the [Run {{pcsm.short}} in Docker](install/docker.md) guide for steps | |
| * See the [Run {{plm.short}} in Docker](install/docker.md) guide for steps |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| docker run -d \ | ||
| --name psmdb-source \ | ||
| --net mymongo \ | ||
| -p 27017:27017 \ | ||
| percona/percona-server-mongodb:8.0 \ | ||
| mongod --replSet rs1 --bind_ip_all |
There was a problem hiding this comment.
The --bind_ip_all flag exposes MongoDB to all network interfaces without authentication initially configured. This creates a security window where the database is accessible without credentials. Consider adding --auth flag or documenting that users should be created immediately after initialization.
| docker run -d \ | ||
| --name psmdb-target \ | ||
| --net mymongo \ | ||
| -p 27018:27017 \ | ||
| percona/percona-server-mongodb:8.0 \ | ||
| mongod --replSet rs2 --bind_ip_all |
There was a problem hiding this comment.
The --bind_ip_all flag exposes MongoDB to all network interfaces without authentication initially configured. This creates a security window where the database is accessible without credentials. Consider adding --auth flag or documenting that users should be created immediately after initialization.
nastena1606
requested review from
chupe,
inelpandzic,
radoslawszulgo and
sandraromanchenko
Docker
modified: docs/install/authentication.md
new file: docs/install/docker.md
modified: docs/install/usage.md
modified: docs/installation.md
modified: docs/system-requirements.md
modified: mkdocs-base.yml