|
3 | 3 | ## This file is a full configuration example documenting all
|
4 | 4 | ## options in comments.
|
5 | 5 | ##
|
6 |
| -## You can find the full configuration reference here: |
7 |
| -## https://docs.percona.com/percona-backup-mongodb/configuration-options.html |
| 6 | +## You can find the full reference for configuration options here: |
| 7 | +## https://docs.percona.com/percona-backup-mongodb/reference/configuration-options.html |
8 | 8 |
|
9 | 9 | #======================Storage Configuration============================
|
10 | 10 |
|
|
25 | 25 | ## When undefined, backups are saved at the root of the bucket.
|
26 | 26 | # prefix:
|
27 | 27 |
|
28 |
| -## The URL to access the bucket for GCS and MinIO |
| 28 | +## The URL to access the bucket for MinIO |
29 | 29 | # endpointURL:
|
30 | 30 |
|
31 | 31 | ## S3 access credentials.
|
|
48 | 48 | ## Use it with caution as it might leave a hole for man-in-the-middle attacks.
|
49 | 49 | # insecureSkipTLSVerify:
|
50 | 50 |
|
51 |
| -## Debug level logging configuration for S3 requests. |
| 51 | +## Debug level logging configuration for S3 requests. |
52 | 52 | # debugLogLevels:
|
53 | 53 |
|
54 | 54 | ## Server-side encryption options.
|
55 | 55 | # serverSideEncryption:
|
56 | 56 | # sseAlgorithm: aws:kms
|
57 | 57 | # kmsKeyID:
|
| 58 | + |
58 | 59 | ## Options for server-side encryption with customer-provided keys stored
|
59 | 60 | ## on the client side
|
60 | 61 | # sseCustomerAlgorithm: AES256
|
|
66 | 67 | # minRetryDelay: 30
|
67 | 68 | # maxRetryDelay: 5
|
68 | 69 |
|
| 70 | +#--------------------Google Cloud Storage Configuration----------------- |
| 71 | + |
| 72 | +# type: |
| 73 | +# gcs: |
| 74 | + |
| 75 | +## The location and name of the bucket that you have configured on the GCS |
| 76 | +# bucket: pbm-testing |
| 77 | + |
| 78 | +## The data directory to store backups in. |
| 79 | +# prefix: |
| 80 | + |
| 81 | +## The size of data chunks in bytes to be uploaded to the storage bucket in a single request. |
| 82 | +# chunkSize: 10MB |
| 83 | + |
| 84 | +## GCS access credentials |
| 85 | +# credentials: |
| 86 | +# clientEmail: |
| 87 | +# privateKey: |
| 88 | +# hmacAccessKey |
| 89 | +# hmacSecret: |
| 90 | + |
| 91 | +## Retry upload configuration options. |
| 92 | +# retryer: |
| 93 | +# backoffInitial: 1 |
| 94 | +# backoffMax: 30 |
| 95 | +# backoffMultiplier: 2 |
| 96 | + |
69 | 97 | #--------------------Filesystem Configuration---------------------------
|
70 | 98 | # type:
|
71 | 99 | # filesystem:
|
|
94 | 122 | #pitr:
|
95 | 123 | # enabled: false
|
96 | 124 |
|
97 |
| -## Adjust the size op oplog chunks (in minutes). |
| 125 | +## Adjust the size of oplog chunks (in minutes). |
98 | 126 | # oplogSpanMin: 10
|
99 | 127 |
|
100 | 128 | ## Set a compression method and level
|
|
104 | 132 | ## Save oplog slicing without the base backup
|
105 | 133 | # oplogOnly: false
|
106 | 134 |
|
| 135 | +## Node priority for saving oplog slices. The highest priority node is used. |
| 136 | +## Nodes with the same priority are randomly elected for saving oplog slices. |
| 137 | +# priority: |
| 138 | + |
| 139 | + |
107 | 140 | #==========================Backup Configuration============================
|
108 | 141 |
|
109 | 142 | ## Adjust priority of mongod nodes for making backups. The highest priority
|
|
116 | 149 | # compression:
|
117 | 150 | # compressionLevel:
|
118 | 151 |
|
| 152 | +## The wait time (in seconds) for PBM to start backups. |
| 153 | +## This timeout controls how long PBM waits for the backup to |
| 154 | +## transition from initial state to running status. |
| 155 | +# timeouts: |
| 156 | +# startingStatus: 33 |
| 157 | + |
| 158 | +## Adjust the size of oplog chunks saved within a logical backup snapshot (in minutes). |
| 159 | +# oplogSpanMin: 10 |
| 160 | + |
| 161 | +## Set the number of parallel collections to process during a logical backup. |
| 162 | +## Default value is half of the number of CPU cores. |
| 163 | +# numParallelCollections: |
| 164 | + |
| 165 | + |
119 | 166 | #==========================Restore Configuration===========================
|
120 | 167 |
|
121 | 168 | ## Options to adjust the memory consumption in environments with tight memory bounds.
|
122 | 169 | #restore:
|
123 | 170 | # batchSize: 500
|
124 | 171 | # numInsertionWorkers: 10
|
125 | 172 |
|
| 173 | +## Set the number of parallel collections to process during a logical restore. |
| 174 | +## Default value is half of the number of CPU cores. |
| 175 | +# numParallelCollections: |
| 176 | + |
126 | 177 | ## Adjust concurrent download of data chunks from storage for physical restore.
|
127 | 178 | # numDownloadWorkers:
|
128 | 179 | # maxDownloadBufferMb:
|
|
133 | 184 | # mongodLocation:
|
134 | 185 | # mongodLocationMap:
|
135 | 186 | # "node-name:port":"path"
|
| 187 | + |
| 188 | +#=========================Logging Configuration============================== |
| 189 | + |
| 190 | +## Options to adjust logging configuration for starting pbm-agents |
| 191 | +#log: |
| 192 | + |
| 193 | +## The path to the log file. If PBM cannot write logs to the specified path it defaults to '/dev/stderr' |
| 194 | +# path: "/var/log/pbm.json" |
| 195 | + |
| 196 | +## The log level. Supported values: debug, info, warn, error, fatal. |
| 197 | +# level: info |
| 198 | + |
| 199 | +## Output logs in JSON format. |
| 200 | +# json: true |
| 201 | + |
0 commit comments