diff --git a/docs/configuration/ai-analysis.rst b/docs/configuration/ai-analysis.rst index 386873f38..45161eca6 100644 --- a/docs/configuration/ai-analysis.rst +++ b/docs/configuration/ai-analysis.rst @@ -28,7 +28,7 @@ Configuration .. tab-item:: OpenAI :name: open-ai - + Create a secret with your OpenAI API key: .. code-block:: bash @@ -62,7 +62,7 @@ Configuration * API_VERSION * DEPLOYMENT_NAME * ENDPOINT - * API_KEY + * API_KEY .. details:: Step-By-Step Instruction for Azure Portal @@ -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=`` + .. 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=' ' + + + 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=`` + Test Holmes Integration ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -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. \ No newline at end of file +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. diff --git a/docs/images/robusta_ai/robusta_ai_api_key.png b/docs/images/robusta_ai/robusta_ai_api_key.png new file mode 100644 index 000000000..c8182fff8 Binary files /dev/null and b/docs/images/robusta_ai/robusta_ai_api_key.png differ