Skip to content

Commit f7c46a7

Browse files
author
Farshad Ghodsian
committed
Updated GPU Operator docs version to 1.2.0 (#61)
1 parent 442e39e commit f7c46a7

File tree

6 files changed

+19
-19
lines changed

6 files changed

+19
-19
lines changed

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# AMD GPU Operator
22

3-
:book: GPU Operator Documentation Site: https://instinct.docs.amd.com/projects/gpu-operator
3+
## :book: GPU Operator Documentation Site
4+
5+
For the most detailed and up-to-date documentation please visit our Instinct Documenation site: [https://instinct.docs.amd.com/projects/gpu-operator](https://instinct.docs.amd.com/projects/gpu-operator)
46

57
## Introduction
68

@@ -53,12 +55,13 @@ helm install cert-manager jetstack/cert-manager \
5355
### 1. Add the AMD Helm Repository
5456

5557
```bash
56-
helm install amd-gpu-operator --namespace kube-amd-gpu --create-namespace https://github.com/ROCm/gpu-operator/releases/download/v1.0.0/gpu-operator-charts-v1.0.0.tgz
58+
helm repo add rocm https://rocm.github.io/gpu-operator
59+
helm repo update
5760
```
5861

5962
### 2. Install the Operator
6063

61-
Basic installation:
64+
#### Basic installation
6265

6366
```bash
6467
helm install amd-gpu-operator rocm/gpu-operator-charts \
@@ -67,19 +70,17 @@ helm install amd-gpu-operator rocm/gpu-operator-charts \
6770
--version=v1.2.0
6871
```
6972

70-
```{note}
71-
Installation Options
72-
- Skip NFD installation: `--set node-feature-discovery.enabled=false`
73-
- Skip KMM installation: `--set kmm.enabled=false`
74-
```
73+
#### Installation Options
7574

76-
```{warning}
77-
It is strongly recommended to use AMD-optimized KMM images included in the operator release.
78-
```
75+
* Skip NFD installation: `--set node-feature-discovery.enabled=false`
76+
* Skip KMM installation: `--set kmm.enabled=false`
77+
78+
> [!WARNING]
79+
> It is strongly recommended to use AMD-optimized KMM images included in the operator release. This is not required when installing the GPU Operator on Red Hat OpenShift.
7980
8081
### 3. Install Custom Resource
8182

82-
After the installation of AMD GPU Operator, you need to create the `DeviceConfig` custom resource in order to trigger the operator to start to work. By preparing the `DeviceConfig` in the YAML file, you can create the resouce by running ```kubectl apply -f deviceconfigs.yaml```. For custom resource definition and more detailed information, please refer to [Custom Resource Installation Guide](https://dcgpu.docs.amd.com/projects/gpu-operator/en/latest/installation/kubernetes-helm.html#install-custom-resource).
83+
After the installation of AMD GPU Operator, you need to create the `DeviceConfig` custom resource in order to trigger the operator to start to work. By preparing the `DeviceConfig` in the YAML file, you can create the resouce by running ```kubectl apply -f deviceconfigs.yaml```. For custom resource definition and more detailed information, please refer to [Custom Resource Installation Guide](https://instinct.docs.amd.com/projects/gpu-operator/en/latest/installation/kubernetes-helm.html#install-custom-resource).
8384

8485
### Grafana Dashboards
8586

-6.74 KB
Loading

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
external_projects_current_project = "amd-gpu-operator"
77

88
project = "AMD Instinct Documentation"
9-
version = "1.1.0"
9+
version = "1.2.0"
1010
release = version
1111
html_title = f"AMD GPU Operator {version}"
1212
author = "Advanced Micro Devices, Inc."

docs/fulldeviceconfig.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,8 @@ Below is an example of a full DeviceConfig CR that can be used to install the AM
9595
# (Optional) Specifying metrics exporter image is optional. Default imagename shown here if not specified.
9696
image: rocm/device-metrics-exporter:v1.2.0 # Change this to trigger metrics exporter upgrade on CR update
9797
config:
98-
name: exporter-configmap # Name of the ConfigMap that contains the metrics exporter configuration
98+
# Name of the ConfigMap that contains the metrics exporter configuration.
99+
name: gpu-config # (Optional) If the configmap does not exist the DeviceConfig will show a validation error and not start any plugin pods
99100
upgradePolicy:
100101
#(Optional) If no UpgradePolicy is mentioned for any of the components but their image is changed, the daemonset will
101102
# get upgraded according to the defaults, which is `upgradeStrategy` set to `RollingUpdate` and `maxUnavailable` set to 1.
@@ -132,8 +133,6 @@ The below is an example of the minimal DeviceConfig CR that can be used to insta
132133
metricsExporter:
133134
enable: true # To enable/disable the metrics exporter, disabled by default
134135
serviceType: "NodePort" # Node port for metrics exporter service
135-
config:
136-
name: exporter-configmap
137136
nodePort: 32500
138137
selector:
139138
feature.node.kubernetes.io/amd-gpu: "true"

docs/installation/openshift-helm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# OpenShift (Helm)
22

33
```{warning}
4-
Installing via Helm is not a recommended method for Red Hat OpenShift. Users wishing to use the AMD GPU with OpenShift should consider using the OLM method instead.
4+
Installing via Helm is not a recommended method for Red Hat OpenShift. Users wishing to use the AMD GPU with OpenShift should consider using the OLM method instead. This method is not supported in the latest version. As a result, this page will be removed in the next release.
55
```
66

77
This guide walks through installing the AMD GPU Operator on an OpenShift cluster using Helm.

example/deviceconfig_example.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,9 @@ spec:
8484
# name: exporterimagesecret
8585

8686
# metrics config in configmap
87-
config:
87+
# config:
8888
# configmap name, example config in example/metricsExporter/config.json
89-
name: configmap-name
89+
# name: gpu-config
9090

9191
# Specify the testrunner config
9292
testRunner:

0 commit comments

Comments
 (0)