|
1 | | -# Inspektor Gadget Tool Usage |
| 1 | +# Inspektor Gadget Observability Tool Usage in AKS-MCP Server |
2 | 2 |
|
3 | | -This document gives an overview of `inspektor_gadget` tool in the AKS-MCP server. |
| 3 | +This document gives an overview of `inspektor_gadget_observability` tool in the AKS-MCP server. |
4 | 4 |
|
5 | 5 | ## Tool Overview |
6 | 6 |
|
7 | 7 | The [Inspektor Gadget](https://go.microsoft.com/fwlink/?linkid=2260072) tool allows users to run various diagnostics and inspections on Kubernetes clusters. |
8 | | -It uses gadgets to collect real-time data with Kubernetes enrichment. `inspektor_gadget` MCP tool essentially allows managing the gadgets, enabling users to |
| 8 | +It uses gadgets to collect real-time data with Kubernetes enrichment. `inspektor_gadget_observability` MCP tool essentially allows managing the gadgets, enabling users to |
9 | 9 | run diagnostics, collect data, and analyze workloads in a Kubernetes environment. It currently supports the following actions: |
10 | 10 |
|
11 | 11 | - **start**: Start a gadget to collect data continuously |
@@ -35,7 +35,7 @@ to get the most relevant data for your workload. |
35 | 35 |
|
36 | 36 | ## Sample Prompts |
37 | 37 |
|
38 | | -Following are some sample prompts that can be used with to quickly try `inspektor_gadget` tool in the AKS-MCP server: |
| 38 | +Following are some sample prompts that can be used with to quickly try `inspektor_gadget_observability` tool in the AKS-MCP server: |
39 | 39 |
|
40 | 40 | ``` |
41 | 41 | Can you check if any DNS queries are failing in AKS cluster? |
@@ -68,12 +68,13 @@ Can you observe system calls for the pod my-pod in the default namespace for few |
68 | 68 | ## Prerequisites |
69 | 69 |
|
70 | 70 | - A kubeconfig file that has access to the AKS cluster. You will need to restart the MCP server if you change the kubeconfig file. |
71 | | -- Ensure the AKS MCP server is running with the `--additional-tools=inspektor-gadget`. |
72 | | -- The tool requires Inspektor Gadget to be installed in the cluster. If you are running with `--additional-tools=inspektor-gadget` and `--access-level=readwrite` or more, the MCP server will automatically |
| 71 | +- The tool requires Inspektor Gadget to be installed in the cluster. If you are running with `--access-level=readwrite` or more, the MCP server will automatically |
73 | 72 | install Inspektor Gadget (action `deploy` ) in the cluster otherwise you can follow the steps to install it manually: [Inspektor Gadget Installation](https://learn.microsoft.com/en-us/troubleshoot/azure/azure-kubernetes/logs/capture-system-insights-from-aks#how-to-install-inspektor-gadget-in-an-aks-cluster) or |
74 | 73 | use the official Helm chart: [Inspektor Gadget Helm Chart](https://inspektor-gadget.io/docs/latest/reference/install-kubernetes#installation-with-the-helm-chart): |
75 | 74 |
|
76 | 75 | ```bash |
77 | 76 | IG_VERSION=$(curl -s https://api.github.com/repos/inspektor-gadget/inspektor-gadget/releases/latest | jq -r '.tag_name' | sed 's/^v//') |
78 | 77 | helm install gadget --namespace=gadget --create-namespace oci://ghcr.io/inspektor-gadget/inspektor-gadget/charts/gadget --version=$IG_VERSION |
79 | 78 | ``` |
| 79 | + |
| 80 | +Once Inspektor Gadget is deployed (or you installed it manually), you only need `readonly` (default) access to use the `inspektor_gadget_observability` tool. |
0 commit comments