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

Update proxy documentation #1609

Merged
merged 5 commits into from
Oct 27, 2024
Merged
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
30 changes: 20 additions & 10 deletions docs/setup-robusta/proxies.rst
Original file line number Diff line number Diff line change
@@ -1,28 +1,38 @@
Deploying Behind Proxies
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Robusta can run in airgapped environments with no internet access. However, to send notifications to external
:ref:`sinks <Sinks Reference>` like Slack, Robusta might need to communicate with services outside your cluster.
Robusta requires internet access in the following cases:

On most clusters this will just work. In clusters behind HTTP(s) proxies, you'll need to configure proxy settings.
* Robusta SaaS is enabled
* Robusta is configured to send notifications to services such as Slack (via :ref:`sinks <Sinks Reference>`)

If your Kubernetes cluster is behind an HTTP proxy or firewall, follow the instructions below to ensure Robusta has the necessary access.

Configuring Proxy Settings for Robusta
----------------------------------------
Only the Robusta Runner pod needs proxy settings, as this is the only Pod that communicates with external sinks.

To configure proxy settings, add environment variables using the following Helm values.
All outbound traffic from Robusta is handled by the `robusta-runner` deployment.

* ``runner.additional_env_vars`` - to set one variable at a time
* ``runner.additional_env_froms`` - to set many environment variables at once
To configure proxy settings for `robusta-runner`, set the `HTTP_PROXY` and `HTTPS_PROXY` environment variables. You can do so with one of the follopwing Helm values:

Either Helm value can be used, depending on your preference.
* ``runner.additional_env_vars`` - to set one environment variable at a time
* ``runner.additional_env_froms`` - to set many environment variables at once

For more details, refer to `this GitHub issue about HTTP(s) proxies <https://github.com/robusta-dev/robusta/pull/450>`_.
Either Helm value can be used, depending on your preference. See `this GitHub issue for details and an example configuration <https://github.com/robusta-dev/robusta/pull/450>`_.

Domains Used by Robusta Saas UI
---------------------------------
To ensure all Robusta SaaS UI features work well in environments with restricted internet access, please allow access to the following domains.

If you are using Robusta SaaS, ensure that your network allows access to the following domains:

.. code:: bash

api.robusta.dev,robusta-charts.storage.googleapis.com,us-central1-docker.pkg.dev,platform.robusta.dev,xvyhpoxfmtpuqqeyqkso.supabase.co,relay.robusta.dev

Running Robusta in Air-Gapped or Offline Environments
------------------------------------------------------------------------------

You can run Robusta entirely offline if the following conditions are met:

* No external sinks are configured (e.g., services on the public internet).
* The Robusta UI is either disabled or running on-premise.
Loading