Updating configuration files

If required, you can adjust configuration parameters of the IBM Storage Enabler for Containers after its installation, using the yml files on the host:

  • ./ubiquity-configmap.yml
  • ./scbe-credentials-secret.yml
  • ./ubiquity-db-credentials-secret.yml
  • ./ubiquity-db-credentials-secret.yml
  • ./yamls/storage-class.yml
  • ./yamls/ubiquity-db-pvc.yml
  • ./yamls/sanity_yamls/sanity-pvc.yml
Table 1. Configuration parameters in ubiquity-configmap.yml
Parameter Description
SCBE-MANAGEMENT-IP IP address or FQDN of the Spectrum Connect server.
To update this parameter after installation:
  1. Update the parameter in the ubiquity-configmap configMap ($> kubectl edit -n ubiquity configmap ubiquity-configmap).
  2. Delete the ubiquity pod of the ubiquity deployment. Then, it is automatically recreated by the deployment with the new parameters.
SCBE-MANAGEMENT-PORT Communication port of the Spectrum Connect server.

To update this parameter after installation, use the same procedure as the one for SCBE-MANAGEMENT-IP.
SCBE-DEFAULT-SERVICE Default Spectrum Connect storage service to be used, if not specified by the storage class.

To update this parameter after installation, use the same procedure as the one for SCBE-MANAGEMENT-IP.
UBIQUITY-INSTANCE-NAME A prefix for any new volume created on the storage system. This parameter cannot be changed.
UBIQUITY-IP-ADDRESS

IP address of the ubiquity service object. The ubiquity_installer.sh automatically updates this parameter during the initial installation.

If the ubiqutiy service is recreated, it receives a new IP address. As a result, this parameter must be updated to allow the FlexVolume pods to access it.

To update the IP address after installation:
  1. Update the IP address in the ubiquity_configmap configMap ($> kubectl edit -n ubiquity configmap ubiquity-configmap).
  2. Delete all FlexVolume pods ($> kubectl get pod -n ubiquity | grep ubiquity-k8s-flex | awk '{print $1}' | xargs kubectl delete pod -n ubiquity.)
DEFAULT-FSTYPE File system type of a new volume, if not specified by the user in the storage class.

Allowed values: ext4 or xfs.

To update this parameter after installation, use the same procedure as the one for SCBE-MANAGEMENT-IP.
DEFAULT-VOLUME-SIZE Default volume size (in GB), if not specified by the user when creating a new volume.

To update this parameter after installation, use the same procedure as the one for SCBE-MANAGEMENT-IP.
LOG-LEVEL Log level.

Allowed values: debug, info, error.

To receive more detailed events about the IBM Storage Enabler for Containers operation, you can adjust the log level after installation. Use this information your troubleshooting and debug processes.

To change the log level after installation:
  1. Change the value in the ubiquity_configmap configMap ($> kubectl edit -n ubiquity configmap ubiquity-configmap).
  2. Stop the IBM Storage Enabler for Containers ($> ubiquty_cli.sh -a stop).
  3. Restart the IBM Storage Enabler for Containers ($> ubiquty_cli.sh -a start).
SSL-MODE SSL verification mode.

Allowed values: require (No validation is required, the IBM Storage Enabler for Containers server generates self-signed certificates on the fly.) or verify-full (Certificates are provided by the user.)

To change the SSL mode to verify-full after installation:

  1. Stop the IBM Storage Enabler for Containers ($> ubiquty_cli.sh -a stop).
  2. Edit the ubiquity-configmap.yml file, setting the SSL_MODE to verify-full.
  3. Edit the ubiquity_installer.conf file, setting the SSL_MODE to verify-full.
  4. Run $> ubiqutiy_installer.sh -a update-ymls -c ubiquity_installer.conf.
  5. Create SSL certificates, as detailed in the Managing SSL certificates section.
  6. Restart the IBM Storage Enabler for Containers ($> ubiquty_cli.sh -a start).
FLEX-LOG-DIR Directory for the ubiquity-k8s-flex.log file. The default location is the /var/log directory.

To change the ubiquity-k8s-flex.log file directory after installation:

  1. Change the default folder in the ubiquity_configmap configMap ($> kubectl edit -n ubiquity FLEX-LOG-DIR <new_directory>).
  2. Edit the ubiquity-k8s-flex-daemonset.yml file, setting the hostPath and mountPath to the new directory value:
    • kubectl delete -f yamls/ubiquity-k8s-flex-daemonset.yml -n ubiquity
    • kubectl create -f yamls/ubiquity-k8s-flex-daemonset.yml -n ubiquity
  3. If you change the default log file location, make sure to set it to the same value in the relevant yml files on the controller-manager pod.
FLEX-LOG-ROTATE-MAXSIZE Maximum size of the ubiquity-k8s-flex.log file.

To change the default log file size after installation:

  • Change the default log file size in the ubiquity_configmap configMap ($> kubectl edit -n ubiquity FLEX-LOG-ROTATE-MAXSIZE <new_size>).
Table 2. Configuration parameters in scbe-credentials-secret.yml
Parameter Description
SCBE-USERNAME Username defined for the IBM Storage Enabler for Containers interface in Spectrum Connect.
To change the Enabler for Containers interface credentials after installation:
  1. Change the credentials for the Enabler for Containers interface, using the Spectrum Connect GUI.
  2. Enter the new Base-64-encoded username and password ($> kubectl edit -n ubiquity scbe-credentials).
  3. Delete the ubiquity-k8s-flex pods, ubiquity-k8s-provisioner pod and ubiquity pod. Do not delete the ubiquity-db pod
    After the deletion, Kubernetes restarts the pods with new credentials.
SCBE-PASSWORD Password defined for the IBM Storage Enabler for Containers interface in Spectrum Connect. Instructions on how to change the interface credentials after installation are detailed in the SCBE-USERNAME description above.
Table 3. Configuration parameters in ubiquity-db-credentials-secret.yml
Parameter Description
UBIQUITY-DB-USERNAME Username for the deployment of ubiquity-db database.

Do not use the postgres username, because it already exists.
UBIQUITY-DB-PASSWORD Password for the deployment of ubiquity-db database.
Note: If you change the ubiquity-db database password, make sure to set the new value for the PostgreSQL as well. Run the psql command from the Enabler for Containers container:
#>> psql " postgresql://ubiquity@ubiquity-db:5432/ubiquity?sslmode=require"
 ==> ALTER ROLE ubiquity password 'new password';
Table 4. Configuration parameters in storage-class.yml, ubiquity-db-pvc.yml, sanity-pvc.yml
Parameter Description
STORAGE-CLASS-NAME Storage class name.
STORAGE-CLASS-PROFILE Storage class profile, directing to the Spectrum Connect storage service.
STORAGE-CLASS-FSTYPE File system type for the storage class profile.

Allowed values: ext4 or xfs.
Note: The storage class parameters are used for creating an initial storage class for the ubiquity-db PVC.