Skip to content

Refactor Kubernetes toolsets documentation and consolidate permissions #1893

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
aantn merged 4 commits into from
Apr 12, 2026
Merged

Refactor Kubernetes toolsets documentation and consolidate permissions #1893

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
65e6d70
Remove check mark emoji from Kubernetes docs section titles
claude Apr 9, 2026
5ebb557
Update Kubernetes toolsets docs: fix capabilities, add defaults, spli…
claude Apr 9, 2026
7c0485f
Restructure Kubernetes docs: nest toolsets under parent heading
claude Apr 9, 2026
275806b
Merge branch 'master' into claude/remove-emoji-section-titles-nRmny
aantn Apr 12, 2026
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
85 changes: 42 additions & 43 deletions docs/data-sources/builtin-toolsets/kubernetes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
# Kubernetes Toolsets
# Kubernetes

## Core ✓
## Toolsets

### Core

!!! info "Enabled by Default"
This toolset is enabled by default and should typically remain enabled.

By enabling this toolset, HolmesGPT will be able to describe and find Kubernetes resources like nodes, deployments, pods, etc.

### Configuration
**Configuration:**

```yaml
holmes:
Expand All @@ -16,22 +18,15 @@ holmes:
enabled: true
```

### Capabilities
**Capabilities:**

| Tool Name | Description |
|-----------|-------------|
| kubectl_describe | Run kubectl describe command on a specific resource |
| kubectl_get_by_name | Get details of a specific resource with labels |
| kubectl_get_by_kind_in_namespace | List all resources of a given type in a namespace |
| kubectl_get_by_kind_in_cluster | List all resources of a given type across the cluster |
| kubectl_find_resources | Search for resources matching a keyword |
| kubectl_get_yaml | Get YAML definition of a resource |
| kubectl_events | Get events for a specific resource |
| kubectl_memory_requests_all_namespaces | Get memory requests for all pods across all namespaces in MiB |
| kubectl_memory_requests_namespace | Get memory requests for all pods in a specific namespace in MiB |
| kubernetes_jq_query | Query Kubernetes resources using jq filters |

## Logs ✓
| kubernetes_jq_query | Query Kubernetes resources using jq filters with pagination |
| kubernetes_tabular_query | Extract specific fields from resources in tabular format with optional filtering |
| kubernetes_count | Count Kubernetes resources matching a jq filter |
Comment thread
aantn marked this conversation as resolved.

### Logs

!!! info "Enabled by Default"
This toolset is enabled by default. You do not need to configure it.
Expand All @@ -40,7 +35,7 @@ By enabling this toolset, HolmesGPT will be able to read Kubernetes pod logs.

--8<-- "snippets/toolsets_that_provide_logging.md"

### Configuration
**Configuration:**

```yaml
holmes:
Expand All @@ -49,23 +44,27 @@ holmes:
enabled: true
```

### Capabilities
**Capabilities:**

| Tool Name | Description |
|-----------|-------------|
| kubectl_logs | Fetch logs from a specific pod |
| kubectl_logs_all_containers | Fetch logs from all containers in a pod |
| kubectl_previous_logs | Fetch previous logs from a pod |
| kubectl_previous_logs_all_containers | Fetch previous logs from all containers in a pod |
| kubectl_previous_logs | Fetch previous logs from a crashed pod |
| kubectl_previous_logs_all_containers | Fetch previous logs from all containers in a crashed pod |
| kubectl_container_previous_logs | Fetch previous logs from a specific container in a crashed pod |
| kubectl_container_logs | Fetch logs from a specific container in a pod |
| kubectl_logs_grep | Search for specific patterns in pod logs |
| kubectl_logs_all_containers_grep | Search for patterns in logs from all containers |
Comment thread
aantn marked this conversation as resolved.

## Live Metrics
### Live Metrics

!!! note "Not Enabled by Default"
This toolset is only available when `kubectl top` is supported (requires [Metrics Server](https://github.com/kubernetes-sigs/metrics-server)).

This toolset retrieves real-time CPU and memory usage for pods and nodes.

### Configuration
**Configuration:**

```yaml
holmes:
Expand All @@ -74,62 +73,62 @@ holmes:
enabled: true
```

### Capabilities
**Capabilities:**

| Tool Name | Description |
|-----------|-------------|
| kubectl_top_pods | Get current CPU and memory usage for pods |
| kubectl_top_nodes | Get current CPU and memory usage for nodes |
Comment thread
aantn marked this conversation as resolved.

## Prometheus Stack
### Kube Prometheus Stack

This toolset fetches Prometheus target definitions. Requires specific cluster role rules.
!!! note "Not Enabled by Default"
This toolset must be explicitly enabled.

### Configuration
This toolset uses `kubectl` to proxy into a Prometheus service running in-cluster and fetch target definitions. This is different from the [Prometheus toolset](prometheus.md), which connects directly to a Prometheus server for metrics querying.

**Configuration:**

```yaml
holmes:
toolsets:
kubernetes/prometheus_stack:
kubernetes/kube-prometheus-stack:
enabled: true
customClusterRoleRules:
- apiGroups: ["monitoring.coreos.com"]
resources: ["servicemonitors", "podmonitors", "prometheusrules"]
verbs: ["get", "list"]
```

### Capabilities
**Capabilities:**

| Tool Name | Description |
|-----------|-------------|
| kubectl_get_prometheus_targets | Get Prometheus monitoring targets |
| kubectl_get_service_monitors | Get ServiceMonitor resources |
| kubectl_get_pod_monitors | Get PodMonitor resources |
| get_prometheus_target | Fetch the definition of a Prometheus target via kubectl proxy |
Comment thread
aantn marked this conversation as resolved.

### Resource Lineage

## Resource Lineage Extras
!!! note "Not Enabled by Default"
This toolset must be explicitly enabled. Requires [kube-lineage](https://github.com/tohjustin/kube-lineage) installed either via `kubectl krew` or built from source.

Two variations of resource lineage toolsets: one native and one using kubectl krew. Provides tools to fetch children/dependents and parents/dependencies of Kubernetes resources.
Provides tools to fetch children/dependents and parents/dependencies of Kubernetes resources. Two variations are available depending on how kube-lineage is installed.

### Configuration
**Configuration:**

```yaml
holmes:
toolsets:
kubernetes/resource_lineage_extras:
kubernetes/kube-lineage-extras:
enabled: true
# OR
kubernetes/resource_lineage_extras_krew:
# OR if installed via krew:
kubernetes/krew-extras:
enabled: true
```

### Capabilities
**Capabilities:**

| Tool Name | Description |
|-----------|-------------|
| kubectl_lineage_children | Get child/dependent resources of a Kubernetes resource |
| kubectl_lineage_parents | Get parent/dependency resources of a Kubernetes resource |
Comment thread
aantn marked this conversation as resolved.

## Adding Permissions for Additional Resources (In-Cluster Deployments)
## Adding Permissions for Additional Resources

!!! note "In-Cluster Only"
This section applies only to HolmesGPT running **inside** a Kubernetes cluster via Helm. For local CLI deployments, permissions are managed through your kubeconfig file.
Expand Down
Loading