Skip to content

Commit 720b457

Browse files
authored
docs: fix broken links (#1594)
You cannot browse all these links within the published docs in GH pages.
1 parent 6caf3a5 commit 720b457

8 files changed

+55
-55
lines changed

docs/administrator.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,11 @@ the upgrade script for you after the manifest is updated and pods are rotated.
6868
[CustomResourceDefinitions](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions)
6969
will be registered with schema validation by default when the operator is
7070
deployed. The `OperatorConfiguration` CRD will only get created if the
71-
`POSTGRES_OPERATOR_CONFIGURATION_OBJECT` [environment variable](../manifests/postgres-operator.yaml#L36)
71+
`POSTGRES_OPERATOR_CONFIGURATION_OBJECT` [environment variable](https://github.com/zalando/postgres-operator/blob/master/manifests/postgres-operator.yaml#L36)
7272
in the deployment yaml is set and not empty.
7373

74-
When submitting manifests of [`postgresql`](../manifests/postgresql.crd.yaml) or
75-
[`OperatorConfiguration`](../manifests/operatorconfiguration.crd.yaml) custom
74+
When submitting manifests of [`postgresql`](https://github.com/zalando/postgres-operator/blob/master/manifests/postgresql.crd.yaml) or
75+
[`OperatorConfiguration`](https://github.com/zalando/postgres-operator/blob/master/manifests/operatorconfiguration.crd.yaml) custom
7676
resources with kubectl, validation can be bypassed with `--validate=false`. The
7777
operator can also be configured to not register CRDs with validation on `ADD` or
7878
`UPDATE` events. Running instances are not affected when enabling the validation
@@ -109,7 +109,7 @@ kubectl config set-context $(kubectl config current-context) --namespace=test
109109
All subsequent `kubectl` commands will work with the `test` namespace. The
110110
operator will run in this namespace and look up needed resources - such as its
111111
ConfigMap - there. Please note that the namespace for service accounts and
112-
cluster role bindings in [operator RBAC rules](../manifests/operator-service-account-rbac.yaml)
112+
cluster role bindings in [operator RBAC rules](https://github.com/zalando/postgres-operator/blob/master/manifests/operator-service-account-rbac.yaml)
113113
needs to be adjusted to the non-default value.
114114

115115
### Specify the namespace to watch
@@ -120,9 +120,9 @@ clusters in the namespace such as "increase the number of Postgres replicas to
120120

121121
By default, the operator watches the namespace it is deployed to. You can
122122
change this by setting the `WATCHED_NAMESPACE` var in the `env` section of the
123-
[operator deployment](../manifests/postgres-operator.yaml) manifest or by
123+
[operator deployment](https://github.com/zalando/postgres-operator/blob/master/manifests/postgres-operator.yaml) manifest or by
124124
altering the `watched_namespace` field in the operator
125-
[configuration](../manifests/postgresql-operator-default-configuration.yaml#L49).
125+
[configuration](https://github.com/zalando/postgres-operator/blob/master/manifests/postgresql-operator-default-configuration.yaml#L49).
126126
In the case both are set, the env var takes the precedence. To make the
127127
operator listen to all namespaces, explicitly set the field/env var to "`*`".
128128

@@ -143,7 +143,7 @@ But, it is also possible to define ownership between operator instances and
143143
Postgres clusters running all in the same namespace or K8s cluster without
144144
interfering.
145145

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)
147147
environment variable in the operator deployment manifest. Then specify the ID
148148
in every Postgres cluster manifest you want this operator to watch using the
149149
`"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.
256256

257257
## Role-based access control for the operator
258258

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)
260260
defines the service account, cluster roles and bindings needed for the operator
261261
to function under access control restrictions. The file also includes a cluster
262262
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
965965
way to quickly create SQL dumps that you can easily restore in an empty test
966966
cluster.
967967

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
969969
via `pg_dumpall` and upload of compressed and encrypted results to an S3 bucket.
970970
`pg_dumpall` requires a `superuser` access to a DB and runs on the replica when
971971
possible.
@@ -984,7 +984,7 @@ of the backup cron job.
984984

985985
6. For that feature to work, your RBAC policy must enable operations on the
986986
`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)
988988

989989
## Sidecars for Postgres clusters
990990

@@ -1038,8 +1038,8 @@ default. Alternatively, a list can also be passed when starting the Python
10381038
application with the `--cluster` option.
10391039

10401040
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).
10431043
Some displayed options can be disabled from UI using simple flags under the
10441044
`OPERATOR_UI_CONFIG` field in the deployment.
10451045

docs/developer.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ the standard Docker `bridge` network. The kind cluster is deleted if tests
267267
finish successfully or on each new run in case it still exists.
268268

269269
End-to-end tests are executed automatically during builds (for more details,
270-
see the [README](../e2e/README.md) in the `e2e` folder):
270+
see the [README](https://github.com/zalando/postgres-operator/blob/master/e2e/README.md) in the `e2e` folder):
271271

272272
```bash
273273
make e2e
@@ -291,35 +291,35 @@ parameters (with exceptions for certain Patroni/Postgres options) and
291291
variables if you feel a per-cluster configuration is necessary.
292292

293293
Note: If one option is defined in the operator configuration and in the cluster
294-
[manifest](../manifests/complete-postgres-manifest.yaml), the latter takes
294+
[manifest](https://github.com/zalando/postgres-operator/blob/master/manifests/complete-postgres-manifest.yaml), the latter takes
295295
precedence.
296296

297297
### Go code
298298

299299
Update the following Go files that obtain the configuration parameter from the
300300
manifest files:
301-
* [operator_configuration_type.go](../pkg/apis/acid.zalan.do/v1/operator_configuration_type.go)
302-
* [operator_config.go](../pkg/controller/operator_config.go)
303-
* [config.go](../pkg/util/config/config.go)
301+
* [operator_configuration_type.go](https://github.com/zalando/postgres-operator/blob/master/pkg/apis/acid.zalan.do/v1/operator_configuration_type.go)
302+
* [operator_config.go](https://github.com/zalando/postgres-operator/blob/master/pkg/controller/operator_config.go)
303+
* [config.go](https://github.com/zalando/postgres-operator/blob/master/pkg/util/config/config.go)
304304

305-
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).
308308
Please, reflect your changes in tests, for example in:
309-
* [config_test.go](../pkg/util/config/config_test.go)
310-
* [k8sres_test.go](../pkg/cluster/k8sres_test.go)
311-
* [util_test.go](../pkg/apis/acid.zalan.do/v1/util_test.go)
309+
* [config_test.go](https://github.com/zalando/postgres-operator/blob/master/pkg/util/config/config_test.go)
310+
* [k8sres_test.go](https://github.com/zalando/postgres-operator/blob/master/pkg/cluster/k8sres_test.go)
311+
* [util_test.go](https://github.com/zalando/postgres-operator/blob/master/pkg/apis/acid.zalan.do/v1/util_test.go)
312312

313313
### Updating manifest files
314314

315315
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)
319319

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.
321321
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.
323323

324324
### Updating documentation
325325

docs/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ manages PostgreSQL clusters on Kubernetes (K8s):
88
user submits a new manifest, the operator fetches that manifest and spawns a
99
new Postgres cluster along with all necessary entities such as K8s
1010
StatefulSets and Postgres roles. See this
11-
[Postgres cluster manifest](../manifests/complete-postgres-manifest.yaml)
11+
[Postgres cluster manifest](https://github.com/zalando/postgres-operator/blob/master/manifests/complete-postgres-manifest.yaml)
1212
for settings that a manifest may contain.
1313

14-
2. The operator also watches updates to [its own configuration](../manifests/configmap.yaml)
14+
2. The operator also watches updates to [its own configuration](https://github.com/zalando/postgres-operator/blob/master/manifests/configmap.yaml)
1515
and alters running Postgres clusters if necessary. For instance, if the
1616
Docker image in a pod is changed, the operator carries out the rolling
1717
update, which means it re-spawns pods of each managed StatefulSet one-by-one

docs/operator-ui.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ status page.
3333
Usually, the startup should only take up to 1 minute. If you feel the process
3434
got stuck click on the "Logs" button to inspect the operator logs. If the logs
3535
look fine, but the UI seems to got stuck, check if you are have configured the
36-
same [cluster name label](../ui/manifests/deployment.yaml#L45) like for the
37-
[operator](../manifests/configmap.yaml#L13).
36+
same [cluster name label](https://github.com/zalando/postgres-operator/blob/master/ui/manifests/deployment.yaml#L45) like for the
37+
[operator](https://github.com/zalando/postgres-operator/blob/master/manifests/configmap.yaml#L13).
3838

3939
From the "Status" field in the top menu you can also retrieve the logs and queue
4040
of each worker the operator is using. The number of concurrent workers can be

docs/quickstart.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -56,15 +56,15 @@ kubectl create -f manifests/api-service.yaml # operator API to be used by UI
5656
```
5757

5858
There is a [Kustomization](https://github.com/kubernetes-sigs/kustomize)
59-
manifest that [combines the mentioned resources](../manifests/kustomization.yaml)
59+
manifest that [combines the mentioned resources](https://github.com/zalando/postgres-operator/blob/master/manifests/kustomization.yaml)
6060
(except for the CRD) - it can be used with kubectl 1.14 or newer as easy as:
6161

6262
```bash
6363
kubectl apply -k github.com/zalando/postgres-operator/manifests
6464
```
6565

6666
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).
6868
manifest.
6969

7070
```bash
@@ -114,8 +114,8 @@ In the following paragraphs we describe how to access and manage PostgreSQL
114114
clusters from the command line with kubectl. But it can also be done from the
115115
browser-based [Postgres Operator UI](operator-ui.md). Before deploying the UI
116116
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)
119119
of the UI.
120120

121121
To deploy the UI simply apply all its manifests files or use the UI helm chart:

docs/reference/cluster_manifest.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ Individual Postgres clusters are described by the Kubernetes *cluster manifest*
44
that has the structure defined by the `postgresql` CRD (custom resource
55
definition). The following section describes the structure of the manifest and
66
the purpose of individual keys. You can take a look at the examples of the
7-
[minimal](../../manifests/minimal-postgres-manifest.yaml)
7+
[minimal](https://github.com/zalando/postgres-operator/blob/master/manifests/minimal-postgres-manifest.yaml)
88
and the
9-
[complete](../../manifests/complete-postgres-manifest.yaml)
9+
[complete](https://github.com/zalando/postgres-operator/blob/master/manifests/complete-postgres-manifest.yaml)
1010
cluster manifests.
1111

1212
When Kubernetes resources, such as memory, CPU or volumes, are configured,

docs/reference/operator_parameters.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ configuration.
1010
maps. String values containing ':' should be enclosed in quotes. The
1111
configuration is flat, parameter group names below are not reflected in the
1212
configuration structure. There is an
13-
[example](../../manifests/configmap.yaml)
13+
[example](https://github.com/zalando/postgres-operator/blob/master/manifests/configmap.yaml)
1414

1515
* CRD-based configuration. The configuration is stored in a custom YAML
1616
manifest. The manifest is an instance of the custom resource definition (CRD)
1717
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)
1919
sets the `POSTGRES_OPERATOR_CONFIGURATION_OBJECT` env variable to a non-empty
2020
value. The variable should point to the `postgresql-operator-configuration`
2121
object in the operator's namespace.
@@ -24,7 +24,7 @@ configuration.
2424
simply represented in the usual YAML way. There are no default values built-in
2525
in the operator, each parameter that is not supplied in the configuration
2626
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)
2828
and change it.
2929

3030
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
5757
`CRD_READY_WAIT_INTERVAL` and `CRD_READY_WAIT_TIMEOUT` environment variables.
5858
They will be deprecated and removed in the future.
5959

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)
6161
mentioned here are likely to be overwritten in your local operator installation
6262
via your local version of the operator configmap. In the case you use the
6363
operator CRD, all the CRD defaults are provided in the
64-
[operator's default configuration manifest](../../manifests/postgresql-operator-default-configuration.yaml)
64+
[operator's default configuration manifest](https://github.com/zalando/postgres-operator/blob/master/manifests/postgresql-operator-default-configuration.yaml)
6565

6666
Variable names are underscore-separated words.
6767

@@ -154,7 +154,7 @@ Those are top-level keys, containing both leaf keys and groups.
154154
cluster nodes. This affects all containers created by the operator (Postgres,
155155
Scalyr sidecar, and other sidecars except **sidecars** defined in the operator
156156
configuration); to set resources for the operator's own container, change the
157-
[operator deployment manually](../../manifests/postgres-operator.yaml#L20).
157+
[operator deployment manually](https://github.com/zalando/postgres-operator/blob/master/manifests/postgres-operator.yaml#L20).
158158
The default is `false`.
159159

160160
## Postgres users
@@ -217,7 +217,7 @@ configuration they are grouped under the `kubernetes` key.
217217
sufficient for the pods to start and for Patroni to access K8s endpoints;
218218
service account on its own lacks any such rights starting with K8s v1.8. If
219219
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)
221221
will be used. The default is empty.
222222

223223
* **pod_terminate_grace_period**
@@ -602,7 +602,7 @@ Postgres logical backups. In the CRD-based configuration those parameters are
602602
grouped under the `logical_backup` key.
603603

604604
* **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)
606606
runs `pg_dumpall` on a replica if possible and uploads compressed results to
607607
an S3 bucket under the key `/spilo/pg_cluster_name/cluster_k8s_uuid/logical_backups`.
608608
The default image is the same image built with the Zalando-internal CI

0 commit comments

Comments
 (0)