Skip to content

Commit aa047e7

Browse files
authored
Merge pull request #6166 from EnterpriseDB/automatic_docs_update/repo_EnterpriseDB/cloud-native-postgres/ref_refs/tags/v1.24.1
Process changes to docs from: repo: EnterpriseDB/cloud-native-postgres ref: refs/tags/v1.24.1
2 parents 5a83801 + 145f81e commit aa047e7

36 files changed

+522
-1026
lines changed

product_docs/docs/postgres_for_kubernetes/1/addons.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -420,7 +420,7 @@ Kasten is a very popular data protection tool for Kubernetes, enabling backup
420420
and restore, disaster recovery, and application mobility for Kubernetes
421421
applications. For more information, see the [Kasten
422422
website](https://www.kasten.io/) and the [Kasten by Veeam Implementation
423-
Guide](https://www.enterprisedb.com/docs/partner_docs/KastenbyVeeam/)
423+
Guide](/partner_docs/KastenbyVeeam/)
424424
425425
In brief, to enable transparent integration with Kasten on an EDB Postgres for
426426
Kubernetes Cluster, you just need to add the `kasten` value to the
@@ -451,8 +451,8 @@ backup hooks through annotations and labels to that instance.
451451
`k8s.enterprisedb.io/snapshotAllowColdBackupOnPrimary: enabled`
452452

453453
For further guidance on how to configure and use Kasten, see the Implementation Guide's
454-
[Configuration](https://www.enterprisedb.com/docs/partner_docs/KastenbyVeeam/04-ConfiguringVeeamKasten/) and
455-
[Using](https://www.enterprisedb.com/docs/partner_docs/KastenbyVeeam/05-UsingVeeamKasten/) sections.
454+
[Configuration](/partner_docs/KastenbyVeeam/04-ConfiguringVeeamKasten/) and
455+
[Using](/partner_docs/KastenbyVeeam/05-UsingVeeamKasten/) sections.
456456

457457
### Limitations
458458

product_docs/docs/postgres_for_kubernetes/1/architecture.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ EDB Postgres for Kubernetes recommends using the `node-role.kubernetes.io/postgr
238238
To assign the `postgres` taint to a node, use the following command:
239239

240240
```sh
241-
kubectl taint node <NODE-NAME> node-role.kubernetes.io/postgres=:noSchedule
241+
kubectl taint node <NODE-NAME> node-role.kubernetes.io/postgres=:NoSchedule
242242
```
243243

244244
To ensure that a `Cluster` resource is scheduled on a node with a `postgres` taint, you must correctly configure the `.spec.affinity.tolerations` stanza in your manifests.

product_docs/docs/postgres_for_kubernetes/1/before_you_start.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ Superuser
132132
PVC group
133133
: A PVC group in EDB Postgres for Kubernetes' terminology is a group of related PVCs
134134
belonging to the same PostgreSQL instance, namely the main volume containing
135-
the PGDATA (`storage`) and the volume for WALs (`walStorage`).|
135+
the PGDATA (`storage`) and the volume for WALs (`walStorage`).
136136

137137
## Cloud terminology
138138

product_docs/docs/postgres_for_kubernetes/1/bootstrap.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -545,7 +545,7 @@ file on the source PostgreSQL instance:
545545
host replication streaming_replica all md5
546546
```
547547

548-
The following manifest creates a new PostgreSQL 16.4 cluster,
548+
The following manifest creates a new PostgreSQL 17.0 cluster,
549549
called `target-db`, using the `pg_basebackup` bootstrap method
550550
to clone an external PostgreSQL cluster defined as `source-db`
551551
(in the `externalClusters` array). As you can see, the `source-db`
@@ -560,7 +560,7 @@ metadata:
560560
name: target-db
561561
spec:
562562
instances: 3
563-
imageName: quay.io/enterprisedb/postgresql:16.4
563+
imageName: quay.io/enterprisedb/postgresql:17.0
564564
565565
bootstrap:
566566
pg_basebackup:
@@ -580,7 +580,7 @@ spec:
580580
```
581581

582582
All the requirements must be met for the clone operation to work, including
583-
the same PostgreSQL version (in our case 16.4).
583+
the same PostgreSQL version (in our case 17.0).
584584

585585
#### TLS certificate authentication
586586

@@ -595,7 +595,7 @@ in the same Kubernetes cluster.
595595
This example can be easily adapted to cover an instance that resides
596596
outside the Kubernetes cluster.
597597

598-
The manifest defines a new PostgreSQL 16.4 cluster called `cluster-clone-tls`,
598+
The manifest defines a new PostgreSQL 17.0 cluster called `cluster-clone-tls`,
599599
which is bootstrapped using the `pg_basebackup` method from the `cluster-example`
600600
external cluster. The host is identified by the read/write service
601601
in the same cluster, while the `streaming_replica` user is authenticated
@@ -610,7 +610,7 @@ metadata:
610610
name: cluster-clone-tls
611611
spec:
612612
instances: 3
613-
imageName: quay.io/enterprisedb/postgresql:16.4
613+
imageName: quay.io/enterprisedb/postgresql:17.0
614614
615615
bootstrap:
616616
pg_basebackup:

product_docs/docs/postgres_for_kubernetes/1/certificates.mdx

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,23 @@ generated outside CNP.
3535
names in user-provided certificates for the `<cluster>-rw` service used for
3636
communication within the cluster.
3737

38-
## Operator-managed mode
39-
40-
By default, the operator generates a single CA and uses it for both client and
41-
server certificates, which are then managed and renewed automatically.
38+
## Operator-Managed Mode
39+
40+
By default, the operator automatically generates a single Certificate Authority
41+
(CA) to issue both client and server certificates. These certificates are
42+
managed continuously by the operator, with automatic renewal 7 days before
43+
expiration (within a 90-day validity period).
44+
45+
!!! Info
46+
You can adjust this default behavior by configuring the
47+
`CERTIFICATE_DURATION` and `EXPIRING_CHECK_THRESHOLD` environment variables.
48+
For detailed guidance, refer to the [Operator Configuration](operator_conf.md).
49+
50+
!!! Important
51+
Certificate renewal does not cause any downtime for the PostgreSQL server,
52+
as a simple reload operation is sufficient. However, any user-managed
53+
certificates not controlled by EDB Postgres for Kubernetes must be re-issued following the
54+
renewal process.
4255

4356
### Server certificates
4457

product_docs/docs/postgres_for_kubernetes/1/container_images.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ with the following requirements:
2424
- PGAudit extension installed (optional - only if PGAudit is required
2525
in the deployed clusters)
2626
- Appropriate locale settings
27+
- `du` (optional, for `kubectl cnp status`)
2728

2829
!!! Important
2930
Only [PostgreSQL versions supported by the PGDG](https://postgresql.org/) are allowed.

product_docs/docs/postgres_for_kubernetes/1/declarative_hibernation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ $ kubectl cnp status <cluster-name>
6161
Cluster Summary
6262
Name: cluster-example
6363
Namespace: default
64-
PostgreSQL Image: quay.io/enterprisedb/postgresql:16.4
64+
PostgreSQL Image: quay.io/enterprisedb/postgresql:17.0
6565
Primary instance: cluster-example-2
6666
Status: Cluster in healthy state
6767
Instances: 3

product_docs/docs/postgres_for_kubernetes/1/evaluation.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ There are two ways to obtain the EDB Postgres Advanced Server image for evaluati
2121

2222
### EDB Image Repository
2323

24-
You can use EDB Postgres for Kubernetes with EDB Postgres Advanced Server. You can access the image by obtaining a repository access token to EDBs image repositories.
24+
You can use EDB Postgres for Kubernetes with EDB Postgres Advanced Server. You can access the image by obtaining a repository access token to EDB's image repositories.
2525

2626
### Obtaining your access token
2727

@@ -38,7 +38,7 @@ You can then use EDB Postgres Advanced Server by setting in the `spec` section o
3838
- `imageName` to point to the quay.io/enterprisedb/edb-postgres-advanced repository
3939
- `licenseKey` to your license key (in the form of a string)
4040

41-
To see how `imageName` and `licenseKey` is set, refer to the [cluster-full-example](https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/samples/cluster-example-full.yaml) file from the [configuration samples](https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/samples/) section.
41+
To see how `imageName` and `licenseKey` is set, refer to the [cluster-full-example](/postgres_for_kubernetes/latest/samples/cluster-example-full.yaml) file from the [configuration samples](/postgres_for_kubernetes/latest/samples/) section.
4242

4343
## Further Information
4444

product_docs/docs/postgres_for_kubernetes/1/image_catalog.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ spec:
3535
- major: 15
3636
image: quay.io/enterprisedb/postgresql:15.6
3737
- major: 16
38-
image: quay.io/enterprisedb/postgresql:16.4
38+
image: quay.io/enterprisedb/postgresql:17.0
3939
```
4040
4141
**Example of a Cluster-Wide Catalog using `ClusterImageCatalog` Resource:**
@@ -50,7 +50,7 @@ spec:
5050
- major: 15
5151
image: quay.io/enterprisedb/postgresql:15.6
5252
- major: 16
53-
image: quay.io/enterprisedb/postgresql:16.4
53+
image: quay.io/enterprisedb/postgresql:17.0
5454
```
5555

5656
A `Cluster` resource has the flexibility to reference either an `ImageCatalog`

product_docs/docs/postgres_for_kubernetes/1/index.mdx

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -106,11 +106,9 @@ EDB Postgres for Kubernetes was made generally available on February 4, 2021. Ea
106106
## Features unique to EDB Postgres of Kubernetes
107107

108108
- [Long Term Support](#long-term-support)
109-
- Red Hat certified operator for OpenShift
110109
- Support on IBM Power and z/Linux through partnership with IBM
111-
- [Oracle compatibility](https://www.enterprisedb.com/docs/epas/latest/fundamentals/epas_fundamentals/epas_compat_ora_dev_guide/) through EDB Postgres Advanced Sever
112-
- [Transparent Data Encryption (TDE)](https://www.enterprisedb.com/docs/tde/latest/) through EDB Postgres Advanced Server
113-
- EDB Postgres for Kubernetes Plugin
110+
- [Oracle compatibility](/epas/latest/fundamentals/epas_fundamentals/epas_compat_ora_dev_guide/) through EDB Postgres Advanced Sever
111+
- [Transparent Data Encryption (TDE)](/tde/latest/) through EDB Postgres Advanced Server
114112
- Cold backup support with Kasten and Velero/OADP
115113
- Generic adapter for third-party Kubernetes backup tools
116114

@@ -176,7 +174,7 @@ format for the following platforms: `linux/amd64`, `linux/arm64`, `linux/ppc64le
176174

177175
The following versions of Postgres are currently supported:
178176

179-
- PostgreSQL: 12 - 16
177+
- PostgreSQL: 12 - 17
180178
- EDB Postgres Advanced: 12 - 16
181179
- EDB Postgres Extended: 12 - 16
182180

product_docs/docs/postgres_for_kubernetes/1/installation_upgrade.mdx

Lines changed: 4 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@ The operator can be installed using the provided [Helm chart](https://github.com
2323
The operator can be installed like any other resource in Kubernetes,
2424
through a YAML manifest applied via `kubectl`.
2525

26-
You can install the [latest operator manifest](https://get.enterprisedb.io/cnp/postgresql-operator-1.24.0.yaml)
26+
You can install the [latest operator manifest](https://get.enterprisedb.io/cnp/postgresql-operator-1.24.1.yaml)
2727
for this minor release as follows:
2828

2929
```sh
3030
kubectl apply --server-side -f \
31-
https://get.enterprisedb.io/cnp/postgresql-operator-1.24.0.yaml
31+
https://get.enterprisedb.io/cnp/postgresql-operator-1.24.1.yaml
3232
```
3333

3434
You can verify that with:
@@ -66,35 +66,6 @@ for a more comprehensive example.
6666
one of the allowed ones, or open the webhooks' port (`9443`) on the
6767
firewall.
6868

69-
### Testing the latest development snapshot
70-
71-
If you want to test or evaluate the latest development snapshot of
72-
EDB Postgres for Kubernetes before the next official patch release, you can download the
73-
manifests from the
74-
[`cloudnative-pg/artifacts`](https://github.com/cloudnative-pg/artifacts)
75-
which provides easy access to the current trunk (main) as well as to each
76-
supported release.
77-
78-
For example, you can install the latest snapshot of the operator with:
79-
80-
```sh
81-
curl -sSfL \
82-
https://raw.githubusercontent.com/cloudnative-pg/artifacts/release-1.24/manifests/operator-manifest.yaml | \
83-
kubectl apply --server-side -f -
84-
```
85-
86-
If you are instead looking for the latest snapshot of the operator for this
87-
specific minor release, you can just run:
88-
89-
```sh
90-
curl -sSfL \
91-
https://raw.githubusercontent.com/cloudnative-pg/artifacts/main/manifests/operator-manifest.yaml | \
92-
kubectl apply --server-side -f -
93-
```
94-
95-
!!! Important
96-
Snapshots are not supported by the EDB Postgres for Kubernetes Community, and are not
97-
intended for use in production.
9869

9970
## Details about the deployment
10071

@@ -235,12 +206,9 @@ When versions are not directly upgradable, the old version needs to be
235206
removed before installing the new one. This won't affect user data but
236207
only the operator itself.
237208

238-
### Upgrading to 1.24.0 or 1.23.4
239209

240-
!!! Important
241-
We encourage all existing users of EDB Postgres for Kubernetes to upgrade to version
242-
1.24.0 or at least to the latest stable version of the minor release you are
243-
currently using (namely 1.23.4).
210+
211+
### Upgrading to 1.24 from a previous minor version
244212

245213
!!! Warning
246214
Every time you are upgrading to a higher minor release, make sure you

product_docs/docs/postgres_for_kubernetes/1/instance_manager.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Please refer to the ["Failover" section](failover.md) for details.
105105
## Disk Full Failure
106106

107107
Storage exhaustion is a well known issue for PostgreSQL clusters.
108-
The [PostgreSQL documentation](https://www.postgresql.org/docs/current/disk-full.html)
108+
The [PostgreSQL documentation](https://www.postgresql.org/docs/current/diskusage.html#DISK-FULL)
109109
highlights the possible failure scenarios and the importance of monitoring disk
110110
usage to prevent it from becoming full.
111111

product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ example using Docker:
4545
For installation, you will need a deployment manifest that points to your Iron
4646
Bank image.
4747
You can take the deployment manifest from the
48-
[installation instructions for EDB PG4K](https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/installation_upgrade/).
48+
[installation instructions for EDB PG4K](/postgres_for_kubernetes/latest/installation_upgrade/).
4949
For example, for the 1.22.0 release, the manifest is available at
5050
`https://get.enterprisedb.io/cnp/postgresql-operator-1.22.0.yaml`. \\
5151
There are a couple of places where you will need to set the image path for the
@@ -89,4 +89,4 @@ site, and from there, re-tag and publish it to a local registry, or push it
8989
directly to your Kubernetes nodes.
9090
9191
Once you have this in place, you can apply your manifest normally with
92-
`kubectl apply -f`, as described in the [installation instructions](https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/installation_upgrade/).
92+
`kubectl apply -f`, as described in the [installation instructions](/postgres_for_kubernetes/latest/installation_upgrade/).

0 commit comments

Comments
 (0)