Changing the deployment profile on Cloud Pak for Integration

You can change an API Connect installation to use a different deployment profile.

Before you begin

This task assumes that you have already deployed an API Connect cluster as explained in Deploying on OpenShift and Cloud Pak for Integration. If you are switching from a development profile to a production profile, ensure that you have production profile hardware (3 nodes) available.

About this task

Important considerations:

  • While it is possible to use a development profile installation in a production deployment, it is not recommended.
  • Based on the resources configured for each microservice in the profile, there might be downtime during a profile change.
  • Supported profiles:
    • Development: n3xc4.m16
    • Production: n12xc4.m12
  • If you enabled the analytics message queue feature, you must disable it before changing to another deployment profile. You can re-enable the message queue feature after the profile change is complete.

    To disable the message queue:

    1. In Platform Navigator, click the overflow menu next to the API Connect capability and select Edit.
    2. Click the YAML tab to edit the top-level APIConnectCluster CR.
    3. In the spec.analytics section, locate the mq subsection and change the enabled setting to false.
      spec:
          analytics:
            mq:
              enabled: false
    4. Click Update to save and apply the change.

    To re-enable the message queue:

    1. In Platform Navigator, click the overflow menu next to the API Connect capability and select Edit.
    2. Click the YAML tab to edit the top-level APIConnectCluster CR.
    3. In the spec.analytics section, locate the mq subsection and change the enabled setting to true.
    4. Click Update to save and apply the change.

Procedure

  1. Workaround for deployments that upgraded to Version 10.0.1.5-eus from a previous version of API Connect. If you upgraded to 10.0.1.5-eus, you must first patch role secret to add permissions:
    oc -n <namespace> patch secret pgorole-pgoadmin --type='json' -p='[{"op" : "replace" ,"path" : "/data/permissions" ,"value" : "Kg=="}]'
  2. Verify that the API Connect cluster is in the Ready state.

    Open the Platform Navigator, locate the API Management capability on the Capabilities tab, and verify that the state displays as Ready. Leave the page open for the next step.

  3. Update the API Management instance:
    1. In Platform Navigator, click the overflow menu next to the capability and select Edit.
    2. In the Details section of the deployment pages, navigate to the Deployment profile field.
    3. Click the field and select the new deployment profile.

      For example, to switch from the development profile to the production profile, n12xc4.m12.

  4. Click Update to save the change.
  5. Wait for microservice to scale up, or scale down, as needed.
  6. Verify that the status for the API Management capability displays as Ready.