Skip to content

Home

Jump to bottom
Leo Christy Jesuraj edited this page Sep 3, 2024 · 11 revisions

Install Runtime Component Operator Development Driver (for testing and demo purposes only)

Note: This driver is for internal testing and demo purposes only. For production use, refer to the instructions here.

  1. Update your OpenShift cluster with a global pull secret for the cp.stg.icr.io entitled registry:
  • Get an entitlement key to the IBM Entitled Container Fulfillment Registry. Log in to MyIBM Container Software Library with the IBMid and password that are associated with the entitled software. Click on 'View library' on the left and it should show that you have entitlement for 'all' IBM software. Follow the process under Obtaining a staging entitlement key if you are not able to access the library or you don't have entitlement to 'all' IBM software.
  • In the Entitlement keys section, select Copy key to copy the entitlement key to the clipboard.
  • Use the console to configure the global pull secret with entitled registry (cp.stg.icr.io) credentials.
  • In the console, click Workloads > Secrets and select the openshift-config namespace.
  • Find the existing pull-secret secret.
  • Select Edit Secret.
  • Click Add Credentials to add an entry for the entitled registry. Specify cp.stg.icr.io as the registry server address, cp as the username, and the entitlement key that you obtained in the previous step as the password.
  1. Install the Operator using Operator Lifecycle Manager (OLM).

2.1. Create ImageContentSourcePolicy for mirroring (this is needed because Operator artifacts are built with production registry reference, but until we GA the images would only be in the staging registry):

apiVersion: operator.openshift.io/v1alpha1
kind: ImageContentSourcePolicy
metadata:
   name: mirror-config
spec:
   repositoryDigestMirrors:
   - mirrors:
     - cp.stg.icr.io/cp
     source: cp.icr.io/cp
   - mirrors:
     - cp.stg.icr.io/cp
     source: icr.io/cpopen
   - mirrors:
     - cp.stg.icr.io/cp
     source: icr.io/appcafe

(To apply the resources, create a file and then copy and paste the contents above on your oc enabled system and run oc apply -f <fileName>)

2.2. Add the CatalogSource for Runtime Component Operator:

apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  name: rco-v1-catalog
  namespace: openshift-marketplace
spec:
  displayName: RCO 1.4.0-rc.1
  image: 'icr.io/appcafe/runtime-component-operator-catalog@sha256:a935a4a26d5ea53b935447acb342513dc7ddd365f53aba7b298ce3c85167724b'
  sourceType: grpc

2.3. Install the Runtime Component Operator via OperatorHub in OpenShift UI:

2.3.1. To Install the Runtime Component Operator:

  • From the OpenShift UI, click on Operators and then OperatorHub
  • In the search box type runtime component. Sometimes it takes a few minutes for the CatalogSource to be loaded by OCP. The operator won't show up until the CatalogSource is loaded.
  • Select the Runtime Component operator **from the above catalog (not Certified) and click Install
  • Complete the install with the default options

2.3.2. To Upgrade the Runtime Component Operator:

  • Uninstall the RCO Operator
  • Go to Administration > CustomResourceDefinitions
  • Find CatalogSource
  • Click on Instances and find rco-v1-catalog
  • Either update image SHA value from wiki or just delete rco-v1-catalog instance and recreate from the wiki page with the latest sha value
  • Complete the install with the default options
  1. Alternative install options (image mirroring is not needed for these):
  1. Create custom resources (CRs) to deploy applications and to gather trace/dump:

New features in 1.4.0

Configure DNS

DNS can be configured in RuntimeComponent CR using the new fields:

  • .spec.dns.config: The DNS Config for the application pod.
  • .spec.dns.policy: The DNS Policy for the application pod. Defaults to ClusterFirst.

Example:

spec:
  dns:
    config:
      nameservers:
        - 8.8.8.8
        - 1.1.1.1
    policy: None

Refer to the Kubernetes documentation for general information on DNS Config and DNS Policy.

Tolerations

Tolerations can be configured in RuntimeComponent CR using the new field:

  • .spec.dns.tolerations: Tolerations to be added to application pods. Tolerations allow the scheduler to schedule pods on nodes with matching taints.

Example:

spec:
  tolerations:
  - key: "key1"
    operator: "Equal"
    value: "value1"

Refer to the Kubernetes documentation for general information on Taints and Tolerations.

Clone this wiki locally