Enabling and disabling foundational services

Your product includes several services that are composed of one or more services.

After you install your product, you can enable or disable services that are comprised in a component. For more information on the default values for the services, see Services disabled and enabled by default.

Required user type or access level: Cluster administrator.

Enabling foundational services

  1. Add a service to the management_services parameter list and set its status to enabled in the config.yaml file to enable a service. Change the service parameter value to enabled to enable the service. For example, if you want to enable logging after the installation:

     management_services:
       monitoring: enabled
       metering: enabled
       logging: enabled
       custom-metrics-adapter: disabled
    
  2. Run the add-on command to enable the service on your cluster:

    • For Linux x86_64:
        docker run -t --net=host -e LICENSE=accept -v $(pwd):/installer/cluster:z -v /var/run:/var/run:z -v /etc/docker:/etc/docker:z --security-opt label:disable ibmcom/icp-inception-amd64:3.2.4 addon
      
    • For Linux on Power (ppc64le):

         sudo docker run -t --net=host -e LICENSE=accept -v $(pwd):/installer/cluster:z -v /var/run:/var/run:z -v /etc/docker:/etc/docker:z --security-opt label:disable ibmcom/icp-inception-ppc64le:3.2.4 addon
      
    • For Linux on IBM Z and LinuxONE:

         sudo docker run -t --net=host -e LICENSE=accept -v $(pwd):/installer/cluster:z -v /var/run:/var/run:z -v /etc/docker:/etc/docker:z --security-opt label:disable ibmcom/icp-inception-s390x:3.2.4 addon
      

Disabling foundational services

Note: If you want to disable an add-on component in a fresh installation, you must update the management services section in the config.yaml. Set the relevant add-on status to disable. The add-on component is skipped during installation. For more information on disabling services during the installation, see Disabling services during the installation.

  1. 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:
       monitoring: enabled
       metering: deleted
       logging: disabled
       custom-metrics-adapter: disabled
       image-security-enforcement: disabled
    
  2. Remove the add-on services by running the following command:

    • For Linux x86_64:
       docker run -t --net=host -e LICENSE=accept -v $(pwd):/installer/cluster:z -v /var/run:/var/run:z -v /etc/docker:/etc/docker:z --security-opt label:disable ibmcom/icp-inception-amd64:3.2.4 addon
      
    • For Linux on Power (ppc64le):

         sudo docker run -t --net=host -e LICENSE=accept -v $(pwd):/installer/cluster:z -v /var/run:/var/run:z -v /etc/docker:/etc/docker:z --security-opt label:disable ibmcom/icp-inception-ppc64le:3.2.4 addon
      
    • For Linux on IBM Z and LinuxONE:

         sudo docker run -t --net=host -e LICENSE=accept -v $(pwd):/installer/cluster:z -v /var/run:/var/run:z -v /etc/docker:/etc/docker:z --security-opt label:disable ibmcom/icp-inception-s390x:3.2.4 addon
      

Important: Disabling services can impact the installation of your product.

Note: The enabled status indicates that the service is installed in the cluster. The disabled status indicates that the service is skipped in the installer for both installation and uninstallation. The deleted status indicates that the installed service will be deleted from the cluster.

Note: 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.

Dependencies of the foundational services

View the following table of the services, their dependencies, and whether they are required for your environment or for supporting foundational services:

Table 1. Management service dependencies
Management service Dependencies Required for foundational services
tiller Yes
cert-manager Yes
mongodb Yes
monitoring-crd Yes
auth-idp mongodb Yes
auth-apikeys mongodb Yes
auth-pap mongodb Yes
auth-pdp mongodb, auth-idp, auth-pap, auth-apikeys Yes
catalog-ui auth-idp, platform-api, helm-api, helm-repo, No
helm-api mongodb, platform-api, icp-management-ingress, helm-repo, mgmt-repo No
helm-repo mongodb No
icp-management-ingress No
logging IAM No
metering mongodb, IAM No
nginx-ingress No
mgmt-repo mongodb No
monitoring IAM Yes
mongdb IAM Yes
platform-api IAM No
common-web-ui auth-idp, platform-api, catalog-ui No
platform-pod-security Yes
secret-watcher Yes
security-onboarding IAM No

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