From ac2ecc06c4ac354573598767360b3ade35b13477 Mon Sep 17 00:00:00 2001 From: nimrik Date: Mon, 4 May 2026 11:02:54 +0200 Subject: [PATCH] updated docs to match new cluster-sizes approach --- docs/help.rst | 4 ++-- docs/setup-robusta/gitops/argocd.rst | 4 ++-- docs/setup-robusta/gitops/flux.rst | 4 ++-- .../installation/_helm_install_no_prometheus.inc.rst | 4 ++-- .../installation/_helm_install_with_prometheus.inc.rst | 5 ++--- docs/setup-robusta/multi-cluster.rst | 4 ++-- 6 files changed, 12 insertions(+), 13 deletions(-) diff --git a/docs/help.rst b/docs/help.rst index d926cad02..d7d5b6821 100644 --- a/docs/help.rst +++ b/docs/help.rst @@ -209,12 +209,12 @@ Issues after installation when pods are running but not working correctly. limits: memory: 1Gi - If using a test cluster like Kind/Colima, re-install Robusta with the ``isSmallCluster=true`` property. + If using a test cluster like Kind/Colima, re-install Robusta with ``clusterSize=small``. If you're also using Robusta's kube-prometheus-stack, add the lines involving prometheusSpec. .. code-block:: bash - helm install robusta robusta/robusta -f ./generated_values.yaml --set clusterName= --set isSmallCluster=true \ + helm install robusta robusta/robusta -f ./generated_values.yaml --set clusterName= --set clusterSize=small \ --set kube-prometheus-stack.prometheus.prometheusSpec.retentionSize=9GB \ --set kube-prometheus-stack.prometheus.prometheusSpec.storageSpec.volumeClaimTemplate.spec.resources.requests.storage=10Gi \ --set kube-prometheus-stack.prometheus.prometheusSpec.resources.requests.memory=512Mi diff --git a/docs/setup-robusta/gitops/argocd.rst b/docs/setup-robusta/gitops/argocd.rst index 3b69bc273..5b62d88de 100644 --- a/docs/setup-robusta/gitops/argocd.rst +++ b/docs/setup-robusta/gitops/argocd.rst @@ -16,14 +16,14 @@ Preparing Robusta's config Prepare your ``generated_values.yaml`` file for ArgoCD: * If it's not already present, add ``clusterName: `` -* If installing on a test cluster like KIND, add ``isSmallCluster: true`` +* If installing on a small or test cluster like KIND, add ``clusterSize: small`` Example ``generated_values.yaml``: .. code-block:: yaml clusterName: my_cluster_name # <- This is the line to be added - isSmallCluster: false # <- Optional. Set this on test clusters to lower Robusta's resource usage. + clusterSize: small # <- Optional. Options: small (< 16 CPUs), medium (16-128 CPUs), large (> 128 CPUs). globalConfig: signing_key: xxxxxx account_id: xxxxxx diff --git a/docs/setup-robusta/gitops/flux.rst b/docs/setup-robusta/gitops/flux.rst index e42c3cb74..cd6c67e37 100644 --- a/docs/setup-robusta/gitops/flux.rst +++ b/docs/setup-robusta/gitops/flux.rst @@ -17,14 +17,14 @@ Preparing Robusta's config Prepare your ``generated_values.yaml`` file for Flux: * If it's not already present, add ``clusterName: `` -* If installing on a test cluster like KIND, add ``isSmallCluster: true`` +* If installing on a small or test cluster like KIND, add ``clusterSize: small`` Example ``generated_values.yaml``: .. code-block:: yaml clusterName: my_cluster_name # <- This is the line to be added - isSmallCluster: false # <- Optional. Set this on test clusters to lower Robusta's resource usage. + clusterSize: small # <- Optional. Options: small (< 16 CPUs), medium (16-128 CPUs), large (> 128 CPUs). globalConfig: signing_key: xxxxxx account_id: xxxxxx diff --git a/docs/setup-robusta/installation/_helm_install_no_prometheus.inc.rst b/docs/setup-robusta/installation/_helm_install_no_prometheus.inc.rst index 9a7d20ab3..6f069d790 100644 --- a/docs/setup-robusta/installation/_helm_install_no_prometheus.inc.rst +++ b/docs/setup-robusta/installation/_helm_install_no_prometheus.inc.rst @@ -77,13 +77,13 @@ On some clusters this can take a while, so don't panic if it appears stuck: .. tab-item:: Local/Test Cluster :name: install-test-clusters - Test clusters tend to have fewer resources. To lower Robusta's resource requests, set ``isSmallCluster=true``. + Test clusters tend to have fewer resources. To lower Robusta's resource requests, set ``clusterSize=small``. .. code-block:: bash :name: cb-helm-install-test-clusters helm repo add robusta https://robusta-charts.storage.googleapis.com && helm repo update - helm install robusta robusta/robusta -f ./generated_values.yaml --set clusterName= --set isSmallCluster=true --set holmes.resources.requests.memory=512Mi + helm install robusta robusta/robusta -f ./generated_values.yaml --set clusterName= --set clusterSize=small Verifying Installation ------------------------------ diff --git a/docs/setup-robusta/installation/_helm_install_with_prometheus.inc.rst b/docs/setup-robusta/installation/_helm_install_with_prometheus.inc.rst index 243896776..4b3fce114 100644 --- a/docs/setup-robusta/installation/_helm_install_with_prometheus.inc.rst +++ b/docs/setup-robusta/installation/_helm_install_with_prometheus.inc.rst @@ -77,17 +77,16 @@ On some clusters this can take a while, so don't panic if it appears stuck: .. tab-item:: Local/Test Cluster :name: install-test-clusters - Test clusters tend to have fewer resources. To lower Robusta's resource requests, set ``isSmallCluster=true``. + Test clusters tend to have fewer resources. To lower Robusta's resource requests, set ``clusterSize=small``. .. code-block:: bash :name: cb-helm-install-test-clusters helm repo add robusta https://robusta-charts.storage.googleapis.com && helm repo update - helm install robusta robusta/robusta -f ./generated_values.yaml --set clusterName= --set isSmallCluster=true \ + helm install robusta robusta/robusta -f ./generated_values.yaml --set clusterName= --set clusterSize=small \ --set kube-prometheus-stack.prometheus.prometheusSpec.retentionSize=9GB \ --set kube-prometheus-stack.prometheus.prometheusSpec.storageSpec.volumeClaimTemplate.spec.resources.requests.storage=10Gi \ --set kube-prometheus-stack.prometheus.prometheusSpec.resources.requests.memory=512Mi - --set holmes.resources.requests.memory=512Mi .. note:: If you are using docker desktop you will need to disable prometheus-node-exporter mounting host root, by adding the following to the above command: diff --git a/docs/setup-robusta/multi-cluster.rst b/docs/setup-robusta/multi-cluster.rst index 10d31c24c..2f2a09de5 100644 --- a/docs/setup-robusta/multi-cluster.rst +++ b/docs/setup-robusta/multi-cluster.rst @@ -40,9 +40,9 @@ If you lost your ``generated_values.yaml`` file, you can extract it from any clu .. code-block:: bash - helm get values -o yaml robusta | grep -v clusterName: | grep -v isSmallCluster: > generated_values.yaml + helm get values -o yaml robusta | grep -v clusterName: | grep -v clusterSize: | grep -v isSmallCluster: > generated_values.yaml .. note:: - The above command strips the ``clusterName`` and ``isSmallCluster`` options so you don't copy them accidentally. + The above command strips the ``clusterName``, ``clusterSize``, and ``isSmallCluster`` options so you don't copy them accidentally. These options should be determined on a cluster by cluster basis.