Installation parameters
The following table lists the Managed services installation parameters and their default values. These parameters are in the spec section of the ibm-management-cam-install operator.
Notes:
- The storage class
rook-ceph-cephfs-internalis specified as an example in this documentation, use the storage class configured in your environment. - The global resource parameters are used while creating the following containers:
cam-controller-manager, cam-iaas, cam-portal-ui, cam-provider-ansible, cam-provider-bpm, cam-provider-helm, cam-provider-terraform-api, cam-provider-terraform-runtime,
cam-proxy, cam-service-composer-api, cam-service-composer-ui, cam-tenant-api, cam-ui-basic.
| Parameter | Description | Default |
|---|---|---|
| Authentication | ||
oauthClientSecret |
Name of the OAuth client secret | cam-oauth-client-secret |
authIdpCredentialsSecret |
Name of the secret with the auth IDP credentials | ibm-iam-bindinfo-platform-auth-idp-credentials |
| Architecture | ||
arch |
Select the value based on the architecture. Linux = amd64 Linux on Power (ppc64le) = ppc64le Linux on IBM Z and LinuxONE = s390x |
amd64 |
| Audit service | ||
auditService.config.journalPath |
The journal path | /run/systemd/journal |
auditService.image.pullPolicy |
Pull policy for the audit image | IfNotPresent |
auditService.image.pullSecret |
Image pull secret for the audit image | |
auditService.image.repository |
Repository for the audit image | quay.io/opencloudio/ |
auditService.image.tag |
Image tag of the audit service | IBM Cloud Pak foundational services version |
auditService.resources.limits.cpu |
CPU resource limits | 200m |
auditService.resources.limits.memory |
Memory resource limits | 512Mi |
auditService.resources.requests.cpu |
CPU resource request | 100m |
auditService.resources.requests.memory |
Memory resource request | 256Mi |
| API | ||
camAPI.camSecret.secretName |
Name of the secret used by the API | cam-api-secret |
camAPI.certificate.certName |
Name of the certificate used by the API | cert |
camAPI.replicaCount |
Number of API pods | 1 |
| Ansible provider | ||
camAnsibleProvider.replicaCount |
Number of pods. Set to 1 if you want to use Ansible provider. After you install Managed services, to enable or disable Ansible integration, see Enable or disable Ansible Integration. |
0 |
| Cloud Discovery | ||
camBPDCDS.options.customSettingsFile |
Cloud Discovery Service custom settings file | Nil |
camBPDCDS.options.debug.enabled |
Enable Cloud Discovery Service debug mode | false |
camBPDCDS.replicaCount |
Number of Cloud Discovery Service pods | 1 |
camBPDCDS.resources.limits.cpu |
CPU resource limits | 200m |
camBPDCDS.resources.limits.memory |
Memory resource limits | 256Mi |
camBPDCDS.resources.requests.cpu |
CPU resource requests | 100m |
camBPDCDS.resources.requests.memory |
Memory resource requests | 128Mi |
| Business Process Management | ||
camBpmProvider.replicaCount |
Number of pods. Set to 1 if you want to use IBM Business Process Manager. After you install Managed services, to enable or disable IBM Business Process Manager integration, see Enable or disable IBM Business Process Manager. |
0 |
camBpmProvider.bpmEndpoint |
IBM Business Process Manager endpoint | "" |
camBpmProvider.bpmUserName |
IBM Business Process Manager user | "" |
camBpmProvider.bpmUserPwd |
IBM Business Process Manager user password | "" |
| Terraform | ||
camProviderTerraform.isolateRuntime |
Set to true to enable isolation mode for Provider Terraform runtime. In this mode, the runtime runs on separate pods. |
false |
camProviderTerraform.runtime.replicaCount |
Number of replicas for Provider Terraform Runtime. This value is applicable only when camProviderTerraform.isolateRuntime is enabled. |
0 |
camProviderTerraform.terraformSSHDir.terraformSSHDirSecret |
Secret that contains the contents of /home/terraform/.ssh directory. See Configuring Managed services to set the SSH keys and known hosts in provider terraform pod for more details. | "" |
| Controller | ||
camController.replicaCount |
Set this to 1 to install the CAM controller. | 1 |
| Logging policy | ||
camLoggingPolicies.logLevel |
Logging level. | info |
| MongoDB PV | ||
camMongoPV.name |
Name of MongoDB volume | cam-mongo-pv |
camMongoPV.persistence.accessMode |
PV access mode. Do not change the default value. | ReadWriteOnce |
camMongoPV.persistence.enabled |
Database persistence | true |
camMongoPV.persistence.existingClaimName |
Database PVC name | nil |
camMongoPV.persistence.existingDynamicVolume |
Whether to use an existing PV | false |
camMongoPV.persistence.size |
Database PV size | 15Gi |
camMongoPV.persistence.storageClassName |
Database storage class | rook-ceph-cephfs-internal |
camMongoPV.persistence.useDynamicProvisioning |
The default is true. The IBM Cloud Pak for AIOps default storage class is used if you do not change the storage class in the camLogsPV.persistence.storageClassName parameter. |
true |
| Proxy | ||
camProxy.replicaCount |
Number of proxy pods | 1 |
| Managed services console | ||
camUI.camUISecret.secretName |
Secret that is used by the UI | cam-ui-secret |
camUI.camUISecret.sessionKey |
Session key that is used by the UI | opsConsole.sid |
camUI.camUISecret.sessionTTL |
UI session expiry time | 43200 seconds |
camUI.replicaCount |
Number of UI pods | 1 |
| MongoDB setting - External or internal | ||
database.bundled |
Use internal MongoDB. Set to false for external. For more information, see Using an external MongoDB | true |
| Global parameters | ||
global.audit |
Controls whether the audit container is added to the build or not. It also enables or disables audit in the service. | false |
global.iam.deployApiKey |
It is used to generate Managed services specific Service ID and API Key. The Managed services API Key is used to interact with the platform authorization. If this value is not specified, the installation generates it automatically. | |
global.id.productID |
Managed services Product Identifier | Defaults to the Managed services product ID. If you are downloading the package from Passport Advantage, you can specify the part number here. |
global.id.productVersion |
IBM Cloud Pak for AIOps version | IBM Cloud Pak for AIOps version |
global.id.cloudpakID |
IBM Cloud Pak for AIOpsID | Defaults to the IBM Cloud Pak for AIOps product ID. |
global.id.cloudpakVersion |
IBM Cloud Pak for AIOps version | IBM Cloud Pak for AIOps version |
global.image.secretname |
Entitled registry image pull secret | Type default to use your namespace default service account image pull secret or enter your Entitled registry image pull secret name. Required if you are downloading images from the Entitled registry. |
global.offline |
Select to optimize the installation for offline. For example, skip attempting to access the internet for public starter templates. | false |
| Cluster parameters | ||
icp.cluster_name |
Your IBM Cloud Pak for AIOps cluster name. | mycluster. |
icp.port |
Port for accessing IBM Cloud Pak for AIOps. The port is used to communicate with the services in IBM Cloud Pak for AIOps. | 443 |
| Image parameters | ||
image.pullPolicy |
Pull Policy for the Managed services images | IfNotPresent |
image.repository |
Repository for the Managed services images | quay.io/opencloudio/ (online installation image repository) mycluster.icp:8500/services/ (offline installation image repository) |
image.tag |
Tag for the Managed services images | IBM Cloud Pak foundational services version |
| Managed services console hostname and port | ||
managementConsole.hostname |
Hostname of the Managed services management console. If this field is kept blank, the installer generates a hostname. You can access the hostname by running the command oc get route -n cp4aiops. |
NA |
managementConsole.port |
Port for Managed services management console. If this field is kept blank, a random valid port is chosen. | The default is 30000 and the valid range is 30000-32767. |
| Environment parameters | ||
platform |
Platform name. | icp |
| Proxy parameters | ||
proxy.useProxy |
Select to use a proxy with Managed services. | false |
| Global resource parameters | ||
resources.limits.cpu |
CPU resource limits | 1 |
resources.limits.memory |
Memory resource limits | 8Gi |
resources.requests.cpu |
CPU resource requests | 100m |
resources.requests.memory |
Memory resource requests | 256Mi |
| Custom secrets | ||
secureValues.secretName |
Name of a secret that you created before the installation of Managed services. It contains secure values, such as proxy, database, and encryption passwords. | Nil. To generate the secret, see Using pre-created secrets in Managed services chart. |
| Red Hat® OpenShift® on IBM Cloud® service | ||
roks |
Indicates if it is a Red Hat® OpenShift® on IBM Cloud® service system | False |
roksRegion |
Red Hat® OpenShift® on IBM Cloud® service storage region | "" |
roksZone |
Red Hat® OpenShift® on IBM Cloud® service storage zone | "" |