|
26 | 26 | short-summary: Name of the resource group.
|
27 | 27 | - name: --model
|
28 | 28 | type: string
|
29 |
| - short-summary: Model to use for the LLM. |
| 29 | + short-summary: Specify the LLM provider and model or deployment to use for the AI assistant. |
| 30 | + long-summary: |- |
| 31 | + The --model parameter determines which large language model (LLM) and provider will be used to analyze your cluster. |
| 32 | + For OpenAI, use the model name directly (e.g., gpt-4o). |
| 33 | + For Azure OpenAI, use `azure/<deployment name>` (e.g., azure/gpt-4.1). |
| 34 | + Each provider may require different environment variables and model naming conventions. |
| 35 | + For a full list of supported providers, model patterns, and required environment variables, see https://docs.litellm.ai/docs/providers. |
| 36 | + Note: For Azure OpenAI, it is recommended to set the deployment name as the model name until https://github.com/BerriAI/litellm/issues/13950 is resolved. |
30 | 37 | - name: --api-key
|
31 | 38 | type: string
|
32 | 39 | short-summary: API key to use for the LLM (if not given, uses environment variables AZURE_API_KEY, OPENAI_API_KEY).
|
|
48 | 55 | - name: --refresh-toolsets
|
49 | 56 | type: bool
|
50 | 57 | short-summary: Refresh the toolsets status.
|
| 58 | + - name: --status |
| 59 | + type: bool |
| 60 | + short-summary: Show AKS agent configuration and status information. |
| 61 | + - name: --no-aks-mcp |
| 62 | + type: bool |
| 63 | + short-summary: Disable AKS MCP integration and use traditional toolsets. |
51 | 64 |
|
52 | 65 | examples:
|
53 | 66 | - name: Ask about pod issues in the cluster with Azure OpenAI
|
54 | 67 | text: |-
|
55 | 68 | export AZURE_API_BASE="https://my-azureopenai-service.openai.azure.com/"
|
56 | 69 | export AZURE_API_VERSION="2025-01-01-preview"
|
57 | 70 | export AZURE_API_KEY="sk-xxx"
|
58 |
| - az aks agent "Why are my pods not starting?" --name MyManagedCluster --resource-group MyResourceGroup --model azure/my-gpt4.1-deployment |
| 71 | + az aks agent "Why are my pods not starting?" --name MyManagedCluster --resource-group MyResourceGroup --model azure/gpt-4.1 |
59 | 72 | - name: Ask about pod issues in the cluster with OpenAI
|
60 | 73 | text: |-
|
61 | 74 | export OPENAI_API_KEY="sk-xxx"
|
62 | 75 | az aks agent "Why are my pods not starting?" --name MyManagedCluster --resource-group MyResourceGroup --model gpt-4o
|
63 |
| - - name: Run in interactive mode without a question |
64 |
| - text: az aks agent "Check the pod status in my cluster" --name MyManagedCluster --resource-group MyResourceGroup --model azure/my-gpt4.1-deployment --api-key "sk-xxx" |
65 |
| - - name: Run in non-interactive batch mode |
66 |
| - text: az aks agent "Diagnose networking issues" --no-interactive --max-steps 15 --model azure/my-gpt4.1-deployment |
67 |
| - - name: Show detailed tool output during analysis |
68 |
| - text: az aks agent "Why is my service workload unavailable in namespace workload-ns?" --show-tool-output --model azure/my-gpt4.1-deployment |
69 |
| - - name: Use custom configuration file |
70 |
| - text: az aks agent "Check kubernetes pod resource usage" --config-file /path/to/custom.yaml --model azure/my-gpt4.1-deployment |
71 |
| - - name: Run agent with no echo of the original question |
72 |
| - text: az aks agent "What is the status of my cluster?" --no-echo-request --model azure/my-gpt4.1-deployment |
73 |
| - - name: Refresh toolsets to get the latest available tools |
74 |
| - text: az aks agent "What is the status of my cluster?" --refresh-toolsets --model azure/my-gpt4.1-deployment |
75 | 76 | - name: Run agent with config file
|
76 | 77 | text: |
|
77 |
| - az aks agent "Check kubernetes pod resource usage" --config-file /path/to/custom.yaml |
| 78 | + az aks agent "Check kubernetes pod resource usage" --config-file /path/to/custom.yaml --name MyManagedCluster --resource-group MyResourceGroup |
78 | 79 | Here is an example of config file:
|
79 | 80 | ```json
|
80 |
| - model: "gpt-4o" |
| 81 | + model: "azure/gpt-4.1" |
81 | 82 | api_key: "..."
|
82 | 83 | # define a list of mcp servers, mcp server can be defined
|
83 | 84 | mcp_servers:
|
|
103 | 104 | aks/core:
|
104 | 105 | enabled: false
|
105 | 106 | ```
|
| 107 | + - name: Run in interactive mode without a question |
| 108 | + text: az aks agent "Check the pod status in my cluster" --name MyManagedCluster --resource-group MyResourceGroup --model azure/gpt-4.1 --api-key "sk-xxx" |
| 109 | + - name: Run in non-interactive batch mode |
| 110 | + text: az aks agent "Diagnose networking issues" --no-interactive --max-steps 15 --model azure/gpt-4.1 |
| 111 | + - name: Show detailed tool output during analysis |
| 112 | + text: az aks agent "Why is my service workload unavailable in namespace workload-ns?" --show-tool-output --model azure/gpt-4.1 |
| 113 | + - name: Use custom configuration file |
| 114 | + text: az aks agent "Check kubernetes pod resource usage" --config-file /path/to/custom.yaml --model azure/gpt-4.1 |
| 115 | + - name: Run agent with no echo of the original question |
| 116 | + text: az aks agent "What is the status of my cluster?" --no-echo-request --model azure/gpt-4.1 |
| 117 | + - name: Refresh toolsets to get the latest available tools |
| 118 | + text: az aks agent "What is the status of my cluster?" --refresh-toolsets --model azure/gpt-4.1 |
| 119 | + - name: Show agent status (MCP readiness) |
| 120 | + text: az aks agent --status |
| 121 | + - name: Run in interactive mode without a question |
| 122 | + text: az aks agent "Check the pod status in my cluster" --name MyManagedCluster --resource-group MyResourceGroup --model azure/my-gpt4.1-deployment --api-key "sk-xxx" |
| 123 | + - name: Run in non-interactive batch mode |
| 124 | + text: az aks agent "Diagnose networking issues" --no-interactive --max-steps 15 --model azure/my-gpt4.1-deployment |
| 125 | + - name: Show detailed tool output during analysis |
| 126 | + text: az aks agent "Why is my service workload unavailable in namespace workload-ns?" --show-tool-output --model azure/my-gpt4.1-deployment |
| 127 | + - name: Use custom configuration file |
| 128 | + text: az aks agent "Check kubernetes pod resource usage" --config-file /path/to/custom.yaml --model azure/my-gpt4.1-deployment |
| 129 | + - name: Run agent with no echo of the original question |
| 130 | + text: az aks agent "What is the status of my cluster?" --no-echo-request --model azure/my-gpt4.1-deployment |
| 131 | + - name: Refresh toolsets to get the latest available tools |
| 132 | + text: az aks agent "What is the status of my cluster?" --refresh-toolsets --model azure/my-gpt4.1-deployment |
106 | 133 | """
|
0 commit comments