Installing EDB Postgres

An instance administrator can install EDB Postgres on IBM® Software Hub Version 5.2.

Who needs to complete this task?

Instance administrator To install EDB Postgres, you must be an instance administrator. An instance administrator has permission to install software in the following projects:

The operators project for the instance

The operators for this instance of EDB Postgres are installed in the operators project.

In the installation commands, the ${PROJECT_CPD_INST_OPERATORS} environment variable refers to the operators project.

The operands project for the instance

The custom resources for the control plane and EDB Postgres are installed in the operands project.

In the installation commands, the ${PROJECT_CPD_INST_OPERANDS} environment variable refers to the operands project.

When do you need to complete this task?

Review the following options to determine whether you need to complete this task:

  • If you want to install multiple services at the same time, follow the process in Running a batch installation of solutions and services instead.
  • If you didn't install EDB Postgres as part of a batch installation, complete this task to add EDB Postgres to your environment.

    Repeat as needed If you are responsible for multiple instances of IBM Software Hub, you can repeat this task to install more instances of EDB Postgres on the cluster.

Information you need to complete this task

Review the following information before you install EDB Postgres:

Version requirements

All of the components that are associated with an instance of IBM Software Hub must be installed at the same release. For example, if the IBM Software Hub control plane is installed at Version 5.2.2, you must install EDB Postgres at Version 5.2.2.

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, run:
    source ./cpd_vars.sh
Security context constraint

EDB Postgres works with the default Red Hat® OpenShift® Container Platform security context constraint, restricted-v2.

Storage requirements
You don't need to specify storage information when you install EDB Postgres. However, you do need to specify storage when you provision an instance of EDB Postgres.

Before you begin

This task assumes that the following prerequisites are met:

System requirements
This task assumes that the cluster meets the minimum requirements for EDB Postgres.
Where to find more information
If this task is not complete, see System requirements.
Workstation
This task assumes that the workstation from which you will run the installation is set up as a client workstation and has the following command-line interfaces:
  • IBM Software Hub CLI: cpd-cli
  • OpenShift CLI: oc
Where to find more information
If this task is not complete, see Setting up a client workstation.
Control plane
This task assumes that the IBM Software Hub control plane is installed.
Where to find more information
If this task is not complete, see Installing an instance of IBM Software Hub.
Private container registry
If your environment uses a private container registry (for example, your cluster is air-gapped), this task assumes that the following tasks are complete:
  1. The EDB Postgres software images are mirrored to the private container registry.
    Where to find more information
    If this task is not complete, see Mirroring images to a private container registry.
  2. The cpd-cli is configured to pull the olm-utils-v3 image from the private container registry.
    Where to find more information
    If this task is not complete, see Pulling the olm-utils-v3 image from the private container registry.
Process IDs limit
The process IDs limit setting is adjusted for EDB Postgres.
Where to find more information
If this task is not complete, see Changing the process IDs limit.
Kernel parameters
The kernel parameter settings are adjusted for EDB Postgres.
Where to find more information
If this task is not complete, see Changing kernel parameter settings.
SMT settings
The simultaneous multithreading (SMT) settings for Kernel-based Virtual Machine (KVM) capable systems and big core PowerVM capable systems are adjusted, if applicable.
Where to find more information
If this task is not complete, see Changing Power settings.
GPU operators
If you plan to use features that require GPUs, this task assumes that the operators required to use GPUs are installed.
Where to find more information
If this task is not complete, see Installing operators for services that require GPUs.

Procedure

Complete the following tasks to install EDB Postgres:

  1. Installing the service
  2. Validating the installation
  3. What to do next

Installing the service

To install EDB Postgres:

  1. Log the cpd-cli in to the Red Hat OpenShift Container Platform cluster:
    ${CPDM_OC_LOGIN}
    Remember: CPDM_OC_LOGIN is an alias for the cpd-cli manage login-to-ocp command.
  2. Run the following command to create the required OLM objects for EDB Postgres in the operators project for the instance:
    cpd-cli manage apply-olm \
    --release=${VERSION} \
    --cpd_operator_ns=${PROJECT_CPD_INST_OPERATORS} \
    --components=edb_cp4d
    Wait for the cpd-cli to return the following message before you proceed to the next step:
    [SUCCESS]... The apply-olm command ran successfully

    If the apply-olm fails, see Troubleshooting the apply-olm command during installation or upgrade.

  3. Create the custom resource for EDB Postgres.
    cpd-cli manage apply-cr \
    --components=edb_cp4d \
    --release=${VERSION} \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --license_acceptance=true

Validating the installation

EDB Postgres is installed when the apply-cr command returns:
[SUCCESS]... The apply-cr command ran successfully

If you want to confirm that the custom resource status is Completed, you can run the cpd-cli manage get-cr-status command:

cpd-cli manage get-cr-status \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--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.