Skip to content

Commit 8a48507

Browse files
author
Jonathan S. Katz
committed
Several documentation updates
1 parent 081b9d3 commit 8a48507

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

docs/content/custom-resources/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -464,7 +464,7 @@ There are two Secrets that need to be created:
464464
1. A Secret containing the certificate authority (CA). You may only need to create this Secret once, as a CA certificate can be shared amongst your clusters.
465465
2. A Secret that contains the TLS private key & certificate.
466466

467-
This assumes that you have already [generated your TLS certificates](https://www.postgresql.org/docs/current/ssl-tcp.html#SSL-CERTIFICATE-CREATION) where the CA is named `ca.crt` and the server key and certificate are named `server.key` and `server.crt` respectively.
467+
This assumes that you have already [generated your TLS certificates](https://blog.crunchydata.com/blog/tls-postgres-kubernetes-openssl) where the CA is named `ca.crt` and the server key and certificate are named `server.key` and `server.crt` respectively.
468468

469469
Substitute the correct values for your environment into the environmental variables in the example below:
470470

docs/content/pgo-client/common-tasks.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1040,7 +1040,7 @@ There are a variety of methods available to generate these items: in fact,
10401040
Kubernetes comes with its own [certificate management system](https://kubernetes.io/docs/tasks/tls/managing-tls-in-a-cluster/)!
10411041
It is up to you to decide how you want to manage this for your cluster. The
10421042
PostgreSQL documentation also provides an example for how to
1043-
[generate a TLS certificate](https://www.postgresql.org/docs/current/ssl-tcp.html#SSL-CERTIFICATE-CREATION)
1043+
[generate a TLS certificate](https://blog.crunchydata.com/blog/tls-postgres-kubernetes-openssl)
10441044
as well.
10451045

10461046
To set up TLS for your PostgreSQL cluster, you have to create two [Secrets](https://kubernetes.io/docs/concepts/configuration/secret/):
@@ -1191,7 +1191,7 @@ pgo create cluster hippo \
11911191
```
11921192

11931193
By default, the PostgreSQL Operator has each replica connect to PostgreSQL using
1194-
a [PostgreSQL TLS mode](https://www.postgresql.org/docs/current/libpq-ssl.html#LIBPQ-SSL-SSLMODE-STATEMENTS)
1194+
a [PostgreSQL TLS mode](https://blog.crunchydata.com/blog/tls-postgres-kubernetes-openssl)
11951195
of `verify-ca`. If you wish to perform TLS mutual authentication between
11961196
PostgreSQL instances (i.e. certificate-based authentication with SSL mode of
11971197
`verify-full`), you will need to create a

docs/content/releases/4.7.0.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ The `pgclusters.crunchydata.com` custom resource now allows for the following at
115115

116116
Additionally, the following flags are now available on the [`pgo update cluster`](https://access.crunchydata.com/documentation/postgres-operator/latest/pgo-client/reference/pgo_update_cluster/) command:
117117

118-
- `--disable-tls`: removes TLS from a cluster
118+
- `--disable-server-tls`: removes TLS from a cluster
119119
- `--disable-tls-only`: removes the TLS-only requirement from a cluster
120120
- `--enable-tls-only`: adds the TLS-only requirement to a cluster
121121
- `--server-ca-secret`: combined with `--server-tls-secret`, enables TLS in a cluster
@@ -167,6 +167,6 @@ Note that PGO will rewrite some of your HBA rules when performing any TLS enable
167167
- Support the substitution for the limit on the number of queries to include the the `pg_stat_statements` support of pgMonitor. Defaults to 20, which is the pgMonitor upstream value. Contributed by Steven Siahetiong (@ssiahetiong).
168168
- Ensure `sshd_config` is correctly set on an upgrade. This could have manifested with some pgBackRest functionality not working. This can be manually fixed by setting `UsePAM no` in the `sshd_config` file in a cluster. Reported by (@douggutaby)
169169
- Ensure major upgrades via `crunchy-upgrade` support PostgreSQL 12 and PostgreSQL 13. Reported by (@lbartnicki92).
170-
- The `pgo-deployer` and Ansible installer will no longer create an initial TLS secret for the PGO apiserver. PGO apiserver has been able to self-create this for a long time, and PGO defers to that. This fixes an issue that occurred on newer builds where certificates generated by OPenSSL contained incomplete usage blocks, which could cause for these certificates to be properly outright rejected.
170+
- The `pgo-deployer` and Ansible installer will no longer create an initial TLS secret for the PGO apiserver. PGO apiserver has been able to self-create this for a long time, and PGO defers to that. This fixes an issue that occurred on newer builds where certificates generated by OpenSSL contained incomplete usage blocks, which could cause for these certificates to be properly outright rejected.
171171
- Fix installed RBAC permissions via OLM. Reported by Tim Bo (@timbrd), with additional analysis from Aleksander Roszig (@AleksanderRoszig) and Eric Ace (@aceeric).
172172
- Fix nonbreaking error message that occurs when `pgo-scheduler` container shuts down in the UBI 8 base container.

docs/content/tutorial/tls.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ There are three items that are required to enable TLS in your PostgreSQL cluster
1515
- A TLS private key
1616
- A TLS certificate
1717

18-
There are a variety of methods available to generate these items: in fact, Kubernetes comes with its own [certificate management system](https://kubernetes.io/docs/tasks/tls/managing-tls-in-a-cluster/)! It is up to you to decide how you want to manage this for your cluster. The PostgreSQL documentation also provides an example for how to [generate a TLS certificate](https://www.postgresql.org/docs/current/ssl-tcp.html#SSL-CERTIFICATE-CREATION) as well.
18+
There are a variety of methods available to generate these items: in fact, Kubernetes comes with its own [certificate management system](https://kubernetes.io/docs/tasks/tls/managing-tls-in-a-cluster/)! It is up to you to decide how you want to manage this for your cluster. The PostgreSQL documentation also provides an example for how to [generate a TLS certificate](https://blog.crunchydata.com/blog/tls-postgres-kubernetes-openssl) as well.
1919

2020
To set up TLS for your PostgreSQL cluster, you have to create two [Secrets](https://kubernetes.io/docs/concepts/configuration/secret/): one that contains the CA certificate, and the other that contains the server TLS key pair.
2121

0 commit comments

Comments
 (0)