helm: require users to explicitly specify the namespace

We have removed the defaulting of the namespace and instead let the users to dictate what namespace they wish to use for installing the Helm chart into. Signed-off-by: Feruzjon Muyassarov <[email protected]>
containers · Jun 21, 2023 · 2aa10d3 · 2aa10d3
1 parent f464460
commit 2aa10d3
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/docs/resource-policy/installation.md b/docs/resource-policy/installation.md
@@ -37,10 +37,10 @@ following components: DaemonSet, ConfigMap, CustomResourceDefinition, and RBAC-r
     cd nri-plugins
     ```
 
-1. Install the plugin using Helm. Replace release name with the desired name for your Helm release. In this example, we named it as topology-aware. The default values for topology-aware resource policy plugin are stored in [values.yaml](TODO) file. If you wish to provide custom values to the Helm chart, refer to the [table](#Helm-parameters) below, which describes the available parameters that can be modified before installation.
+1. Install the plugin using Helm. Replace release name with the desired name for your Helm release. In this example, we named it as topology-aware. The default values for topology-aware resource policy plugin are stored in [values.yaml](TODO) file. If you wish to provide custom values to the Helm chart, refer to the [table](#Helm-parameters) below, which describes the available parameters that can be modified before installation.  It's important to note that specifying the namespace (using `--namespace`) is crucial when installing the Helm chart, as failing to do so may result in broken YAML manifests.
 
     ```sh
-    helm install topology-aware deployment/helm/resource-management-policies/topology-aware/
+    helm install topology-aware --namespace kube-system deployment/helm/resource-management-policies/topology-aware/
     ```
 
 1. Verify the status of the daemonset to ensure that the plugin is running successfully