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	`AND` `and` `+` (plus symbol) `&` (ampersand)	`cat AND dog` `"cat food"+milk` `"cat food"&"dog food"`
Either word in a topic	`OR` `or` `\|` (pipe)	`cat OR dog` `cat \| dog`
Topics that do not contain a specific word or phrase	`NOT` `not` `!` (exclamation point)	`NOT cat` `! dog`
Topics that contain one string and do not contain another	`^` (caret)	`cat ^ mouse`
A combination of search types	`( )` parentheses	`cat + (dog \| mouse)` `cat \| dog + (! mouse)`

Operations Bridge Suite2017.04

Install > Installation > Install the ITOM Platform > Step 5. Set up one master node

Step 5. Set up one master node

The following steps describe how to install the ITOM Platform on a master node.

Make sure you have already downloaded the installation package to a temporary directory on the master node. For details, see Step 3. Unzip the installation package.
Unzip the zip file.
Skip this step if you use a dedicated NFS server. If you did not install a dedicated NFS server, you must set up the master node as the NFS server.
1. On the master node, run the following command to set up the core NFS share:
  
  <platform_temp_dir>/scripts/setupNFS.sh
2. Then run the following command to set up the Operations Bridge NFS share:
  
  <platform_temp_dir>/scripts/setupNFS.sh /var/vols/itom/<opsbridge_directory>
  
  Replace <opsbridge_directory> with a directory name you choose, for example opsbridge.
On the master node, go to the <platform_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>" * INGRESS_HOST=<master node IP address> * EXTERNAL_ACCESS_HOST=<master node FQDN> * NFS_SERVER=<master node IP address> * REGISTRY_ORGNAME=hpeswitom

Additionally, configure the proxy settings if you want to pull the Docker images from the master node and you need a proxy to connect to the internet.

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.
On the master node, access the <platform_temp_dir> directory, and run the following command:

./install

Wait until the installation on the master node is complete.

Tip You can check the installation log at /opt/kubernetes/install-<date><time>.log

In the following installation steps, the directory containing the installed ITOM Platform files (/opt/kubernetes by default) will be referred to as <platform_install_dir>.

Parameters in the install.properties file

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. Note that the Operations Bridge Suite 2017.04 does not support multiple master node setups.

Parameter	Description	Notes
`MASTER_NODES`	Lists the cluster master nodes (IPv4 format), separated by a blank and enclosed in double quotes. Example: `MASTER_NODES="10.10.10.10 10.10.10.11 10.10.10.12"`	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 `WORKER_NODES`. 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: `WORKER_NODES="16.255.255.255"`	Mandatory
`INGRESS_HOST`	Defines the IP address (a single IPV4 address) of the node on which you want to start the Ingress Controller. You must use one of the master or worker nodes. Everything that runs on a cluster is actually on a private network, which is not externally accessible. If you want any suite functionality to be available from outside the network (for example, a Help Desk operative on client machine on another network that needs to access Service manager), you must provide an ingress into the cluster to be able to access the functionality. This is done by configuring the INGRESS_HOST and EXTERNAL_ACCESS_HOST parameters. Example: `INGRESS_IP=10.10.10.10` (IP address of one of the master nodes)	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 `/etc/hosts`. Example: `EXTERNAL_ACCESS_HOST=myd.XXXX.YYY.net`	Mandatory
`NFS_SERVER`	Specifies the IP (IPv4) address of the NFS server that serves the persistent volumes of the cluster services. Example: `NFS_SERVER=16.255.25.255`	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 `install.properties` file. Example: `CLIENT_CA_FILE=/tmp/ca.crt`	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 `install.properties` file. Example: `CLIENT_CERT_FILE=/tmp/client.crt`	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 `install.properties` file. Example: `CLIENT_KEY_FILE=/tmp/client.key`	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: `HA_VIRTUAL_IP="18.16.10.9"`	Mandatory only if you are using multiple master nodes
`HA_NGINX_NODES`	Specifies the IP addresses of the two master nodes that will run `Nginx` and `keepalived` for the API server Ingress load balancing. The value of the parameter is a space-delimited list of the two IPv4 address of the master nodes enclosed in double quotes. Example: `HA_NGINX_NODES="10.10.10.10 10.10.10.11"`	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: `PEER_CA_FILE=/tmp/ca/crt`	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: `PEER_CERT_FILE=/tmp/server.crt`	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: `PEER_KEY_FILE=/tmp/server.key`	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. If you want to save information such as configuration files, any other files, or databases, they must be located outside the container in a persistent volume provided by a Network File System (NFS). When you install the infrastructure, you must install an NFS server that shares out the network volumes. The server can be a master node or an external server. Example: `NFS_FOLDER=/var/vols/itom`	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 ITOM Platform, 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: `ROOTCA=/tmp/ca.crt`	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: `ROOTCA=/tmp/ca.key`	Optional
`NFS_STORAGE_SIZE`	Specifies the size of the NFS volume exported by the NFS server. Example: `NFS_STORAGE_SIZE=50Gi`	Optional
`K8S_HOME`	Specifies the installation directory (fully-qualified directory) for the core platform binaries. Example: `K8S_HOME=/opt/kubernetes`	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 `kubectl` command line tool communicates with the K8S server. Example: `MASTER_API_PORT=8080`	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 `kubectl` command line tool communicates with the K8S server. Example: `MASTER_API_SSL_PORT=6443`	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). Example: `THINPOOL_DEVICE=/dev/mapper/docker-thinpool`	Optional
`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: `DOCKER_HTTP_PROXY="http://web.proxy.host.domain:8080"`	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: `DOCKER_HTTPS_PROXY="https://web.proxy.host.domain:8080"`	Optional
`REGISTRY_ORGNAME`	Specifies the organization name where the suite images are placed. The default name is `hpeswitomsandbox`. Example: `REGISTRY_ORGNAME=hpeswitomsandbox`	Optional
`FLANNEL_IFACE`	Specify the IPv4 address or the interface name for the Docker inter-host communication to use. Example: `FLANNEL_IFACE=10.10.10.10`	Optional

Send Help Center feedback