Merge pull request #2192 from cgoveas/main

Updating documentation
dell · Oct 16, 2023 · 38c8398 · 38c8398
2 parents 8837893 + 3ff52ca
commit 38c8398
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 5 deletions.
diff --git a/docs/Security/Security Configuration Guide.pdf b/docs/Security/Security Configuration Guide.pdf
diff --git a/docs/source/InstallationGuides/Benchmarks/OneAPI.rst b/docs/source/InstallationGuides/Benchmarks/OneAPI.rst
@@ -1,7 +1,7 @@
 Install oneAPI for MPI jobs on Intel processors
 ________________________________________________
 
-This topic explains how to manually install oneAPI for MPI jobs. To automate the procedure, `click here. <AutomatingOneAPI.html>`_
+This topic explains how to manually install oneAPI for MPI jobs. To install oneAPI automatically, `click here. <AutomatingOneAPI.html>`_
 
 **Pre-requisites**
 

diff --git a/docs/source/SecurityConfigGuide/ProductSubsystemSecurity.rst b/docs/source/SecurityConfigGuide/ProductSubsystemSecurity.rst
@@ -4,7 +4,7 @@ Product and Subsystem Security
 Security controls map
 ----------------------
 
-.. image:: ../images/securityControlsMap.JPG
+.. image:: ../images/securityControlsMap.jpg
 
 Omnia performs bare metal configuration to enable AI/HPC workloads. It uses Ansible playbooks to perform installations and configurations. iDRAC is supported for provisioning bare metal servers. Omnia installs xCAT to enable provisioning of clusters via PXE in different ways:
 
@@ -311,7 +311,7 @@ Omnia configures the following ports for use by third-party tools installed by O
 Data security
 -------------
 
-Omnia does not store data. The passwords Omnia accepts as input to configure the third party tools are validated and then encrypted using Ansible Vault.
+Omnia does not store data. The passwords Omnia accepts as input to configure the third party tools are validated and then encrypted using Ansible Vault. Run ``yum update --security`` routinely on the control plane for the latest security updates.
 
 For more information on the passwords used by Omnia, see Login Security Settings.
 

diff --git a/docs/source/Tables/Metrics.csv b/docs/source/Tables/Metrics.csv
@@ -47,7 +47,7 @@ gpu_health_thermal:gpu,For AMD GPU: ``rocm-smi --showbus --csv``,GPU temperature
 Kubernetespodsstatus,``sudo kubectl get pods -A -o json``,"Value is pass when all pods and containers are in running state, otherwise Fail.",Cluster Level
 Kuberneteschildnode,``sudo kubectl get nodes -o json``,"Value is pass when all child nodes are in Ready or Ready,SchedulingDisabled state, otherwise Fail.",Cluster Level
 kubernetesnodesstatus,``sudo kubectl get nodes -o json``,"Value is pass when all nodes are in Ready or Ready,SchedulingDisabled state, otherwise Fail.",Cluster Level
-kubernetescomponentsstatus,sudo kubectl get --raw=/livez?verbose,"Value is Pass when health check is passed in ``kubectl get --raw=/livez?verbose`` command , otherwise fail.",Cluster Level
+kubernetescomponentsstatus,``sudo kubectl get --raw=/livez?verbose``,"Value is Pass when health check is passed in ``kubectl get --raw=/livez?verbose`` command , otherwise fail.",Cluster Level
 Smart,``smartctl -a <device name>``,,Node Level
 gpu_temperature:gpu,"* For NVIDIA GPU: ``nvidia-smi --query-gpu=temperature.gpu --format=csv,nounits``
 * For AMD GPU: ``rocm-smi -t --csv``",,Node Level

diff --git a/docs/source/bestpractices.rst b/docs/source/bestpractices.rst
@@ -9,4 +9,5 @@ Best Practices
 * Review the prerequisites before running Omnia Scripts.
 * Ensure that the firefox version being used on the control plane is the latest available. This can be achieved using ``dnf update firefox -y``
 * It is recommended to configure devices using Omnia playbooks for better interoperability and ease of access.
-* Ensure that the ``/var`` partition has adequate space to complete commands.
+* Ensure that the ``/var`` partition has adequate space to complete commands.
+* Run ``yum update --security`` routinely on the control plane for the latest security updates.