PBM-1562 Updated PBM config template with newly added options

packaging/conf/pbm-conf-reference.yml

@@ -3,8 +3,8 @@
 ## This file is a full configuration example documenting all 
 ## options in comments. 
 ##
-## You can find the full configuration reference here:
-## https://docs.percona.com/percona-backup-mongodb/configuration-options.html
+## You can find the full reference for configuration options here:
+## https://docs.percona.com/percona-backup-mongodb/reference/configuration-options.html
 
 #======================Storage Configuration============================
 
@@ -25,7 +25,7 @@
 ## When undefined, backups are saved at the root of the bucket.
 #     prefix:  
 
-## The URL to access the bucket for GCS and MinIO
+## The URL to access the bucket for MinIO
 #     endpointURL: 
 
 ## S3 access credentials.
@@ -48,13 +48,14 @@
 ## Use it with caution as it might leave a hole for man-in-the-middle attacks. 
 #     insecureSkipTLSVerify:
 
-## Debug level logging configuration for S3 requests.
+## Debug level logging configuration for S3 requests. 
 #     debugLogLevels: 
 
 ## Server-side encryption options.
 #     serverSideEncryption:
 #       sseAlgorithm: aws:kms
 #       kmsKeyID: 
+
 ## Options for server-side encryption with customer-provided keys stored 
 ## on the client side
 #       sseCustomerAlgorithm: AES256
@@ -66,6 +67,33 @@
 #       minRetryDelay: 30
 #       maxRetryDelay: 5
 
+#--------------------Google Cloud Storage Configuration-----------------
+
+#  type:
+#    gcs:
+
+## The location and name of the bucket that you have configured on the GCS
+#      bucket: pbm-testing
+
+## The data directory to store backups in. 
+#      prefix: 
+
+## The size of data chunks in bytes to be uploaded to the storage bucket in a single request. 
+#      chunkSize: 10MB
+
+## GCS access credentials
+#      credentials:
+#        clientEmail:  
+#        privateKey: 
+#        hmacAccessKey
+#        hmacSecret:
+
+## Retry upload configuration options.
+#      retryer:
+#        backoffInitial: 1
+#        backoffMax: 30
+#        backoffMultiplier: 2
+
 #--------------------Filesystem Configuration---------------------------
 #  type:
 #    filesystem:
@@ -94,7 +122,7 @@
 #pitr:
 #  enabled: false
 
-## Adjust the size op oplog chunks (in minutes).
+## Adjust the size of oplog chunks (in minutes).
 #  oplogSpanMin: 10 
 
 ## Set a compression method and level
@@ -104,6 +132,11 @@
 ## Save oplog slicing without the base backup
 #  oplogOnly: false
 
+## Node priority for saving oplog slices. The highest priority node is used.
+## Nodes with the same priority are randomly elected for saving oplog slices.
+#  priority:
+
+
 #==========================Backup Configuration============================
 
 ## Adjust priority of mongod nodes for making backups. The highest priority 
@@ -116,13 +149,31 @@
 #  compression:
 #  compressionLevel:
 
+## The wait time (in seconds) for PBM to start backups. 
+## This timeout controls how long PBM waits for the backup to 
+## transition from initial state to running status.
+#  timeouts:
+#    startingStatus: 33
+
+## Adjust the size of oplog chunks saved within a logical backup snapshot (in minutes).
+#  oplogSpanMin: 10
+
+## Set the number of parallel collections to process during a logical backup.
+## Default value is half of the number of CPU cores.
+#  numParallelCollections: 
+
+
 #==========================Restore Configuration===========================
 
 ## Options to adjust the memory consumption in environments with tight memory bounds.
 #restore:
 #  batchSize: 500
 #  numInsertionWorkers: 10
 
+## Set the number of parallel collections to process during a logical restore.
+## Default value is half of the number of CPU cores.
+#  numParallelCollections: 
+
 ## Adjust concurrent download of data chunks from storage for physical restore.
 #  numDownloadWorkers: 
 #  maxDownloadBufferMb: 
@@ -133,3 +184,18 @@
 #  mongodLocation: 
 #  mongodLocationMap:
 #    "node-name:port":"path"
+
+#=========================Logging Configuration==============================
+
+## Options to adjust logging configuration for starting pbm-agents
+#log:
+
+## The path to the log file. If PBM cannot write logs to the specified path it defaults to '/dev/stderr'
+#  path: "/var/log/pbm.json"
+
+## The log level. Supported values: debug, info, warn, error, fatal.
+#  level: info
+
+## Output logs in JSON format.
+#  json: true
+