Skip to content

Commit

Permalink
Updating doc links
Browse files Browse the repository at this point in the history
Signed-off-by: cgoveas <[email protected]>
  • Loading branch information
cgoveas committed Jun 9, 2023
1 parent 149ae01 commit bcc00bd
Show file tree
Hide file tree
Showing 14 changed files with 25 additions and 25 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Omnia (Latin: all or everything) is a deployment tool to turn servers with RPM-b

Omnia Documentation is hosted on [Read The Docs](https://omnia-doc.readthedocs.io/en/latest/index.html).

Current Status: ![GitHub](https://readthedocs.org/projects/omnia-documentation/badge/?version=latest)
Current Status: ![GitHub](https://readthedocs.org/projects/omnia-doc/badge/?version=latest)

## Licensing

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Building clusters
2. Create an inventory file in the *omnia* folder. Add login node IP address under the manager node IP address under the *[manager]* group, compute node IP addresses under the *[compute]* group, and Login node IP under the *[login_node]* group,. Check out the `sample inventory for more information <../samplefiles.html>`_.

.. note::
* RedHat nodes that are not configured by Omnia need to have a valid subscription. To set up a subscription, `click here <https://omnia-documentation.readthedocs.io/en/latest/Roles/Utils/rhsm_subscription.html>`_.
* RedHat nodes that are not configured by Omnia need to have a valid subscription. To set up a subscription, `click here <https://omnia-doc.readthedocs.io/en/latest/Roles/Utils/rhsm_subscription.html>`_.
* Omnia creates a log file which is available at: ``/var/log/omnia.log``.
* If only Slurm is being installed on the cluster, docker credentials are not required.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/InstallationGuides/CleanUpScript.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Uninstalling the provision tool
--------------------------------

Use this script to undo all the changes made by the provision tool. For a list of actions taken by the provision tool, `click here <https://omnia-documentation.readthedocs.io/en/latest/InstallationGuides/InstallingProvisionTool/installprovisiontool.html>`_ .
Use this script to undo all the changes made by the provision tool. For a list of actions taken by the provision tool, `click here <https://omnia-doc.readthedocs.io/en/latest/InstallationGuides/InstallingProvisionTool/installprovisiontool.html>`_ .

To run the script: ::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Configuring ethernet switches (Z series)

* Where ``ethernet_switch_username`` is the username used to authenticate into the switch.

* The inventory file should be a list of IPs separated by newlines. Check out the switch_inventory section in `Sample Files <https://omnia-documentation.readthedocs.io/en/latest/samplefiles.html>`_
* The inventory file should be a list of IPs separated by newlines. Check out the switch_inventory section in `Sample Files <https://omnia-doc.readthedocs.io/en/latest/samplefiles.html>`_

* Where ``ethernet_switch_password`` is the password used to authenticate into the switch.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Configuring ethernet switches (S3 and S4 series)

* Where ``ethernet_switch_username`` is the username used to authenticate into the switch.

* The inventory file should be a list of IPs separated by newlines. Check out the switch_inventory section in `Sample Files <https://omnia-documentation.readthedocs.io/en/latest/samplefiles.html>`_
* The inventory file should be a list of IPs separated by newlines. Check out the switch_inventory section in `Sample Files <https://omnia-doc.readthedocs.io/en/latest/samplefiles.html>`_

* Where ``ethernet_switch_password`` is the password used to authenticate into the switch.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Configuring ethernet switches (S5 series)

* Where ``ethernet_switch_username`` is the username used to authenticate into the switch.

* The inventory file should be a list of IPs separated by newlines. Check out the switch_inventory section in `Sample Files <https://omnia-documentation.readthedocs.io/en/latest/samplefiles.html>`_
* The inventory file should be a list of IPs separated by newlines. Check out the switch_inventory section in `Sample Files <https://omnia-doc.readthedocs.io/en/latest/samplefiles.html>`_

* Where ``ethernet_switch_password`` is the password used to authenticate into the switch.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -115,5 +115,5 @@ If ``enable_split_port`` is **false**, run::

* Passwords should contain at least one of each: Lowercase, uppercase and digits.

* The inventory file should be a list of IPs separated by newlines. Check out the ``switch_inventory`` section in `Sample Files <https://omnia-documentation.readthedocs.io/en/latest/samplefiles.html>`_
* The inventory file should be a list of IPs separated by newlines. Check out the ``switch_inventory`` section in `Sample Files <https://omnia-doc.readthedocs.io/en/latest/samplefiles.html>`_

2 changes: 1 addition & 1 deletion docs/source/SecurityConfigGuide/Preface.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Document references
In addition to this guide, more information on Omnia can be found through the below links:

* `Omnia: Read Me <https://github.com/dellhpc/omnia#readme>`_
* `Omnia: Quick Installation Guide <https://omnia-documentation.readthedocs.io/en/latest/InstallationGuides/index.html>`_
* `Omnia: Quick Installation Guide <https://omnia-doc.readthedocs.io/en/latest/InstallationGuides/index.html>`_

Reporting security vulnerabilities
----------------------------------
Expand Down
2 changes: 1 addition & 1 deletion prereq.sh
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@ echo "Please set the hostname for the control plane in the format hostname.domai
echo ""
echo "Once hostname is set, provide inputs in input/provision_config.yml and execute the playbook provision/provision.yml"
echo ""
echo "For more information: https://omnia-documentation.readthedocs.io/en/latest/InstallationGuides/InstallingProvisionTool/index.html"
echo "For more information: https://omnia-doc.readthedocs.io/en/latest/InstallationGuides/InstallingProvisionTool/index.html"
2 changes: 1 addition & 1 deletion provision/README.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Provision
----------

`Click here <https://omnia-documentation.readthedocs.io/en/latest/InstallationGuides/InstallingProvisionTool/index.html>`_ for more information on ``provision.yml``.
`Click here <https://omnia-doc.readthedocs.io/en/latest/InstallationGuides/InstallingProvisionTool/index.html>`_ for more information on ``provision.yml``.
2 changes: 1 addition & 1 deletion scheduler/readme.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Building clusters
2. Create an inventory file in the *omnia* folder. Add login node IP address under the manager node IP address under the *[manager]* group, compute node IP addresses under the *[compute]* group, and Login node IP under the *[login_node]* group,. Check out the `sample inventory for more information <../samplefiles.html>`_.

.. note::
* RedHat nodes that are not configured by Omnia need to have a valid subscription. To set up a subscription, `click here <https://omnia-documentation.readthedocs.io/en/latest/Roles/Utils/rhsm_subscription.html>`_.
* RedHat nodes that are not configured by Omnia need to have a valid subscription. To set up a subscription, `click here <https://omnia-doc.readthedocs.io/en/latest/Roles/Utils/rhsm_subscription.html>`_.
* Omnia creates a log file which is available at: ``/var/log/omnia.log``.
* If only Slurm is being installed on the cluster, docker credentials are not required.

Expand Down
2 changes: 1 addition & 1 deletion security/readme.rst
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ Run: ::
cd security
ansible-playbook security.yml -i inventory

The inventory should contain compute, manager, login_node as per the inventory file in `samplefiles <https://omnia-documentation.readthedocs.io/en/latest/samplefiles.html>`_.
The inventory should contain compute, manager, login_node as per the inventory file in `samplefiles <https://omnia-doc.readthedocs.io/en/latest/samplefiles.html>`_.

* To enable security features on the login node, ensure that ``enable_secure_login_node`` in ``input/security_config.yml`` is set to true.
* To customize the security features on the login node, fill out the parameters in ``input/login_node_security_config.yml``.
Expand Down
8 changes: 4 additions & 4 deletions telemetry/readme.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,10 +102,10 @@ All your data in a glance

Using the following graphs, data can be visualized to gather correlational information.

* `ParallelCoordinates <https://omnia-documentation.readthedocs.io/en/latest/Roles/Telemetry/ParallelCoordinates.html>`_
* `SankeyLayout <https://omnia-documentation.readthedocs.io/en/latest/Roles/Telemetry/SankeyLayout.html>`_
* `SpiralLayout <https://omnia-documentation.readthedocs.io/en/latest/Roles/Telemetry/SpiralLayout.html>`_
* `PowerMap <https://omnia-documentation.readthedocs.io/en/latest/Roles/Telemetry/PowerMap.html>`_
* `ParallelCoordinates <https://omnia-doc.readthedocs.io/en/latest/Roles/Telemetry/ParallelCoordinates.html>`_
* `SankeyLayout <https://omnia-doc.readthedocs.io/en/latest/Roles/Telemetry/SankeyLayout.html>`_
* `SpiralLayout <https://omnia-doc.readthedocs.io/en/latest/Roles/Telemetry/SpiralLayout.html>`_
* `PowerMap <https://omnia-doc.readthedocs.io/en/latest/Roles/Telemetry/PowerMap.html>`_

.. note:: The timestamps used for the time metric are based on the timezone set in ``input/provision_config.yml``. In the event of a mismatch between the timezone on the browser being used to access Grafana UI and the timezone in ``input/provision_config.yml``, the time range being used to filter information on the Grafana UI will have to be adjusted per the timezone in ``input/provision_config.yml``.

18 changes: 9 additions & 9 deletions utils/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@ Utils

The Utilities role allows users to set up certain tasks such as

* `Installing Extra Packages for Enterprise Linux (EPEL) <https://omnia-documentation.readthedocs.io/en/latest/Roles/Utils/epel.html>`_
* `Updating Kernels on RHEL <https://omnia-documentation.readthedocs.io/en/latest/Roles/Utils/kernel_upgrade.html>`_
* `Red Hat Subscription <https://omnia-documentation.readthedocs.io/en/latest/Roles/Utils/rhsm_subscription.html>`_
* `Set PXE NICs to Static <https://omnia-documentation.readthedocs.io/en/latest/Roles/Utils/configuringPXE.html>`_
* `FreeIPA installation on the NFS node <https://omnia-documentation.readthedocs.io/en/latest/Roles/Utils/freeipa_installation.html>`_
* `Uninstalling the provision tool <https://omnia-documentation.readthedocs.io/en/latest/Roles/Utils/cleanupscript.html>`_
* `OS Package Update <https://omnia-documentation.readthedocs.io/en/latest/Roles/Utils/OSPackageUpdate.html>`_
* `Clearing ports from Omnia <https://omnia-documentation.readthedocs.io/en/latest/Roles/Utils/portcleanup.html>`_
* `Installing Extra Packages for Enterprise Linux (EPEL) <https://omnia-doc.readthedocs.io/en/latest/Roles/Utils/epel.html>`_
* `Updating Kernels on RHEL <https://omnia-doc.readthedocs.io/en/latest/Roles/Utils/kernel_upgrade.html>`_
* `Red Hat Subscription <https://omnia-doc.readthedocs.io/en/latest/Roles/Utils/rhsm_subscription.html>`_
* `Set PXE NICs to Static <https://omnia-doc.readthedocs.io/en/latest/Roles/Utils/configuringPXE.html>`_
* `FreeIPA installation on the NFS node <https://omnia-doc.readthedocs.io/en/latest/Roles/Utils/freeipa_installation.html>`_
* `Uninstalling the provision tool <https://omnia-doc.readthedocs.io/en/latest/Roles/Utils/cleanupscript.html>`_
* `OS Package Update <https://omnia-doc.readthedocs.io/en/latest/Roles/Utils/OSPackageUpdate.html>`_
* `Clearing ports from Omnia <https://omnia-doc.readthedocs.io/en/latest/Roles/Utils/portcleanup.html>`_

For more information, check out our `docs <https://omnia-documentation.readthedocs.io/en/latest/Roles/Utils/index.html>`_!
For more information, check out our `docs <https://omnia-doc.readthedocs.io/en/latest/Roles/Utils/index.html>`_!

0 comments on commit bcc00bd

Please sign in to comment.