Skip to content

Commit 5307f70

Browse files
committed
Removed prompt sign from code blocks
1 parent 4da2516 commit 5307f70

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+475
-477
lines changed

.github/styles/config/vocabularies/Percona/accept.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,5 @@ MinIO
2323
[Rr]esync
2424
(?i)HMAC
2525
retryer
26+
Alibaba
27+
Alibaba Cloud

docs/details/authentication.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@ etc. as the `mongo` shell or `mongodump` command does.
1717

1818
The `pbm-agent` processes should connect to their localhost `mongod` with a standalone type of connection.
1919

20-
```{.bash data-prompt="$"}
20+
```bash
2121
pbm-agent --mongodb-uri "mongodb://pbmuser:secretpwd@localhost:27017/?authSource=admin"
2222
```
2323

2424
Alternatively:
2525

26-
```{.bash data-prompt="$"}
26+
```bash
2727
export PBM_MONGODB_URI="mongodb://pbmuser:secretpwd@localhost:27017/?authSource=admin"
2828
pbm-agent
2929
```
@@ -32,15 +32,15 @@ etc. as the `mongo` shell or `mongodump` command does.
3232

3333
=== "The `pbm` CLI connection string"
3434

35-
```{.bash data-prompt="$"}
35+
```bash
3636
pbm status --mongodb-uri "mongodb://pbmuser:secretpwd@mongocsvr1:27017,mongocsvr2:27017,mongocsvr3:27017/?replicaSet=configrs&authSource=admin"
3737
```
3838

3939
Alternatively:
4040

41-
```{.bash data-prompt="$"}
41+
```bash
4242
export PBM_MONGODB_URI="mongodb://pbmuser:secretpwd@mongocsvr1:27017,mongocsvr2:27017,mongocsvr3:27017/?replicaSet=configrs&authSource=admin"
43-
$ pbm status
43+
pbm status
4444
```
4545
4646
Replace the `pbmuser:secretpwd` with the credentials of [the user who owns the pbm process](../install/configure-authentication.md#create-the-pbm-user)
@@ -86,28 +86,28 @@ Specify new values in MongoDB connection URI string as follows:
8686

8787
=== "The pbm-agent connection string"
8888

89-
```
89+
```bash
9090
pbm-agent --mongodb-uri "mongodb://pbmuser:secretpwd@localhost:27017/?authSource=admin&readConcernLevel=local&w=1"
9191
```
9292

9393
Alternatively:
9494

95-
```
95+
```bash
9696
export PBM_MONGODB_URI="mongodb://pbmuser:secretpwd@localhost:27017/?authSource=admin&readConcernLevel=local&w=1"
9797
pbm-agent
9898
```
9999

100100
=== "The `pbm` CLI connection string"
101101

102-
```{.bash data-prompt="$"}
102+
```bash
103103
pbm status --mongodb-uri "mongodb://pbmuser:secretpwd@mongocsvr1:27017,mongocsvr2:27017,mongocsvr3:27017/?replicaSet=configrs&authSource=admin&readConcernLevel=local&w=1"
104104
```
105105

106106
Alternatively:
107107

108-
```{.bash data-prompt="$"}
108+
```bash
109109
export PBM_MONGODB_URI="mongodb://pbmuser:secretpwd@mongocsvr1:27017,mongocsvr2:27017,mongocsvr3:27017/?replicaSet=configrs&authSource=admin&readConcernLevel=local&w=1"
110-
$ pbm status
110+
pbm status
111111
```
112112

113113
Supported values are:
@@ -131,14 +131,14 @@ For [Kerberos authentication :octicons-link-external-16:](https://docs.percona.c
131131

132132
Specify the following string for MongoDB connection URI:
133133

134-
```
134+
```bash
135135
PBM_MONGODB_URI="mongodb://<username>%40<KERBEROS_REALM>@<hostname>:27018/?authMechanism=GSSAPI&authSource=%24external&replSetName=xxxx"
136136
```
137137

138138
Note that you must first obtain the ticket for the `pbm` user with the `kinit` command before you start the **pbm-agent**:
139139

140-
```{.bash data-prompt="$"}
141-
$ sudo -u {USER} kinit pbm
140+
```bash
141+
sudo -u {USER} kinit pbm
142142
```
143143

144144
Note that the `{USER}` is the user that you will run the `pbm-agent` process.
@@ -147,7 +147,7 @@ Note that the `{USER}` is the user that you will run the `pbm-agent` process.
147147

148148
For [authentication and authorization via Native LDAP :octicons-link-external-16:](https://docs.percona.com/percona-server-for-mongodb/latest/authorization.html#authentication-and-authorization-with-direct-binding-to-ldap), you only create roles for LDAP groups in MongoDB as the users are stored and managed on the LDAP server. However, you still define the `$external` database as your authentication source:
149149

150-
```
150+
```bash
151151
PBM_MONGODB_URI="mongodb://<user>:<password>@<hostname>:27017/?authMechanism=PLAIN&authSource=%24external&replSetName=xxxx"
152152
```
153153

@@ -170,7 +170,7 @@ When using [AWS IAM authentication :octicons-link-external-16:](https://docs.per
170170

171171
The MongoDB connection URI string then looks like the following:
172172

173-
```
173+
```bash
174174
PBM_MONGODB_URI="mongodb://<aws_access_key_id>:<aws_secret_access_key>@<hostname>:27017/?authMechanism=MONGODB-AWS&authSource=%24external&replSetName=xxxx"
175175
```
176176

docs/details/azure.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,32 +26,32 @@ For either method you need a storage account.
2626
1. Install the [Azure CLI :octicons-link-external-16:](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli). After the installation, the `az` is available for you.
2727
2. Sign in to Azure CLI:
2828

29-
```{.bash data-prompt="$"}
30-
$ az login
29+
```bash
30+
az login
3131
```
3232

3333
3. Create a Resource group if it's not created for you:
3434

35-
```{.bash data-prompt="$"}
36-
$ az group create --name <your-resource-group> --location <your-location>
35+
```bash
36+
az group create --name <your-resource-group> --location <your-location>
3737
```
3838

3939
For the list of available locations, run:
4040

41-
```{.bash data-prompt="$"}
42-
$ az account list-locations
41+
```bash
42+
az account list-locations
4343
```
4444

4545
4. Create a storage account:
4646

47-
```{.bash data-prompt="$"}
48-
$ az storage account create --name <storage-account-name> --resource-group <your-resource-group> --location <your-location> --sku Standard_LRS
47+
```bash
48+
az storage account create --name <storage-account-name> --resource-group <your-resource-group> --location <your-location> --sku Standard_LRS
4949
```
5050

5151
4. Create a blob container:
5252

53-
```{.bash data-prompt="$"}
54-
$ az storage container create --account-name <storage-account-name> --name <your-container> --public-access off
53+
```bash
54+
az storage container create --account-name <storage-account-name> --name <your-container> --public-access off
5555
```
5656

5757
??? example "Expected output"

docs/details/gcs.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,14 @@ To use GCS, you need the following:
3232

3333
2. Create a bucket
3434

35-
```{.bash data-prompt="$"}
36-
$ gcloud storage buckets create my-gcs-bucket --location=US
35+
```bash
36+
gcloud storage buckets create my-gcs-bucket --location=US
3737
```
3838

3939
3. Verify the bucket creation
4040

41-
```{.bash data-prompt="$"}
42-
$ gcloud storage buckets list
41+
```bash
42+
gcloud storage buckets list
4343
```
4444

4545
After the bucket is created, apply the proper [permissions for PBM to use the bucket](storage-configuration.md#permissions-setup).

docs/details/s3-storage.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,14 @@ Here are some examples of the steps required to create a bucket.
1717

1818
2. Create an S3 bucket
1919

20-
```{.bash data-prompt="$"}
21-
$ aws s3api create-bucket --bucket my-s3-bucket --region us-east-1
20+
```bash
21+
aws s3api create-bucket --bucket my-s3-bucket --region us-east-1
2222
```
2323
2424
3. Verify the bucket creation
2525

26-
```{.bash data-prompt="$"}
27-
$ aws s3 ls
26+
```bash
27+
aws s3 ls
2828
```
2929
3030
=== ":simple-minio: MinIo"
@@ -33,20 +33,20 @@ Here are some examples of the steps required to create a bucket.
3333

3434
2. Configure the `mc` command line tool with a MinIO Server
3535

36-
```{.bash data-prompt="$"}
37-
$ mc alias set myminio http://127.0.0.1:9000 MINIO_ACCESS_KEY MINIO_SECRET_KEY
36+
```bash
37+
mc alias set myminio http://127.0.0.1:9000 MINIO_ACCESS_KEY MINIO_SECRET_KEY
3838
```
3939

4040
3. Create a bucket
4141

42-
```{.bash data-prompt="$"}
43-
$ mc mb myminio/my-minio-bucket
42+
```bash
43+
mc mb myminio/my-minio-bucket
4444
```
4545
4646
4. Verify the bucket creation
4747

48-
```{.bash data-prompt="$"}
49-
$ mc ls myminio
48+
```bash
49+
mc ls myminio
5050
```
5151

5252
After the bucket is created, apply the proper [permissions for PBM to use the bucket](storage-configuration.md#permissions-setup).
@@ -244,25 +244,25 @@ Let's assume that your custom CA certificate is at `/etc/ssl/minio-ca.crt` path
244244

245245
2. Set the `SSL_CERT_FILE` environment variable to that file's path on each host where `pbm-agent` and PBM CLI are running:
246246

247-
```{.bash data-prompt="$"}
248-
$ export SSL_CERT_FILE=/etc/ssl/minio-ca.crt
247+
```bash
248+
export SSL_CERT_FILE=/etc/ssl/minio-ca.crt
249249
```
250250

251251
If this variable isn't set, PBM uses the system root certificates.
252252

253253
3. Restart `pbm-agent`:
254254

255-
```{.bash data-prompt="$"}
256-
$ sudo systemctl start pbm-agent
255+
```bash
256+
sudo systemctl start pbm-agent
257257
```
258258

259259
4. Verify that your custom certificate is recognized. Check PBM logs for successful S3 access.
260260

261261

262262
Alternatively, you can disable the TLS verification of the S3 storage in Percona Backup for MongoDB configuration:
263263

264-
```{.bash data-prompt="$"}
265-
$ pbm config --set storage.s3.insecureSkipTLSVerify=True
264+
```bash
265+
pbm config --set storage.s3.insecureSkipTLSVerify=True
266266
```
267267

268268
!!! warning

docs/features/multi-storage.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,14 @@ storage:
3838

3939
To upload the configuration profile to PBM, use the [`pbm profile add`](../reference/pbm-commands.md#pbm-profile-add) command and specify the path to the profile.
4040

41-
```{.bash data-prompt="$"}
42-
$ pbm profile add <profile_name> /path/to/profile.yaml
41+
```bash
42+
pbm profile add <profile_name> /path/to/profile.yaml
4343
```
4444

4545
To show the information about the external backup storage, use the [`pbm profile show`](../reference/pbm-commands.md#pbm-profile-show) command:
4646

47-
```{.bash data-prompt="$"}
48-
$ pbm profile show <profile_name>
47+
```bash
48+
pbm profile show <profile_name>
4949
```
5050

5151
See the full list of the configuration profile management commands in the [pbm commands](../reference/pbm-commands.md) reference.
@@ -54,8 +54,8 @@ See the full list of the configuration profile management commands in the [pbm c
5454

5555
To make a backup to an external backup storage, pass the profile name with the `--profile` flag for the `pbm backup` command. For example, to run a physical backup and store it in the MinIO storage defined via the `minio` configuration profile, run the following command:
5656

57-
```{.bash data-prompt="$"}
58-
$ pbm backup -t physical --profile=minio --wait
57+
```bash
58+
pbm backup -t physical --profile=minio --wait
5959
```
6060

6161
??? example "Sample output"
@@ -76,8 +76,8 @@ Before you start, make sure that `pbm-agents` have the read permissions to backu
7676

7777
1. List backups by running the `pbm list` or `pbm status` commands.
7878

79-
```{.bash data-prompt="$"}
80-
$ pbm list
79+
```bash
80+
pbm list
8181
```
8282

8383
The output shows the backup names and timestamps. External backups are marked with an asterisk:
@@ -96,8 +96,8 @@ Before you start, make sure that `pbm-agents` have the read permissions to backu
9696

9797
2. To make a point-in-time restore, you must explicitly pass the backup name for the `pbm restore` command:
9898

99-
```{.bash data-prompt="$"}
100-
$ pbm-restore --time=<timestamp> --base-snapshot <backup-name>
99+
```bash
100+
pbm-restore --time=<timestamp> --base-snapshot <backup-name>
101101
```
102102

103103
3. After the restore is complete, do the required post-restore steps depending on the restore type.
@@ -109,8 +109,8 @@ You can delete backups from an external storage only by name.
109109

110110
Run the `pbm delete` command and pass the backup name:
111111

112-
```{.bash data-prompt="$"}
113-
$ pbm delete-backup 2024-06-25T10:54:55Z
112+
```bash
113+
pbm delete-backup 2024-06-25T10:54:55Z
114114
```
115115

116116
## Implementation specifics

docs/features/physical.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -156,8 +156,8 @@ To configure physical restores with a fallback directory, use either the PBM con
156156

157157
You can start the restore with a fallback directory directly using the `--fallback-enabled` flag:
158158

159-
```{.bash data-prompt="$"}
160-
$ pbm restore --time <time> --fallback-enabled=true
159+
```bash
160+
pbm restore --time <time> --fallback-enabled=true
161161
```
162162

163163

@@ -172,8 +172,8 @@ A restore can succeed on most nodes, but it might fail on a few, resulting in a
172172

173173
=== ":material-console: Command line"
174174

175-
```{.bash data-prompt="$"}
176-
$ pbm restore --time <time> --fallback-enabled=true --allow-partly-done=true
175+
```bash
176+
pbm restore --time <time> --fallback-enabled=true --allow-partly-done=true
177177
```
178178
179179
If you allow partial restores (default value), PBM finalizes the restore. Once the cluster is up and running, the failed node receives the necessary data from other members through an initial sync.

docs/features/point-in-time-recovery.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ Set the `pitr.enabled` configuration option to `true`.
2727

2828
=== ":octicons-file-code-24: Command line"
2929

30-
```{.bash data-prompt="$"}
31-
$ pbm config --set pitr.enabled=true
30+
```bash
31+
pbm config --set pitr.enabled=true
3232
```
3333

3434
=== ":material-console: Configuration file"
@@ -87,8 +87,8 @@ You can change the duration of an oplog span via the configuration file. Specify
8787

8888
=== ":octicons-file-code-24: Command line"
8989

90-
```{.bash data-prompt="$"}
91-
$ pbm config --set pitr.oplogSpanMin=5
90+
```bash
91+
pbm config --set pitr.oplogSpanMin=5
9292
```
9393

9494
=== ":material-console: Configuration file"
@@ -157,8 +157,8 @@ The remaining secondaries and the primary nodes in the cluster receive priority
157157

158158
To check the priorities, run the `pbm status` command with the `--priority` flag.
159159

160-
```{.bash data-prompt="$"}
161-
$ pbm status --priority
160+
```bash
161+
pbm status --priority
162162
```
163163

164164
??? example "Sample output"
@@ -183,8 +183,8 @@ The oplog slices are saved with the `s2` compression method by default. You can
183183

184184
=== ":octicons-file-code-24: Command line"
185185

186-
```{.bash data-prompt="$"}
187-
$ pbm config --set pitr.compression=gzip
186+
```bash
187+
pbm config --set pitr.compression=gzip
188188
```
189189

190190
=== ":material-console: Configuration file"
@@ -214,8 +214,8 @@ The [`pbm list`](../reference/pbm-commands.md#pbm-list) output includes the foll
214214
* Valid time ranges for recovery
215215
* Point-in-time recovery status
216216

217-
```{.bash data-prompt="$"}
218-
$ pbm list
217+
```bash
218+
pbm list
219219
220220
2021-08-04T13:00:58Z [restore_to_time: 2021-08-04T13:01:23Z]
221221
2021-08-05T13:00:47Z [restore_to_time: 2021-08-05T13:01:11Z]

0 commit comments

Comments
 (0)