Installation via CASE
The Container Application Software for Enterprises (CASE) provides a common packaging definition for the many ways to install, manage, operate, upgrade, and uninstall complex software using multiple roles and personas.
Prerequisites
To install the CASE, you must have:
- Downloaded the ibm-datapower-operator CASE bundle.
- Installed the latest
ibm-pakplugin for oc here. - An OCP cluster, see Prerequisites for supported versions.
CASE Inventory
The IBM CASE structure has a concept of inventory items. These items are discrete sets of functionality; installing the DataPower Operator, for example. The DataPower Operator CASE has two primary inventory items: datapowerOperator and kibanaDashboard.
The datapowerOperator inventory item contains multiple scripted installation actions to install and uninstall the Operator either with OLM or using standard Kubernetes objects (Deployments). There are additional actions for configuring
your cluster to support air-gapped installation of the Operator and DataPower Firmware. The kibanaDashboard item simply contains the dashboard json along with instructions for importing it in the README.
The DataPower Operator CASE also contains a set of DataPower Operand inventory items which allow for the selection of the correct DataPower Operand for your license type during installation.
Cloud Pak for Integration Instructions
The Cloud Pak for Integration documentation provides up-to-date instructions on how to install CASE images here.
In this document, we will document any important notes that are specific to installing the DataPower CASE bundles.
Environmental Variables
This is an example of environmental variables for DataPower:
export CASE_NAME=ibm-datapower-operator
export CASE_VERSION=1.7.0
export TARGET_REGISTRY=localhost:5000
If you are using an entitled registry, you will additionally need to setup an auth file and assign the path to a variable. More information can be found here.
export REGISTRY_AUTH_FILE=$HOME/.docker/config.json
Where:
$CASE_NAMEis the name of the CASE, i.e.ibm-datapower-operator.$CASE_VERSIONis the target DataPower Operator version, i.e.1.7.0.$TARGET_REGISTRYis the local registry hostname and port. See here for more details.
Mirroring
When generating the mirror-manifests, we suggest filtering on your specific Image Group.
For example, to only pull the images for the developers-limited version, you would use the following:
oc ibm-pak generate mirror-manifests $CASE_NAME --version $CASE_VERSION $TARGET_REGISTRY --filter ibmdpLimited
Groups:
license.use |
Image Group |
|---|---|
production |
ibmdpProd |
nonproduction |
ibmdpNonprod |
developers |
ibmdpDeved |
developers-limited |
ibmdpLimited |
Note: When deploying within IBM Cloud Pak for Integration, use image group ibmdpCp4i.