Skip to content

Commit 8bb69f2

Browse files
authored
Merge pull request #6200 from EnterpriseDB/docs/pg4k/edbprivaterepos
First pass of changes for license-key free installation
2 parents fe0b268 + 65940bc commit 8bb69f2

File tree

7 files changed

+289
-61
lines changed

7 files changed

+289
-61
lines changed

product_docs/docs/postgres_for_kubernetes/1/installation_upgrade.mdx

Lines changed: 67 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,39 @@ originalFilePath: 'src/installation_upgrade.md'
1414

1515
## Installation on Kubernetes
1616

17+
### Obtaining an EDB subscription token
18+
19+
!!! Important
20+
You must obtain an EDB subscription token to install EDB Postgres for Kubernetes. Without a token, you will not be able to access the EDB private software repositories.
21+
22+
Installing EDB Postgres for Kubernetes requires an EDB Repos 2.0 token to gain access to the EDB private software repositories.
23+
24+
You can obtain the token by visiting your [EDB Account Profile](https://www.enterprisedb.com/accounts/profile). You will have to sign in if you are not already logged in.
25+
26+
Your account profile page displays the token to use next to **Repos 2.0 Token** label. By default, the token is obscured, click the "Show" button (an eye icon) to reveal it.
27+
28+
Your token entitles you to access one of two repositories: standard or enterprise.
29+
30+
* `standard` - Includes the operator and the EDB Postgres Extended operand images.
31+
* `enterprise` - Includes the operator and the EDB Postgres Advanced and EDB Postgres Extended operand images.
32+
33+
Set the relevant value, determined by your subscription, as an environment variable `EDB_SUBSCRIPTION_PLAN`.
34+
35+
```shell
36+
EDB_SUBSCRIPTION_PLAN=enterprise
37+
```
38+
39+
then set the Repos 2.0 token to an environment variable `EDB_SUBSCRIPTION_TOKEN`.
40+
41+
```shell
42+
EDB_SUBSCRIPTION_TOKEN=<your-token>
43+
```
44+
45+
!!! Warning
46+
The token is sensitive information. Please ensure that you don't expose it to unauthorized users.
47+
48+
You can now proceed with the installation.
49+
1750
### Using the Helm Chart
1851

1952
The operator can be installed using the provided [Helm chart](https://github.com/EnterpriseDB/edb-postgres-for-kubernetes-charts).
@@ -23,12 +56,43 @@ The operator can be installed using the provided [Helm chart](https://github.com
2356
The operator can be installed like any other resource in Kubernetes,
2457
through a YAML manifest applied via `kubectl`.
2558

59+
#### Install the EDB pull secret
60+
61+
Before installing EDB Postgres for Kubernetes, you need to create a pull secret for EDB software in the `postgresql-operator-system` namespace.
62+
63+
64+
The pull secret needs to be saved in the namespace where the operator will reside. Create the `postgresql-operator-system` namespace using this command:
65+
66+
```shell
67+
kubectl create namespace postgresql-operator-system
68+
```
69+
70+
To create the pull secret itself, run the following command:
71+
72+
```shell
73+
kubectl create secret -n postgresql-operator-system docker-registry edb-pull-secret \
74+
--docker-server=docker.enterprisedb.com \
75+
--docker-username=k8s_$EDB_SUBSCRIPTION_PLAN \
76+
--docker-password=$EDB_SUBSCRIPTION_TOKEN
77+
```
78+
79+
#### Install the operator
80+
81+
Now that the pull-secret has been added to the namespace, the operator can be installed like any other resource in Kubernetes,
82+
through a YAML manifest applied via `kubectl`.
83+
84+
There are two different manifests available depending on your subscription plan:
85+
86+
- Standard: The [latest standard operator manifest](https://get.enterprisedb.io/pg4k/pg4k-standard-1.24.1.yaml).
87+
- Enterprise: The [latest enterprise operator manifest](https://get.enterprisedb.io/pg4k/pg4k-enterprise-1.24.1.yaml).
88+
89+
You can install the manifest for the latest version of the operator by running:
2690
You can install the [latest operator manifest](https://get.enterprisedb.io/cnp/postgresql-operator-1.24.1.yaml)
2791
for this minor release as follows:
2892

2993
```sh
3094
kubectl apply --server-side -f \
31-
https://get.enterprisedb.io/cnp/postgresql-operator-1.24.1.yaml
95+
https://get.enterprisedb.io/pg4k/pg4k-$EDB_SUBSCRIPTION_PLAN-1.24.1.yaml
3296
```
3397

3498
You can verify that with:
@@ -72,9 +136,8 @@ for a more comprehensive example.
72136
In Kubernetes, the operator is by default installed in the `postgresql-operator-system`
73137
namespace as a Kubernetes `Deployment`. The name of this deployment
74138
depends on the installation method.
75-
When installed through the manifest or the `cnp` plugin, it is called
76-
`postgresql-operator-controller-manager` by default. When installed via Helm, the default name
77-
is `postgresql-operator-cloudnative-pg`.
139+
When installed through the manifest or the `cnp` plugin, by default, it is called `postgresql-operator-controller-manager`.
140+
When installed via Helm, by default, the deployment name is derived from the helm release name, appended with the suffix `-edb-postgres-for-kubernetes` (e.g., `<name>-edb-postgres-for-kubernetes`).
78141

79142
!!! Note
80143
With Helm you can customize the name of the deployment via the

0 commit comments

Comments
 (0)