Customizing your installation

You can complete most of your cluster customization in the /<installation_directory>/cluster/config.yaml file. These customizations must be done during the installation of your cluster.

To review a full list of parameters that are available to customize, see Customizing the cluster with the config.yaml file.

You can also set node-specific parameters values in the /<installation_directory>/cluster/hosts file. However, parameter values that are set in the config.yaml file have the highest priority during an installation. To set a parameter value in the hosts file, you must remove the parameter from the config.yaml file. For more information about setting node-specific parameter values in the hosts file, see Setting the node roles in the hosts file.

General installation options

To customize your cluster, the following are a few of the optional features that can be configured during installation.

  1. Configure the monitoring service. See Configuring the monitoring service. Important: If you use a high availability configuration, follow the monitoring service configuration steps to allow the monitoring service to use a network shared storage provider.
  2. Specify a certificate authority (CA) for your cluster. See Specifying your own certificate authority (CA) for IBM Cloud Private services.
  3. Set up a federation. See Table 8: Federation settings. This feature is available as a technology preview only. This feature is not available for IBM Cloud Private-CE (Community Edition).
  4. Enable the Vulnerability Advisor. See Enabling the Vulnerability Advisor. This feature is not available for IBM Cloud Private-CE (Community Edition).
  5. Provision GlusterFS storage on worker nodes. See GlusterFS storage.
  6. Configure vSphere Cloud Provider. See Configuring a vSphere Cloud Provider.
  7. Configure AWS Cloud Provider. See AWS Cloud Provider settings.
  8. Create one or more storage classes for the storage provisioners in your environment. See Dynamic storage provisioning.
  9. Encrypt cluster data network traffic with IPsec. See Encrypting cluster data network traffic with IPsec.
  10. Encrypt the etcd key-value store. See Encrypting volumes by using eCryptfs. Note: eCryptfs is not supported on Red Hat Enterprise Linux (RHEL).
  11. Integrate VMware NSX-T 2.0 with IBM Cloud Private cluster nodes. See Integrating VMware NSX-T 2.0 with IBM Cloud Private.
  12. Specify a default Docker storage directory. See Specifying a default Docker storage directory by using bind mount.
  13. Specify other default storage directories. See Specifying other default storage directories by using bind mount.

HA installation options

Ensure that you review the High availability IBM® Cloud Private clusters topic. HA is supported for IBM Cloud Private Cloud Native and Enterprise editions only.

For HA clusters, configure the HA parameters:

  1. To configure HA for your master nodes, update the HA settings section in the config.yaml file. For the vip_iface parameter value, provide your environment's interface name. For the cluster_vip parameter value, provide an available IP address, preferably one from the same IP range that your cluster nodes use. The configuration resembles the following code:

    # HA settings
    vip_iface:  eth0
    cluster_vip:  5.5.5.1
    
  2. To configure HA for your proxy nodes, update the Proxy settings section in the config.yaml file. For the proxy_vip_iface parameter value, provide your environment's interface name. For the proxy_vip parameter value, provide an available IP address, preferably one from the same IP range that your cluster nodes use. The configuration resembles the following code:

    # Proxy settings
    proxy_vip_iface:  eth0
    proxy_vip:  5.5.5.2
    

    Note: You must use different IP addresses for the cluster_vip and proxy_vip parameter values.

    Note: You can also set these node-specific parameters in the hosts file. For example, you can set the vip_iface parameter values, as shown in the following code:

    [master]
    <master_node_1_IP_address> vip_iface=eth0
    <master_node_2_IP_address> vip_iface=ens192
    <master_node_3_IP_address> vip_iface=ens160
    

Parameter values in the config.yaml file have the highest priority during an installation. To set a parameter value in the hosts file, you must remove the parameter from the config.yaml file.

Cluster directory structure

The cluster directory contains the following files: