install.md

Table of Contents generated with DocToc

• Install the operand deployment lifecycle manager On OCP 4.2+
  • 1. Create OperatorSource
  • 2. Create Namespace ibm-common-services
  • 3. Install operand deployment lifecycle manager
    • Search ODLM Package in the OperatorHub
    • Install ODLM Operator
  • 4. Manage Other Operators with ODLM
    • (Optional) Update OperandRegistry and OperandConfig instances
    • Create Operand Request
    • Enable or Delete an Operator
• Post-installation

Install the operand deployment lifecycle manager On OCP 4.2+

1. Create OperatorSource

Before install ODLM, this operator source should be created to get operator bundles from quay.io.

apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  name: opencloud-operators
  namespace: openshift-marketplace
spec:
  displayName: IBMCS Operators
  publisher: IBM
  sourceType: grpc
  image: docker.io/ibmcom/ibm-common-service-catalog:latest
  updateStrategy:
    registryPoll:
      interval: 45m

Click the plus button, and then copy the above catalog source into the editor.

Check if operator packages are loaded, run command:

oc -n openshift-marketplace get operatorsource opencloud-operators -o jsonpath="{.status.packages}"

The output is a list of operators

ibm-cert-manager-operator-app,ibm-management-ingress-operator-app...

Note: During development, if you need to update the csv package frequently, but the operator source needs a long time to sync the new package, you can delete the catalog source to trigger a reload. Then the new packages will be updated immediately.

oc delete catalogsource opencloudio -n openshift-marketplace

2. Create Namespace ibm-common-services

Open the OperatorHub page in OCP console left menu, then Create Project, e.g., create a project named ibm-common-services.

3. Install operand deployment lifecycle manager

Search ODLM Package in the OperatorHub

Type operand-deployment-lifecycle-manager in the search box Open OperatorHub and search operand-deployment-lifecycle-manager to find the operator, and install it.

Install ODLM Operator

Select the namespace ibm-common-services that created in step Create Project

Waiting for about 1 minute, OperandRegistry and OperandConfig operand will be ready. Sometimes, you need to refresh the webpage to check them.

So far, the ODLM operator installation is completed. Next, you can start to install other common service operators.

4. Manage Other Operators with ODLM

(Optional) Update OperandRegistry and OperandConfig instances

This is an optional step to install operand deployment lifecycle manager.

• You can edit OperandRegistry instances to update operators. For more details, you can check How to update OperandRegistry
• You can edit OperandConfig instances to update operands. You can update OperandConfig instances post installation as well. For more details, you can check How to update OperandConfig

Create Operand Request

Select OperandRequest from Create New button

Modify the OperandRequest to add the operator you want to install into spec.requests.operands

This is the list of operators are going to be installed:

    - name: ibm-cert-manager-operator
    - name: ibm-mongodb-operator
    - name: ibm-iam-operator
    - name: ibm-monitoring-exporters-operator
    - name: ibm-monitoring-prometheusext-operator
    - name: ibm-monitoring-grafana-operator
    - name: ibm-healthcheck-operator
    - name: ibm-management-ingress-operator
    - name: ibm-licensing-operator
    - name: ibm-metering-operator
    - name: ibm-commonui-operator
    - name: ibm-elastic-stack-operator
    - name: ibm-ingress-nginx-operator
    - name: ibm-auditlogging-operator
    - name: ibm-platform-api-operator

After the OperandRequest created, you can click the left navigation tree Installed Operators to check if our common services install successfully.

Enable or Delete an Operator

• Enable an operator, you can add the operator into the OperandRequest

• Delete an operator, you can remove the operator from theOperandRequest

Post-installation

The operators and their operands would be deployed in the cluster.

• You can edit OperandConfig instances to update operands. For more details, you can check How to update OperandConfig