Enabling and disabling IBM Cloud Private components

IBM® Cloud Private includes several components which are composed of one or more management services.

After you install IBM Cloud Private, you can enable or disable management services that are comprised in a component. For more information on the default values for the management services, see Customizing the cluster with the config.yaml file. For more information on the components that are available and the management services that are included with the component, see IBM® Cloud Private components. This topic covers the platform that a service can run on and service dependencies.

See IBM® Cloud Private components for more information on the components that are available and the management services that are included with the component.

Required user type or access level: Cluster administrator.

Enabling IBM Cloud Private components

1. To enable a service, edit the config.yaml file to add service to the management_services parameter list and set the status to enabled.

   For example, the following configuration shows how to enable vulnerability-advisor:

    management_services:
        istio: disabled
        vulnerability-advisor: enabled
        storage-glusterfs: disabled
        storage-minio: disabled
        platform-security-netpols: disabled
        node-problem-detector-draino: disabled
        knative: disabled
   

   Important:

   • Review the details in the specific service document for resource requirements and any changes to be made to the hosts file when you are enabling a new service.
   • You must also enable or disable all services that comprise a component. The following services cannot be disabled: tiller, calico/nsx-t, kube-dns, monitoring-crd, cert-manager.

2. Run the add-on command to enable the service on your cluster:

    docker run --rm -t -e LICENSE=accept --net=host -v $(pwd):/installer/cluster ibmcom/icp-inception-$(uname -m | sed 's/x86_64/amd64/g'):3.2.1-ee addon
   

   Note: IBM Cloud Private management services have dependency relationships between each other. The dependency relationships are valid only if tiller, calico/nsx-t, kube-dns, monitoring-crd and cert-manager are enabled.

Disabling IBM Cloud Private components

1. If you want to disable an add-on component in the fresh install, you must update the management services section in the config.yaml. Set the relevant add-on status to disabled. The add-on component is skipped during installation.

   For example, if you want to disable metering during the installation:

    management_services:
      istio: disabled
      vulnerability-advisor: enabled
      storage-glusterfs: disabled
      storage-minio: disabled
      platform-security-netpols: disabled
      node-problem-detector-draino: disabled
      knative: disabled
      metering: disabled
   

2. If you want to remove an add-on component after you install IBM Cloud Private, complete the following steps to remove it from the cluster:

   • Set the add-on component that you want to remove to the deleted status in the management services section of the config.yaml.

     For example, if you want to disable metering after the installation:

     management_services:
       istio: disabled
       vulnerability-advisor: enabled
       storage-glusterfs: disabled
       storage-minio: disabled
       platform-security-netpols: disabled
       node-problem-detector-draino: disabled
       knative: disabled
       metering: deleted
     

3. Remove the add-on components by running the following command:

    docker run --rm -t -e LICENSE=accept --net=host -v $(pwd):/installer/cluster ibmcom/icp-inception-$(uname -m | sed 's/x86_64/amd64/g'):3.2.1-ee addon
   

Important: Disabling services may impact the installation of IBM Cloud Pak.

Notes:

• During IBM Cloud Private installation, use the status enabled and disabled to add or skip enabling a service. For post-installation use enabled and deleted status to add or delete a service. Node restart is not required.
• IBM Cloud Private management services have dependency relationships between each other. For example, the auth-idp service depends on the mongodb service. If mongodb is disabled, the auth-idp service cannot function.
• There is a change in IBM Cloud Private 3.2.1 and service status "disabled" represent ignoring this service. The service will not be added or deleted when you run the addon command.

Dependencies of the IBM Cloud Private components

View the following table of the IBM Cloud Private management services, their dependencies, and whether they are required for the IBM Cloud Private with OpenShift environment or for supporting IBM Cloud Pak:

Note: Identity and Access Management (IAM) includes the following services: auth-idp, auth-pap, auth-pdp, auth-apikeys, and secret-watcher.