Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions gpu-operator/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions openshift/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <introduction.rst>
Prerequisites <prerequisites.rst>
Installation and Upgrade Overview <steps-overview.rst>
NFD Operator Installation <install-nfd.rst>
GPU Operator Installation <install-gpu-ocp.rst>
nvaie-with-ocp.rst
mig-ocp.rst
clean-up.rst
Expand Down
18 changes: 8 additions & 10 deletions openshift/install-gpu-ocp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <cluster-entitlement>`.
For more information see :ref:`broken driver toolkit <broken-dtk>`.

With the :ref:`Node Feature Discovery Operator<install-nfd>` 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
Expand Down
15 changes: 12 additions & 3 deletions openshift/install-nfd.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 .

Expand Down
15 changes: 11 additions & 4 deletions openshift/introduction.rst
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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 <https://github.com/NVIDIA/nvidia-container-toolkit>`_,
automatic node labelling using `GFD <https://github.com/NVIDIA/gpu-feature-discovery>`_, `DCGM <https://developer.nvidia.com/dcgm>`_ based monitoring and others.

For guidance on the specific NVIDIA support entitlement needs, see `obtaining support from NVIDIA <https://access.redhat.com/solutions/5174941>`_.
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 <https://access.redhat.com/solutions/5174941>`_
Red Hat Knowledgebase article.
7 changes: 4 additions & 3 deletions openshift/prerequisites.rst
Original file line number Diff line number Diff line change
@@ -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 <https://docs.openshift.com/container-platform/latest/installing/index.html>`_ for guidance on installing.
Expand Down
6 changes: 3 additions & 3 deletions openshift/steps-overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@

.. _steps_overview:

#################################
Installation and Upgrade Overview
#################################
##############################################
Installation and Upgrade Overview on OpenShift
##############################################

.. contents::
:depth: 2
Expand Down