Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added numbers to quickstart steps #169

Merged
merged 1 commit into from
Apr 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/install/repos.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ To install the software from Percona repositories means to subscribe to them. Pe

--8<-- "pbm-install-nodes.md"

## Before you start

Check the [system requirements](../system-requirements.md).

## Procedure

<i warning>:material-alert: Warning:</i> Run the following commands as root or via the `sudo` command.
Expand Down
14 changes: 0 additions & 14 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,6 @@ Percona Backup for MongoDB (PBM) is an open source and distributed solution for

Find the list of supported platforms for Percona Backup for MongoDB on the [Percona Software and Platform Lifecycle :octicons-link-external-16:](https://www.percona.com/services/policies/percona-software-platform-lifecycle#mongodb) page.

## System requirements

* At least 1GB RAM is required on every node for `pbm-agents` to operate successfully.
* All `pbm-agents` in the cluster must be able to connect to all config server replica set nodes that could become a new primary. In non-sharded replica set deployments, this means to connect to all the nodes that could become a new primary node. To become a primary, a node must meet the following criteria:

* have `priority` greater than `0` and must be able to vote (`votes`: 1)
* is not an arbiter (`arbiterOnly: false`)
* is not hidden (`hidden: false`)
* is not delayed

* All `pbm-agents` in your deployment must be able to connect to the same [remote backup storage](details/storage-configuration.md) using the same credentials.

Note that networking issues like connection to the remote backup storage can also affect PBM performance.

## Tutorials

You can use any of the easy-install guides but **we recommend using the package manager of your operating system** for a convenient and quick way to try the software first.
Expand Down
13 changes: 13 additions & 0 deletions docs/system-requirements.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# System requirements

* At least 1GB RAM is required on every node for `pbm-agents` to operate successfully.
* All `pbm-agents` in the cluster must be able to connect to all config server replica set nodes that could become a new primary. In non-sharded replica set deployments, this means to connect to all the nodes that could become a new primary node. To become a primary, a node must meet the following criteria:

* have `priority` greater than `0` and must be able to vote (`votes`: 1)
* is not an arbiter (`arbiterOnly: false`)
* is not hidden (`hidden: false`)
* is not delayed

* All `pbm-agents` in your deployment must be able to connect to the same [remote backup storage](details/storage-configuration.md) using the same credentials.

Note that networking issues like connection to the remote backup storage can also affect PBM performance.
7 changes: 3 additions & 4 deletions mkdocs-base.yml
Original file line number Diff line number Diff line change
Expand Up @@ -165,18 +165,18 @@ nav:
- Comparison with MongoDB: 'features/comparison.md'
- Get started:
- Quickstart guide: installation.md
- Install:
- 1. Install:
- System requirements: system-requirements.md
- From repositories: install/repos.md
- Download tarballs: install/tarball.md
- Build from source: install/source.md
- Run in Docker: install/docker.md
- Set up and configure:
- 2. Set up and configure:
- Overview: install/initial-setup.md
- install/configure-authentication.md
- install/backup-storage.md
- install/start-pbm-agent.md
- Backup and restore:
# - Via the command line:
- Make a backup : "usage/start-backup.md"
- Restore a backup: usage/restore.md
- Make a point-in-time restore: usage/pitr-tutorial.md
Expand All @@ -188,7 +188,6 @@ nav:
- usage/restore-progress.md
- usage/oplog-replay.md
- usage/logs.md
# - Via web interface:
- Backup management via PMM: pmm.md
- Administer PBM:
- 'Overview': manage/overview.md
Expand Down
Loading