Merge pull request #1042 from cgoveas/release-1.2

Release 1.2
dell · Apr 21, 2022 · 176bb71 · 176bb71
2 parents 39c32d1 + 0dd6d5b
commit 176bb71
Show file tree

Hide file tree

Showing 9 changed files with 29 additions and 29 deletions.
diff --git a/docs/Input_Parameter_Guide/Control_Plane_Parameters/base_vars.md b/docs/Input_Parameter_Guide/Control_Plane_Parameters/base_vars.md
@@ -20,7 +20,7 @@ This file is located in [/control_plane/input_params](../../../control_plane/inp
 | mount_location	[Required]		          |   **/opt/omnia/**                                                                                     |   The filepath where the grafana persistent   volume will be created. <br> When `telemetry.yml` is run, both the   `timescaledb` and the `mysqldb` are stored here.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          	|
 | provision_method   [Required]               |   **PXE**, idrac                                                                                      |     This variable is used to set node provisioning method <br> If   `device_config_support` is true, **PXE** will be used. <br> __Note__ :   This parameter is case sensitive.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               	|
 | provision_state [Required]                  |   **stateful**                                                                                        |   If       stateful is set, cobbler is used to provision disks. Stateless is   currently     not supported.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  	|
-| provision_os   [Required]                   |   **rocky**, centos   ,   leap                                                                        |     This is the operating system image that will   be used for provisioning compute nodes in   the cluster.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  	|
+| provision_os   [Required]                   |   **rocky**, centos,leap	                                                                          |     This is the operating system image that will   be used for provisioning compute nodes in   the cluster.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  	|
 | iso_file_path	[Required]	                  |     **/root/Rocky-8.x-x86_64-minimal.iso**,     <br><br>/root/openSUSE-Leap-15.3-NET-x86_64-Media.iso |      Provide the relevant ISO file path. This   ISO file is used by Cobbler   to   provision the OS on the   compute   nodes. **Note**: It is recommended that   the ISO image file is not renamed.     And, you **must not** change the path of this ISO image file as the   provisioning of the OS on the compute   nodes may be impacted.	                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 	|
 | timezone   [Required]	                      |   	**GMT**	                                                                                          |  Enter a timezone that is set during the   provisioning of OS. **GMT** is set as   the   default time zone. You can set   the     time zone to **EST**, **CET**,   **MST**, **CST6CDT**, or **PST8PDT**.     For a   list of available time   zones,   see the   `appliance/common/files/timezone.txt`     file.	                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             	|
 | language [Required]	                      |   	**en-US**	                                                                                      |      Set the language used during the     provisioning of OS. By default, it is   set to **en-US**.	                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          	|

diff --git a/docs/Input_Parameter_Guide/Security_Parameters/security_vars.md b/docs/Input_Parameter_Guide/Security_Parameters/security_vars.md
@@ -13,6 +13,6 @@ Configure the below parameters to set up security on the Control Plane (`/contro
 | user                                                                                 |                                                       | Array of users that are allowed or   denied based on the `allow_deny`     value. Multiple users must be separated by a space. Accepted user value formats are: root [email protected]. <br> __Note:__ If IPs are to be specified in the user value, ensure that every IP associated with the host (often 2 or more) in question is listed in the user list. <br> __Eg:__ For a host with IPs xx.xx.xx.xx and yy.yy.yy.yy where root is to be restricted, the user array will contain [email protected] [email protected]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 | allow_deny                                                                           | **Allow**                                             | This variable sets whether the user list   is Allowed or Denied. <br>     Accepted Values: Allow, Deny                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 | restrict_program_support                                                             | **false**                                             | This variable sets whether the network   services/protocols listed in `restrict_softwares` are to be blocked.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
-| restrict_softwares                                                                   |                                                       | Array of services/protocols to be   blocked by Omnia. Values are to be separated by commas. <br> Accepted   values: telnet,lpd,bluetooth,rlogin,rexec <br> Non Accepted values:   ftp,smbd,nmbd,automount,portmap                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
+| restrict_softwares                                                                   |                                                       | Array of services/protocols to be   blocked by Omnia. Values are to be separated by commas. <br> Accepted   values: telnet,lpd,bluetooth,rlogin,rexec <br> Non Accepted values:   ftp,smbd,nmbd,automount,portmap <br> __Note:__ This parameter is __Case Sensitive__.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
 
 >> __Note:__ The same parameters are also available in `omnia_security_config.yml` to configure security for the Login Node.
diff --git a/docs/README.md b/docs/README.md
@@ -42,9 +42,9 @@ Omnia can deploy firmware, install Kubernetes or Slurm (or both), along with add
 1. Verify that your system meets Omnia's [hardware](Support_Matrix/Hardware) and [software requirements](Support_Matrix/Software/Operating_Systems)
 2. Ensure that all [pre-requisites](PreRequisites) are met.
 3. Fill out all the required [input parameters](Input_Parameter_Guide).
-4. [Run Control_Plane](Installation_Guides/INSTALL_OMNIA_CONTROL_PLANE.md) to provision OS's, [configure devices](Device_Configuration) and set up [security measures](Security):
+4. [Run Control_Plane](Installation_Guides/INSTALL_OMNIA_CONTROL_PLANE.md) to provision OS's, [configure devices](Device_Configuration) and set up [security measures](Security).
 5. [Run Omnia](Installation_Guides/INSTALL_OMNIA_CLI.md) to set up Kubernetes and Slurm.
-6. Run the telemetry playbook to [set up](Installation_Guides/INSTALL_TELEMETRY.md) and use [Telemetry and Visualization Services](Telemetry_Visualization)
+6. Run the telemetry playbook to [set up](Installation_Guides/INSTALL_TELEMETRY.md) and use [Telemetry and Visualization Services](Telemetry_Visualization).
 ![Omnia Flow](images/Omnia_Flow.png)
 
 ## Troubleshooting Omnia

diff --git a/docs/Security/ENABLE_SECURITY_CONTROL_PLANE.md b/docs/Security/ENABLE_SECURITY_CONTROL_PLANE.md
@@ -26,6 +26,8 @@ To encourage security, users who have been idle over 3 minutes will be logged ou
 
 Optionally, different communication protocols can be disabled on the control plane using the `restrict_program_support` and `restrict_softwares` variables. These protocols include: telnet,lpd,bluetooth,rlogin and rexec. Features that cannot be disabled include: ftp,smbd,nmbd,automount and portmap. 
 
+>> __Note:__ The parameter `restrict_softwares` is __case-sensitive__
+
 ## Logging Program Executions using Snoopy
 
 Omnia installs Snoopy to log all program executions on Linux/BSD systems. For more information on Snoopy, click [here](https://github.com/a2o/snoopy).

diff --git a/docs/Security/ENABLE_SECURITY_LOGIN_NODE.md b/docs/Security/ENABLE_SECURITY_LOGIN_NODE.md
@@ -18,6 +18,8 @@ To encourage security, users who have been idle over 3 minutes will be logged ou
 
 Optionally, different communication protocols can be disabled on the control plane using the `restrict_program_support` and `restrict_softwares` variables in `omnia_security_vars.yml. These protocols include: telnet,lpd,bluetooth,rlogin and rexec. Features that cannot be disabled include: ftp,smbd,nmbd,automount and portmap. 
 
+>> __Note:__ The parameter `restrict_softwares` is __case-sensitive__
+
 ## Logging Program Executions using Snoopy
 
 Omnia installs Snoopy to log all program executions on Linux/BSD systems. For more information on Snoopy, click [here](https://github.com/a2o/snoopy).