Skip to content

Commit 8efb743

Browse files
FxKuFxKu
committed
fix reference docs
1 parent 948d9b8 commit 8efb743

File tree

2 files changed

+33
-31
lines changed

2 files changed

+33
-31
lines changed

‎docs/reference/cluster_manifest.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -56,16 +56,21 @@ These parameters are grouped directly under the `spec` key in the manifest.
5656
name of the team the cluster belongs to. Changing it after the cluster
5757
creation is not supported. Required field.
5858

59+
* **numberOfInstances**
60+
total number of instances for a given cluster. The operator parameters
61+
`max_instances` and `min_instances` may also adjust this number. Required
62+
field.
63+
5964
* **dockerImage**
6065
custom docker image that overrides the **docker_image** operator parameter.
61-
It should be a [Spilo](https://github.com/zalando/spilo) image. Optional.
66+
It should be a [Spilo](https://github.com/zalando/spilo) image. Optional.
6267

6368
* **spiloFSGroup**
6469
the Persistent Volumes for the spilo pods in the StatefulSet will be owned and
6570
writable by the group ID specified. This will override the **spilo_fsgroup**
6671
operator parameter. This is required to run Spilo as a non-root process, but
6772
requires a custom spilo image. Note the FSGroup of a Pod cannot be changed
68-
without recreating a new Pod.
73+
without recreating a new Pod. Optional.
6974

7075
* **enableMasterLoadBalancer**
7176
boolean flag to override the operator defaults (set by the
@@ -84,11 +89,6 @@ These parameters are grouped directly under the `spec` key in the manifest.
8489
this parameter. Optional, when empty the load balancer service becomes
8590
inaccessible from outside of the Kubernetes cluster.
8691

87-
* **numberOfInstances**
88-
total number of instances for a given cluster. The operator parameters
89-
`max_instances` and `min_instances` may also adjust this number. Required
90-
field.
91-
9292
* **users**
9393
a map of usernames to user flags for the users that should be created in the
9494
cluster by the operator. User flags are a list, allowed elements are
@@ -116,7 +116,7 @@ These parameters are grouped directly under the `spec` key in the manifest.
116116
that should be assigned to the cluster pods. When not specified, the value
117117
is taken from the `pod_priority_class_name` operator parameter, if not set
118118
then the default priority class is taken. The priority class itself must be
119-
defined in advance.
119+
defined in advance. Optional.
120120

121121
* **enableShmVolume**
122122
Start a database pod without limitations on shm memory. By default docker
@@ -128,19 +128,21 @@ These parameters are grouped directly under the `spec` key in the manifest.
128128
about mounting a volume will be made based on operator configuration
129129
(`enable_shm_volume`, which is `true` by default). It it's present and value
130130
is `false`, then no volume will be mounted no matter how operator was
131-
configured (so you can override the operator configuration).
131+
configured (so you can override the operator configuration). Optional.
132132

133133
* **enableLogicalBackup**
134134
Determines if the logical backup of this cluster should be taken and uploaded
135-
to S3. Default: false.
135+
to S3. Default: false. Optional.
136136

137137
* **logicalBackupSchedule**
138-
Schedule for the logical backup k8s cron job. Please take [the reference schedule format](https://kubernetes.io/docs/tasks/job/automated-tasks-with-cron-jobs/#schedule)
139-
into account. Default: "30 00 \* \* \*"
138+
Schedule for the logical backup k8s cron job. Please take
139+
[the reference schedule format](https://kubernetes.io/docs/tasks/job/automated-tasks-with-cron-jobs/#schedule)
140+
into account. Optional. Default is: "30 00 \* \* \*"
140141

141142
## Postgres parameters
142143

143-
Those parameters are grouped under the `postgresql` top-level key.
144+
Those parameters are grouped under the `postgresql` top-level key, which is
145+
required in the manifest.
144146

145147
* **version**
146148
the postgres major version of the cluster. Looks at the [Spilo
@@ -283,7 +285,7 @@ archive is supported.
283285

284286
* **s3_wal_path**
285287
the url to S3 bucket containing the WAL archive of the remote primary.
286-
Optional.
288+
Required when the `standby` section is present.
287289

288290
## EBS volume resizing
289291

@@ -301,7 +303,7 @@ properties of the persistent storage that stores postgres data.
301303
for the details on storage classes. Optional.
302304

303305
* **subPath**
304-
Subpath to use when mounting volume into Spilo container
306+
Subpath to use when mounting volume into Spilo container. Optional.
305307

306308
## Sidecar definitions
307309

‎docs/reference/operator_parameters.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -375,7 +375,7 @@ In the CRD-based configuration they are grouped under the `load_balancer` key.
375375
with the hosted zone (the value of the `db_hosted_zone` parameter). No other
376376
placeholders are allowed.
377377

378-
** **replica_dns_name_format** defines the DNS name string template for the
378+
* **replica_dns_name_format** defines the DNS name string template for the
379379
replica load balancer cluster. The default is
380380
`{cluster}-repl.{team}.{hostedzone}`, where `{cluster}` is replaced by the
381381
cluster name, `{team}` is replaced with the team name and `{hostedzone}` is
@@ -415,25 +415,25 @@ yet officially supported.
415415
* **additional_secret_mount_path**
416416
Path to mount the above Secret in the filesystem of the container(s). The default is empty.
417417

418-
## Logical backup
418+
## Logical backup
419419

420-
These parameters configure a k8s cron job managed by the operator to produce
421-
Postgres logical backups. In the CRD-based configuration those parameters are
422-
grouped under the `logical_backup` key.
420+
These parameters configure a k8s cron job managed by the operator to produce
421+
Postgres logical backups. In the CRD-based configuration those parameters are
422+
grouped under the `logical_backup` key.
423423

424-
* **logical_backup_schedule**
425-
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 \* \* \*"
424+
* **logical_backup_schedule**
425+
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 \* \* \*"
426426

427-
* **logical_backup_docker_image**
428-
An image for pods of the logical backup job. The [example image](../../docker/logical-backup/Dockerfile)
429-
runs `pg_dumpall` on a replica if possible and uploads compressed results to
430-
an S3 bucket under the key `/spilo/pg_cluster_name/cluster_k8s_uuid/logical_backups`.
431-
The default image is the same image built with the Zalando-internal CI
432-
pipeline. Default: "registry.opensource.zalan.do/acid/logical-backup"
427+
* **logical_backup_docker_image**
428+
An image for pods of the logical backup job. The [example image](../../docker/logical-backup/Dockerfile)
429+
runs `pg_dumpall` on a replica if possible and uploads compressed results to
430+
an S3 bucket under the key `/spilo/pg_cluster_name/cluster_k8s_uuid/logical_backups`.
431+
The default image is the same image built with the Zalando-internal CI
432+
pipeline. Default: "registry.opensource.zalan.do/acid/logical-backup"
433433

434-
* **logical_backup_s3_bucket**
435-
S3 bucket to store backup results. The bucket has to be present and
436-
accessible by Postgres pods. Default: empty.
434+
* **logical_backup_s3_bucket**
435+
S3 bucket to store backup results. The bucket has to be present and
436+
accessible by Postgres pods. Default: empty.
437437

438438
## Debugging the operator
439439

0 commit comments

Comments
 (0)