You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In the case both are set, the env var takes the precedence. To make the
127
127
operator listen to all namespaces, explicitly set the field/env var to "`*`".
128
128
@@ -143,7 +143,7 @@ But, it is also possible to define ownership between operator instances and
143
143
Postgres clusters running all in the same namespace or K8s cluster without
144
144
interfering.
145
145
146
-
First, define the [`CONTROLLER_ID`](../../manifests/postgres-operator.yaml#L38)
146
+
First, define the [`CONTROLLER_ID`](https://github.com/zalando/postgres-operator/blob/master/manifests/postgres-operator.yaml#L38)
147
147
environment variable in the operator deployment manifest. Then specify the ID
148
148
in every Postgres cluster manifest you want this operator to watch using the
149
149
`"acid.zalan.do/controller"` annotation:
@@ -256,7 +256,7 @@ update of the pods because the UID is used as part of backup path to S3.
256
256
257
257
## Role-based access control for the operator
258
258
259
-
The manifest [`operator-service-account-rbac.yaml`](../manifests/operator-service-account-rbac.yaml)
259
+
The manifest [`operator-service-account-rbac.yaml`](https://github.com/zalando/postgres-operator/blob/master/manifests/operator-service-account-rbac.yaml)
260
260
defines the service account, cluster roles and bindings needed for the operator
261
261
to function under access control restrictions. The file also includes a cluster
262
262
role `postgres-pod` with privileges for Patroni to watch and manage pods and
@@ -965,7 +965,7 @@ but only snapshots of your data. In its current state, see logical backups as a
965
965
way to quickly create SQL dumps that you can easily restore in an empty test
966
966
cluster.
967
967
968
-
2. The [example image](../docker/logical-backup/Dockerfile) implements the backup
968
+
2. The [example image](https://github.com/zalando/postgres-operator/blob/master/docker/logical-backup/Dockerfile) implements the backup
969
969
via `pg_dumpall` and upload of compressed and encrypted results to an S3 bucket.
970
970
`pg_dumpall`requires a `superuser` access to a DB and runs on the replica when
971
971
possible.
@@ -984,7 +984,7 @@ of the backup cron job.
984
984
985
985
6. For that feature to work, your RBAC policy must enable operations on the
986
986
`cronjobs`resource from the `batch` API group for the operator service account.
987
-
See [example RBAC](../manifests/operator-service-account-rbac.yaml)
987
+
See [example RBAC](https://github.com/zalando/postgres-operator/blob/master/manifests/operator-service-account-rbac.yaml)
988
988
989
989
## Sidecars for Postgres clusters
990
990
@@ -1038,8 +1038,8 @@ default. Alternatively, a list can also be passed when starting the Python
1038
1038
application with the `--cluster` option.
1039
1039
1040
1040
The Operator API endpoint can be configured via the `OPERATOR_API_URL`
1041
-
environment variables in the [deployment manifest](../ui/manifests/deployment.yaml#L40).
1042
-
You can also expose the operator API through a [service](../manifests/api-service.yaml).
1041
+
environment variables in the [deployment manifest](https://github.com/zalando/postgres-operator/blob/master/ui/manifests/deployment.yaml#L40).
1042
+
You can also expose the operator API through a [service](https://github.com/zalando/postgres-operator/blob/master/manifests/api-service.yaml).
1043
1043
Some displayed options can be disabled from UI using simple flags under the
Postgres manifest parameters are defined in the [api package](../pkg/apis/acid.zalan.do/v1/postgresql_type.go).
306
-
The operator behavior has to be implemented at least in [k8sres.go](../pkg/cluster/k8sres.go).
307
-
Validation of CRD parameters is controlled in [crds.go](../pkg/apis/acid.zalan.do/v1/crds.go).
305
+
Postgres manifest parameters are defined in the [api package](https://github.com/zalando/postgres-operator/blob/master/pkg/apis/acid.zalan.do/v1/postgresql_type.go).
306
+
The operator behavior has to be implemented at least in [k8sres.go](https://github.com/zalando/postgres-operator/blob/master/pkg/cluster/k8sres.go).
307
+
Validation of CRD parameters is controlled in [crds.go](https://github.com/zalando/postgres-operator/blob/master/pkg/apis/acid.zalan.do/v1/crds.go).
308
308
Please, reflect your changes in tests, for example in:
For the CRD-based configuration, please update the following files:
316
-
* the default [OperatorConfiguration](../manifests/postgresql-operator-default-configuration.yaml)
317
-
* the CRD's [validation](../manifests/operatorconfiguration.crd.yaml)
318
-
* the CRD's validation in the [Helm chart](../charts/postgres-operator/crds/operatorconfigurations.yaml)
316
+
* the default [OperatorConfiguration](https://github.com/zalando/postgres-operator/blob/master/manifests/postgresql-operator-default-configuration.yaml)
317
+
* the CRD's [validation](https://github.com/zalando/postgres-operator/blob/master/manifests/operatorconfiguration.crd.yaml)
318
+
* the CRD's validation in the [Helm chart](https://github.com/zalando/postgres-operator/blob/master/charts/postgres-operator/crds/operatorconfigurations.yaml)
319
319
320
-
Add new options also to the Helm chart's [values file](../charts/postgres-operator/values.yaml) file.
320
+
Add new options also to the Helm chart's [values file](https://github.com/zalando/postgres-operator/blob/master/charts/postgres-operator/values.yaml) file.
321
321
It follows the OperatorConfiguration CRD layout. Nested values will be flattened for the ConfigMap.
322
-
Last but no least, update the [ConfigMap](../manifests/configmap.yaml) manifest example as well.
322
+
Last but no least, update the [ConfigMap](https://github.com/zalando/postgres-operator/blob/master/manifests/configmap.yaml) manifest example as well.
For convenience, we have automated starting the operator with minikube using the
67
-
`run_operator_locally` script. It applies the [`acid-minimal-cluster`](../manifests/minimal-postgres-manifest.yaml).
67
+
`run_operator_locally` script. It applies the [`acid-minimal-cluster`](https://github.com/zalando/postgres-operator/blob/master/manifests/minimal-postgres-manifest.yaml).
68
68
manifest.
69
69
70
70
```bash
@@ -114,8 +114,8 @@ In the following paragraphs we describe how to access and manage PostgreSQL
114
114
clusters from the command line with kubectl. But it can also be done from the
115
115
browser-based [Postgres Operator UI](operator-ui.md). Before deploying the UI
116
116
make sure the operator is running and its REST API is reachable through a
117
-
[K8s service](../manifests/api-service.yaml). The URL to this API must be
118
-
configured in the [deployment manifest](../ui/manifests/deployment.yaml#L43)
117
+
[K8s service](https://github.com/zalando/postgres-operator/blob/master/manifests/api-service.yaml). The URL to this API must be
118
+
configured in the [deployment manifest](https://github.com/zalando/postgres-operator/blob/master/ui/manifests/deployment.yaml#L43)
119
119
of the UI.
120
120
121
121
To deploy the UI simply apply all its manifests files or use the UI helm chart:
* CRD-based configuration. The configuration is stored in a custom YAML
16
16
manifest. The manifest is an instance of the custom resource definition (CRD)
17
17
called `OperatorConfiguration`. The operator registers this CRD during the
18
-
start and uses it for configuration if the [operator deployment manifest](../../manifests/postgres-operator.yaml#L36)
18
+
start and uses it for configuration if the [operator deployment manifest](https://github.com/zalando/postgres-operator/blob/master/manifests/postgres-operator.yaml#L36)
19
19
sets the `POSTGRES_OPERATOR_CONFIGURATION_OBJECT` env variable to a non-empty
20
20
value. The variable should point to the `postgresql-operator-configuration`
21
21
object in the operator's namespace.
@@ -24,7 +24,7 @@ configuration.
24
24
simply represented in the usual YAML way. There are no default values built-in
25
25
in the operator, each parameter that is not supplied in the configuration
26
26
receives an empty value. In order to create your own configuration just copy
27
-
the [default one](../../manifests/postgresql-operator-default-configuration.yaml)
27
+
the [default one](https://github.com/zalando/postgres-operator/blob/master/manifests/postgresql-operator-default-configuration.yaml)
28
28
and change it.
29
29
30
30
To test the CRD-based configuration locally, use the following
@@ -57,11 +57,11 @@ parameters, those parameters have no effect and are replaced by the
57
57
`CRD_READY_WAIT_INTERVAL` and `CRD_READY_WAIT_TIMEOUT` environment variables.
58
58
They will be deprecated and removed in the future.
59
59
60
-
For the configmap configuration, the [default parameter values](../../pkg/util/config/config.go#L14)
60
+
For the configmap configuration, the [default parameter values](https://github.com/zalando/postgres-operator/blob/master/pkg/util/config/config.go#L14)
61
61
mentioned here are likely to be overwritten in your local operator installation
62
62
via your local version of the operator configmap. In the case you use the
63
63
operator CRD, all the CRD defaults are provided in the
@@ -217,7 +217,7 @@ configuration they are grouped under the `kubernetes` key.
217
217
sufficient for the pods to start and for Patroni to access K8s endpoints;
218
218
service account on its own lacks any such rights starting with K8s v1.8. If
219
219
not explicitly defined by the user, a simple definition that binds the
220
-
account to the 'postgres-pod' [cluster role](../../manifests/operator-service-account-rbac.yaml#L198)
220
+
account to the 'postgres-pod' [cluster role](https://github.com/zalando/postgres-operator/blob/master/manifests/operator-service-account-rbac.yaml#L198)
221
221
will be used. The default is empty.
222
222
223
223
***pod_terminate_grace_period**
@@ -602,7 +602,7 @@ Postgres logical backups. In the CRD-based configuration those parameters are
602
602
grouped under the `logical_backup` key.
603
603
604
604
***logical_backup_docker_image**
605
-
An image for pods of the logical backup job. The [example image](../../docker/logical-backup/Dockerfile)
605
+
An image for pods of the logical backup job. The [example image](https://github.com/zalando/postgres-operator/blob/master/docker/logical-backup/Dockerfile)
606
606
runs `pg_dumpall` on a replica if possible and uploads compressed results to
607
607
an S3 bucket under the key `/spilo/pg_cluster_name/cluster_k8s_uuid/logical_backups`.
608
608
The default image is the same image built with the Zalando-internal CI
0 commit comments