Changing deployment profiles on Kubernetes

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: Planning your deployment topology.

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.

Procedure

  1. Management subsystem:
    1. Verify that subsystem is in Running state.
      kubectl get ManagementCluster -n <namespace>
    2. Edit the CR:
      kubectl edit ManagementCluster -n <namespace>

      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 -n <namespace>
  2. Developer Portal subsystem:
    1. Verify that subsystem is in Running state.
      kubectl get PortalCluster -n <namespace>
    2. Edit the CR:
      kubectl edit PortalCluster -n <namespace>

      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 -n <namespace>
  3. Analytics subsystem:
    1. Verify that subsystem is in Running state.
      kubectl get AnalyticsCluster -n <namespace>
    2. Edit the Analytics CR:
      kubectl edit AnalyticsCluster -n <namespace>

      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 -n <namespace>
    5. Restart analytics data collection as explained in the topic, Restarting Analytics pods and data collection.
  4. Gateway subsystem
    1. Verify that subsystem is in Running state.
      kubectl get GatewayCluster -n <namespace>
    2. Edit the CR:
      kubectl edit GatewayCluster -n <namespace>

      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 -n <namespace>