Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ directoryDefaults:
version: "1.27.1"
displayBanner: |
We're preparing the next release of {{name.ln}}, and a release candidate is available.
For more information, see <a href="/docs/postgres_for_kubernetes/preview/preview_version/">the v1.28.0-rc1 documentation</a>
For more information, see <a href="/docs/postgres_for_kubernetes/preview/preview_version/">the v1.28.0-rc2 documentation</a>
navigation:
- rel_notes
- '!commercial_support.mdx'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ are not backwards compatible and could be removed entirely.

## Current Preview Version

The current preview version is **1.28.0-rc1**.
The current preview version is **1.28.0-rc2**.

For more information on the current preview version and how to test, please view the links below:

- [Announcement](/postgres_for_kubernetes/preview/rel_notes/1_28_0-rc1_rel_notes)
- [Announcement](/postgres_for_kubernetes/preview/rel_notes/1_28_0-rc2_rel_notes)
- [Documentation](/postgres_for_kubernetes/preview/)
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ as they can simply rely on the WAL archive to synchronize across long
distances, extending disaster recovery goals across different regions.

When you [configure a WAL archive](wal_archiving.md), {{name.ln}} provides
out-of-the-box an [RPO](before_you_start.md#rpo) &lt;= 5 minutes for disaster
out-of-the-box an [RPO](before_you_start.md#rpo) 5 minutes for disaster
recovery, even across regions.

!!! Important
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'Before You Start'
title: 'Before you start'
originalFilePath: 'src/before_you_start.md'
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'Instance pod configuration'
title: 'Instance Pod configuration'
originalFilePath: 'src/cluster_conf.md'
---

Expand Down
26 changes: 26 additions & 0 deletions product_docs/docs/postgres_for_kubernetes/preview/cnp_i.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,32 @@ spec:
You can provide your own certificate bundles, but the recommended method is
to use [Cert-manager](https://cert-manager.io).

#### Customizing the Certificate DNS Name

By default, {{name.ln}} uses the Service name as the server name for TLS
verification when connecting to the plugin. If your environment requires the
certificate to have a different DNS name (e.g., `barman-cloud.svc`), you can
customize it using the `k8s.enterprisedb.io/pluginServerName` annotation:

```yaml
apiVersion: v1
kind: Service
metadata:
annotations:
k8s.enterprisedb.io/pluginClientSecret: cnpg-i-plugin-example-client-tls
k8s.enterprisedb.io/pluginServerSecret: cnpg-i-plugin-example-server-tls
k8s.enterprisedb.io/pluginPort: "9090"
k8s.enterprisedb.io/pluginServerName: barman-cloud.svc
name: barman-cloud
namespace: postgresql-operator-system
spec:
[...]
```

This allows the operator to verify the plugin's certificate against the
specified DNS name instead of the default Service name. The server certificate
must include this DNS name in its Subject Alternative Names (SAN).

## Using a plugin

To enable a plugin, configure the `.spec.plugins` section in your `Cluster`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'Connection pooling'
title: 'Connection Pooling'
originalFilePath: 'src/connection_pooling.md'
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'PostgreSQL Database Management'
title: 'PostgreSQL Database management'
originalFilePath: 'src/declarative_database_management.md'
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'PostgreSQL Role Management'
title: 'PostgreSQL Role management'
originalFilePath: 'src/declarative_role_management.md'
---

Expand Down
4 changes: 2 additions & 2 deletions product_docs/docs/postgres_for_kubernetes/preview/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: The {{name.ln}} operator is a fork based on CloudNativePG™ which
originalFilePath: src/index.md
indexCards: none
directoryDefaults:
version: "1.28.0-rc1"
version: "1.28.0-rc2"
displayBanner: |
This documentation covers the upcoming release of
{{name.ln}}; you may want to read the docs for
Expand Down Expand Up @@ -166,7 +166,7 @@ version for 12-18 months before upgrading.

{{name.ln}} works with both PostgreSQL, EDB Postgres Extended and EDB Postgres
Advanced server, and is available under the
[EDB Limited Use License](https://www.enterprisedb.com/limited-use-license).
[EDB End User License Agreement](https://www.enterprisedb.com/legal/EDB-Eula).

You can [evaluate {{name.ln}} for free](evaluation.md) as part of a trial subscription.
You need a valid EDB subscription to use {{name.ln}} in production.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ You can install the manifest for the latest version of the operator by running:

```sh
kubectl apply --server-side -f \
https://get.enterprisedb.io/pg4k/pg4k-1.28.0-rc1.yaml
https://get.enterprisedb.io/pg4k/pg4k-1.28.0-rc2.yaml
```

You can verify that with:
Expand Down Expand Up @@ -155,8 +155,7 @@ plane for self-managed Kubernetes installations).
## Upgrades

!!! Warning CRITICAL WARNING: UPGRADING OPERATORS

OpenShift users, or any customer attempting an operator upgrade, MUST configure the new unified repository pull secret (docker.enterprisedb.com/k8s) before running the upgrade. If the old, deprecated repository path is still in use during the upgrade process, image pull failure will occur, leading to deployment failure and potential downtime. Follow the [Central Migration Guide](migrating_edb_registries) first.
OpenShift users, or any customer attempting an operator upgrade, MUST configure the new unified repository pull secret (docker.enterprisedb.com/k8s) before running the upgrade. If the old, deprecated repository path is still in use during the upgrade process, image pull failure will occur, leading to deployment failure and potential downtime. Follow the [Central Migration Guide](/postgres_for_kubernetes/latest/migrating_edb_registries) first.

!!! Important
Please carefully read the [release notes](rel_notes)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'Postgres instance manager'
title: 'Postgres Instance Manager'
originalFilePath: 'src/instance_manager.md'
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,11 @@ them in your systems.

#### Debian packages

For example, let's install the 1.28.0-rc1 release of the plugin, for an Intel based
For example, let's install the 1.28.0-rc2 release of the plugin, for an Intel based
64 bit server. First, we download the right `.deb` file.

```sh
wget https://github.com/EnterpriseDB/kubectl-cnp/releases/download/v1.28.0-rc1/kubectl-cnp_1.28.0-rc1_linux_x86_64.deb \
wget https://github.com/EnterpriseDB/kubectl-cnp/releases/download/v1.28.0-rc2/kubectl-cnp_1.28.0-rc2_linux_x86_64.deb \
--output-document kube-plugin.deb
```

Expand All @@ -50,17 +50,17 @@ $ sudo dpkg -i kube-plugin.deb
Selecting previously unselected package cnp.
(Reading database ... 6688 files and directories currently installed.)
Preparing to unpack kube-plugin.deb ...
Unpacking kubectl-cnp (1.28.0-rc1) ...
Setting up kubectl-cnp (1.28.0-rc1) ...
Unpacking kubectl-cnp (1.28.0-rc2) ...
Setting up kubectl-cnp (1.28.0-rc2) ...
```

#### RPM packages

As in the example for `.rpm` packages, let's install the 1.28.0-rc1 release for an
As in the example for `.rpm` packages, let's install the 1.28.0-rc2 release for an
Intel 64 bit machine. Note the `--output` flag to provide a file name.

```sh
curl -L https://github.com/EnterpriseDB/kubectl-cnp/releases/download/v1.28.0-rc1/kubectl-cnp_1.28.0-rc1_linux_x86_64.rpm \
curl -L https://github.com/EnterpriseDB/kubectl-cnp/releases/download/v1.28.0-rc2/kubectl-cnp_1.28.0-rc2_linux_x86_64.rpm \
--output kube-plugin.rpm
```

Expand All @@ -74,7 +74,7 @@ Dependencies resolved.
Package Architecture Version Repository Size
====================================================================================================
Installing:
cnp x86_64 1.28.0-rc1-1 @commandline 20 M
cnp x86_64 1.28.0-rc2-1 @commandline 20 M

Transaction Summary
====================================================================================================
Expand Down Expand Up @@ -243,9 +243,9 @@ sandbox-3 0/604DE38 0/604DE38 0/604DE38 0/604DE38 00:00:00 00:00:00 00
Instances status
Name Current LSN Replication role Status QoS Manager Version Node
---- ----------- ---------------- ------ --- --------------- ----
sandbox-1 0/604DE38 Primary OK BestEffort 1.28.0-rc1 k8s-eu-worker
sandbox-2 0/604DE38 Standby (async) OK BestEffort 1.28.0-rc1 k8s-eu-worker2
sandbox-3 0/604DE38 Standby (async) OK BestEffort 1.28.0-rc1 k8s-eu-worker
sandbox-1 0/604DE38 Primary OK BestEffort 1.28.0-rc2 k8s-eu-worker
sandbox-2 0/604DE38 Standby (async) OK BestEffort 1.28.0-rc2 k8s-eu-worker2
sandbox-3 0/604DE38 Standby (async) OK BestEffort 1.28.0-rc2 k8s-eu-worker
```

If you require more detailed status information, use the `--verbose` option (or
Expand Down Expand Up @@ -299,9 +299,9 @@ sandbox-primary primary 1 1 1
Instances status
Name Current LSN Replication role Status QoS Manager Version Node
---- ----------- ---------------- ------ --- --------------- ----
sandbox-1 0/6053720 Primary OK BestEffort 1.28.0-rc1 k8s-eu-worker
sandbox-2 0/6053720 Standby (async) OK BestEffort 1.28.0-rc1 k8s-eu-worker2
sandbox-3 0/6053720 Standby (async) OK BestEffort 1.28.0-rc1 k8s-eu-worker
sandbox-1 0/6053720 Primary OK BestEffort 1.28.0-rc2 k8s-eu-worker
sandbox-2 0/6053720 Standby (async) OK BestEffort 1.28.0-rc2 k8s-eu-worker2
sandbox-3 0/6053720 Standby (async) OK BestEffort 1.28.0-rc2 k8s-eu-worker
```

With an additional `-v` (e.g. `kubectl cnp status sandbox -v -v`), you can
Expand Down Expand Up @@ -524,12 +524,12 @@ Archive: report_operator_<TIMESTAMP>.zip

```output
====== Begin of Previous Log =====
2023-03-28T12:56:41.251711811Z {"level":"info","ts":"2023-03-28T12:56:41Z","logger":"setup","msg":"Starting EDB Postgres for Kubernetes Operator","version":"1.28.0-rc1","build":{"Version":"1.28.0-rc1+dev107","Commit":"cc9bab17","Date":"2023-03-28"}}
2023-03-28T12:56:41.251711811Z {"level":"info","ts":"2023-03-28T12:56:41Z","logger":"setup","msg":"Starting EDB Postgres for Kubernetes Operator","version":"1.28.0-rc2","build":{"Version":"1.28.0-rc2+dev107","Commit":"cc9bab17","Date":"2023-03-28"}}
2023-03-28T12:56:41.251851909Z {"level":"info","ts":"2023-03-28T12:56:41Z","logger":"setup","msg":"Starting pprof HTTP server","addr":"0.0.0.0:6060"}
<snipped …>

====== End of Previous Log =====
2023-03-28T12:57:09.854306024Z {"level":"info","ts":"2023-03-28T12:57:09Z","logger":"setup","msg":"Starting EDB Postgres for Kubernetes Operator","version":"1.28.0-rc1","build":{"Version":"1.28.0-rc1+dev107","Commit":"cc9bab17","Date":"2023-03-28"}}
2023-03-28T12:57:09.854306024Z {"level":"info","ts":"2023-03-28T12:57:09Z","logger":"setup","msg":"Starting EDB Postgres for Kubernetes Operator","version":"1.28.0-rc2","build":{"Version":"1.28.0-rc2+dev107","Commit":"cc9bab17","Date":"2023-03-28"}}
2023-03-28T12:57:09.854363943Z {"level":"info","ts":"2023-03-28T12:57:09Z","logger":"setup","msg":"Starting pprof HTTP server","addr":"0.0.0.0:6060"}
```

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'Kubernetes Upgrade and Maintenance'
title: 'Kubernetes upgrade and maintenance'
originalFilePath: 'src/kubernetes_upgrade.md'
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'Labels and annotations'
title: 'Labels and Annotations'
originalFilePath: 'src/labels_annotations.md'
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ License keys are a legacy management mechanism for {{name.ln}}. You do not need
If you are not using an EDB subscription token and installing from public repositories, then you will need a license key. The only exception is when you run the operator with Community PostgreSQL: in this case, if the license key is unset, a cluster will be started with the default trial license - which automatically expires after 30 days. This is not the recommended way of trialing {{name.ln}} - see the [installation guide](installation_upgrade.md) for the recommended options.

!!! Warning CRITICAL WARNING: UPGRADING OPERATORS

OpenShift users, or any customer attempting an operator upgrade, MUST configure the new unified repository pull secret (docker.enterprisedb.com/k8s) before running the upgrade. If the old, deprecated repository path is still in use during the upgrade process, image pull failure will occur, leading to deployment failure and potential downtime. Follow the [Central Migration Guide](migrating_edb_registries) first.
OpenShift users, or any customer attempting an operator upgrade, MUST configure the new unified repository pull secret (docker.enterprisedb.com/k8s) before running the upgrade. If the old, deprecated repository path is still in use during the upgrade process, image pull failure will occur, leading to deployment failure and potential downtime. Follow the [Central Migration Guide](/postgres_for_kubernetes/latest/migrating_edb_registries) first.

The following documentation is only for users who have installed the operator using a license key.

Expand Down Expand Up @@ -96,8 +95,8 @@ This field will take precedence over `licenseKey`: it will be refreshed
when you change the secret, in order to extend the expiration date, or switching from a trial
license to a production license.

{{name.ln}} is distributed under the EDB Limited Usage License
Agreement, available at [enterprisedb.com/limited-use-license](https://www.enterprisedb.com/limited-use-license).
{{name.ln}} is distributed under the EDB End User License
Agreement, available at [enterprisedb.com/legal/EDB-Eula](https://www.enterprisedb.com/legal/EDB-Eula).

{{name.ln}}: Copyright (C) 2019-2022 EnterpriseDB Corporation.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ cnp_collector_up{cluster="cluster-example"} 1

# HELP cnp_collector_postgres_version Postgres version
# TYPE cnp_collector_postgres_version gauge
cnp_collector_postgres_version{cluster="cluster-example",full="17.6"} 17.6
cnp_collector_postgres_version{cluster="cluster-example",full="18.1"} 18.1

# HELP cnp_collector_last_failed_backup_timestamp The last failed backup as a unix timestamp (Deprecated)
# TYPE cnp_collector_last_failed_backup_timestamp gauge
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: 'Red Hat OpenShift'
originalFilePath: 'src/openshift.md'
---


{{name.ln}} is certified to run on
[Red Hat OpenShift Container Platform (OCP) version 4.x](https://www.openshift.com/products/container-platform)
and is available directly from the
Expand Down Expand Up @@ -243,8 +242,7 @@ release.
Please refer to ["Accessing EDB private image registries"](private_edb_registries.md) for further details.

!!! Warning CRITICAL WARNING: UPGRADING OPERATORS

OpenShift users, or any customer attempting an operator upgrade, MUST configure the new unified repository pull secret (docker.enterprisedb.com/k8s) before running the upgrade. If the old, deprecated repository path is still in use during the upgrade process, image pull failure will occur, leading to deployment failure and potential downtime. Follow the [Central Migration Guide](migrating_edb_registries) first.
OpenShift users, or any customer attempting an operator upgrade, MUST configure the new unified repository pull secret (docker.enterprisedb.com/k8s) before running the upgrade. If the old, deprecated repository path is still in use during the upgrade process, image pull failure will occur, leading to deployment failure and potential downtime. Follow the [Central Migration Guide](/postgres_for_kubernetes/latest/migrating_edb_registries) first.

The OpenShift install will use pull secrets in order to access the
operand and operator images, which are held in a private repository.
Expand Down Expand Up @@ -385,8 +383,7 @@ different projects. In this case, make sure you read
for information on how to install the `oc` command-line interface.

!!! Warning CRITICAL WARNING: UPGRADING OPERATORS

OpenShift users, or any customer attempting an operator upgrade, MUST configure the new unified repository pull secret (docker.enterprisedb.com/k8s) before running the upgrade. If the old, deprecated repository path is still in use during the upgrade process, image pull failure will occur, leading to deployment failure and potential downtime. Follow the [Central Migration Guide](migrating_edb_registries) first.
OpenShift users, or any customer attempting an operator upgrade, MUST configure the new unified repository pull secret (docker.enterprisedb.com/k8s) before running the upgrade. If the old, deprecated repository path is still in use during the upgrade process, image pull failure will occur, leading to deployment failure and potential downtime. Follow the [Central Migration Guide](/postgres_for_kubernetes/latest/migrating_edb_registries) first.

Instead of using the OpenShift Container Platform web console, you can install
the {{name.ln}} Operator from the OperatorHub and create a
Expand Down
Loading