restore alphabetical order of settings (addresses review)
This commit is contained in:
parent
ac7813b47d
commit
440aa957da
|
|
@ -242,25 +242,25 @@ configLogicalBackup:
|
||||||
logical_backup_docker_image: "registry.opensource.zalan.do/acid/logical-backup:v.1.6.0"
|
logical_backup_docker_image: "registry.opensource.zalan.do/acid/logical-backup:v.1.6.0"
|
||||||
# path of google cloud service account json file
|
# path of google cloud service account json file
|
||||||
# logical_backup_google_application_credentials: ""
|
# logical_backup_google_application_credentials: ""
|
||||||
|
# prefix for the backup job name
|
||||||
|
logical_backup_job_prefix: "logical-backup-"
|
||||||
# storage provider - either "s3" or "gcs"
|
# storage provider - either "s3" or "gcs"
|
||||||
logical_backup_provider: "s3"
|
logical_backup_provider: "s3"
|
||||||
# S3 Access Key ID
|
# S3 Access Key ID
|
||||||
logical_backup_s3_access_key_id: ""
|
logical_backup_s3_access_key_id: ""
|
||||||
# S3 bucket to store backup results
|
# S3 bucket to store backup results
|
||||||
logical_backup_s3_bucket: "my-bucket-url"
|
logical_backup_s3_bucket: "my-bucket-url"
|
||||||
# S3 region of bucket
|
|
||||||
logical_backup_s3_region: ""
|
|
||||||
# S3 endpoint url when not using AWS
|
# S3 endpoint url when not using AWS
|
||||||
logical_backup_s3_endpoint: ""
|
logical_backup_s3_endpoint: ""
|
||||||
|
# S3 region of bucket
|
||||||
|
logical_backup_s3_region: ""
|
||||||
# S3 Secret Access Key
|
# S3 Secret Access Key
|
||||||
logical_backup_s3_secret_access_key: ""
|
logical_backup_s3_secret_access_key: ""
|
||||||
# S3 server side encryption
|
# S3 server side encryption
|
||||||
logical_backup_s3_sse: "AES256"
|
logical_backup_s3_sse: "AES256"
|
||||||
# backup schedule in the cron format
|
# backup schedule in the cron format
|
||||||
logical_backup_schedule: "30 00 * * *"
|
logical_backup_schedule: "30 00 * * *"
|
||||||
# prefix for the backup job name
|
|
||||||
logical_backup_job_prefix: "logical-backup-"
|
|
||||||
|
|
||||||
# automate creation of human users with teams API service
|
# automate creation of human users with teams API service
|
||||||
configTeamsApi:
|
configTeamsApi:
|
||||||
|
|
|
||||||
|
|
@ -551,11 +551,6 @@ These parameters configure a K8s cron job managed by the operator to produce
|
||||||
Postgres logical backups. In the CRD-based configuration those parameters are
|
Postgres logical backups. In the CRD-based configuration those parameters are
|
||||||
grouped under the `logical_backup` key.
|
grouped under the `logical_backup` key.
|
||||||
|
|
||||||
* **logical_backup_schedule**
|
|
||||||
Backup schedule in the cron format. Please take the
|
|
||||||
[reference schedule format](https://kubernetes.io/docs/tasks/job/automated-tasks-with-cron-jobs/#schedule)
|
|
||||||
into account. Default: "30 00 \* \* \*"
|
|
||||||
|
|
||||||
* **logical_backup_docker_image**
|
* **logical_backup_docker_image**
|
||||||
An image for pods of the logical backup job. The [example image](../../docker/logical-backup/Dockerfile)
|
An image for pods of the logical backup job. The [example image](../../docker/logical-backup/Dockerfile)
|
||||||
runs `pg_dumpall` on a replica if possible and uploads compressed results to
|
runs `pg_dumpall` on a replica if possible and uploads compressed results to
|
||||||
|
|
@ -563,35 +558,40 @@ grouped under the `logical_backup` key.
|
||||||
The default image is the same image built with the Zalando-internal CI
|
The default image is the same image built with the Zalando-internal CI
|
||||||
pipeline. Default: "registry.opensource.zalan.do/acid/logical-backup"
|
pipeline. Default: "registry.opensource.zalan.do/acid/logical-backup"
|
||||||
|
|
||||||
|
* **logical_backup_google_application_credentials**
|
||||||
|
Specifies the path of the google cloud service account json file. Default is empty.
|
||||||
|
|
||||||
|
* **logical_backup_job_prefix**
|
||||||
|
The prefix to be prepended to the name of a k8s CronJob running the backups. Beware the prefix counts towards the name length restrictions imposed by k8s. Empty string is a legitimate value. Operator does not do the actual renaming: If you change the prefix, you will have to recreate respective CronJobs manually. Default: "logical-backup-".
|
||||||
|
|
||||||
* **logical_backup_provider**
|
* **logical_backup_provider**
|
||||||
Specifies the storage provider to which the backup should be uploaded (`s3` or `gcs`).
|
Specifies the storage provider to which the backup should be uploaded (`s3` or `gcs`).
|
||||||
Default: "s3"
|
Default: "s3"
|
||||||
|
|
||||||
|
* **logical_backup_s3_access_key_id**
|
||||||
|
When set, value will be in AWS_ACCESS_KEY_ID env variable. The Default is empty.
|
||||||
|
|
||||||
* **logical_backup_s3_bucket**
|
* **logical_backup_s3_bucket**
|
||||||
S3 bucket to store backup results. The bucket has to be present and
|
S3 bucket to store backup results. The bucket has to be present and
|
||||||
accessible by Postgres pods. Default: empty.
|
accessible by Postgres pods. Default: empty.
|
||||||
|
|
||||||
* **logical_backup_job_prefix**
|
* **logical_backup_s3_endpoint**
|
||||||
The prefix to be prepended to the name of a k8s CronJob running the backups. Beware the prefix counts towards the name length restrictions imposed by k8s. Empty string is a legitimate value. Operator does not do the actual renaming: If you change the prefix, you will have to recreate respective CronJobs manually. Default: "logical-backup-".
|
When using non-AWS S3 storage, endpoint can be set as a ENV variable. The default is empty.
|
||||||
|
|
||||||
* **logical_backup_s3_region**
|
* **logical_backup_s3_region**
|
||||||
Specifies the region of the bucket which is required with some non-AWS S3 storage services. The default is empty.
|
Specifies the region of the bucket which is required with some non-AWS S3 storage services. The default is empty.
|
||||||
|
|
||||||
* **logical_backup_s3_endpoint**
|
* **logical_backup_s3_secret_access_key**
|
||||||
When using non-AWS S3 storage, endpoint can be set as a ENV variable. The default is empty.
|
When set, value will be in AWS_SECRET_ACCESS_KEY env variable. The Default is empty.
|
||||||
|
|
||||||
* **logical_backup_s3_sse**
|
* **logical_backup_s3_sse**
|
||||||
Specify server side encryption that S3 storage is using. If empty string
|
Specify server side encryption that S3 storage is using. If empty string
|
||||||
is specified, no argument will be passed to `aws s3` command. Default: "AES256".
|
is specified, no argument will be passed to `aws s3` command. Default: "AES256".
|
||||||
|
|
||||||
* **logical_backup_s3_access_key_id**
|
* **logical_backup_schedule**
|
||||||
When set, value will be in AWS_ACCESS_KEY_ID env variable. The Default is empty.
|
Backup schedule in the cron format. Please take the
|
||||||
|
[reference schedule format](https://kubernetes.io/docs/tasks/job/automated-tasks-with-cron-jobs/#schedule)
|
||||||
* **logical_backup_s3_secret_access_key**
|
into account. Default: "30 00 \* \* \*"
|
||||||
When set, value will be in AWS_SECRET_ACCESS_KEY env variable. The Default is empty.
|
|
||||||
|
|
||||||
* **logical_backup_google_application_credentials**
|
|
||||||
Specifies the path of the google cloud service account json file. Default is empty.
|
|
||||||
|
|
||||||
## Debugging the operator
|
## Debugging the operator
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -317,6 +317,8 @@ spec:
|
||||||
type: string
|
type: string
|
||||||
logical_backup_google_application_credentials:
|
logical_backup_google_application_credentials:
|
||||||
type: string
|
type: string
|
||||||
|
logical_backup_job_prefix:
|
||||||
|
type: string
|
||||||
logical_backup_provider:
|
logical_backup_provider:
|
||||||
type: string
|
type: string
|
||||||
logical_backup_s3_access_key_id:
|
logical_backup_s3_access_key_id:
|
||||||
|
|
@ -334,8 +336,6 @@ spec:
|
||||||
logical_backup_schedule:
|
logical_backup_schedule:
|
||||||
type: string
|
type: string
|
||||||
pattern: '^(\d+|\*)(/\d+)?(\s+(\d+|\*)(/\d+)?){4}$'
|
pattern: '^(\d+|\*)(/\d+)?(\s+(\d+|\*)(/\d+)?){4}$'
|
||||||
logical_backup_job_prefix:
|
|
||||||
type: string
|
|
||||||
debug:
|
debug:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
|
|
||||||
|
|
@ -117,6 +117,7 @@ configuration:
|
||||||
logical_backup:
|
logical_backup:
|
||||||
logical_backup_docker_image: "registry.opensource.zalan.do/acid/logical-backup:v.1.6.0"
|
logical_backup_docker_image: "registry.opensource.zalan.do/acid/logical-backup:v.1.6.0"
|
||||||
# logical_backup_google_application_credentials: ""
|
# logical_backup_google_application_credentials: ""
|
||||||
|
logical_backup_job_prefix: "logical-backup-"
|
||||||
logical_backup_provider: "s3"
|
logical_backup_provider: "s3"
|
||||||
# logical_backup_s3_access_key_id: ""
|
# logical_backup_s3_access_key_id: ""
|
||||||
logical_backup_s3_bucket: "my-bucket-url"
|
logical_backup_s3_bucket: "my-bucket-url"
|
||||||
|
|
@ -125,7 +126,6 @@ configuration:
|
||||||
# logical_backup_s3_secret_access_key: ""
|
# logical_backup_s3_secret_access_key: ""
|
||||||
logical_backup_s3_sse: "AES256"
|
logical_backup_s3_sse: "AES256"
|
||||||
logical_backup_schedule: "30 00 * * *"
|
logical_backup_schedule: "30 00 * * *"
|
||||||
logical_backup_job_prefix: "logical-backup-"
|
|
||||||
debug:
|
debug:
|
||||||
debug_logging: true
|
debug_logging: true
|
||||||
enable_database_access: true
|
enable_database_access: true
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue