Editing the configuration options in values.yaml

To configure your Cloud App Management deployment, modify the Helm chart by editing the values.yaml file. Change the values of settings such as environmentSize: and storageClassName:. The environmentSize: setting adjusts the size of your environment. The storageClassName: setting changes the storage type that you want to use in your deployment.

Before you begin

Before you edit the values.yaml file, you must download and extract the contents of the Cloud App Management IBM® Passport Advantage® Archive (PPA) file. For more information, see Installing IBM Cloud App Management on IBM Cloud Private.
Note: Use all lowercase characters when editing the values in the values.yaml file.

Procedure

  1. Access the /charts/ directory, where the PPA file is located. Open the /my_install_dir/ibm-cloud-appmgmt-prod/values.yaml file in a text editor of your choice.

    Where my_install_dir is the IBM Cloud Private installation directory that you specified when you extracted the PPA file.

  2. Find the setting that you need to configure. Enter the values for that setting, or replace the existing values with your own custom values. Save and close the file.
  3. Issue the following command from the my_install_dir directory to repackage the Helm chart: 
    helm package ibm-cloud-appmgmt-prod

    Use the following table as a reference when you are configuring the settings. It includes each option that you can edit, descriptions, the values that you can enter for some options, and examples.

    Configuration setting Value/Description/Example
    global.environmentSize [size0_amd64|size1_amd64|--size0_ppc64le|--size1_ppc64le] This setting determines the Kubernetes resource requests and the limits that are used by the microservices. size0 minimises the resources. Use only for small basic tests and trials. size1 sets the microservices to larger resource requests and limits. Use for production or larger tests and trials. For more information, see Planning hardware and sizing.
    global.license Accept the ICAM license by replacing the empty string with "accept".
    global.masterIP The external IP address of the IBM Cloud Private master.
    global.masterPort Port address of the IBM Cloud Private master. For example: 8443.
    global.proxyIP The external IP address of the IBM Cloud Private proxy.
    global.proxyHost The full hostname address of the IBM Cloud Private proxy. For example: vm1.mydomain.com.
    global.ingress.domain The full hostname address of the IBM Cloud Private proxy. For example: vm1.mydomain.com.
    global.image.repository The Docker image repository. For example: mycluster.icp:8500/default.
    global.persistence.storageClassName The environment-wide storage class. If you are individually setting the storageClassOption, which is required for local storage, leave this setting empty. Example: vsphere-class.
    global.persistence.storageClassOption.cassandradata The storage class for the Cassandra data. If you are using an environment-wide global.persistence.storageClassName, such as: local-storage-cassandra, leave this setting as default.
    global.persistence.storageClassOption.zookeeperdata Storage class for the ZooKeeper data. If you are using an environment-wide global.persistence.storageClassName, such as local-storage-zookeeper, leave this setting as default.
    global.persistence.storageClassOption.kafkadata Storage class for the Kafka data. If you are using an environment-wide global.persistence.storageClassName, such as local-storage-kafka, leave this setting as default.
    global.persistence.storageClassOption.datalayerdata Storage class for the Datalayer data. If you are using an environment-wide global.persistence.storageClassName, such as local-storage-datalayer, leave this setting as default.
    global.persistence.storageClassOption.couchdbdata Storage class for the CouchDB data. If you are using an environment-wide global.persistence.storageClassName, such as local-storage-couchdb, leave this setting as default.
    global.persistence.storageSize.cassandradata Storage size for the Cassandra data.
    global.persistence.storageSize.zookeeperdata Storage size for the ZooKeeper data.
    global.persistence.storageSize.kafkadata Storage size for the Kafka data.
    global.persistence.storageSize.datalayerdata Storage size for the Datalayer data
    global.persistence.storageSize.couchdbdata Storage size for the CouchDB data.
    ibm-cem.icpbroker:adminusername Cluster administrator user name. The default name is admin, which is configured when IBM Cloud Pak for Multicloud Management is installed. Replace this default name when you are using a different cluster administrator user name in your environment.