OpenShift Data Foundation add-on parameter reference
Classic VPC
Review the following parameter reference for the OpenShift Data Foundation cluster add-on.
You can also find the add-on parameters in the Red Hat OpenShift clusters console during add-on deployment, or by running the following command and specifying the add-on version you want to use.
ibmcloud oc cluster addon options --addon openshift-data-foundation --version VERSION
| Parameter | Description | Default | Editable after deployment |
|---|---|---|---|
name |
Specify a name for your resource that uses only lowercase letters, numbers, - or . |
N/A | Yes |
odfDeploy |
Specify true to deploy the ODF resources such as storage classes, PVCs, and PVs when you enable the add-on. When set to false, only the add-on is deployed and you must then configure your ODF resources later via
YAML configuration files. |
false |
Yes |
osdStorageClassName |
|
N/A | Yes |
osdSize |
Specify a size for your storage devices. Example: 512Gi. The total storage capacity of your ODF cluster is equivalent to the osdSize multiplied by the numOfOsd. |
512Gi |
Yes |
numOfOsd |
Specify the number of object storage daemons (OSDs) that you want to create. ODF creates three times the specified number. For example, if you Specify 1, ODF creates 3 OSDs. |
1 |
Yes |
autoDiscoverDevices |
Classic Specify true to automatically discover the available disks on your worker nodes. |
true |
Yes |
osdDevicePaths |
Classic Specify a comma separated list of the device paths for the devices that you want to use for the OSD devices. The devices that you specify are used as your application storage in
your configuration. Each device must have at least 100GiB of space and must be unformatted and unmounted. The parameter format is /dev/disk/by-id/<device-id>. Example device path value for a partitioned
device: /dev/disk/by-id/scsi-0000000a00a00a00000a0aa000a00a0a0-part2. If you specify more than one device path, be sure there are no spaces between each path. For example: /dev/disk/by-id/scsi-1111111a11a11a11111a1aa111a11a1a1-part2,/dev/disk/by-id/scsi-0000000a00a00a00000a0aa000a00a0a0-part2. |
N/A | Yes |
billingType |
Specify a billingType of either essentials or advanced for your deployment. For more information about billing type, see Feature support by billing type. |
advanced |
Yes |
ocsUpgrade |
Specify true to upgrade the major version of your ODF deployment. |
false |
Yes |
workerPool |
4.14 and later Specify one of workerPool or workerNodes. Specify either the name or the ID of a worker pool to use for ODF. Don't specify this option if you want
to use all the worker nodes in your cluster. To retrieve your worker node name, run the ibmcloud oc worker ls -C CLUSTER command. |
N/A | Yes |
workerNodes |
Specify one of workerPool or workerNodes. Specify the names of the worker nodes that you want to use for your ODF deployment. Don't specify this option if you want to use all the worker nodes in your cluster. To
retrieve your worker node name, run the oc get nodes command. |
N/A | Yes |
clusterEncryption |
Optional: Specify true to enable encryption. |
false |
No |
hpcsServiceName |
Optional: Specify the name of your Hyper Protect Crypto Services or Key Protect instance. For example: Hyper-Protect-Crypto-Services-eugb. |
false |
Yes |
hpcsInstanceId |
Optional: Specify your Hyper Protect Crypto Services or Key Protect instance ID. For example: d11a1a43-aa0a-40a3-aaa9-5aaa63147aaa. |
N/A | Yes |
hpcsSecretName |
Optional: Specify the name of the secret that you created by using your Hyper Protect Crypto Services or Key Protect credentials. For example: ibm-hpcs-secret. |
N/A | Yes |
hpcsBaseUrl |
Optional: Specify the public or private endpoint of your Hyper Protect Crypto Services or Key Protect instance. For example: https://api.eu-gb.hs-crypto.cloud.ibm.com:8389. |
N/A | Yes |
hpcsTokenUrl |
Optional: Specify https://iam.cloud.ibm.com/identity/token. |
N/A | Yes |
encryptionInTransit |
4.13 and later Specify true to enable in-transit encryption. Enabling in-transit encryption does not affect the existing mapped or mounted volumes. After a volume is mapped/mounted,
it retains the encryption settings that were used when it was initially mounted. To change the encryption settings for existing volumes, they must be remounted again one-by-one. |
false |
No |
ignoreNoobaa |
[4.13 and later] Specify true if you do not want to deploy MultiCloud Object Gateway. |
true |
No |
disableNoobaaLB |
4.14 and later Specify true to disable to NooBaa public load balancer. |
false |
No |
taintNodes |
4.14 and later Specify true to taint the selected worker nodes so that only OpenShift Data Foundation pods can run on those nodes. Use this option only if you limit ODF to
a subset of nodes in your cluster. |
false |
No |
addSingleReplicaPool |
4.14 and later Specify true to create a single replica pool without data replication, increasing the risk of data loss, data corruption, and potential system instability. |
false |
No |
prepareForDisasterRecovery |
4.14 and later Specify true to set up the storage system for disaster recovery service with the essential configurations in place. This allows seamless implementation of disaster
recovery strategies for your workloads. |
false |
Yes |
useCephRBDAsDefaultStorageClass |
4.15 and later Set the Ceph RADOS block device (RBD) storage class as the default storage class in the cluster during the deployment of OpenShift Data Foundation. Make sure you remove the
existing default storage class before setting this parameter to true. |
false |
Yes |
enableNFS |
4.15 and later Enabling this feature allows you to export Network File System (NFS) data that can then be accessed internally or externally from the OpenShift cluster. | false |
Yes |
resourceProfile |
4.15 and later Specify a resource profile based on the availability of resources during deployment. Select either lean which requires 24 CPUs and 72GiB memory, balanced which requires 30 CPUs and 72 GiB memory, or performance which requires 45 CPUs and 96 GiB memory. |
balanced |
Yes |