Changing deployment profiles on Kubernetes and OpenShift

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

About this task

After you complete initial installation of the API Connect subsystems, you can change to another of the profiles that are supported for the subsystem. For more information on the available profiles, see: Deployment and component profiles.

Important considerations:

  • If you are changing from a one replica profile to a three replica profile, ensure that you have three replica profile hardware (at least 3 worker nodes).
  • Based on the resources configured for each microservice in the profile, there might be downtime during the profile change.
Note: For OpenShift users: The steps that are detailed in this topic use the Kubernetes kubectl command. On OpenShift, use the equivalent oc command in its place.

Procedure

  1. Management subsystem:
    1. Verify that subsystem is in Running state.
      kubectl get ManagementCluster
    2. Edit the CR:
      kubectl edit ManagementCluster

      Change spec.profile value to the new profile you want to use.

    3. When switching from one replica profile to a three replica profile, wait for the microservice to scale up. When switching from a three replica profile to a one replica profile, wait for the microservice to scale down.
    4. Verify that subsystem is in Running state.
      kubectl get ManagementCluster
  2. Developer Portal subsystem:
    1. Verify that subsystem is in Running state.
      kubectl get PortalCluster
    2. Edit the CR:
      kubectl edit PortalCluster

      Change spec.profile value to the new profile you want to use.

    3. When switching from one replica profile to a three replica profile, wait for the microservice to scale up. When switching from a three replica profile to a one replica profile, wait for the microservice to scale down.
    4. Verify that subsystem is in Running state.
      kubectl get PortalCluster
  3. Analytics subsystem:
    Note: If you have a three replica profile, and want to change to one replica, you must first change your analytics configuration to shared storage. Dedicated storage is not supported on the one replica profile.
    1. Verify that subsystem is in Running state.
      kubectl get AnalyticsCluster
    2. Edit the Analytics CR:
      kubectl edit AnalyticsCluster

      Change spec.profile value to the new profile you want to use.

    3. When switching from one replica profile to a three replica profile, wait for the microservice to scale up. When switching from a three replica profile to a one replica profile, wait for the microservice to scale down.
    4. Verify that subsystem is in Running state.
      kubctl get AnalyticsCluster
  4. Gateway subsystem
    1. Verify that subsystem is in Running state.
      kubectl get GatewayCluster
    2. Edit the CR:
      kubectl edit GatewayCluster

      Change spec.profile value to the new profile you want to use.

    3. When switching from one replica profile to a three replica profile, wait for the microservice to scale up. When switching from a three replica profile to a one replica profile, wait for the microservice to scale down.
    4. Verify that subsystem is in Running state.
      kubectl get GatewayCluster