Input parameters for the cluster

These parameters are located in input/omnia_config.yml, input/security_config.yml, and input/storage_config.yml. To initiate telemetry support, fill out these parameters in input/telemetry_config.yml.

Caution

Do not remove or comment any lines in the input/omnia_config.yml, input/security_config.yml, input/telemetry_config.yml, and input/storage_config.yml file.

omnia_config.yml

Parameters for kubernetes setup
Variables	Details
k8s_cni `string` Required	Kubernetes SDN network. Required when `scheduler_type: "k8s"` Choices: `"calico"` <- default `"flannel"`
pod_external_ip_range `string` Required	These addresses will be used by Loadbalancer for assigning External IPs to K8s services Make sure the IP range is not assigned to any node in the cluster. Example: “10.11.0.100-10.11.0.150” , “10.11.0.0/16”
ansible_config_file_path `string` Required	Path to directory hosting ansible config file (ansible.cfg file) This directory is on the host running ansible, if ansible is installed using dnf If ansible is installed using pip, this path should be set Default value: `/etc/ansible`
k8s_service_addresses `string` Optional	Kubernetes internal network for services. This network must be unused in your network infrastructure. Default value: “10.233.0.0/18”
k8s_pod_network_cidr `string` Optional	Kubernetes pod network CIDR for internal network. When used, it will assign IP addresses from this range to individual pods. This network must be unused in your network infrastructure. Default value: “10.233.64.0/18”
topology_manager_policy `string` Optional	Kubernetes Topology manager policies. Accepted values are `none`, `best-effort`, `restricted`, or `single-numa-node`. Default value: `none` Example: `topology_manager_policy: "none"`
topology_manager_scope `string` Optional	Kubernetes Topology manager scope. Accepted values are `container` or `pod`. Default value: `container` Example: `topology_manager_scope: "container"`
run_intel_gaudi_tests `boolean` Optional	If value is `true`, Omnia performs validation tests on the nodes containing Intel Gaudi accelerators. It uses the Habana Collective Communications Library (HCCL) and Qualification tool. If value is `false`, Omnia does not perform any validation tests on the nodes. Accepted values are `true` or `false`. Default value: `false` Example: `run_intel_gaudi_tests: "false"`
k8s_offline_install `boolean` Optional	Default value: `true`. Keep it `true` when you want Omnia to provision OS on the cluster nodes. With the variable set to `true`, all packages and images necessary to set up a Kubernetes cluster are pulled from the OIM local repository. Set it to `false` only when you want to add external nodes (with pre-loaded OS) to a Kubernetes cluster. With the variable set to `false`, all packages and images necessary to set up a Kubernetes cluster are pulled from the internet instead of the OIM local repository.

security_config.yml

Parameters for Authentication
Parameter	Details
domain_name `string` Required	Sets the intended domain name. If dc=omnia,dc=test, Provide `omnia.test` If dc=dell,dc=omnia,dc=com Provide `dell.omnia.com` Default values: `omnia.test`

Parameters for OpenLDAP configuration
Parameter	Details
ldap_connection_type `string` Required	For a TLS connection, provide a valid certification path. For an SSL connection, ensure port 636 is open. Choices: `TLS` <- Default `SSL`
tls_ca_certificate `string` Optional	File path pointing to the Certificate Authority (CA) issued certificate path. Certificate files should be saved with a .pem or .crt extension. If not provided, a self-signed certificate is generated by Omnia.
tls_certificate `string` Optional	File path pointing to the certificate used to authorize the LDAP server. Certificate files should be saved with a .pem or .crt extension.
tls_certificate_key `string` Optional	The private key that matches the LDAP certificate.
openldap_db_username `string` Required	The username used to manage the LDAP database. Default value: `"admin"`
openldap_db_password `string` Required	The password used to configure and manage the LDAP database. Ensure that this value is 8 characters long.
openldap_config_username `string` Required	The username used to configure the LDAP database. Default value: `"admin"`
openldap_config_password `string` Required	The password used to configure the LDAP database. Ensure that this value is 8 characters long.
openldap_monitor_password `string` Required	The password used to monitor the LDAP database. Ensure that this value is 8 characters long.
openldap_organization `string` Required	LDAP server is configured using organizations. They are necessary for user creation and group mapping. Default value: `"omnia"`
openldap_organizationational_unit `string` Required	LDAP server is configured using organizations. They are necessary for user creation and group mapping. Default value: `"People"`

storage_config.yml

Parameters for Storage
Variables	Details
nfs_client_params `JSON List` Required	This JSON list contains all parameters required to set up NFS. Indicates if `k8s_share` or `slurm_share` is true. For a bolt-on set up where there is a pre-existing NFS export, set `nfs_server` to `false`. When `nfs_server` is set to `true`, an NFS share is created on the OIM for access by all cluster nodes. For more information on the different kinds of configuration available, click here.
beegfs_rdma_support `boolean` Optional	This variable is used if user has RDMA-capable network hardware (e.g., InfiniBand) Choices: `false` <- Default `true`
beegfs_ofed_kernel_modules_path `string` Optional	The path where separate OFED kernel modules are installed. Ensure that the path provided here exists on all target nodes. Default value: `"/usr/src/ofa_kernel/default/include"`
beegfs_mgmt_server `string` Required	BeeGFS management server IP. Note The provided IP should have an explicit BeeGFS management server running .
beegfs_mounts `string` Optional	Beegfs-client file system mount location. If `storage_yml` is being used to change the BeeGFS mounts location, set `beegfs_unmount_client` to `true`. Default value: “/mnt/beegfs”
beegfs_unmount_client `boolean` Optional	Changing this value to true will unmount running instance of BeeGFS client and should only be used when decommisioning BeeGFS, changing the mount location or changing the BeeGFS version. Choices: `false` <- Default `true`
beegfs_version_change `boolean` Optional	Use this variable to change the BeeGFS version on the target nodes. Choices: `false` <- Default `true`
ansible_config_file_path `string` Required	Path to directory hosting ansible config file (ansible.cfg file) This directory is on the host running ansible, if ansible is installed using dnf If ansible is installed using pip, this path should be set Default values: `/etc/ansible`
beegfs_secret_storage_filepath `string` Required	The filepath (including the filename) where the `connauthfile` is placed. Required for Beegfs version >= 7.2.7 Default values: `/home/connauthfile`

Click here for more information on OpenLDAP, BeeGFS, or NFS.

Note

The input/omnia_config.yml and input/security_config.yml files are encrypted during the execution of omnia.yml playbook. Use the below commands to edit the encrypted input files:
- omnia_config.yml:
  ansible-vault edit omnia_config.yml --vault-password-file .omnia_vault_key
- security_config.yml:
  ansible-vault edit security_config.yml --vault-password-file .security_vault.key

If you have any feedback about Omnia documentation, please reach out at omnia.readme@dell.com.