Opensearch¶

By enabling this toolset, HolmesGPT will be able to access cluster metadata information like health, shards, and settings. This allows HolmesGPT to better troubleshoot problems with one or more opensearch clusters.

Configuration¶

The configuration for Opensearch is passed through to the underlying opensearch-py library. Consult this library's user guide or reference documentation for configuring the connection to Opensearch, including how to authenticate this toolset to an opensearch cluster.

holmes:
    toolsets:
        opensearch/status:
            enabled: true
            config:
                opensearch_clusters:
                    - hosts:
                        - host1.com
                        - host2.com
                      headers:
                        header1: "value1"
                      use_ssl: <boolean>
                      ssl_assert_hostname: <boolean>
                      verify_certs: <boolean>
                      ssl_show_warn: <boolean>
                      http_auth:
                        username: <basic auth username>
                        password: <basic auth password>

Here is an example of an insecure Opensearch configuration for local development using a bearer token:

holmes:
    additionalEnvVars:
        - name: OPENSEARCH_URL
          value: <opensearch host URL>
        - name: OPENSEARCH_BEARER_TOKEN
          value: <secret bearer token>
    toolsets:
        opensearch:
            enabled: true
            config:
                opensearch_clusters:
                    - hosts:
                        - host: "{{ env.OPENSEARCH_URL }}"
                        port: 9200
                    headers:
                        Authorization: "Basic {{ env.OPENSEARCH_BEARER_TOKEN }}"
                    use_ssl: true
                    ssl_assert_hostname: false
                    verify_certs: false
                    ssl_show_warn: false

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

helm upgrade robusta robusta/robusta --values=generated_values.yaml --set clusterName=<YOUR_CLUSTER_NAME>

Capabilities¶

The table below describes the specific capabilities provided by this toolset. HolmesGPT can decide to invoke any of these capabilities when answering questions or investigating issues.

Tool Name	Description
opensearch_list_shards	List the shards within an opensearch cluster
opensearch_get_cluster_settings	Retrieve the cluster's settings
opensearch_get_cluster_health	Retrieve the cluster's health