From 8ef464eca52aa41c0858c484a3f1d2bf4306d816 Mon Sep 17 00:00:00 2001 From: Tuomas Katila Date: Tue, 30 Jun 2026 17:57:10 +0300 Subject: [PATCH] readme: update install instructions for 0.3.0 Signed-off-by: Tuomas Katila --- README.md | 35 +++++++++++++---------- charts/gpu-base-operator-policy/README.md | 6 ++-- charts/gpu-base-operator/README.md | 11 ++----- 3 files changed, 26 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 73981ba..f5a8ff8 100644 --- a/README.md +++ b/README.md @@ -92,13 +92,9 @@ Helm deployment is split into two charts: operator and policy. The reason for th The basic installation is as follows: ``` -kubectl create ns intel-gpu-operator -# Required by DRA's admin access -kubectl label ns intel-gpu-operator resource.kubernetes.io/admin-access=true - -helm install --namespace "intel-gpu-operator" --version 0.2.1 gpu-operator \ +helm install --create-namespace --namespace "intel-gpu-base-operator" --version 0.3.0 gpu-operator \ oci://ghcr.io/intel/intel-gpu-base-operator-chart --wait -helm install --namespace "intel-gpu-operator" --version 0.2.1 gpu-policy \ +helm install --namespace "intel-gpu-base-operator" --version 0.3.0 gpu-policy \ oci://ghcr.io/intel/intel-gpu-base-operator-policy-chart --set resourceRegistration=dra ``` @@ -107,20 +103,20 @@ This installs the operator and a DRA-enabled deployment with Intel XPU Manager. #### Example: DRA without NFD ``` -helm install --namespace "intel-gpu-operator" --version 0.2.1 gpu-operator \ +helm install --create-namespace --namespace "intel-gpu-base-operator" --version 0.3.0 gpu-operator \ oci://ghcr.io/intel/intel-gpu-base-operator-chart --wait -helm install --namespace "intel-gpu-operator" --version 0.2.1 gpu-policy \ +helm install --namespace "intel-gpu-base-operator" --version 0.3.0 gpu-policy \ oci://ghcr.io/intel/intel-gpu-base-operator-policy-chart --set resourceRegistration=dra ``` #### Example: DRA with NFD and Kueue ``` -helm install --namespace "intel-gpu-operator" --version 0.2.1 gpu-operator \ +helm install --create-namespace --namespace "intel-gpu-base-operator" --version 0.3.0 gpu-operator \ oci://ghcr.io/intel/intel-gpu-base-operator-chart --wait \ --set nfd.install=true \ --set kueue.install=true -helm install --namespace "intel-gpu-operator" --version 0.2.1 gpu-policy \ +helm install --namespace "intel-gpu-base-operator" --version 0.3.0 gpu-policy \ oci://ghcr.io/intel/intel-gpu-base-operator-policy-chart \ --set resourceRegistration=dra \ --set useNFDLabeling=true \ @@ -130,10 +126,10 @@ helm install --namespace "intel-gpu-operator" --version 0.2.1 gpu-policy \ #### Example: Device Plugin with NFD ``` -helm install --namespace "intel-gpu-operator" --version 0.2.1 gpu-operator \ +helm install --create-namespace --namespace "intel-gpu-base-operator" --version 0.3.0 gpu-operator \ oci://ghcr.io/intel/intel-gpu-base-operator-chart --wait \ --set nfd.install=true -helm install --namespace "intel-gpu-operator" --version 0.2.1 gpu-policy \ +helm install --namespace "intel-gpu-base-operator" --version 0.3.0 gpu-policy \ oci://ghcr.io/intel/intel-gpu-base-operator-policy-chart \ --set resourceRegistration=dp \ --set useNFDLabeling=true @@ -141,13 +137,22 @@ helm install --namespace "intel-gpu-operator" --version 0.2.1 gpu-policy \ Uninstalling the charts: ``` -helm uninstall --namespace "intel-gpu-operator" gpu-policy --wait -helm uninstall --namespace "intel-gpu-operator" gpu-operator -kubectl delete ns intel-gpu-operator +helm uninstall --namespace "intel-gpu-base-operator" gpu-policy --wait +helm uninstall --namespace "intel-gpu-base-operator" gpu-operator ``` See more details for the charts in the [operator](charts/gpu-base-operator/README.md) and [policy](charts/gpu-base-operator-policy/README.md) READMEs. +#### Installation to an existing namespace + +Installation to a pre-existing namespace needs to set `createNamespace=false` chart variable and drop the `--create-namespace` argument to prevent chart from trying to create the namespace. + +Also note that DRA requires the install namespace to contain `resource.kubernetes.io/admin-access=true` label for the monitoring to function. If one installs the operator to an existing namespace, the namespace has to be labeled: + +``` +kubectl label ns resource.kubernetes.io/admin-access=true +``` + ### Custom Resource (CR) fields CR fields control how the operator configures the cluster. See the [full struct](api/v1alpha1/clusterpolicy_types.go) for all options. diff --git a/charts/gpu-base-operator-policy/README.md b/charts/gpu-base-operator-policy/README.md index 98c6d52..eac9454 100644 --- a/charts/gpu-base-operator-policy/README.md +++ b/charts/gpu-base-operator-policy/README.md @@ -5,19 +5,19 @@ Helm chart is for installing the Intel GPU base operator policy. The operator ha ## Helm install ``` -helm install --namespace "intel-gpu-operator" --version 0.2.1 gpu-policy \ +helm install --namespace "intel-gpu-base-operator" --version 0.3.0 gpu-policy \ oci://ghcr.io/intel/intel-gpu-base-operator-policy-chart ``` ## Helm upgrade ``` -helm upgrade --namespace "intel-gpu-operator" --version 0.2.1 gpu-policy \ +helm upgrade --namespace "intel-gpu-base-operator" --version 0.3.0 gpu-policy \ oci://ghcr.io/intel/intel-gpu-base-operator-policy-chart ``` ## Helm uninstall ``` -helm uninstall --namespace "intel-gpu-operator" gpu-policy --wait +helm uninstall --namespace "intel-gpu-base-operator" gpu-policy --wait ``` ## Configuration diff --git a/charts/gpu-base-operator/README.md b/charts/gpu-base-operator/README.md index 00fdd3f..a81528e 100644 --- a/charts/gpu-base-operator/README.md +++ b/charts/gpu-base-operator/README.md @@ -9,24 +9,19 @@ Helm chart is for installing the Intel GPU base operator. Operator installation ## Helm install ``` -kubectl create ns intel-gpu-operator -# Required by DRA's admin access -kubectl label ns intel-gpu-operator resource.kubernetes.io/admin-access=true - -helm install --namespace "intel-gpu-operator" --version 0.2.1 gpu-operator \ +helm install --create-namespace --namespace "intel-gpu-base-operator" --version 0.3.0 gpu-operator \ oci://ghcr.io/intel/intel-gpu-base-operator-chart --wait ``` ## Helm upgrade ``` -helm upgrade --namespace "intel-gpu-operator" --version 0.2.1 gpu-operator \ +helm upgrade --namespace "intel-gpu-base-operator" --version 0.3.0 gpu-operator \ oci://ghcr.io/intel/intel-gpu-base-operator-chart --wait ``` ## Helm uninstall ``` -helm uninstall --namespace "intel-gpu-operator" gpu-operator -kubectl delete ns intel-gpu-operator +helm uninstall --namespace "intel-gpu-base-operator" gpu-operator ``` ## Configuration