From 9b88070be422f3db2677ff42f55820b1fa1271bf Mon Sep 17 00:00:00 2001 From: Josh Earlenbaugh Date: Wed, 20 Nov 2024 14:06:19 -0500 Subject: [PATCH 1/8] First pass at changes. --- .../postgres_for_kubernetes/1/iron-bank.mdx | 52 ++++++++++++++++--- 1 file changed, 44 insertions(+), 8 deletions(-) diff --git a/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx b/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx index 13f7e7b85a9..b5b2108e452 100644 --- a/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx +++ b/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx @@ -23,7 +23,7 @@ Iron Bank is a part of DoD's [Platform One](https://p1.dso.mil/). You will need your Iron Bank credentials to access the Iron Bank page for [EDB Postgres for Kubernetes](https://repo1.dso.mil/dsop/enterprisedb/edb-pg4k-operator). -## Pulling the EDB PG4K image from Iron Bank +## Pulling the EDB PG4K and operand images from Iron Bank The images are pulled from the separate [Iron Bank container registry](https://registry1.dso.mil/). To be able to pull images from the Iron Bank registry, please follow the @@ -33,19 +33,25 @@ Specifically, you will need to use your [registry1](https://registry1.dso.mil/harbor/projects) credentials to pull images. -To find the desired operator image, we recommend to use the search tool to look +To find the desired operator or operand images, we recommend to use the search tool to look with the string `edb`, and filter by `Tags`, looking for `stable`, as shown in -the image. From there, you can get the instruction to pull the image, for -example using Docker: +the image. From there, you can get the instruction to pull the image: ![pulling-ironbank-images](./images/ironbank/pulling-the-image.png) +For example, to pull the latest EPAS16 operand from Ironbank, you can run: + +```bash +docker pull registry1.dso.mil/ironbank/enterprisedb/edb-postgres-advanced-16:16 + +``` + +If you want to pick a more specific tag or use a specific SHA, you need to find it from the [Harbor page](https://registry1.dso.mil/harbor/projects/3/repositories/enterprisedb%2Fedb-postgres-adbanced-server%2Fedb-postgres-advanced-16/artifacts-tab). + ## Installing the PG4K operator using the Iron Bank image -For installation, you will need a deployment manifest that points to your Iron -Bank image. -You can take the deployment manifest from the -[installation instructions for EDB PG4K](/postgres_for_kubernetes/latest/installation_upgrade/). +For installation, you will need a deployment manifest that points to your Iron Bank image. +You can take the deployment manifest from the [installation instructions for EDB PG4K](/postgres_for_kubernetes/latest/installation_upgrade/). For example, for the 1.22.0 release, the manifest is available at `https://get.enterprisedb.io/cnp/postgresql-operator-1.22.0.yaml`. \\ There are a couple of places where you will need to set the image path for the @@ -90,3 +96,33 @@ directly to your Kubernetes nodes. Once you have this in place, you can apply your manifest normally with `kubectl apply -f`, as described in the [installation instructions](/postgres_for_kubernetes/latest/installation_upgrade/). + +## Deploy clusters with EPAS operands using their Iron Bank image + +To deploy a cluster using an [operand](/postgres_for_kubernetes/latest/private_edb_registries/#operand-images) from a pulled image, you must reference the Ironbank operand image appropriately in a Custom Resource (CR) file. +For example, for an EPAS 16 operand: + +1. Create or edit a Custom Resource (CR) YAML file with the following content: + + ```yaml + apiVersion: postgresql.k8s.enterprisedb.io/v1 + kind: Cluster + metadata: + name: cluster-example-full + spec: + imageName: registry1.dso.mil/ironbank/enterprisedb/edb-postgres-advanced-16@16.4 + imagePullSecrets: + - name: my_ironbank_secret + ``` + +2. Apply the YAML: + + ``` + kubectl apply -f + ``` + +3. Verify the status of the resource: + + ``` + kubectl get clusters + ``` From 18b867ca8dbaf2c282d9814143a0a748a5ba4f44 Mon Sep 17 00:00:00 2001 From: Josh Earlenbaugh Date: Wed, 20 Nov 2024 14:12:25 -0500 Subject: [PATCH 2/8] Small changes --- product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx b/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx index b5b2108e452..486c02a0e13 100644 --- a/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx +++ b/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx @@ -100,7 +100,7 @@ Once you have this in place, you can apply your manifest normally with ## Deploy clusters with EPAS operands using their Iron Bank image To deploy a cluster using an [operand](/postgres_for_kubernetes/latest/private_edb_registries/#operand-images) from a pulled image, you must reference the Ironbank operand image appropriately in a Custom Resource (CR) file. -For example, for an EPAS 16 operand: +For example, for an EPAS 16.4 operand: 1. Create or edit a Custom Resource (CR) YAML file with the following content: From 6df8840b46390140ec323f303fef03c6ca95d256 Mon Sep 17 00:00:00 2001 From: Josh Earlenbaugh Date: Wed, 20 Nov 2024 14:28:24 -0500 Subject: [PATCH 3/8] Changed title to gerund --- product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx b/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx index 486c02a0e13..2821f60b469 100644 --- a/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx +++ b/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx @@ -97,7 +97,7 @@ directly to your Kubernetes nodes. Once you have this in place, you can apply your manifest normally with `kubectl apply -f`, as described in the [installation instructions](/postgres_for_kubernetes/latest/installation_upgrade/). -## Deploy clusters with EPAS operands using their Iron Bank image +## Deploying clusters with EPAS operands using their Iron Bank image To deploy a cluster using an [operand](/postgres_for_kubernetes/latest/private_edb_registries/#operand-images) from a pulled image, you must reference the Ironbank operand image appropriately in a Custom Resource (CR) file. For example, for an EPAS 16.4 operand: From febc4a669fc7b26016814b80c3706b3c44a92888 Mon Sep 17 00:00:00 2001 From: Josh Earlenbaugh Date: Wed, 20 Nov 2024 14:32:35 -0500 Subject: [PATCH 4/8] Small changes. --- product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx b/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx index 2821f60b469..9440657e112 100644 --- a/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx +++ b/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx @@ -100,7 +100,7 @@ Once you have this in place, you can apply your manifest normally with ## Deploying clusters with EPAS operands using their Iron Bank image To deploy a cluster using an [operand](/postgres_for_kubernetes/latest/private_edb_registries/#operand-images) from a pulled image, you must reference the Ironbank operand image appropriately in a Custom Resource (CR) file. -For example, for an EPAS 16.4 operand: +For example, to deploy a PG4K cluster using a EPAS 16.4 operand: 1. Create or edit a Custom Resource (CR) YAML file with the following content: From 17922af65b03cd8623e29565fc5ff554c7562e4e Mon Sep 17 00:00:00 2001 From: Josh Earlenbaugh Date: Mon, 2 Dec 2024 14:13:29 -0500 Subject: [PATCH 5/8] Small change in wording. --- product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx b/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx index 9440657e112..f6424a48478 100644 --- a/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx +++ b/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx @@ -99,7 +99,7 @@ Once you have this in place, you can apply your manifest normally with ## Deploying clusters with EPAS operands using their Iron Bank image -To deploy a cluster using an [operand](/postgres_for_kubernetes/latest/private_edb_registries/#operand-images) from a pulled image, you must reference the Ironbank operand image appropriately in a Custom Resource (CR) file. +To deploy a cluster using the EPAS [operand](/postgres_for_kubernetes/latest/private_edb_registries/#operand-images) from a pulled image, you must reference the Ironbank operand image appropriately in a Custom Resource (CR) file. For example, to deploy a PG4K cluster using a EPAS 16.4 operand: 1. Create or edit a Custom Resource (CR) YAML file with the following content: From 0f566995462b46c8fcdf0969fc6b61362181afcc Mon Sep 17 00:00:00 2001 From: Josh Earlenbaugh Date: Mon, 2 Dec 2024 14:16:10 -0500 Subject: [PATCH 6/8] Another small word change. --- product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx b/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx index f6424a48478..31a815592ec 100644 --- a/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx +++ b/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx @@ -39,7 +39,7 @@ the image. From there, you can get the instruction to pull the image: ![pulling-ironbank-images](./images/ironbank/pulling-the-image.png) -For example, to pull the latest EPAS16 operand from Ironbank, you can run: +For example, to pull the EPAS16 operand from Ironbank, you can run: ```bash docker pull registry1.dso.mil/ironbank/enterprisedb/edb-postgres-advanced-16:16 From b79b52793d44a60d9a4b3a0529fb999f3a393c52 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Niccol=C3=B2=20Fei?= Date: Wed, 4 Dec 2024 16:29:52 +0100 Subject: [PATCH 7/8] docs: review --- .../postgres_for_kubernetes/1/iron-bank.mdx | 21 +++++++++---------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx b/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx index 31a815592ec..470286ea671 100644 --- a/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx +++ b/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx @@ -34,7 +34,7 @@ Specifically, you will need to use your credentials to pull images. To find the desired operator or operand images, we recommend to use the search tool to look -with the string `edb`, and filter by `Tags`, looking for `stable`, as shown in +with the string `enterprisedb`, and filter by `Tags`, looking for `stable`, as shown in the image. From there, you can get the instruction to pull the image: ![pulling-ironbank-images](./images/ironbank/pulling-the-image.png) @@ -46,16 +46,15 @@ docker pull registry1.dso.mil/ironbank/enterprisedb/edb-postgres-advanced-16:16 ``` -If you want to pick a more specific tag or use a specific SHA, you need to find it from the [Harbor page](https://registry1.dso.mil/harbor/projects/3/repositories/enterprisedb%2Fedb-postgres-adbanced-server%2Fedb-postgres-advanced-16/artifacts-tab). +If you want to pick a more specific tag or use a specific SHA, you need to find it from the [Harbor page](https://registry1.dso.mil/harbor/projects/3/repositories/enterprisedb%2Fedb-postgres-advanced-16/artifacts-tab). ## Installing the PG4K operator using the Iron Bank image For installation, you will need a deployment manifest that points to your Iron Bank image. You can take the deployment manifest from the [installation instructions for EDB PG4K](/postgres_for_kubernetes/latest/installation_upgrade/). For example, for the 1.22.0 release, the manifest is available at -`https://get.enterprisedb.io/cnp/postgresql-operator-1.22.0.yaml`. \\ -There are a couple of places where you will need to set the image path for the -IronBank image. +`https://get.enterprisedb.io/cnp/postgresql-operator-1.22.0.yaml`. +There are a couple of places where you will need to set the image path for the IronBank image. ```yaml apiVersion: apps/v1 @@ -97,12 +96,12 @@ directly to your Kubernetes nodes. Once you have this in place, you can apply your manifest normally with `kubectl apply -f`, as described in the [installation instructions](/postgres_for_kubernetes/latest/installation_upgrade/). -## Deploying clusters with EPAS operands using their Iron Bank image +## Deploying clusters with EPAS operands using IronBank images -To deploy a cluster using the EPAS [operand](/postgres_for_kubernetes/latest/private_edb_registries/#operand-images) from a pulled image, you must reference the Ironbank operand image appropriately in a Custom Resource (CR) file. -For example, to deploy a PG4K cluster using a EPAS 16.4 operand: +To deploy a cluster using the EPAS [operand](/postgres_for_kubernetes/latest/private_edb_registries/#operand-images) you must reference the Ironbank operand image appropriately in the `Cluster` resource YAML. +For example, to deploy a PG4K Cluster using the EPAS 16 operand: -1. Create or edit a Custom Resource (CR) YAML file with the following content: +1. Create or edit a `Cluster` resource YAML file with the following content: ```yaml apiVersion: postgresql.k8s.enterprisedb.io/v1 @@ -110,9 +109,9 @@ For example, to deploy a PG4K cluster using a EPAS 16.4 operand: metadata: name: cluster-example-full spec: - imageName: registry1.dso.mil/ironbank/enterprisedb/edb-postgres-advanced-16@16.4 + imageName: registry1.dso.mil/ironbank/enterprisedb/edb-postgres-advanced-16@16 imagePullSecrets: - - name: my_ironbank_secret + - name: my_ironbank_secret ``` 2. Apply the YAML: From 4e6caa5460dd813545f60981f68aee42691aa98a Mon Sep 17 00:00:00 2001 From: Josh Earlenbaugh Date: Tue, 17 Dec 2024 12:13:28 -0500 Subject: [PATCH 8/8] Fixed typo. --- product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx b/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx index 470286ea671..70e7a1e51fd 100644 --- a/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx +++ b/product_docs/docs/postgres_for_kubernetes/1/iron-bank.mdx @@ -109,7 +109,7 @@ For example, to deploy a PG4K Cluster using the EPAS 16 operand: metadata: name: cluster-example-full spec: - imageName: registry1.dso.mil/ironbank/enterprisedb/edb-postgres-advanced-16@16 + imageName: registry1.dso.mil/ironbank/enterprisedb/edb-postgres-advanced-17:17 imagePullSecrets: - name: my_ironbank_secret ```