diff --git a/gpu-operator/getting-started.rst b/gpu-operator/getting-started.rst index 3cc518389..1b8f03b13 100644 --- a/gpu-operator/getting-started.rst +++ b/gpu-operator/getting-started.rst @@ -79,6 +79,11 @@ Prerequisites Procedure ********* +.. tip:: + + For installation on Red Hat OpenShift Container Platform, + refer to :external+ocp:doc:`steps-overview`. + #. Add the NVIDIA Helm repository: .. code-block:: console diff --git a/openshift/index.rst b/openshift/index.rst index 77cb0470a..9fee76700 100644 --- a/openshift/index.rst +++ b/openshift/index.rst @@ -5,11 +5,11 @@ NVIDIA GPU Operator on Red Hat OpenShift Container Platform .. toctree:: :titlesonly: - introduction.rst - prerequisites.rst - steps-overview.rst - install-nfd.rst - install-gpu-ocp.rst + Introduction + Prerequisites + Installation and Upgrade Overview + NFD Operator Installation + GPU Operator Installation nvaie-with-ocp.rst mig-ocp.rst clean-up.rst diff --git a/openshift/install-gpu-ocp.rst b/openshift/install-gpu-ocp.rst index f81d6a61a..05cd216dd 100644 --- a/openshift/install-gpu-ocp.rst +++ b/openshift/install-gpu-ocp.rst @@ -3,16 +3,14 @@ .. _install-nvidiagpu: -################################### -Installing the NVIDIA GPU Operator -################################### - -.. note:: If you are installing the **NVIDIA GPU Operator** on OpenShift <``4.9.9`` ensure you have :ref:`enabled a Cluster-wide entitlement `. - For more information see :ref:`broken driver toolkit `. - -With the :ref:`Node Feature Discovery Operator` installed you can continue with the final step and install the **NVIDIA GPU Operator**. - -As a cluster administrator, you can install the **NVIDIA GPU Operator** using the OpenShift Container Platform CLI or the web console. +############################################### +Installing the NVIDIA GPU Operator on OpenShift +############################################### + +.. contents:: + :depth: 2 + :local: + :backlinks: none *********************************************************** Installing the NVIDIA GPU Operator by using the web console diff --git a/openshift/install-nfd.rst b/openshift/install-nfd.rst index 653d0764a..9ae63e21f 100644 --- a/openshift/install-nfd.rst +++ b/openshift/install-nfd.rst @@ -3,9 +3,18 @@ .. _install-nfd: -#################################################### -Installing the Node Feature Discovery (NFD) Operator -#################################################### +########################################################### +Installing the Node Feature Discovery Operator on OpenShift +########################################################### + +.. contents:: + :depth: 2 + :local: + :backlinks: none + +********* +Procedure +********* The Node Feature Discovery (NFD) Operator is a prerequisite for the **NVIDIA GPU Operator**. Install the NFD Operator using the Red Hat OperatorHub catalog in the OpenShift Container Platform web console . diff --git a/openshift/introduction.rst b/openshift/introduction.rst index 5160dcf60..c929ce5a0 100644 --- a/openshift/introduction.rst +++ b/openshift/introduction.rst @@ -1,11 +1,15 @@ .. Date: Oct 24 2022 .. Author: kquinn +.. _essug: https://docs.nvidia.com/enterprise-support-and-services-user-guide/about-this-user-guide/index.html +.. |essug| replace:: *NVIDIA Enterprise Support and Services User Guide* + .. _openshift-introduction: -***************************************** -Introduction -***************************************** +************************************************ +Introduction to NVIDIA GPU Operator on OpenShift +************************************************ + Kubernetes is an open-source platform for automating the deployment, scaling, and managing of containerized applications. Red Hat OpenShift Container Platform is a security-centric and enterprise-grade hardened Kubernetes platform for deploying and managing Kubernetes clusters at scale, developed and supported by Red Hat. @@ -15,4 +19,7 @@ The NVIDIA GPU Operator uses the operator framework within Kubernetes to automat Kubernetes device plugin for GPUs, the `NVIDIA Container Toolkit `_, automatic node labelling using `GFD `_, `DCGM `_ based monitoring and others. -For guidance on the specific NVIDIA support entitlement needs, see `obtaining support from NVIDIA `_. +For guidance on the specific NVIDIA support entitlement needs, +refer |essug|_ if you have an NVIDIA AI Enterprise entitlement. +Otherwise, refer to the `Obtaining Support from NVIDIA `_ +Red Hat Knowledgebase article. diff --git a/openshift/prerequisites.rst b/openshift/prerequisites.rst index 6cc930a80..95c065d24 100644 --- a/openshift/prerequisites.rst +++ b/openshift/prerequisites.rst @@ -1,9 +1,10 @@ .. Date: November 26 2021 .. Author: kquinn -***************************************** -Prerequisites -***************************************** +******************************************* +Prerequisites for GPU Operator on OpenShift +******************************************* + Before following the steps in this guide, ensure that your environment has: * A working OpenShift cluster up and running with a GPU worker node. See `OpenShift Container Platform installation `_ for guidance on installing. diff --git a/openshift/steps-overview.rst b/openshift/steps-overview.rst index 7525dc0a5..cfa388033 100644 --- a/openshift/steps-overview.rst +++ b/openshift/steps-overview.rst @@ -5,9 +5,9 @@ .. _steps_overview: -################################# -Installation and Upgrade Overview -################################# +############################################## +Installation and Upgrade Overview on OpenShift +############################################## .. contents:: :depth: 2