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.

Sign up for GitHub

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

Jump to bottom

Update configure-authentication.md #229

Merged
merged 2 commits into from
Nov 25, 2024
Merged

Update configure-authentication.md #229

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8fee454
Update configure-authentication.md
igroene Nov 19, 2024
eec93b4
Improved rendering
nastena1606 Nov 25, 2024
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
31 changes: 21 additions & 10 deletions docs/install/configure-authentication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@

## Create the `pbm` user

<i info>:material-information: Info:</i> Execute this step on a primary node of each replica set. In a sharded cluster, this means on every shard replica set and the config server replica set.
{.power-number}
!!! info

Execute this step on a primary node of each replica set. In a sharded cluster, this means on every shard replica set and the config server replica set.

1. Create the role that allows any action on any resource.

Expand Down Expand Up @@ -54,18 +55,20 @@

## Set the MongoDB connection URI for `pbm-agent`

<i info>:material-information: Info:</i> Execute this step needs on each node where `pbm-agent` is installed.
!!! info

Execute this step on each node where `pbm-agent` is installed.

!!! important

A **pbm-agent** process connects to its localhost `mongod` node with a standalone type of connection.
Each **pbm-agent** process needs to connect to its localhost `mongod` node with a standalone type of connection. Avoid using the replica set URI with **pbm-agent** as it can lead to unexpected behaviour.

To set the MongoDB URI connection string means to configure a service init script (`pbm-agent.service` systemd unit file) that runs a **pbm-agent**.
Note that the MongoDB connection URI for `pbm-agent` is different from the connection string required by pbm CLI.

The `pbm-agent.service` systemd unit file includes the environment file. You set the MongoDB URI connection string for the `PBM_MONGODB_URI` variable within the environment file for every **pbm-agent**.
The `pbm-agent.service` systemd unit file includes the location of the environment file. You set the MongoDB URI connection string for the `PBM_MONGODB_URI` variable within the environment file for every **pbm-agent**.

Check failure on line 68 in docs/install/configure-authentication.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/install/configure-authentication.md#L68 

[Vale.Spelling] Did you really mean 'systemd'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'systemd'?", "location": {"path": "docs/install/configure-authentication.md", "range": {"start": {"line": 68, "column": 25}}}, "severity": "ERROR"}

??? tip "How to find the environment file"

The path to the environment file is specified in the `pbm-agent.service` systemd unit file.

In Ubuntu and Debian, the pbm-agent.service systemd unit file is at the path `/lib/systemd/system/pbm-agent.service`.

In Red Hat and CentOS, the path to this file is `/usr/lib/systemd/system/pbm-agent.service`.
Expand Down Expand Up @@ -119,7 +122,15 @@

## Set the MongoDB connection URI for `pbm CLI`

<i info>:material-information: Info:</i> Execute this step only on a host at which you will use `pbm` CLI.
!!! info

Execute this step only on a host at which you will use `pbm` CLI.

!!! important

The pbm CLI needs to connect to the replica set that stores PBM Control Collections. The MongoDB connection URI format is different from the one required by `pbm-agent`.

In a non-sharded replica set it is simply that replica set. In a sharded cluster it is the config server replica set.

Set the MongoDB URI connection string for `pbm` CLI in your shell. This allows you to call `pbm` commands without the `--mongodb-uri` flag.

Expand All @@ -136,4 +147,4 @@

## Next steps

[Configure backup storage :material-arrow-right:](backup-storage.md){.md-button}
[Configure backup storage :material-arrow-right:](backup-storage.md){.md-button}
Loading