Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Onboarding: small cluster sizes for prometheus if selected #1656

Merged
merged 1 commit into from
Dec 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/help.rst
Original file line number Diff line number Diff line change
Expand Up @@ -127,11 +127,15 @@ Robusta runner, Prometheus or Holmes failures
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 the ``isSmallCluster=true`` property.
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=<YOUR_CLUSTER_NAME> --set isSmallCluster=true
helm install robusta robusta/robusta -f ./generated_values.yaml --set clusterName=<YOUR_CLUSTER_NAME> --set isSmallCluster=true \
--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


.. details:: robusta-runner isn't working or has exceptions
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ On some clusters this can take a while, so don't panic if it appears stuck:
helm repo add robusta https://robusta-charts.storage.googleapis.com && helm repo update
helm install robusta robusta/robusta -f ./generated_values.yaml --set clusterName=<YOUR_CLUSTER_NAME>

.. tab-item:: Kind/Colima
.. 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``.
Expand Down
100 changes: 100 additions & 0 deletions docs/setup-robusta/installation/_helm_install_with_prometheus.inc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
.. updated to .inc.rst because of "WARNING: duplicate label"

Install with Helm
------------------------------

Copy the below commands, replacing the ``<YOUR_CLUSTER_NAME>`` placeholder.

On some clusters this can take a while, so don't panic if it appears stuck:

.. tab-set::

.. tab-item:: Normal Clusters
:name: install-standard

.. code-block:: bash
:name: cb-helm-install-only-robusta

helm repo add robusta https://robusta-charts.storage.googleapis.com && helm repo update
helm install robusta robusta/robusta -f ./generated_values.yaml --set clusterName=<YOUR_CLUSTER_NAME>

.. tab-item:: EKS
:name: install-eks

To use all Robusta features, ensure storage is enabled on your cluster. If necessary, refer to the EKS documentation and install the `EBS CSI add-on <https://docs.aws.amazon.com/eks/latest/userguide/managing-ebs-csi.html#adding-ebs-csi-eks-add-on>`_

.. details:: How do I know if my cluster has storage enabled?

Try installing Robusta. If storage is not configured, you'll receive an error:

.. code-block::

PreBind plugin "VolumeBinding": binding volumes: timed out waiting for the condition

Running ``kubectl get pvc -A`` will also show PersistentVolumeClaims in ``Pending`` state.

In this case, follow the instructions above and enable storage for your cluster.

.. code-block:: bash
:name: cb-helm-install-eks

helm repo add robusta https://robusta-charts.storage.googleapis.com && helm repo update
helm install robusta robusta/robusta -f ./generated_values.yaml --set clusterName=<YOUR_CLUSTER_NAME>

.. tab-item:: GKE Autopilot
:name: install-gke-autopilot

Due to Autopilot restrictions, some components are disabled for Robusta's bundled Prometheus. Don't worry, everything will still work.

.. code-block:: bash
:name: cb-helm-install-gke-autopilot

helm repo add robusta https://robusta-charts.storage.googleapis.com && helm repo update
helm install robusta robusta/robusta -f ./generated_values.yaml \
--set clusterName=<YOUR_CLUSTER_NAME> \
--set kube-prometheus-stack.coreDns.enabled=false \
--set kube-prometheus-stack.kubeControllerManager.enabled=false \
--set kube-prometheus-stack.kubeDns.enabled=false \
--set kube-prometheus-stack.kubeEtcd.enabled=false \
--set kube-prometheus-stack.kubeProxy.enabled=false \
--set kube-prometheus-stack.kubeScheduler.enabled=false \
--set kube-prometheus-stack.nodeExporter.enabled=false \
--set kube-prometheus-stack.prometheusOperator.kubeletService.enabled=false

.. tab-item:: OpenShift
:name: install-openshift

First :ref:`modify the Helm values to enable OpenShift support<openshift-permissions>`.

Then install Robusta as usual with Helm:

.. code-block:: bash
:name: cb-helm-install-openshift

helm repo add robusta https://robusta-charts.storage.googleapis.com && helm repo update
helm install robusta robusta/robusta -f ./generated_values.yaml --set clusterName=<YOUR_CLUSTER_NAME>

.. 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``.

.. code-block:: bash
:name: cb-helm-install-test-clusters

helm repo add robusta https://robusta-charts.storage.googleapis.com && helm repo update
helm upgrade robusta robusta/robusta -f ./generated_values.yaml --set clusterName=<YOUR_CLUSTER_NAME> --set isSmallCluster=true \
--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

Verifying Installation
------------------------------

Confirm that two Robusta pods are running with no errors in the logs:

.. code-block:: bash
:name: cb-get-pods-robusta-logs

kubectl get pods -A | grep robusta
robusta logs
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Prerequisites
:header_update_levels:
:file: setup-robusta/installation/_generate_config.jinja

.. include:: ./_helm_install.inc.rst
.. include:: ./_helm_install_with_prometheus.inc.rst

.. include:: ./_see_robusta_in_action.rst

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Prerequisites
:header_update_levels:
:file: setup-robusta/installation/_generate_config.jinja

.. include:: ./_helm_install.inc.rst
.. include:: ./_helm_install_no_prometheus.inc.rst

.. include:: ./_see_robusta_in_action.rst

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Prerequisites
:header_update_levels:
:file: setup-robusta/installation/_generate_config.jinja

.. include:: ./_helm_install.inc.rst
.. include:: ./_helm_install_no_prometheus.inc.rst

.. include:: ./_see_robusta_in_action.rst

Expand Down
Loading