Skip to content

Commit 70afbc6

Browse files
nhermentnherment
authored
Merge branch 'master' into initial_prometheus_toolset_docs
2 parents b4ee323 + 093cf0c commit 70afbc6

22 files changed

Lines changed: 751 additions & 316 deletions

‎docs/configuration/holmesgpt/builtin_toolsets.rst‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ Builtin Toolsets
1111
toolsets/confluence
1212
toolsets/datetime
1313
toolsets/docker
14-
toolsets/grafana
14+
toolsets/grafanaloki
15+
toolsets/grafanatempo
1516
toolsets/helm
1617
toolsets/internet
1718
toolsets/kafka

‎docs/configuration/holmesgpt/custom_toolsets.rst‎

Lines changed: 219 additions & 88 deletions
Large diffs are not rendered by default.

‎docs/configuration/holmesgpt/toolsets/_toolset_configuration.inc.rst‎

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
11

22

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

5-
To enable this integration, copy the above example into your Helm values for Robusta (``generated_values.yaml``).
5+
.. code-block:: bash
66
7-
After making changes, apply them using Helm:
8-
9-
.. code-block:: bash
10-
11-
helm upgrade robusta robusta/robusta --values=generated_values.yaml --set clusterName=<YOUR_CLUSTER_NAME>
7+
helm upgrade robusta robusta/robusta --values=generated_values.yaml --set clusterName=<YOUR_CLUSTER_NAME>

‎docs/configuration/holmesgpt/toolsets/argocd.rst‎

Lines changed: 42 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ HolmesGPT needs permission to establish a port-forward to ArgoCD. The configurat
3939
toolsets:
4040
argocd/core:
4141
enabled: true
42-
42+
4343
.. note::
4444

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

51+
.. include:: ./_toolset_configuration.inc.rst
52+
5153

5254
2. Server URL
5355
^^^^^^^^^^^^^
5456

5557
This is the recommended approach if your argocd is reachable through a public DNS.
5658

57-
.. code-block:: yaml
5859

59-
holmes:
60-
additionalEnvVars:
61-
- name: ARGOCD_AUTH_TOKEN
62-
value: <your argocd auth token>
63-
- name: ARGOCD_SERVER
64-
value: argocd.example.com
65-
toolsets:
66-
argocd/core:
67-
enabled: true
60+
.. md-tab-set::
6861

69-
.. include:: ./_toolset_configuration.inc.rst
62+
.. md-tab-item:: Robusta Helm Chart
63+
64+
.. code-block:: yaml
65+
66+
holmes:
67+
additionalEnvVars:
68+
- name: ARGOCD_AUTH_TOKEN
69+
value: <your argocd auth token>
70+
- name: ARGOCD_SERVER
71+
value: argocd.example.com
72+
toolsets:
73+
argocd/core:
74+
enabled: true
75+
76+
.. include:: ./_toolset_configuration.inc.rst
77+
78+
.. md-tab-item:: Holmes CLI
79+
80+
First create the `ARGOCD_AUTH_TOKEN` environment variable:
81+
82+
.. code-block:: shell
83+
84+
export ARGOCD_AUTH_TOKEN="<your argocd auth token>"
85+
export ARGOCD_SERVER="argocd.example.com"
86+
87+
Then add the following to **~/.holmes/config.yaml**, creating the file if it doesn't exist:
88+
89+
.. code-block:: yaml
90+
91+
toolsets:
92+
argocd/core:
93+
enabled: true
94+
95+
To test, run:
96+
97+
.. code-block:: yaml
98+
99+
holmes ask "Which argocd applications are failing and why?"
70100
71101
Capabilities
72102
------------

‎docs/configuration/holmesgpt/toolsets/aws.rst‎

Lines changed: 94 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
AWS
2-
===
2+
=====
33

44
Security
55
--------
@@ -8,26 +8,58 @@ Set of tools to audit AWS cloudtrail events and audit logs.
88

99

1010
Configuration
11-
*************
11+
***************
12+
13+
14+
.. md-tab-set::
15+
16+
.. md-tab-item:: Robusta Helm Chart
17+
18+
.. code-block:: yaml
19+
20+
holmes:
21+
additionalEnvVars:
22+
- name: AWS_ACCESS_KEY_ID
23+
value: AKIAIOSFODNN7EXAMPLE
24+
- name: AWS_SECRET_ACCESS_KEY
25+
value: =wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
26+
- name: AWS_DEFAULT_REGION
27+
value: us-west-2
28+
toolsets:
29+
aws/security:
30+
enabled: true
31+
32+
.. include:: ./_toolset_configuration.inc.rst
33+
34+
.. md-tab-item:: Holmes CLI
35+
36+
37+
First, add the following environment vairables:
38+
39+
.. code-block:: yaml
40+
41+
export AWS_ACCESS_KEY_ID="<your AWS access key ID>"
42+
export AWS_SECRET_ACCESS_KEY="<your AWS secret access key>"
43+
export AWS_DEFAULT_REGION="us-west-2"
44+
45+
46+
Then, add the following to **~/.holmes/config.yaml**, creating the file if it doesn't exist:
47+
48+
.. code-block:: yaml
1249
13-
.. code-block:: yaml
50+
toolsets:
51+
aws/security:
52+
enabled: true
1453
15-
holmes:
16-
additionalEnvVars:
17-
- name: AWS_ACCESS_KEY_ID
18-
value: AKIAIOSFODNN7EXAMPLE
19-
- name: AWS_SECRET_ACCESS_KEY
20-
value: =wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
21-
- name: AWS_DEFAULT_REGION
22-
value: us-west-2
23-
toolsets:
24-
aws/security:
25-
enabled: true
2654
27-
.. include:: ./_toolset_configuration.inc.rst
55+
To test, run:
56+
57+
.. code-block:: yaml
58+
59+
holmes ask "Are there any security misconfigurations my signup application, particularly in the database?"
2860
2961
Capabilities
30-
************
62+
**************
3163
.. include:: ./_toolset_capabilities.inc.rst
3264

3365
.. list-table::
@@ -45,31 +77,61 @@ Capabilities
4577

4678

4779
RDS
48-
---
80+
----
4981

5082
Read access to Amazon RDS instances, events and logs
5183

5284
Configuration
53-
************
85+
****************
86+
87+
.. md-tab-set::
88+
89+
.. md-tab-item:: Robusta Helm Chart
90+
91+
.. code-block:: yaml
92+
93+
holmes:
94+
additionalEnvVars:
95+
- name: AWS_ACCESS_KEY_ID
96+
value: AKIXDDDSDSdSA
97+
- name: AWS_SECRET_ACCESS_KEY
98+
value: =wJalrXUtnFEMI/KNG/bPxRfiCYEXAMPLEKEY
99+
- name: AWS_DEFAULT_REGION
100+
value: us-west-2
101+
toolsets:
102+
aws/rds:
103+
enabled: true
104+
105+
.. include:: ./_toolset_configuration.inc.rst
106+
107+
.. md-tab-item:: Holmes CLI
108+
109+
First, add the following environment vairables:
54110

55-
.. code-block:: yaml
111+
.. code-block:: yaml
56112
57-
holmes:
58-
additionalEnvVars:
59-
- name: AWS_ACCESS_KEY_ID
60-
value: AKIAIOSFODNN7EXAMPLE
61-
- name: AWS_SECRET_ACCESS_KEY
62-
value: =wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
63-
- name: AWS_DEFAULT_REGION
64-
value: us-west-2
65-
toolsets:
66-
aws/rds:
67-
enabled: true
113+
export AWS_ACCESS_KEY_ID="<your AWS access key ID>"
114+
export AWS_SECRET_ACCESS_KEY="<your AWS secret access key>"
115+
export AWS_DEFAULT_REGION="us-west-2"
116+
117+
Then, add the following to **~/.holmes/config.yaml**, creating the file if it doesn't exist:
118+
119+
.. code-block:: yaml
120+
121+
toolsets:
122+
aws/rds:
123+
enabled: true
124+
125+
To test, run:
126+
127+
.. code-block:: yaml
128+
129+
holmes ask "Why is my signup application slow, also look into the database"
68130
69-
.. include:: ./_toolset_configuration.inc.rst
70131
71132
Capabilities
72-
************
133+
*************
134+
73135
.. include:: ./_toolset_capabilities.inc.rst
74136

75137
.. list-table::

‎docs/configuration/holmesgpt/toolsets/confluence.rst‎

Lines changed: 39 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,50 @@ Confluence
33

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

88

99
Configuration
1010
-------------
1111

12-
.. code-block:: yaml
13-
14-
holmes:
15-
additionalEnvVars:
16-
- name: CONFLUENCE_USER
17-
value: <Confluence's username>
18-
- name: CONFLUENCE_API_KEY
19-
value: <Confluence's API key>
20-
- name: CONFLUENCE_BASE_URL
21-
value: <Confluence's base URL>
22-
toolsets:
23-
confluence:
24-
enabled: true
25-
26-
.. include:: ./_toolset_configuration.inc.rst
12+
.. md-tab-set::
13+
14+
.. md-tab-item:: Robusta Helm Chart
15+
16+
**Helm Values:**
17+
18+
.. code-block:: yaml
19+
20+
holmes:
21+
additionalEnvVars:
22+
- name: CONFLUENCE_USER
23+
value: <Confluence's username>
24+
- name: CONFLUENCE_API_KEY
25+
value: <Confluence's API key>
26+
- name: CONFLUENCE_BASE_URL
27+
value: <Confluence's base URL>
28+
toolsets:
29+
confluence:
30+
enabled: true
31+
32+
.. include:: ./_toolset_configuration.inc.rst
33+
34+
.. md-tab-item:: Holmes CLI
35+
36+
Set the following environment variables and the Confluence toolset will be automatically enabled:
37+
38+
.. code-block:: shell
39+
40+
export CONFLUENCE_USER="<confluence username>"
41+
export CONFLUENCE_API_KEY="<confluence API key>"
42+
export CONFLUENCE_BASE_URL="<confluence's base URL>"
43+
44+
45+
To test, run:
46+
47+
.. code-block:: yaml
48+
49+
holmes ask "why is my application failing? Get revelant runbooks from Confluence"
2750
2851
Capabilities
2952
------------

0 commit comments

Comments
 (0)