Skip to content

Commit 093add7

Browse files
authored
Merge pull request #234 from chaitanya1731/doc
device_plugins: Update md in Readme for proper formatting
2 parents f768f35 + 287a6a4 commit 093add7

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

device_plugins/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Setting up Intel Device Plugins Operator
22

3-
# Overview
3+
## Overview
44
Intel Device Plugins are utilized to advertise Intel hardware features (resources) to a Red Hat OpenShift Container Platform (RHOCP) Cluster. This allows workloads running on pods deployed within the clusters to leverage these features. To handle the deployment and lifecycle of these device plugins, the [Intel Device Plugins Operator](https://catalog.redhat.com/software/container-stacks/detail/61e9f2d7b9cdd99018fc5736) is used. The Intel Device Plugins container images and operator have been officially certified and published on the [Red Hat Ecosystem Catalog](https://catalog.redhat.com/software/container-stacks/detail/61e9f2d7b9cdd99018fc5736). For more details on the upstream project, please refer to [Intel Device Plugins for Kubernetes](https://github.com/intel/intel-device-plugins-for-kubernetes).
55

6-
# Prerequisities
6+
## Prerequisities
77
- Provisioned RHOCP cluster. Follow steps [here](/README.md).
88
- Setup Node Feature Discovery (NFD). Follow steps [here](/nfd/README.md).
99
- Follow the additional prerequisites for provisioning Intel® Data Center GPU:
@@ -12,30 +12,30 @@ Intel Device Plugins are utilized to advertise Intel hardware features (resource
1212
- Follow the additional prerequisites for provisioning Intel® QuickAssist Technology:
1313
- Configure MCO for provisioning Intel QAT. Follow steps [here](/machine_configuration/README.md#machine-configuration-for-provisioning-intel-qat).
1414

15-
# Install Intel Device Plugins Operator on Red Hat OpenShift
16-
## Installation via web console
15+
## Install Intel Device Plugins Operator on Red Hat OpenShift
16+
### Installation via web console
1717
Follow the steps below to install Intel Device Plugins Operator using OpenShift web console:
1818
1. In the OpenShift web console, navigate to **Operator** -> **OperatorHub**.
1919
2. Search for **Intel Device Plugins Operator** in all items field -> Click **Install**.
20-
## Verify Installation via web console
20+
### Verify Installation via web console
2121
1. Go to **Operator** -> **Installed Operators**.
2222
2. Verify that the status of the operator is **Succeeded**.
2323

24-
## Installation via command line interface (CLI)
24+
### Installation via command line interface (CLI)
2525
Apply the [install_operator.yaml](/device_plugins/install_operator.yaml) file:
2626
```
2727
$ oc apply -f https://raw.githubusercontent.com/intel/intel-technology-enabling-for-openshift/main/device_plugins/install_operator.yaml
2828
```
2929

30-
## Verify Installation via CLI
30+
### Verify Installation via CLI
3131
Verify that the operator controller manager pod is up and running:
3232
```
3333
$ oc get pod | grep inteldeviceplugins-controller-manager
3434
3535
inteldeviceplugins-controller-manager-6b8c76c867-hftqm 2/2 Running 0 17m
3636
```
3737

38-
# Resources Provided by Intel Device Plugins
38+
## Resources Provided by Intel Device Plugins
3939
The resources are the user interface for customers to claim and consume the hardware features provided by Intel Device Plugins from the user pods. See below table for the details:
4040

4141
| Feature | Resources | Description | Usage |
@@ -45,7 +45,7 @@ The resources are the user interface for customers to claim and consume the hard
4545
| Intel® QAT | `qat.intel.com/cy` </br> `qat.intel.com/dc` | `cy`: Intel QAT VFIO Virtual Function device configured for cryptography for user pod to claim </br> `dc`: Intel QAT VFIO Virtual Function device configured for cryptography for user pod to claim | [Link](https://github.com/intel/intel-technology-enabling-for-openshift/blob/main/tests/l2/qat/qatlib_job.yaml#L24) </br> [Link](https://github.com/intel/intel-technology-enabling-for-openshift/blob/main/tests/l2/qat/qatlib_job.yaml#L28) |
4646

4747

48-
# Creating Intel Device Plugin custom resource (CR)
48+
## Creating Intel Device Plugin custom resource (CR)
4949
- To create an Intel SGX device plugin CR, follow this [link](/device_plugins/deploy_sgx.md).
5050
- To create an Intel GPU device plugin CR, follow this [link](/device_plugins/deploy_gpu.md).
5151
- To create an Intel QAT device plugin CR, follow this [link](/device_plugins/deploy_qat.md).

0 commit comments

Comments
 (0)