Skip to content

Commit

Permalink
Improved wording
Browse files Browse the repository at this point in the history
  • Loading branch information
nastena1606 committed Nov 25, 2024
1 parent 6f20170 commit 9a81cbf
Showing 1 changed file with 12 additions and 14 deletions.
26 changes: 12 additions & 14 deletions docs/install/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,29 @@ Docker images of Percona Backup for MongoDB are hosted publicly on [Docker Hub :

For more information about using Docker, see the [Docker Docs :octicons-link-external-16:](https://docs.docker.com/).

!!! note
Make sure that you are using the latest version of Docker. The ones provided via apt and yum may be outdated and cause errors.

Check notice on line 7 in docs/install/docker.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/install/docker.md#L7

[Google.Passive] In general, use active voice instead of passive voice ('be outdated').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('be outdated').", "location": {"path": "docs/install/docker.md", "range": {"start": {"line": 7, "column": 98}}}, "severity": "INFO"}

Make sure that you are using the latest version of Docker. The ones provided via apt and yum may be outdated and cause errors.

By default, Docker will pull the image from Docker Hub if it is not available locally.
By default, Docker will pull the image from Docker Hub if it is not available locally.

Check warning on line 9 in docs/install/docker.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/install/docker.md#L9

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/install/docker.md", "range": {"start": {"line": 9, "column": 20}}}, "severity": "WARNING"}

Check notice on line 9 in docs/install/docker.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/install/docker.md#L9

[Google.Contractions] Use 'it's' instead of 'it is'.
Raw output
{"message": "[Google.Contractions] Use 'it's' instead of 'it is'.", "location": {"path": "docs/install/docker.md", "range": {"start": {"line": 9, "column": 59}}}, "severity": "INFO"}

## Prerequisites

* You need to deploy MongoDB or Percona Server for MongoDB. See [what MongoDB deployments are supported](../details/deployments.md).
* [Create the pbm user](initial-setup.md#create-the-pbm-user) in your deployment. You will need this user credentials to start Percona Backup for MongoDB container.

Check warning on line 14 in docs/install/docker.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/install/docker.md#L14

[Google.Will] Avoid using 'will'.
Raw output
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/install/docker.md", "range": {"start": {"line": 14, "column": 87}}}, "severity": "WARNING"}
* For physical backups, make sure to use a container that includes both the mongod binary as well as the PBM files. Here is an example Dockerfile:
* For physical backups, make sure to use a container that includes both the `mongod` binary as well as the PBM files. Here is an example Dockerfile:

Check failure on line 15 in docs/install/docker.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/install/docker.md#L15

[Vale.Spelling] Did you really mean 'Dockerfile'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Dockerfile'?", "location": {"path": "docs/install/docker.md", "range": {"start": {"line": 15, "column": 138}}}, "severity": "ERROR"}

```{.bash data-prompt="$"}
FROM percona/percona-server-mongodb:latest AS mdb
FROM percona/percona-backup-mongodb:latest AS pbm
```{.bash data-prompt="$"}
FROM percona/percona-server-mongodb:latest AS mdb
FROM percona/percona-backup-mongodb:latest AS pbm

FROM oraclelinux:8
FROM oraclelinux:8

RUN mkdir -p /data/db /data/configdb
RUN mkdir -p /data/db /data/configdb

COPY --from=mdb /usr/bin/mongod /usr/bin/
COPY --from=pbm /usr/bin/pbm* /usr/bin/
```
COPY --from=mdb /usr/bin/mongod /usr/bin/
COPY --from=pbm /usr/bin/pbm* /usr/bin/
```

* If using a dedicated container for PBM, it should also have read-write access to MongoDB data volume and run under the same user id as the MongoDB container.
* If you are using a dedicated container for PBM, it should also have read-write access to MongoDB data volume and you should run it under the same user ID as the MongoDB container.

## Start Percona Backup for MongoDB

Expand Down

0 comments on commit 9a81cbf

Please sign in to comment.