Installing the EDB Postgres service
A project administrator can install EDB Postgres on IBM Cloud Pak® for Data.
- What permissions do you need to complete this task?
- The permissions that you need depend on which tasks you must complete:
- To install the EDB
Postgres operators, you must have the appropriate permissions to
create operators and you must be an administrator of the project where the Cloud Pak for Data operators are installed. This project is identified by
the
${PROJECT_CPD_OPS}
environment variable. - To install EDB
Postgres, you must be an administrator of the project where you will
install EDB
Postgres. This project is identified by the
${PROJECT_CPD_INSTANCE}
environment variable.
- To install the EDB
Postgres operators, you must have the appropriate permissions to
create operators and you must be an administrator of the project where the Cloud Pak for Data operators are installed. This project is identified by
the
- When do you need to complete this task?
- If you didn't install EDB
Postgres when you installed the platform, you can complete
this task to add EDB
Postgres to your environment.
If you want to install all of the Cloud Pak for Data components at the same time, follow the process in Installing the platform and services instead.
Important: All of the Cloud Pak for Data components in a deployment must be installed at the same release.
Information you need to complete this task
Review the following information before you install EDB Postgres:
- Environment variables
- The commands in this task use environment variables so that you can run the commands exactly as
written.
- If you don't have the script that defines the environment variables, see Setting up installation environment variables.
- To use the environment variables from the script, you must source the environment variables
before you run the commands in this task, for
example:
source ./cpd_vars.sh
- Security context constraint requirements
- EDB
Postgres uses the
restricted
security context constraint (SCC).
- Installation location
- EDB
Postgres must be installed in the same project
(namespace) as the Cloud Pak for Data control
plane. This project is
identified by the
${PROJECT_CPD_INSTANCE}
environment variable.
- Storage requirements
- You don't need to specify storage when you install EDB Postgres; however you will need to specify storage when you provision an instance of EDB Postgres.
Before you begin
This task assumes that the following prerequisites are met:
Prerequisite | Where to find more information |
---|---|
The cluster meets the minimum requirements for installing EDB Postgres. | If this task is not complete, see System requirements. |
The workstation from which you will run the installation is set up as a client workstation
and includes the following command-line interfaces:
|
If this task is not complete, see Setting up a client workstation. |
The Cloud Pak for Data control plane is installed. | If this task is not complete, see Installing the platform and services. |
For environments that use a private container registry, such as air-gapped environments, the EDB Postgres software images are mirrored to the private container registry. | If this task is not complete, see Mirroring images to a private container registry. |
Procedure
Complete the following tasks to install EDB Postgres:
Logging in to the cluster
To run cpd-cli
manage
commands, you must log in to the cluster.
To log in to the cluster:
-
Run the
cpd-cli manage login-to-ocp
command to log in to the cluster as a user with sufficient permissions to complete this task. For example:cpd-cli manage login-to-ocp \ --username=${OCP_USERNAME} \ --password=${OCP_PASSWORD} \ --server=${OCP_URL}
Tip: Thelogin-to-ocp
command takes the same input as theoc login
command. Runoc login --help
for details.
Installing the operator
The EDB Postgres operator simplifies the process of managing the EDB Postgres service on Red Hat® OpenShift Container Platform.
To install EDB Postgres, you must install the EDB Postgres operator and create the Operator Lifecycle Manager (OLM) objects, such as the catalog source and subscription, for the operator.
- Who needs to complete this task?
- You must be a cluster administrator (or a user with the appropriate permissions to install operators) to create the OLM objects.
- When do you need to complete this task?
- Complete this task if the EDB
Postgres operator and other OLM artifacts have not been created for the current
release.
If you complete this task and the OLM artifacts already exist on the cluster, the
cpd-cli
detects that you already have the OLM objects for the components at the specified release, thecpd-cli
does not attempt to create the OLM objects again.
To install the operator:
- Create
the OLM objects for EDB
Postgres:
cpd-cli manage apply-olm \ --release=${VERSION} \ --cpd_operator_ns=${PROJECT_CPD_OPS} \ --components=edb_cp4d
- If the command succeeds, it returns [SUCCESS]... The apply-olm command ran successfully.
- If the command fails, it returns [ERROR] and includes information about the cause of the failure.
What to do next: Install the EDB Postgres service.
Installing the service
After the EDB Postgres operator is installed, you can install EDB Postgres.
- Who needs to complete this task?
- You must be an administrator of the project where you will install EDB Postgres.
- When do you need to complete this task?
- Complete this task if you want to add EDB Postgres to your environment.
To install the service:
- Create the custom resource for EDB
Postgres.
cpd-cli manage apply-cr \ --components=edb_cp4d \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INSTANCE} \ --license_acceptance=true
Validating the installation
EDB
Postgres is installed when the apply-cr
command returns [SUCCESS]... The apply-cr command ran
successfully.
However, you can optionally run the cpd-cli
manage
get-cr-status
command if you want to confirm that the custom
resource status is Completed
:
cpd-cli manage get-cr-status \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--components=edb_cp4d
What to do next
You must complete Post-installation setup for the EDB Postgres service before users can access EDB Postgres instances.