diff --git a/product_docs/docs/postgres_distributed_for_kubernetes/1/architecture.mdx b/product_docs/docs/postgres_distributed_for_kubernetes/1/architecture.mdx index ebe98c9cf17..94c12537ef2 100644 --- a/product_docs/docs/postgres_distributed_for_kubernetes/1/architecture.mdx +++ b/product_docs/docs/postgres_distributed_for_kubernetes/1/architecture.mdx @@ -193,7 +193,6 @@ requirements. For more information, see ["Connectivity"](connectivity.md). !!! Note Regions and availability zones - When creating Kubernetes clusters in different regions or availability zones for cross-regional replication, ensure the clusters can communicate with each other by enabling network connectivity. Specifically, every service created with a `-node` or `-group` suffix must be discoverable by all other `-node` and `-group` services. You can achieve this by deploying a network connectivity application like [Submariner](https://submariner.io/) on every cluster. diff --git a/product_docs/docs/postgres_distributed_for_kubernetes/1/installation_upgrade.mdx b/product_docs/docs/postgres_distributed_for_kubernetes/1/installation_upgrade.mdx index 096f5075247..820911a07c2 100644 --- a/product_docs/docs/postgres_distributed_for_kubernetes/1/installation_upgrade.mdx +++ b/product_docs/docs/postgres_distributed_for_kubernetes/1/installation_upgrade.mdx @@ -4,7 +4,6 @@ originalFilePath: 'src/installation_upgrade.md' --- !!! Seealso "OpenShift" - For instructions on how to install Cloud Native PostgreSQL on Red Hat OpenShift Container Platform, please refer to the ["OpenShift"](openshift.md) section. @@ -14,7 +13,6 @@ originalFilePath: 'src/installation_upgrade.md' ### Obtaining an EDB subscription token !!! Important - You must obtain an EDB subscription token to install EDB Postgres Distributed for Kubernetes. Without a token, you will not be able to access the EDB private software repositories. @@ -42,7 +40,6 @@ EDB_SUBSCRIPTION_TOKEN= ``` !!! Warning - The token is sensitive information. Please ensure that you don't expose it to unauthorized users. You can now proceed with the installation. @@ -52,7 +49,6 @@ You can now proceed with the installation. The operator can be installed using the provided [Helm chart](https://github.com/EnterpriseDB/edb-postgres-for-kubernetes-charts). !!! Info - For more details on the Helm chart, see the [Helm chart repo documentation](https://github.com/EnterpriseDB/edb-postgres-for-kubernetes-charts). @@ -79,12 +75,16 @@ helm repo add edb \ https://enterprisedb.github.io/edb-postgres-for-kubernetes-charts/ ``` -#### Deploy the images +#### Deploy the operator -The helm command below will deploy the operator to the namespace `pgd-operator-pgd`. -The container images for both the operator and the selected operand are downloaded -from the `global.repository`. The credentials used to pull image are +The helm command provided below will deploy the operator into the `pgd-operator-pgd` +namespace. The container images for both the operator and the selected operand are +downloaded from the `global.repository`. The credentials for pulling the images are specified by `image.imageCredentials.username` and `image.imageCredentials.password`. +Additionally, this helm command creates the operator configuration ConfigMap +`pgd-operator-controller-manager-config`, which contains default values for the pgd +and proxy operand images. The default operand images will be used for any pgd clusters +created afterwards. For more details, please refer to the [operator configuration](operator_conf.md). ```shell helm upgrade --dependency-update \ @@ -99,7 +99,6 @@ helm upgrade --dependency-update \ ``` !!! Note - The Helm command above will also install the cert-manager. If you already have cert-manager installed, please add `--set cert-manager.enabled=false`. For more information, see [Deploying the PG4K-PGD operators and cert-manager individually](https://enterprisedb.github.io/edb-postgres-for-kubernetes-charts/#deploying-the-pg4k-pgd-operators-and-cert-manager-individually) @@ -121,6 +120,11 @@ creating PGD clusters. See the ### Directly using the operator manifest +We can also deploy the EDB Postgres Distributed for Kubernetes operator directly using the manifest. +This manifest will install both EDB Postgres Distributed for Kubernetes operator and the latest +supported EDB Postgres for Kubernetes operator in the same namespace. To deploy the operators +using the manifest, follow the steps below: + #### Install the cert-manager EDB Postgres Distributed for Kubernetes requires Cert Manager 1.10 or higher. Following the @@ -153,7 +157,7 @@ kubectl create secret -n pgd-operator-system docker-registry edb-pull-secret \ --docker-password=${EDB_SUBSCRIPTION_TOKEN} ``` -#### Install the EDB Postgres Distributed for Kubernetes operator +#### Install the operator manifest 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`. @@ -177,7 +181,6 @@ kubectl get deployment -n pgd-operator-system pgd-operator-controller-manager ``` !!! Note - As EDB Postgres Distributed for Kubernetes internally manages each PGD node using the `Cluster` resource as defined by EDB Postgres for Kubernetes, we also need to have the EDB Postgres for Kubernetes operator installed as a dependency. The manifest mentioned @@ -193,7 +196,6 @@ When installed via Helm, by default, the deployment name is derived from the hel suffix `-edb-postgres-distributed-for-kubernetes` (e.g., `-edb-postgres-distributed-for-kubernetes`). !!! Note - With Helm you can customize the name of the deployment via the `fullnameOverride` field in the [*"values.yaml"* file](https://helm.sh/docs/chart_template_guide/values_files/). @@ -224,7 +226,6 @@ not run on the same nodes where the actual PostgreSQL clusters are running (this include the control plane for self-managed Kubernetes installations). !!! Seealso "Operator configuration" - You can change the default behavior of the operator by overriding some default options. For more information, please refer to the ["Operator configuration"](operator_conf.md) section. @@ -294,7 +295,6 @@ To upgrade PGD4K operator, ensure that the PG4K operator is upgraded to a suppor version first. Only then can the PGD4K operator be upgraded. !!! Important - As PGD4K v1.0.0 does not require referencing an LTS release of the PG4K operator, it may have been installed with any PG4K version. If the installed PG4K version is less than 1.22, you can upgrade to PG4K version 1.22 by changing the subscription diff --git a/product_docs/docs/postgres_distributed_for_kubernetes/1/pg4k-pgd.v1beta1.mdx b/product_docs/docs/postgres_distributed_for_kubernetes/1/pg4k-pgd.v1beta1.mdx index b4fdcbe4b08..793c3012c8f 100644 --- a/product_docs/docs/postgres_distributed_for_kubernetes/1/pg4k-pgd.v1beta1.mdx +++ b/product_docs/docs/postgres_distributed_for_kubernetes/1/pg4k-pgd.v1beta1.mdx @@ -924,7 +924,7 @@ Make sure you reserve enough time for the operator to request a fast shutdown of storage [Required]
-sStorageConfiguration +StorageConfiguration

Configuration of the storage of the instances

diff --git a/product_docs/docs/postgres_distributed_for_kubernetes/1/private_edb_registries.mdx b/product_docs/docs/postgres_distributed_for_kubernetes/1/private_edb_registries.mdx index a25d62f1ae1..a8abb707a83 100644 --- a/product_docs/docs/postgres_distributed_for_kubernetes/1/private_edb_registries.mdx +++ b/product_docs/docs/postgres_distributed_for_kubernetes/1/private_edb_registries.mdx @@ -165,13 +165,13 @@ for an overview of PGD versions and corresponding PGD proxy versions. The table By default, all operand and proxy image are ubi-8 based, if you want to have ubi-9 based image, append the `-ubi9` suffix to the operand image name and proxy image name. -## Customize Operand Distribution or Version +## Customize Operand images -### Customize During Operator Deployment +You can customize the default operand images for the EDB Postgres Distributed for Kubernetes operator, +and these changes will apply to all future PGDGroup creations. Additionally, you have the option to +customize the operand for each individual PGDGroup deployment. -When deploying the EDB Postgres Distributed for Kubernetes operator, you can specify the distribution -and version of the operand and proxy images. This configuration will be applied to all subsequent PGDGroup -creations. +### Customize Default Operand Images in Helm Chart Deployment Use the following Helm chart command to deploy the EDB Postgres Distributed for Kubernetes operator with customized operand and proxy names. Please note that all operand and operator images will be @@ -216,7 +216,13 @@ helm upgrade --dependency-update \ --set image.imageCredentials.password= ``` -### Customize for single PGDGroup +### Update Default Operand Images for an Existing Operator + +You can modify the default operand images by updating the `pgd-operator-controller-manager-config` +ConfigMap or Secret. For further details, please refer to the [Operator Configuration](operator_conf.md) +documentation. + +### Customize Operand Images for Single PGDGroup Deployment You can also customize operand and proxy image for a single PGDGroup deployment. In this case, it's necessary to create the image pull secrets in the target namespace. diff --git a/product_docs/docs/postgres_distributed_for_kubernetes/1/supported_versions.mdx b/product_docs/docs/postgres_distributed_for_kubernetes/1/supported_versions.mdx index cf463d3685f..b1a33ad2258 100644 --- a/product_docs/docs/postgres_distributed_for_kubernetes/1/supported_versions.mdx +++ b/product_docs/docs/postgres_distributed_for_kubernetes/1/supported_versions.mdx @@ -56,7 +56,7 @@ release, please refer to the [platform compatibility](https://www.enterprisedb.c | Version | Supported OpenShift Versions | Supported PG4K Versions | Supported Cert-manager versions | | ------- | ---------------------------- | ----------------------- | ------------------------------- | -| 1.1.0 | v4.12 - v4.18 | v1.22.8, v1.25.x | >v1.10.0 | +| 1.1.0 | v4.12 - v4.17 | v1.22.8, v1.25.x | >v1.10.0 | | 1.0.1 | v4.12 - v4.16 | v1.22.x | >v1.10.0 | | 1.0.0 | v4.12 - v4.15 | >v1.18.0 | >v1.10.0 |