Merge branch 'devel' into ib_conf_file

control_plane/input_params/base_vars.yml

@@ -14,60 +14,60 @@
 ---
 
 # Path to directory hosting ansible config file (ansible.cfg file)
-# Default value is /etc/ansible
+# Default value: /etc/ansible
 # 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
 ansible_conf_file_path: /etc/ansible
 
 # This variable is used to enable ethernet switch configuration
-# It accepts boolean values "true" or "false". 
-# By default its value is "false".
+# Accepted values:  "true" or "false". 
+# Default value: "true".
 # If ethernet switch support is needed set this to "true"
 ethernet_switch_support: true
 
 # This variable is used to enable infiniband switch configuration
-# It accepts boolean values "true" or "false". 
-# By default its value is "false".
+# Accepted values:  "true" or "false". 
+# Default value: "true".
 # If infiniband configuration is needed set this to "true"
 ib_switch_support: true
 
 # This variable is used to enable powervault configuration
-# It accepts boolean values "true" or "false". 
-# By default its value is "false".
-# If powervault configuration is needed set this to "true"
+# Accepted values:  "true" or "false". 
+# Default value: "false".
+# If powervault configuration is needed, set this to "true"
 powervault_support: false
 
 # The nic/ethernet card that will be connected to the public internet.
-# Default value of nic is eno2
+# Default value: eno2
 public_nic: "eno2"
 
 # Kubernetes pod network CIDR for appliance k8s network
 # Make sure this value does not overlap with any of the host networks.
-# Default value is "192.168.0.0/16"
+# Default value: "192.168.0.0/16"
 appliance_k8s_pod_net_cidr: "192.168.0.0/16"
 
 ### Usage: provision_idrac, network_ib, network_ethernet, powervault_me4 ###
 
 # The trap destination IP address is the IP address of the SNMP Server where the trap will be sent
-# If this variable is left blank, it means SNMP will be disabled
+# If this variable is left blank, SNMP will be disabled.
 # Provide a valid SNMP server IP
 snmp_trap_destination: ""
 
 # Provide the snmp community name needed
-# By default this is set to "public"
+# Default value:"public"
 snmp_community_name: "public"
 
 ### Usage: webui_awx ###
 
 # Organization name that is created in AWX.
-# The default value is “DellEMC”
+# Default value: “DellEMC”
 awx_organization: "DellEMC"
 
 ### Usage: provision_cobbler, provision_idrac ###
 
 # This variable is used to set node provisioning method
-# It accepts values: idrac, pxe
-# Default value is "idrac"
+# Accepted values: idrac, pxe
+# Default value: "idrac"
 # If provisioning needs to be done through cobbler, set it to "pxe"
 # If idrac license is not present, provisioning mode will be set to "pxe"
 provision_method: "idrac"
@@ -85,7 +85,7 @@ language: "en-US"
 # This is the path where the user has to place the iso image that needs to be provisioned in target nodes.
 # The iso file should be CentOS7-2009-minimal edition.
 # Other iso files are not supported.
-# Mandatory value required
+# Required field
 iso_file_path: "/root/CentOS-7-x86_64-Minimal-2009.iso"
 
 # Default lease time that will be used by dhcp
@@ -93,7 +93,7 @@ iso_file_path: "/root/CentOS-7-x86_64-Minimal-2009.iso"
 # Min: 21600 seconds
 # Default: 86400 seconds
 # Max: 31536000 seconds
-# Mandatory value required
+# Required field
 default_lease_time: "86400"
 
 ### Usage: control_plane_device ###
@@ -101,12 +101,12 @@ default_lease_time: "86400"
 # The nic/ethernet card that needs to be connected to provision 
 # the fabric, idrac and powervault.
 # This nic will be configured by Omnia for the DHCP server.
-# Default value of nic is eno1
+# Default value: "eno1"
 mngmnt_network_nic: "eno1"
 
 # The dhcp range for assigning the IPv4 address
 # Example: 172.17.0.1
-# Mandatory value required
+# Required field
 mngmnt_network_dhcp_start_range: "172.19.0.100"
 mngmnt_network_dhcp_end_range: "172.19.0.200"
 
@@ -121,12 +121,12 @@ mngmnt_mapping_file_path: ""
 
 # The nic/ethernet card that needs to be connected to provision the OS of bare metal servers
 # This nic will be configured by Omnia for the DHCP server.
-# Default value of nic is eno3
+# Default value: "eno3"
 host_network_nic: "eno3"
 
 # The dhcp range for assigning the IPv4 address
 # Example: 172.17.0.1
-# Mandatory value required
+# Required field
 host_network_dhcp_start_range: "172.17.0.100"
 host_network_dhcp_end_range: "172.17.0.200"
 
@@ -146,7 +146,7 @@ host_mapping_file_path: ""
 
 # The nic/ethernet card that needs to be connected to configure infiniband switch
 # This nic will be configured by Omnia for the DHCP server.
-# Default value of nic is ib0
+# Default value: ib0
 ib_network_nic: "ib0"
 
 # The dhcp range for assigning the IPv4 address

control_plane/input_params/idrac_tools_vars.yml

@@ -23,25 +23,25 @@
 # 2FA will be enabled only if email notification is working using SMTP.
 
 # DNS domain name to set to iDRAC
-# Mandatory value required
+# Required field
 dns_domain_name: ""
 
 # IPV4 static DNS1 and DNS2
-# Mandatory value required
+# Required field
 ipv4_static_dns1: ""
 ipv4_static_dns2: ""
 
 # Server IP used for SMTP
-# Mandatory value required
+# Required field
 smtp_server_ip: ""
 
 # Email address used for enabling 2FA
-# Mandatory value required
+# Required field
 use_email_address_2fa: ""
 
 # SMTP authentication disabled by default
-# If enabled provide smtp username and password
-# Mandatory value required
+# If enabled, provide smtp username and password
+# Required field
 smtp_authentication: "disabled"
 
 # Username used for SMTP
@@ -60,13 +60,13 @@ smtp_password: ""
 
 # CA certification validation value
 # cert_validation_enable supports only disabled
-# CA Certificate can't be upload using this playbook idrac_ldap.yml.
+# CA Certificate can't be uploaded using the playbook idrac_ldap.yml.
 # If required user has to manually upload CA certificate after idrac_ldap.yml execution.
 cert_validation_enable: "disabled"
 
 # Sever address used for LDAP
-# Mandatory value required
-# Recommended to provided LDAP server ip address instead of FQDN
+# Required field
+# It's recommended to provide the LDAP server ip address instead of FQDN
 ldap_server_address: ""
 
 # TCP port port at which the LDAP server is listening for connections
@@ -83,7 +83,7 @@ bind_password: ""
 
 # The distinguished name of the search base. 
 # For example: dc=mycompany,dc=com
-# Mandatory value required
+# Required field
 base_dn: ""
 
 # User attribute used for search in LDAP server
@@ -92,9 +92,9 @@ user_attribute: ""
 # Group attribute used for search in LDAP server
 group_attribute: ""
 
-# Specify group attribute type is DN or not
-# Supported options are "enabled" or "disabled"
-# By default group_attribute_is_dn will be disabled
+# Specify whether the group attribute type is DN or not
+# Accepted Values: "enabled" or "disabled"
+# Default value: disabled
 group_attribute_is_dn: "disabled"
 
 # Search scope is related to the Base DN. 
@@ -104,11 +104,11 @@ search_filter: ""
 # DN of LDAP group be to added
 # Supports adding only one role group
 # For example: cn=Admins,cn=Group,dc=mycompany,dc=com
-# Mandatory value required
+# Required field
 role_group1_dn: ""
 
 # Privielege to LDAP role group 1
-# Supported options are Administrator, Operator, ReadOnly
-# By default role_group1_privilege will be Administrator
-# Mandatory value required
+# Supported values: "Administrator", "Operator", "ReadOnly"
+# Default value: role_group1_privilege will be "Administrator"
+# Required field
 role_group1_privilege: "Administrator"

control_plane/input_params/idrac_vars.yml

@@ -16,13 +16,13 @@
 ### Usage: provision_idrac ###
 
 # This indicates the system profile name used for BIOS configuration of the server
-# The values supported are - "Performance", "PerformancePerWatt(DAPC)", "PerformancePerWatt(OS)", "WorkstationPerformance".
-# The default value is "Performance"
+# Accepted values:  - "Performance", "PerformancePerWatt(DAPC)", "PerformancePerWatt(OS)", "WorkstationPerformance".
+# Default value:  "Performance"
 idrac_system_profile: "Performance"
 
 # Boolean value indicating whether OMNIA should perform firmware update or not
-# It takes values "true" or "false" indicating required and not required cases respectively.
-# Default value is "true"
+# Accepted values: true, false
+# Default value: true
 firmware_update_required: true
 
 # This is the list of poweredge server models
@@ -40,24 +40,24 @@ poweredge_model: C6420
 ### Usage: idrac_secure_boot ###
 
 # Specify whether the secure boot mode to be enabled
-# By default secure boot will be "disabled"
-# If required it can be "enabled"
+# Default value: "disabled"
+# Accepted values: "enabled", "disabled"
 uefi_secure_boot: "disabled"
 
 ### Usage: idrac_system_lockdown ###
 
 # Specify whether the system lockdown to be enabled
-# By default system lockdown will be "disabled"
-# If required it can be "enabled"
+# Default value: "disabled"
+# Accepted values: "enabled", "disabled"
 # Make sure system_lockdown is enabled only after OS provisioning is completed
 system_lockdown: "disabled"
 
 ### Usage: idrac_2fa ###
 
 # Specify whether the two factor authentication to be enabled
-# By default two factor authentication will be "disabled"
-# If required it can be "enabled"
-# [WARNING] Once 2FA is enabled, user has to disable 2FA manually. Other iDRAC playbooks won't run if 2FA is enabled
+# Default value: "disabled"
+# Accepted values: "enabled", "disabled"
+# [WARNING] Once 2FA is enabled, the user has to disable 2FA manually. Other iDRAC playbooks won't run if 2FA is enabled
 # Update 2FA input parameters in idrac_tools_vars.yml if two_factor_authentication is enabled
 # Command to edit idrac_tools_vars.yml: ansible-vault edit idrac_tools_vars.yml --vault-password-file .idrac_vault_key
 two_factor_authentication: "disabled"
@@ -65,8 +65,8 @@ two_factor_authentication: "disabled"
 ### Usage: idrac_ldap ###
 
 # Specify whether the LDAP directory services to be enabled
-# By default LDAP directory services will be disabled
-# If required it can be "enabled"
+# Default value: "disabled"
+# Accepted values: "enabled", "disabled"
 # Update 2FA input parameters in idrac_tools_vars.yml if two_factor_authentication is enabled
 # Command to edit idrac_tools_vars.yml: ansible-vault edit idrac_tools_vars.yml --vault-password-file .idrac_vault_key
 ldap_directory_services: "disabled"

control_plane/input_params/login_vars.yml

@@ -16,9 +16,9 @@
 ### Usage: provision_cobbler, provison_idrac ###
 
 # Password used while deploying OS on bare metal servers.
-# The Length of the password should be at least 8.
+# The Length of the password should be at least 8 characters.
 # The password must not contain -,\, ',"
-# Mandatory value required
+# Required field
 provision_password: ""
 
 ### Usage: provision_cobbler ###
@@ -26,19 +26,19 @@ provision_password: ""
 # Password used for cobbler
 # The Length of the password should be at least 8.
 # The password must not contain -,\, ',"
-# Mandatory value required
+# Required field
 cobbler_password: ""
 
 ### Usage: provision_idrac ###
 
 # The username for idrac
 # The username must not contain -,\, ',"
-# Mandatory value required
+# Required field
 idrac_username: ""
 
 # Password used for idrac
 # The password must not contain -,\, ',"
-# Mandatory value required
+# Required field
 idrac_password: ""
 
 ### Usage: webui_awx ###

control_plane/input_params/powervault_me4_vars.yml

@@ -16,11 +16,11 @@
 ### Usage: powervault_me4 ###
 
 # This variable indicates the language selection
-# Currently only "English" is supported
+# Currently, only "English" is supported
 locale: "English"
 
 # Specify the system name to identify the system
-# By default it is set to "Uninitialized_Name"
+# Default value:  "Uninitialized_Name"
 # Length should be less than 30 and it should not contain space.
 # Optional
 powervault_me4_system_name: "Unintialized_Name"
@@ -33,13 +33,13 @@ powervault_me4_system_name: "Unintialized_Name"
 # info: Sends notifications for all events.
 # none: All events are excluded from trap notification and traps are disabled. 
 # However, Critical events and managed-logs events 400–402 are sent regardless of the notification setting.
-# Default value is "none"
-# Compulsory
+# Default value: "none"
+# Required field
 powervault_me4_snmp_notify_level: "none"
 
 # The type of pool to be created on the powervault
 # It can be either linear or virtual.
-# Default: linear
+# Default value: "linear"
 powervault_me4_pool_type: "linear"
 
 # Specify the required RAID Level
@@ -49,8 +49,8 @@ powervault_me4_pool_type: "linear"
 # r6/raid6: 4-16
 # r10/raid10: 4-16
 # adapt: 12-128
-# Default value is "raid1"
-# Compulsory
+# Default value: "raid1"
+# Required field
 powervault_me4_raid_levels: "raid1"
 
 # Specify the range of disks
@@ -61,31 +61,31 @@ powervault_me4_raid_levels: "raid1"
 # For ME4012 - 0.0-0.11 are the allowed values
 # For RAID 10 disk range should be given in subgroups separated by colons with no spaces.
 # RAID-10 example:1.1-2:1.3-4:1.7,1.10
-# Default value is 0.1-2
-# Compulsory
+# Default value: 0.1-2
+# Required field
 powervault_me4_disk_range: "0.1-2"
 
 # Specify the volume names
-# the default value is "k8s_volume" and "slurm_volume"
-# Compulsory
+# Default value "k8s_volume" and "slurm_volume"
+# Required field
 powervault_me4_k8s_volume_name: "k8s_volume"
 powervault_me4_slurm_volume_name: "slurm_volume"
 
 # Specify the disk group name
-# Mandatory
+# Required field
 powervault_me4_disk_group_name: "omnia"
 
 # Specify the percentage for partition in disk
 # Default value is "60%"
 # Min: 5
 # Max: 90
-# Compulsory
+# Required field
 powervault_me4_disk_partition_size: "60"
 
 # Specify the volume size
 # Format: 100GB <SizeGB>
 # Default: 100GB
-# Compulsory
+# Required field
 powervault_me4_volume_size: "100GB"
 
 # Specify the pool for disk and volumes
@@ -95,6 +95,6 @@ powervault_me4_pool: "a"
 
 # Specify the nic of the server with which Powervault is connected.
 # Make sure nfs server also has 3 nics (for internet, OS provision and powervault connection)
-# Default value is em1.
-# Compulsory
+# Default value: "em1".
+# Required field
 powervault_me4_server_nic: "em1"