Skip to content

fix: update broken links #239

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 6, 2025
Merged

fix: update broken links #239

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/advanced/doca-drivers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ RHCOS
Prerequisites
~~~~~~~~~~~~~

- Install `oc <https://docs.openshift.com/container-platform/latest/cli_reference/openshift_cli/getting-started-cli.html>`_ CLI tool.
- Install `oc <https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/cli_tools/openshift-cli-oc>`_ CLI tool.
- Download OpenShift `pull secret <https://console.redhat.com/openshift/install/pull-secret>`_.

~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/advanced/proxy-airgapped.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ HTTP Proxy Configuration for Openshift
--------------------------------------

For Openshift, it is recommended to use the cluster-wide Proxy object to provide proxy information for the cluster.
Please follow the procedure described in `Configuring the Cluster-wide Proxy <https://docs.openshift.com/container-platform/latest/networking/enable-cluster-wide-proxy.html>`_ via the Red Hat Openshift public documentation. The NVIDIA Network Operator will automatically inject proxy related ENV into the driver container, based on the information present in the cluster-wide Proxy object.
Please follow the procedure described in `Configuring the Cluster-wide Proxy <https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/configuring_network_settings/enable-cluster-wide-proxy>`_ via the Red Hat Openshift public documentation. The NVIDIA Network Operator will automatically inject proxy related ENV into the driver container, based on the information present in the cluster-wide Proxy object.

------------------------
HTTP Proxy Configuration
Expand Down
2 changes: 1 addition & 1 deletion docs/deployment-guide-kubernetes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1505,7 +1505,7 @@ Network Operator Deployment with an SR-IOV InfiniBand Network with PKey Manageme
----------------------------------------------------------------------------------

.. _this article: https://docs.mellanox.com/display/MLNXOFEDv51258060/OpenSM
.. _the project documentation: https://docs.nvidia.com/networking/display/UFMEnterpriseUMv652
.. _the project documentation: https://docs.nvidia.com/networking/software/management-software/index.html#ufm-enterprise

Network Operator deployment with InfiniBand network requires the following:

Expand Down
14 changes: 7 additions & 7 deletions docs/getting-started-openshift.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Network Operator Deployment on an OpenShift Container Platform
Node Feature Discovery
----------------------

To enable Node Feature Discovery, please follow the official `guide <https://docs.openshift.com/container-platform/latest/hardware_enablement/psap-node-feature-discovery-operator.html>`_.
To enable Node Feature Discovery, please follow the official `guide <https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/specialized_hardware_and_driver_enablement/psap-node-feature-discovery-operator>`_.
A single instance of Node Feature Discovery is expected to be used in the cluster.


Expand Down Expand Up @@ -73,7 +73,7 @@ An example of Node Feature Discovery configuration:

Verify that the following label is present on the nodes containing NVIDIA networking hardware: `feature.node.kubernetes.io/pci-15b3.present=true`

For more details please read official NFD `documentation <https://docs.openshift.com/container-platform/4.16/hardware_enablement/psap-node-feature-discovery-operator.html#creating-nfd-cr-cli_psap-node-feature-discovery-operator>`_.
For more details please read official NFD `documentation <https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/specialized_hardware_and_driver_enablement/psap-node-feature-discovery-operator#creating-nfd-cr-cli_psap-node-feature-discovery-operator>`_.

.. code-block:: bash

Expand Down Expand Up @@ -102,7 +102,7 @@ For more details please read official NFD `documentation <https://docs.openshift
SR-IOV Network Operator
-----------------------

If you are planning to use SR-IOV, follow these `instructions <https://docs.openshift.com/container-platform/latest/networking/hardware_networks/installing-sriov-operator.html>`_ to install SR-IOV Network Operator on an OpenShift Container Platform.
If you are planning to use SR-IOV, follow these `instructions <https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/networking_operators/sr-iov-operator#installing-sriov-operator>`_ to install SR-IOV Network Operator on an OpenShift Container Platform.

.. warning::
The SR-IOV resources created will have the `openshift.io` prefix.
Expand All @@ -116,7 +116,7 @@ For the default SriovOperatorConfig CR to work with the NVIDIA DOCA-OFED Driver
--patch '{ "spec": { "configDaemonNodeSelector": { "network.nvidia.com/operator.mofed.wait": "false", "node-role.kubernetes.io/worker": "", "feature.node.kubernetes.io/pci-15b3.sriov.capable": "true" } } }'

.. warning::
SR-IOV Network Operator configuration documentation can be found on the `Official Website <https://docs.openshift.com/container-platform/latest/networking/hardware_networks/configuring-sriov-operator.html#configuring-sriov-operator>`_.
SR-IOV Network Operator configuration documentation can be found on the `Official Website <https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/networking_operators/sr-iov-operator#configuring-sriov-operator>`_.

------------
GPU Operator
Expand All @@ -136,7 +136,7 @@ Network Operator Installation Using OpenShift Catalog

- In the OpenShift Container Platform web console side menu, select Operators > OperatorHub, and search for the NVIDIA Network Operator.
- Select NVIDIA Network Operator, and click Install in the first screen and in the subsequent one.
- For additional information, see the `Red Hat OpenShift Container Platform Documentation <https://docs.openshift.com/container-platform/latest/operators/admin/olm-adding-operators-to-cluster.html>`_.
- For additional information, see the `Red Hat OpenShift Container Platform Documentation <https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/operators/administrator-tasks#olm-adding-operators-to-a-cluster>`_.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Network Operator Installation using OpenShift OC CLI
Expand Down Expand Up @@ -529,6 +529,6 @@ The `pod.yaml` configuration file for such a deployment:
Network Operator Deployment for DPDK Workloads - OCP
""""""""""""""""""""""""""""""""""""""""""""""""""""

In order to configure `HUGEPAGES` in OpenShift, refer to this `steps <https://docs.openshift.com/container-platform/latest/scalability_and_performance/what-huge-pages-do-and-how-they-are-consumed-by-apps.html>`_.
In order to configure `HUGEPAGES` in OpenShift, refer to this `steps <https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/scalability_and_performance/what-huge-pages-do-and-how-they-are-consumed>`_.

For SR-IOV Network Operator configuration instructions, visit the Official `Website <https://docs.openshift.com/container-platform/latest/networking/hardware_networks/configuring-sriov-operator.html#configuring-sriov-operator>`_.
For SR-IOV Network Operator configuration instructions, visit the Official `Website <https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/networking_operators/sr-iov-operator#configuring-sriov-operator>`_.
2 changes: 1 addition & 1 deletion docs/life-cycle-management.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -496,7 +496,7 @@ Make sure that the CRDs created during the operator installation have been remov
Uninstalling the Network Operator on an OpenShift Cluster
---------------------------------------------------------

.. _Red Hat OpenShift Container Platform Documentation: https://docs.openshift.com/container-platform/4.10/operators/admin/olm-deleting-operators-from-cluster.html
.. _Red Hat OpenShift Container Platform Documentation: https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/operators/administrator-tasks#olm-deleting-operators-from-a-cluster

From the console:

Expand Down