Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.

Search for | Example | Results |
---|---|---|
A single word | cat
|
Topics that contain the word "cat". You will also find its grammatical variations, such as "cats". |
A phrase. You can specify that the search results contain a specific phrase. |
"cat food" (quotation marks) |
Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase. |

Search for | Operator | Example |
---|---|---|
Two or more words in the same topic |
|
|
Either word in a topic |
|
|
Topics that do not contain a specific word or phrase |
|
|
Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
A combination of search types | ( ) parentheses |
|
Configure the install.properties file
On the (first) master node, go to the <foundation_temp_dir>
directory, and edit the install.properties
file by setting the following parameters:
* MASTER_NODES="<master node IP address>"
* WORKER_NODES="<worker node 1 IP address> <worker node 2 IP address> <worker node 3 IP address>"
* EXTERNAL_ACCESS_HOST=<master node FQDN>
* NFS_SERVER=<master node IP address>
* DEFAULT_DB_TYPE=<EMBEDDED | EXTERNAL_PG >
* REGISTRY_ORGNAME=hpeswitom
Additionally, configure the following proxy settings if access to the Docker Hub or registry requires a proxy to connect to the internet:
* DOCKER_HTTP_PROXY="<HTTP proxy URL>:<port>"
* DOCKER_HTTPS_PROXY="<HTTPS proxy URL>:<port>"
* DOCKER_NO_PROXY=<IP address>
To reuse the install.properties
file for additional master and worker node installations, list all IP addresses or FQDNs for all cluster nodes that you are going to install. Make sure that all FQDNs are resolved to the correct IP addresses, not the loop back IP 127.0.0.1.
This configuration uses the master node as the NFS server. If you installed a separate NFS server, configure the NFS server IP in the NFS_SERVER parameter. For a full description of the parameters in the install.properties
file, see Parameters in the install.properties file.
Caution The worker node IP addresses must be separated with a space, and the master node and worker nodes must have a static IP address. Additionally, the EXTERNAL_ACCESS_HOST parameter must be set to an FQDN with only lowercase letters.

The following parameters in the install.properties
file are required to correctly configure the Kubernetes cluster.
Note The table below lists settings that are only mandatory if you are using multiple master nodes. Also, the file contains settings for Oracle databases. Note that Oracle databases are currently not supported by the Operations Bridge Suite.
Parameter | Description | Notes |
---|---|---|
MASTER_NODES
|
Lists the cluster master nodes (IPv4 format), separated by a blank and enclosed in double quotes. If you use more than one master node, you must work with high availability. Example:
|
Mandatory |
WORKER_NODES
|
Lists the cluster worker nodes, separated by a blank and enclosed in double quotes.
If you also want to use a master node as a worker node, enter its address in Typically, a worker node runs the workload when you deploy a suite. By default, when you install a suite, you target a worker node. Example:
|
Mandatory |
EXTERNAL_ACCESS_HOST
|
Defines a fully qualified domain name for external clients to access cluster services. The specified name must resolve the IP address where the ingress is running. The host name must be DNS resolvable, not only via Example:
|
Mandatory |
NFS_SERVER
|
Specifies the IP (IPv4) address of the NFS server that serves the persistent volumes of the cluster services. Example:
|
Mandatory |
CLIENT_CA_FILE
|
Specifies the CA certificate that is used for TLS authentication to the API server. The value is the file name of the CA certificate including the absolute path. When the master node is installed, it will generate a number of certificates and keys that are required when you install other master or worker nodes. You must copy these files and specify them in the Example:
|
Mandatory only for worker nodes |
CLIENT_CERT_FILE
|
Specifies the certificate that is used for TLS authentication to the API server. The value is the file name of the certificate including the absolute path. When the master node is installed, it will generate a number of certificates and keys that are required when you install other master or worker nodes. You must copy these files and specify them in the Example:
|
Mandatory only for worker nodes |
CLIENT_KEY_FILE
|
Specifies the private key that is used for TLS authentication to the API server. The value is the file name of the private key including the absolute path. When the master node is installed, it will generate a number of certificates and keys that are required when you install other master or worker nodes. You must copy these files and specify them in the Example:
|
Mandatory only for worker nodes |
HA_VIRTUAL_IP
|
Sets up a virtual IP address (single IPv4 address enclosed in double quotes) when setting up multiple master nodes. The IP address must not be occupied before the installation. The virtual IP, the master node, and the worker nodes must all exist in the same subnet. Example:
|
Mandatory only if you are using multiple master nodes |
PEER_CA_FILE
|
Specifies the CA certificate for TLS authentication. The value of the parameter is the file name of the CA certificate, including the absolute path. Example:
|
Mandatory only if you are using multiple master nodes |
PEER_CERT_FILE
|
Specifies the certificate for TLS authentication. The value of the parameter is the file name of the certificate, including the absolute path. Example:
|
Mandatory only if you are using multiple master nodes |
PEER_KEY_FILE
|
Specifies the private key for TLS authentication. The value of the parameter is the file name of the private key, including the absolute path. Example:
|
Mandatory only if you are using multiple master nodes |
NFS_FOLDER
|
Specifies the root folder (fully-qualified directory) for the persistent volume that the NFS server exports. Note If a container stops and is restarted, all changes made inside the container are lost. When you install the infrastructure, you must either install an NFS server or use the (first) master node as the NFS server. The NFS server shares out the network volumes. Example:
|
Optional |
ROOTCA
|
Specifies the root or intermediate CA certificate for generating server and client certificates. The value of the parameter is the file name of the CA certificate, including the absolute path. When you install the Container Deployment Foundation, all communication between the components is secured via TLS. Therefore, communications use certificates to maintain security. These certificates can be self-signed or signed with a Certificate Authority. The default value is a self-signed certificate. Example:
|
Optional |
ROOTCAKEY
|
Specifies the CA key for generating server and client certificates. The value of the parameter is the file name of the CA key, including the absolute path. When you install the infrastructure, all communication between the components is secured via TLS. Therefore, communications use certificates to maintain security. These certificates can be self-signed or signed with a Certificate Authority. The default value is a self-signed certificate. Example:
|
Optional |
NFS_STORAGE_SIZE
|
Specifies the size of the NFS volume exported by the NFS server. Example:
|
Optional |
K8S_HOME
|
Specifies the installation directory (fully-qualified directory) for the core platform binaries. Example:
|
Optional |
MASTER_API_PORT
|
Specifies the HTTP port for the Kubernetes (K8S) API server. If you want to use K8S, you must dock to the K8S API server. The Example:
|
Optional |
MASTER_API_SSL_PORT
|
Specifies the HTTPS port for the K8S API server.
If you want to use K8S, you must dock to the K8S API server. The Example:
|
Optional |
THINPOOL_DEVICE
|
Specifies the path to a Docker device mapper storage driver. To configure the thinpool device, see the Docker documentation. Note If this parameter is specified, the installation will use the devicemapper(direct-lvm) Docker storage driver. If it is not specified, the installation will use devicemapper(loop). For production environments, HPE recommends devicemapper(direct-lvm). Example:
|
Optional |
DEFAULT_DB_TYPE
|
Specifies the database type that the CDF will use for the service connection. The possible values for
When you decide to use an external PostgreSQL database, you must additionally specify the Example:
|
Mandatory |
DEFAULT_DB_HOST
|
Specifies the database host when choosing the external PostgreSQL database as the Example:
|
Mandatory only if you choose EXTERNAL_PG as the DEFAULT_DB_TYPE and the DEFAULT_DB_CONNECTION_URL is not specified. |
DEFAULT_DB_PORT
|
Specifies the database port when choosing the external PostgreSQL database as the Example:
|
Mandatory only if you choose EXTERNAL_PG as the DEFAULT_DB_TYPE and the DEFAULT_DB_CONNECTION_URL is not specified. |
DEFAULT_DB_NAME
|
Specifies the database name when choosing the external PostgreSQL database as the Example:
|
Mandatory only if you choose EXTERNAL_PG as the DEFAULT_DB_TYPE and the DEFAULT_DB_CONNECTION_URL is not specified. |
DEFAULT_DB_CONNECTION_URL
|
Specifies the database connection URL when choosing the external PostgreSQL database as the Example:
|
Mandatory only if you choose EXTERNAL_PG as the DEFAULT_DB_TYPE and the DEFAULT_DB_HOST , DEFAULT_DB_PORT , and DEFAULT_DB_NAME are not specified. |
DOCKER_HTTP_PROXY
|
Specifies the proxy settings for Docker. Configure this parameter if access to the Docker hub or registry requires a proxy (the default value is no proxy). The value of the parameter is any valid HTTP proxy URL. When you install suites and launch containers on Docker inside the K8S cluster, you may need to download the images from the internet, for which you need to use proxies. Example:
|
Optional |
DOCKER_HTTPS_PROXY
|
Specifies the proxy settings for Docker. Configure this parameter if access to the Docker hub or registry requires a proxy (the default value is no proxy). The value of the parameter is any valid HTTPS proxy URL. When you install suites and launch containers on Docker inside the K8S cluster, you may need to download the images from the internet, for which you need to use proxies. Example:
|
Optional |
DOCKER_NO_PROXY
|
Specifies the IPv4 IP address or FQDN that does not need the proxy settings for Docker. Example:
|
Optional |
REGISTRY_ORGNAME
|
Specifies the organization name where the suite images are placed. The default name is Example:
|
Mandatory |
FLANNEL_IFACE
|
Specifies the IPv4 address or the interface name for the Docker inter-host communication to use. This setting is used when the nodes have more than one network adapter. Example:
|
Mandatory only if you install CDF on a node which has more than one network adapter. |
CLOUD_PROVIDER
|
Specifies the cloud provider when installing the CDF on a cloud server. Example:
|
Optional |
AWS_REGION
|
Specifies the AWS region to use when choosing AWS as the cloud provider. The default value of this parameter is an empty string. Example:
|
Mandatory only if you choose AWS as the cloud provider. |
We welcome your comments!
To open the configured email client on this computer, open an email window.
Otherwise, copy the information below to a web mail client, and send this email to ovdoc-asm@hpe.com.
Help Topic ID:
Product:
Topic Title:
Feedback: