Skip to content

Commit

Permalink
MAIN-2112 Holmes using robusta ai (#1565)
Browse files Browse the repository at this point in the history
* add docs on how to use robusta ai with holmes

* fixes

---------

Co-authored-by: arik <alon.arik@gmail.com>
  • Loading branch information
RoiGlinik and arikalon1 authored Sep 23, 2024
1 parent f456e96 commit 790671a
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 4 deletions.
43 changes: 39 additions & 4 deletions docs/configuration/ai-analysis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Configuration

.. tab-item:: OpenAI
:name: open-ai

Create a secret with your OpenAI API key:

.. code-block:: bash
Expand Down Expand Up @@ -62,7 +62,7 @@ Configuration
* API_VERSION
* DEPLOYMENT_NAME
* ENDPOINT
* API_KEY
* API_KEY

.. details:: Step-By-Step Instruction for Azure Portal

Expand Down Expand Up @@ -184,10 +184,45 @@ Configuration
secretKeyRef:
name: holmes-secrets
key: awsSecretAccessKey
Do a Helm upgrade to apply the new values: ``helm upgrade robusta robusta/robusta --values=generated_values.yaml --set clusterName=<YOUR_CLUSTER_NAME>``


.. tab-item:: Robusta
:name: robusta-ai

1. Go into the robusta platform. In settings > API keys, create an api key with Robusta AI write capabilities.

.. image:: /images/robusta_ai/robusta_ai_api_key.png
:width: 600px

2. Get your account id from your ``generated_values.yaml`` file


Create a secret in the following format using both your accountid and robusta API key:

.. code-block:: bash
kubectl create secret generic holmes-secrets -n robusta --from-literal=openAiKey='<account id> <robusta api key>'
Update your helm values (``generated_values.yaml`` file) with the following configuration:

.. code-block:: yaml
enableHolmesGPT: true
holmes:
additionalEnvVars:
- name: ROBUSTA_AI
value: true
- name: OPENAI_API_KEY
valueFrom:
secretKeyRef:
name: holmes-secrets
key: openAiKey
Do a Helm upgrade to apply the new values: ``helm upgrade robusta robusta/robusta --values=generated_values.yaml --set clusterName=<YOUR_CLUSTER_NAME>``

Test Holmes Integration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand All @@ -211,4 +246,4 @@ Before we proceed, you must follow the instructions above and configure Holmes.
.. image:: /images/AI_Analysis_demo2.png
:width: 1000px

Additionally your alerts on Slack will have an "Ask Holmes" button. Clicking it will give you results in the Slack channel itself. Note that due to technical limitations with Slack-buttons, alerts analyzed from Slack will be sent to the AI without alert-labels. For the most accurate results, it is best to use the UI.
Additionally your alerts on Slack will have an "Ask Holmes" button. Clicking it will give you results in the Slack channel itself. Note that due to technical limitations with Slack-buttons, alerts analyzed from Slack will be sent to the AI without alert-labels. For the most accurate results, it is best to use the UI.
Binary file added docs/images/robusta_ai/robusta_ai_api_key.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 790671a

Please sign in to comment.