Merge branch 'master' into cluster-label-docs

Author: pavangudiwada

docs/configuration/holmesgpt/builtin_toolsets.rst

@@ -63,6 +63,11 @@ by the user by providing credentials or API keys to external systems.
         :link: toolsets/helm
         :link-type: doc
 
+    .. grid-item-card:: :octicon:`cpu;1em;` Internet
+        :class-card: sd-bg-light sd-bg-text-light
+        :link: toolsets/internet
+        :link-type: doc
+
     .. grid-item-card:: :octicon:`cpu;1em;` Kubernetes
         :class-card: sd-bg-light sd-bg-text-light
         :link: toolsets/kubernetes

docs/configuration/holmesgpt/toolsets/argocd.rst

@@ -7,15 +7,61 @@ and configuration of ArgoCD applications.
 Configuration
 -------------
 
-This toolset requires an ``ARGOCD_AUTH_TOKEN`` environment variable as described in
-the `argocd documentation <https://argo-cd.readthedocs.io/en/latest/user-guide/commands/argocd_account_generate-token/>`_.
+This toolset requires an ``ARGOCD_AUTH_TOKEN`` environment variable. Generate such auth token by following
+`these steps <https://argo-cd.readthedocs.io/en/latest/user-guide/commands/argocd_account_generate-token/>`_.
+You can consult the `available environment variables <https://argo-cd.readthedocs.io/en/latest/user-guide/environment-variables/>`_
+on argocd's official documentation for the CLI.
+
+In addition to the auth token, you will need to tell argocd how to connect to the server. This can be done two ways:
+
+1. **Using port forwarding**. This is the recommended approach if your argocd is inside your Kubernetes cluster.
+2. **Setting the env var** ``SERVER_URL``. This is the recommended approach if your argocd is reachable through a public DNS
+
+1. Port forwarding
+^^^^^^^^^^^^^^^^^^
+
+This is the recommended approach if your argocd is inside your Kubernetes cluster.
+
+HolmesGPT needs permission to establish a port-forward to ArgoCD. The configuration below includes that authorization.
+
+.. code-block:: yaml
+
+    holmes:
+        customClusterRoleRules:
+            - apiGroups: [""]
+              resources: ["pods/portforward"]
+              verbs: ["create"]
+        additionalEnvVars:
+            - name: ARGOCD_AUTH_TOKEN
+              value: <your argocd auth token>
+            - name: ARGOCD_OPTS
+              value: "--port-forward --port-forward-namespace <your_argocd_namespace> --grpc-web"
+        toolsets:
+            argocd/core:
+                enabled: true
+
+.. note::
+
+    Change the namespace ``--port-forward-namespace <your_argocd_namespace>`` to the namespace in which your argocd service
+    is deployed.
+
+    The option ``--grpc-web`` in ``ARGOCD_OPTS`` prevents some connection errors from leaking into the tool responses and
+    provides a cleaner output for HolmesGPT.
+
+
+2. Server URL
+^^^^^^^^^^^^^
+
+This is the recommended approach if your argocd is reachable through a public DNS.
 
 .. code-block:: yaml
 
     holmes:
         additionalEnvVars:
             - name: ARGOCD_AUTH_TOKEN
               value: <your argocd auth token>
+            - name: ARGOCD_SERVER
+              value: argocd.example.com
         toolsets:
             argocd/core:
                 enabled: true

docs/configuration/holmesgpt/toolsets/helm.rst

@@ -12,6 +12,22 @@ Configuration
         toolsets:
             helm/core:
                 enabled: true
+        customClusterRoleRules:
+            - apiGroups: [""]
+              resources: ["secrets", "pods", "services", "configmaps", "persistentvolumeclaims"]
+              verbs: ["get", "list", "watch"]
+            - apiGroups: [""]
+              resources: ["namespaces"]
+              verbs: ["get"]
+            - apiGroups: ["apps"]
+              resources: ["deployments", "statefulsets", "daemonsets"]
+              verbs: ["get", "list", "watch"]
+            - apiGroups: ["batch"]
+              resources: ["jobs", "cronjobs"]
+              verbs: ["get", "list", "watch"]
+            - apiGroups: ["networking.k8s.io"]
+              resources: ["ingresses"]
+              verbs: ["get", "list", "watch"]
 
 .. include:: ./_toolset_configuration.inc.rst
 
@@ -38,6 +54,6 @@ Capabilities
    * - helm_hooks
      - Get the hooks for a Helm release
    * - helm_chart
-     - Get the hooks for a Helm release
+     - Show the chart used to create a Helm release
    * - helm_notes
      - Show the notes provided by the Helm chart

docs/configuration/holmesgpt/toolsets/kubernetes.rst

@@ -143,6 +143,13 @@ Configuration
 .. code-block:: yaml
 
     holmes:
+        customClusterRoleRules:
+            - apiGroups:
+                - ""
+              resources:
+                - services/proxy
+              verbs:
+                - get
         toolsets:
             kubernetes/kube-prometheus-stack:
                 enabled: true

docs/configuration/sinks/ms-teams.rst

@@ -77,3 +77,20 @@ Example:
             name: main_ms_teams_sink
             webhook_url: teams-incoming-webhook  # see instructions below
             webhook_override: ${annotations.kubernetes.io/service-name}
+
+Redirect to Platform
+-------------------------------------------------------------------
+
+By default, MS Teams notifications include buttons to view more information in the Robusta SaaS platform.
+If you don't use Robusta SaaS you can modify these links to point at Prometheus instead.
+To do so, set prefer_redirect_to_platform: false.
+
+For example:
+
+.. code-block:: yaml
+
+     sinks_config:
+     - ms_teams_sink:
+        name: main_ms_teams_sink
+        webhook_url: teams-incoming-webhook
+        prefer_redirect_to_platform: false

docs/configuration/sinks/slack.rst

@@ -95,6 +95,25 @@ Example:
          slack_channel: my-fallback-channel
          channel_override: "$cluster_name-alerts-$labels.env-${annotations.kubernetes.io/service-name}"
 
+Redirect to Platform
+-------------------------------------------------------------------
+
+By default, Slack notifications include buttons to view more information in the Robusta SaaS platform.
+If you don't use Robusta SaaS you can modify these links to point at Prometheus instead.
+To do so, set prefer_redirect_to_platform: false.
+
+For example:
+
+.. code-block:: yaml
+
+     sinks_config:
+     # slack integration params
+     - slack_sink:
+         name: main_slack_sink
+         api_key: xoxb-112...
+         slack_channel: my-fallback-channel
+         prefer_redirect_to_platform: false
+
 
 Using Private Channels
 -------------------------------------------------------------------

src/robusta/integrations/msteams/msteams_msg.py

@@ -67,7 +67,7 @@ def _add_actions(self, platform_enabled: bool, finding: Finding, cluster_name: s
 
         for link in finding.links:
             link_url = link.url
-            if link.type == LinkType.PROMETHEUS_GENERATOR_URL and self.prefer_redirect_to_platform:
+            if link.type == LinkType.PROMETHEUS_GENERATOR_URL and self.prefer_redirect_to_platform and platform_enabled:
                 link_url = convert_prom_graph_url_to_robusta_metrics_explorer(link.url, cluster_name, account_id)
             action: str = f"[{link.link_text}]({link_url})"
             actions.append(action)

src/robusta/integrations/slack/sender.py

@@ -411,7 +411,7 @@ def __create_links(
 
         for link in finding.links:
             link_url = link.url
-            if link.type == LinkType.PROMETHEUS_GENERATOR_URL and prefer_redirect_to_platform:
+            if link.type == LinkType.PROMETHEUS_GENERATOR_URL and prefer_redirect_to_platform and platform_enabled:
                 link_url = convert_prom_graph_url_to_robusta_metrics_explorer(
                     link.url, self.cluster_name, self.account_id
                 )