Skip to content

Process changes to docs from: repo: EnterpriseDB/cloud-native-postgres ref: refs/heads/main #3063

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
github-actions wants to merge 1 commit into
base: develop
Choose a base branch
from
Draft

Process changes to docs from: repo: EnterpriseDB/cloud-native-postgres ref: refs/heads/main #3063

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion product_docs/docs/postgres_for_kubernetes/1/imagevolume_extensions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Extension images must be built according to the
To use image volume extensions with {{name.ln}}, you need:

- **PostgreSQL 18 or later**, with support for `extension_control_path`.
- **Kubernetes 1.33**, with the `ImageVolume` feature gate enabled.
- **Kubernetes 1.35** or later (1.33 and 1.34 with the `ImageVolume` feature gate enabled).
- **Container runtime with `ImageVolume` support**:
- `containerd` v2.1.0 or later, or
- `CRI-O` v1.31 or later.
Expand Down
2 changes: 1 addition & 1 deletion product_docs/docs/postgres_for_kubernetes/1/installation_upgrade.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ kubectl create secret -n postgresql-operator-system docker-registry edb-pull-sec
Now that the pull-secret has been added to the namespace, the operator can be installed like any other resource in Kubernetes,
through a YAML manifest applied via `kubectl`.

You can install the [latest operator manifest](https://get.enterprisedb.io/pg4k/pg4k-1.28.0.yaml)
You can install the [latest operator manifest](https://get.enterprisedb.io/pg4k/pg4k-1.28.1.yaml)
for this minor release as follows:

```sh
Expand Down
2 changes: 1 addition & 1 deletion product_docs/docs/postgres_for_kubernetes/1/kubectl-plugin.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Dependencies resolved.
Package Architecture Version Repository Size
====================================================================================================
Installing:
cnp x86_64 1.28.1 @commandline 20 M
cnp x86_64 1.28.1-1 @commandline 20 M

Transaction Summary
====================================================================================================
Expand Down
123 changes: 10 additions & 113 deletions ...stgres_for_kubernetes/1/pg4k.v1/index.mdx → ...for_kubernetes/1/pg4k.v1/v1.28.1-next.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,113 +1,7 @@
---
title: API Reference - v1.28.1
originalFilePath: src/pg4k.v1.md
navTitle: API Reference
navigation:
- v1.28.1
- v1.28.0
- v1.27.1
- v1.27.0
- v1.26.1
- v1.26.0
- v1.25.1
- v1.25.0
- v1.24.3
- v1.24.2
- v1.24.1
- v1.24.0
- v1.23.6
- v1.23.5
- v1.23.4
- v1.23.3
- v1.23.2
- v1.23.1
- v1.23.0
- v1.22.9
- v1.22.8
- v1.22.7
- v1.22.6
- v1.22.5
- v1.22.4
- v1.22.3
- v1.22.2
- v1.22.1
- v1.22.0
- v1.21.6
- v1.21.5
- v1.21.4
- v1.21.3
- v1.21.2
- v1.21.1
- v1.21.0
- v1.20.6
- v1.20.5
- v1.20.4
- v1.20.3
- v1.20.2
- v1.20.1
- v1.20.0
- v1.19.6
- v1.19.5
- v1.19.4
- v1.19.3
- v1.19.2
- v1.19.1
- v1.19.0
- v1.18.13
- v1.18.12
- v1.18.11
- v1.18.10
- v1.18.9
- v1.18.8
- v1.18.7
- v1.18.6
- v1.18.5
- v1.18.4
- v1.18.3
- v1.18.2
- v1.18.1
- v1.18.0
- v1.17.5
- v1.17.4
- v1.17.3
- v1.17.2
- v1.17.1
- v1.17.0
- v1.16.5
- v1.16.4
- v1.16.3
- v1.16.2
- v1.16.1
- v1.16.0
- v1.15.5
- v1.15.4
- v1.15.3
- v1.15.2
- v1.15.1
- v1.15.0
- v1.14.0
- v1.13.0
- v1.12.0
- v1.11.0
- v1.10.0
- v1.9.2
- v1.9.1
- v1.9.0
- v1.8.0
- v1.7.1
- v1.7.0
- v1.6.0
- v1.5.1
- v1.5.0
- v1.4.0
- v1.3.0
- v1.2.1
- v1.2.0
- v1.1.0
- v1.0.0
- v0.8.0
- v0.7.0
- v0.6.0
title: API Reference - v1.28.1-next
navTitle: v1.28.1-next
pdfExclude: 'true'

---

Expand Down Expand Up @@ -319,8 +213,10 @@ BackupStatus defines the observed state of Backup
| `backupId` *string* | The ID of the Barman backup | | | |
| `backupName` *string* | The Name of the Barman backup | | | |
| `phase` *[BackupPhase](#backupphase)* | The last backup status | | | |
| `startedAt` *[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#time-v1-meta)* | When the backup was started | | | |
| `stoppedAt` *[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#time-v1-meta)* | When the backup was terminated | | | |
| `startedAt` *[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#time-v1-meta)* | When the backup execution was started by the backup tool | | | |
| `stoppedAt` *[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#time-v1-meta)* | When the backup execution was terminated by the backup tool | | | |
| `reconciliationStartedAt` *[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#time-v1-meta)* | When the backup process was started by the operator | | | |
| `reconciliationTerminatedAt` *[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#time-v1-meta)* | When the reconciliation was terminated by the operator (either successfully or not) | | | |
| `beginWal` *string* | The starting WAL | | | |
| `endWal` *string* | The ending WAL | | | |
| `beginLSN` *string* | The starting xlog | | | |
Expand Down Expand Up @@ -1632,8 +1528,9 @@ PostgresConfiguration defines the PostgreSQL configuration

*Underlying type:* *string*

PrimaryUpdateMethod contains the method to use when upgrading
the primary server of the cluster as part of rolling updates
PrimaryUpdateMethod defines the method to use when upgrading
the primary instance of the cluster as part of rolling updates.
The default method is "restart"

*Appears in:*

Expand Down
6 changes: 3 additions & 3 deletions product_docs/docs/postgres_for_kubernetes/1/rolling_update.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ updated.

When `primaryUpdateStrategy` is set to `unsupervised`, the rolling update
process is managed by Kubernetes and is entirely automated. Once the replicas
have been upgraded, the selected `primaryUpdateMethod` operation will initiate
on the primary. This is the default behavior.
have been upgraded, the selected `primaryUpdateMethod` operation will be executed
on the primary. Unsupervised update is the default behavior.

The `primaryUpdateMethod` option accepts one of the following values:

Expand Down Expand Up @@ -76,7 +76,7 @@ requirements in terms of [RPO](before_you_start.md#postgresql-terminology) and
[RTO](before_you_start.md#postgresql-terminology), whether your PostgreSQL architecture is shared
or shared nothing, and so on.

Indeed, being PostgreSQL a primary/standby architecture database management
Indeed, since PostgreSQL is a primary/standby architecture database management
system, the update process inevitably generates a downtime for your
applications. One important aspect to consider for your context is the time it
takes for your pod to download the new PostgreSQL container image, as that
Expand Down
4 changes: 2 additions & 2 deletions product_docs/docs/postgres_for_kubernetes/1/samples.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,9 +129,9 @@ For a list of available options, see [API reference](pg4k.v1.md).

## PostGIS

**PostGIS example**
**PostGIS example with image volume extensions**
: [`postgis-example.yaml`](../samples/postgis-example.yaml):
An example of a PostGIS cluster. See [PostGIS](postgis.md) for details.
An example of a PostGIS cluster using image volume extensions. See [PostGIS](postgis.md) for details.

## Managed roles

Expand Down
19 changes: 15 additions & 4 deletions product_docs/docs/postgres_for_kubernetes/1/samples/postgis-example.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,19 @@ kind: Cluster
metadata:
name: postgis-example
spec:
imageName: docker.enterprisedb.com/k8s_enterprise/postgresql:18.1-minimal-ubi9
instances: 1
imageName: docker.enterprisedb.com/k8s/postgresql:18-postgis-ubi9

storage:
size: 1Gi

postgresql:
parameters:
log_statement: ddl
extensions:
- name: postgis
image:
reference: ghcr.io/cloudnative-pg/postgis-extension:3.6.1-18-trixie
ld_library_path:
- system
---
apiVersion: postgresql.k8s.enterprisedb.io/v1
kind: Database
Expand All @@ -22,6 +28,11 @@ spec:
name: postgis-example
extensions:
- name: postgis
- name: postgis_topology
version: '3.6.1'
- name: postgis_raster
- name: postgis_sfcgal
- name: fuzzystrmatch
- name: address_standardizer
- name: address_standardizer_data_us
- name: postgis_tiger_geocoder
- name: postgis_topology