Skip to content

Adding Holmes CLI docs #1749

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.

Sign up for GitHub

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

Merged
pavangudiwada merged 9 commits into from
Mar 12, 2025
Merged

Adding Holmes CLI docs #1749

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4f4fa60
Updated with Holmescli docs
pavangudiwada Mar 6, 2025
5094b0d
More holmes cli docs
pavangudiwada Mar 6, 2025
816f6e6
Added more Holmes CLI instructions
pavangudiwada Mar 6, 2025
6a8825f
Fixed most comments
pavangudiwada Mar 7, 2025
d17165a
Fixed some comments
pavangudiwada Mar 9, 2025
728e61b
Added instructions on creating a Grafana service account token
pavangudiwada Mar 9, 2025
89e8188
Merge branch 'master' into holmes-cli-docs
pavangudiwada Mar 9, 2025
885743a
Merge branch 'master' into holmes-cli-docs
pavangudiwada Mar 11, 2025
24c9acb
Removed opensearch Holmes changes
pavangudiwada Mar 12, 2025
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
3 changes: 2 additions & 1 deletion docs/configuration/holmesgpt/builtin_toolsets.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ Builtin Toolsets
toolsets/aws
toolsets/confluence
toolsets/docker
toolsets/grafana
toolsets/grafanaloki
toolsets/grafanatempo
toolsets/helm
toolsets/internet
toolsets/kafka
Expand Down
307 changes: 219 additions & 88 deletions docs/configuration/holmesgpt/custom_toolsets.rst
View file
Open in desktop

Large diffs are not rendered by default.

10 changes: 3 additions & 7 deletions docs/configuration/holmesgpt/toolsets/_toolset_configuration.inc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@


.. details:: Enable this integration
Update your Helm values (generated_values.yaml) with the above configuration and run a Helm upgrade:

To enable this integration, copy the above example into your Helm values for Robusta (``generated_values.yaml``).
.. code-block:: bash
After making changes, apply them using Helm:

.. code-block:: bash
helm upgrade robusta robusta/robusta --values=generated_values.yaml --set clusterName=<YOUR_CLUSTER_NAME>
helm upgrade robusta robusta/robusta --values=generated_values.yaml --set clusterName=<YOUR_CLUSTER_NAME>
54 changes: 42 additions & 12 deletions docs/configuration/holmesgpt/toolsets/argocd.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ HolmesGPT needs permission to establish a port-forward to ArgoCD. The configurat
toolsets:
argocd/core:
enabled: true

.. note::

Change the namespace ``--port-forward-namespace <your_argocd_namespace>`` to the namespace in which your argocd service
Expand All @@ -48,25 +48,55 @@ HolmesGPT needs permission to establish a port-forward to ArgoCD. The configurat
The option ``--grpc-web`` in ``ARGOCD_OPTS`` prevents some connection errors from leaking into the tool responses and
provides a cleaner output for HolmesGPT.

.. include:: ./_toolset_configuration.inc.rst


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
.. md-tab-set::

.. include:: ./_toolset_configuration.inc.rst
.. md-tab-item:: Robusta Helm Chart

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

.. include:: ./_toolset_configuration.inc.rst

.. md-tab-item:: Holmes CLI

First create the `ARGOCD_AUTH_TOKEN` environment variable:

.. code-block:: shell

export ARGOCD_AUTH_TOKEN="<your argocd auth token>"
Comment thread
pavangudiwada marked this conversation as resolved.
export ARGOCD_SERVER="argocd.example.com"

Then add the following to **~/.holmes/config.yaml**, creating the file if it doesn't exist:

.. code-block:: yaml

toolsets:
argocd/core:
enabled: true

To test, run:

.. code-block:: yaml

holmes ask "Which argocd applications are failing and why?"

Capabilities
------------
Expand Down
126 changes: 94 additions & 32 deletions docs/configuration/holmesgpt/toolsets/aws.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
AWS
===
=====

Security
--------
Expand All @@ -8,26 +8,58 @@ Set of tools to audit AWS cloudtrail events and audit logs.


Configuration
*************
***************


.. md-tab-set::

.. md-tab-item:: Robusta Helm Chart

.. code-block:: yaml

holmes:
additionalEnvVars:
- name: AWS_ACCESS_KEY_ID
value: AKIAIOSFODNN7EXAMPLE
- name: AWS_SECRET_ACCESS_KEY
value: =wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
- name: AWS_DEFAULT_REGION
value: us-west-2
toolsets:
aws/security:
enabled: true

.. include:: ./_toolset_configuration.inc.rst

.. md-tab-item:: Holmes CLI


First, add the following environment vairables:

.. code-block:: yaml

export AWS_ACCESS_KEY_ID="<your AWS access key ID>"
export AWS_SECRET_ACCESS_KEY="<your AWS secret access key>"
export AWS_DEFAULT_REGION="us-west-2"


Then, add the following to **~/.holmes/config.yaml**, creating the file if it doesn't exist:

.. code-block:: yaml

.. code-block:: yaml
toolsets:
aws/security:
enabled: true

holmes:
additionalEnvVars:
- name: AWS_ACCESS_KEY_ID
value: AKIAIOSFODNN7EXAMPLE
- name: AWS_SECRET_ACCESS_KEY
value: =wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
- name: AWS_DEFAULT_REGION
value: us-west-2
toolsets:
aws/security:
enabled: true

.. include:: ./_toolset_configuration.inc.rst
To test, run:

.. code-block:: yaml

holmes ask "Are there any security misconfigurations my signup application, particularly in the database?"

Capabilities
************
**************
.. include:: ./_toolset_capabilities.inc.rst

.. list-table::
Expand All @@ -45,31 +77,61 @@ Capabilities


RDS
---
----

Read access to Amazon RDS instances, events and logs

Configuration
************
****************

.. md-tab-set::

.. md-tab-item:: Robusta Helm Chart

.. code-block:: yaml

holmes:
additionalEnvVars:
- name: AWS_ACCESS_KEY_ID
value: AKIXDDDSDSdSA
- name: AWS_SECRET_ACCESS_KEY
value: =wJalrXUtnFEMI/KNG/bPxRfiCYEXAMPLEKEY
- name: AWS_DEFAULT_REGION
value: us-west-2
toolsets:
aws/rds:
enabled: true

.. include:: ./_toolset_configuration.inc.rst

.. md-tab-item:: Holmes CLI

First, add the following environment vairables:

.. code-block:: yaml
.. code-block:: yaml

holmes:
additionalEnvVars:
- name: AWS_ACCESS_KEY_ID
value: AKIAIOSFODNN7EXAMPLE
- name: AWS_SECRET_ACCESS_KEY
value: =wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
- name: AWS_DEFAULT_REGION
value: us-west-2
toolsets:
aws/rds:
enabled: true
export AWS_ACCESS_KEY_ID="<your AWS access key ID>"
export AWS_SECRET_ACCESS_KEY="<your AWS secret access key>"
export AWS_DEFAULT_REGION="us-west-2"

Then, add the following to **~/.holmes/config.yaml**, creating the file if it doesn't exist:

.. code-block:: yaml

toolsets:
aws/rds:
enabled: true

To test, run:

.. code-block:: yaml

holmes ask "Why is my signup application slow, also look into the database"

.. include:: ./_toolset_configuration.inc.rst

Capabilities
************
*************

.. include:: ./_toolset_capabilities.inc.rst

.. list-table::
Expand Down
55 changes: 39 additions & 16 deletions docs/configuration/holmesgpt/toolsets/confluence.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,50 @@ Confluence

By enabling this toolset, HolmesGPT will be able to fetch confluence pages. This is particularly useful if you store runbooks in
Confluence and want Holmes to run investigations using these runbooks.
This toolset requires an `API key <https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/>`_.
This toolset requires an `Atlassian API Key <https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/>`_.


Configuration
Comment thread
pavangudiwada marked this conversation as resolved.
-------------

.. code-block:: yaml

holmes:
additionalEnvVars:
- name: CONFLUENCE_USER
value: <Confluence's username>
- name: CONFLUENCE_API_KEY
value: <Confluence's API key>
- name: CONFLUENCE_BASE_URL
value: <Confluence's base URL>
toolsets:
confluence:
enabled: true

.. include:: ./_toolset_configuration.inc.rst
.. md-tab-set::

.. md-tab-item:: Robusta Helm Chart

**Helm Values:**

.. code-block:: yaml

holmes:
additionalEnvVars:
- name: CONFLUENCE_USER
value: <Confluence's username>
- name: CONFLUENCE_API_KEY
value: <Confluence's API key>
- name: CONFLUENCE_BASE_URL
value: <Confluence's base URL>
toolsets:
confluence:
enabled: true

.. include:: ./_toolset_configuration.inc.rst

.. md-tab-item:: Holmes CLI

Set the following environment variables and the Confluence toolset will be automatically enabled:

.. code-block:: shell

export CONFLUENCE_USER="<confluence username>"
export CONFLUENCE_API_KEY="<confluence API key>"
export CONFLUENCE_BASE_URL="<confluence's base URL>"


To test, run:

.. code-block:: yaml

holmes ask "why is my application failing? Get revelant runbooks from Confluence"
Comment thread
moshemorad marked this conversation as resolved.

Capabilities
------------
Expand Down
Loading
Loading