Skip to content
Merged
30 changes: 5 additions & 25 deletions docs/book/src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,34 +6,14 @@ Azure Kubernetes Service (AKS) Extension for Visual Studio Code helps enable AKS

## Features

* [Add AKS clusters to kubeconfig](./features/merge-save-kubeconfig.md)
* [Perform AKS Diagnostics checks on your AKS cluster](./features/aks-diagnostics.md)
* [Install Azure Service Operator on your AKS cluster](./features/install-azureserviceoperator.md)
* [Create GitHub Workflow from your AKS cluster (deprecated)](./features/create-gh-workflow.md)
* [Show AKS cluster overview in Azure Portal](./features/show-properties-azureportal-start-stop.md)
* [Show AKS cluster properties](./features/show-properties-azureportal-start-stop.md)
* [Create AKS cluster from Azure Portal](./features/show-properties-azureportal-start-stop.md)
* [Stop and Start the AKS cluster](./features/show-properties-azureportal-start-stop.md)
* [Run Kubectl Commands from your AKS cluster](./features/run-kubectl-command.md)
* [Run Managed Cluster Operations from your AKS cluster](./features/manage-cluster-operations.md)
* [Run Kubernetes API Health Endpoints](./features/k8s-api-health-points.md)
* [Run Inspektor Gadget Commands](./features/inspektor-gadget.md)
* [Collect TCP Dumps](./features/tcp-dumps.md)
* [Compare AKS Cluster](./features/aks-compare-cluster.md)
* [Run Image Cleaner Eraser Tool](./features/image-cleaner-eraser-tool.md)
* [Run Retina Capture](./features/retina-capture.md)
* [Run Deployment Tools Commands](./features/draft-integration.md)
* [Use Container Assist Integration (Preview)](./features/container-assist-integration.md)
* [Install and Deploy KAITO Models](./features/kaito-install-deploy.md)
* [Manage and Test KAITO Deployments](./features/kaito-manage-test.md)
* [Use Simplified AKS Menu Structure (Feature Flag)](./features/simplified-menu-structure.md)
* [Use Argo CD GitOps Integration (Feature Flag)](./features/argocd-gitops-integration.md)
* [Create AKS Fleet Manager from VS Code](./features/aks-fleet-manager.md)
* [AKS MCP Server](./features/aks-mcp-server-integration.md)
See the [Features index](./features/features.md) for the full list, grouped by task.

For an exhaustive, generated list of every command, setting and pinned tool version, see
the [Reference](./reference.md).

## Development and Release

* [What's New in 2.1.0](./release/whats-new-2.1.0.md)
* [Release notes](./release.md)
* [How to release](./release/releasing.md)
* [Development](./development/development.md)
* [Webview Development](./development/webview-development.md)
16 changes: 8 additions & 8 deletions docs/book/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,11 @@
- [Add AKS clusters to kubeconfig](./features/merge-save-kubeconfig.md)
- [Perform AKS Diagnostics checks on your AKS cluster](./features/aks-diagnostics.md)
- [Install Azure Service Operator on your AKS cluster](./features/install-azureserviceoperator.md)
- [Create GitHub Workflow from your AKS cluster (deprecated)](./features/create-gh-workflow.md)
- [Show AKS cluster overview in Azure Portal](./features/show-properties-azureportal-start-stop.md)
- [Show AKS cluster properties](./features/show-properties-azureportal-start-stop.md)
- [Create AKS cluster from Azure Portal](./features/show-properties-azureportal-start-stop.md)
- [Stop and Start the AKS cluster](./features/show-properties-azureportal-start-stop.md)
- [Show Properties, Show in Azure Portal, Start/Stop](./features/show-properties-azureportal-start-stop.md)
- [Run Kubectl Commands from your AKS cluster](./features/run-kubectl-command.md)
- [Run Managed Cluster Operations from your AKS cluster](./features/manage-cluster-operations.md)
- [Manage Cluster Operations](./features/manage-cluster-operations.md)
- [Run Kubernetes API Health Endpoints](./features/k8s-api-health-points.md)
- [Deploy and Undeploy InspektorGadget](./features/inspektor-gadget.md)
- [Enable Non-Interactive InspektorGadget Commands like Top, Profile and Snapshot](./features/inspektor-gadget.md)
- [Inspektor Gadget](./features/inspektor-gadget.md)
- [Collect TCP Dump](./features/tcp-dumps.md)
- [Compare AKS Cluster](./features/aks-compare-cluster.md)
- [Run Image Cleaner Eraser Tool](./features/image-cleaner-eraser-tool.md)
Expand All @@ -38,6 +33,11 @@
- [AKS MCP Server](./features/aks-mcp-server-integration.md)
- [Argo CD GitOps Integration](./features/argocd-gitops-integration.md)

- [Reference](./reference.md)
- [Commands](./reference/commands.md)
- [Settings](./reference/settings.md)
- [Pinned versions](./reference/pinned-versions.md)

- [Release](./release.md)
- [What's New in 2.1.0](./release/whats-new-2.1.0.md)
- [Releasing Information](./release/releasing.md)
Expand Down
4 changes: 2 additions & 2 deletions docs/book/src/features/aks-compare-cluster.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Compare 2 AKS Cluster within Same Subscription

### Compare AKS Clusters
## Compare AKS Clusters

Right click on your AKS cluster and select **Compare AKS Cluster** to use vscode diff to compare json object of 2 AKS clusters.
Right-click your Azure subscription > **Compare AKS Cluster** to use VS Code diff to compare json object of 2 AKS clusters.

![right click command](../resources/right-click-compare-cluster.png)

Expand Down
4 changes: 2 additions & 2 deletions docs/book/src/features/aks-diagnostics.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# AKS Diagnostics

### AKS Diagnostics
## AKS Diagnostics

Right click on your AKS cluster and click on **Run AKS Diagnostics** to display diagnostics information based on your AKS cluster's backend telemetry for:
Right-click your AKS cluster > **Troubleshoot & Diagnose** > **Run AKS Diagnostics** to display diagnostics information based on your AKS cluster's backend telemetry for:

- Best Practices
- Create, Upgrade, Delete and Scale issues
Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/features/aks-fleet-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The extension allows you to create AKS Fleet Manager resources and visualize them in the tree view.

### Create an AKS Fleet Manager
## Create an AKS Fleet Manager
- Right-click on the subscription where you want to create a Fleet.
- Choose **Fleet Manager**, then select **Create Fleet**.

Expand Down
10 changes: 5 additions & 5 deletions docs/book/src/features/aks-mcp-server-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The AKS extension registers a Model Context Protocol (MCP) server that gives Copilot Chat contextual access to your AKS clusters. The server is registered automatically — there is no setup command to run.

### How to Use
## How to Use

1. Open the **Command Palette** (`Cmd+Shift+P` on macOS / `Ctrl+Shift+P` on Windows/Linux) and run `MCP: List Servers`.
2. Find **AKS MCP** in the list and start it. The first start downloads the server binary, and subsequent starts will use the stored copy.
Expand All @@ -17,11 +17,11 @@ Once started, the AKS MCP server appears in the **Copilot Chat: Configure Tools*

![aks-mcp ghc configuration](../resources/aks-mcp-server-ghc-list.png)

### Remote development (WSL, Remote-SSH, Dev Containers)
## Remote development (WSL, Remote-SSH, Dev Containers)

The server registers itself in whichever extension host you're connected to, and the binary downloads to that same machine on first usage. No additional setup is required.

### Limiting Enabled Components
## Limiting Enabled Components

Some components require local CLI tools (e.g. `helm`, `cilium`, `hubble`). The default configuration enables `az_cli`, `monitor`, `fleet`, `network`, `compute`, `detectors`, `advisor`, `inspektorgadget`, and `kubectl` to ensure a comprehensive setup out of the box. You can change this by setting `aks.aksmcpserver.enabledComponents` in your VS Code user settings.

Expand All @@ -31,11 +31,11 @@ Some components require local CLI tools (e.g. `helm`, `cilium`, `hubble`). The d

Available components: `az_cli`, `monitor`, `fleet`, `network`, `compute`, `detectors`, `advisor`, `inspektorgadget`, `kubectl`, `helm`, `cilium`, `hubble`. Set to an empty string to enable all components.

### Pinning the Server Version
## Pinning the Server Version

The extension pins a specific `aks-mcp` release via the `aks.aksmcpserver.releaseTag` setting. Override it to test a different release. Binaries are cached at `~/.vs-kubernetes/tools/aks-mcp/<version>/`; you can delete old versions manually if needed.

### Troubleshooting
## Troubleshooting

* If the server doesn't appear in `MCP: List Servers`, restart VS Code so the extension can re-register the provider.
* If the server fails to start, open `MCP: List Servers`, select **AKS MCP**, and choose **Show Output** to view the server log.
Expand Down
4 changes: 2 additions & 2 deletions docs/book/src/features/argocd-gitops-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ The integration provides four commands, all prefixed with **AKS:**
|---------|-----------------|-------------|
| **AKS: Create Argo CD Application** | Command Palette, Explorer folder context menu | Generate an annotated Argo CD Application manifest pointing at a repo which contains Kubernetes manifests or a Helm chart to be deployed |
| **AKS: Apply Argo CD Application to Cluster** | Explorer YAML file context menu, Editor context menu | Apply an Application YAML to the active cluster |
| **AKS: Check Argo CD Status** | AKS cluster tree right-click menu | Show Argo CD pod and service health in an output channel |
| **AKS: Check Argo CD Status** | AKS cluster > **Develop & Deploy** | Show Argo CD pod and service health in an output channel |
| **AKS: Argo CD Post-Deploy Actions** | Shown after a successful apply, or from the Command Palette | Open UI (SSO-aware), configure Azure Workload Identity (when source is ACR / Azure DevOps), connect a private GitHub repo, or open the Argo CD sync guide |

---
Expand Down Expand Up @@ -138,7 +138,7 @@ For **Azure DevOps** or **ACR** sources, prefer the *Configure Workload Identity

## Check Argo CD Status

1. In the AKS cluster tree, right-click a cluster node.
1. Right-click your AKS cluster > **Develop & Deploy**.
2. Select **AKS: Check Argo CD Status**.
3. The **Argo CD** output channel shows:
- Whether the `argocd` namespace exists.
Expand Down
10 changes: 4 additions & 6 deletions docs/book/src/features/container-assist-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,13 +140,11 @@ This can also be enabled from the VS Code Settings UI.

Container Assist can be launched from:

- Explorer folder context menu: `AKS: Deploy application to AKS (Preview)`
- AKS cluster context menu: `AKS: Run Container Assist (Preview)`
- Explorer folder context menu: `AKS: Migrate Application to AKS`, `AKS: Generate Dockerfiles and K8s Manifests for App`, `AKS: Deploy App with Automated Pipeline`
- AKS cluster context menu, under **Develop & Deploy**: the same three commands

The AKS cluster context menu entry is shown when:

- `aks.containerAssistEnabledPreview` is `true` (default in `2.1.0`)
- At least one workspace folder is open
The Explorer entries require `aks.containerAssistEnabledPreview` (enabled by default) and a folder selection.
On the cluster menu, `AKS: Migrate Application to AKS` needs only the setting; the other two also need an open workspace folder.

## User flow and options

Expand Down
14 changes: 0 additions & 14 deletions docs/book/src/features/create-gh-workflow.md

This file was deleted.

107 changes: 45 additions & 62 deletions docs/book/src/features/features.md
Original file line number Diff line number Diff line change
@@ -1,67 +1,50 @@
## Features

Once you successfully log in with your Azure Account, you can view all AKS clusters in your Azure subscriptions(s) under the section named **Azure**. You can right click on your AKS cluster and click a menu item to perform following actions.

## Release spotlight

This release adds the following experiences:

- [Container Assist Integration (Preview)](./container-assist-integration.md)
# Features

Once you sign in with your Azure account, your AKS clusters appear under the **Azure**
section of the Cloud Explorer. Right-click a cluster to reach these actions. Cluster
commands are grouped under **Develop & Deploy**, **Troubleshoot & Diagnose**, and
**Manage Cluster** — see [Simplified AKS Menu Structure](./simplified-menu-structure.md).

For the full list of commands and where each one lives, see the
[command reference](../reference/commands.md).

## Cluster access and properties

- [Merge and Save Into Kubeconfig](./merge-save-kubeconfig.md)
- [Show Properties, Show in Azure Portal](./show-properties-azureportal-start-stop.md)
- [Compare 2 AKS Clusters within the Same Subscription](./aks-compare-cluster.md)
- [Manage Cluster Operations](./manage-cluster-operations.md)

## Troubleshooting and diagnostics

- [AKS Diagnostics](./aks-diagnostics.md)
- [Kubernetes API Health Endpoints](./k8s-api-health-points.md)
- [Inspektor Gadget](./inspektor-gadget.md)
- [Collect TCP Dumps](./tcp-dumps.md)
- [Run Retina Distributed Capture](./retina-capture.md)
- [Garbage Collection Using Eraser Image Cleanup Tool](./image-cleaner-eraser-tool.md)

## Develop and deploy

- [Run Kubectl Commands](./run-kubectl-command.md)
- [Install Azure Service Operator](./install-azureserviceoperator.md)
- [Deployment Tools: Draft Tool Integration](./draft-integration.md)
- [Argo CD GitOps Integration](./argocd-gitops-integration.md)
- [Container Assist (Preview)](./container-assist-integration.md)
- [Azure Resources and Permissions](./container-assist-azure-resources.md)
- [AI Data Flow and Privacy](./container-assist-ai-data-flow.md)
- [GitHub Workflow and OIDC Setup](./container-assist-github-workflow.md)
- [Containerization Assist Skills for Copilot Chat (Preview)](./containerization-assist-skills.md)
- [Simplified AKS Menu Structure (Feature Flag)](./simplified-menu-structure.md)

Container Assist and the simplified menu can be enabled independently:

```json
{
"aks.containerAssistEnabledPreview": true,
"aks.simplifiedMenuStructure": true
}
```

From `2.1.0`, `aks.containerAssistEnabledPreview` is enabled by default.
The Containerization Assist skills require no feature flag or additional setup.

Container Assist release screenshots:

![Container Assist menu in AKS cluster context menu](../resources/container-assist/container-assist-commands-1.png)

![Container Assist workspace menu entry](../resources/container-assist/container-assist-workspacemenu.png)

Menu simplification release screenshots:

![Classic AKS cluster context menu](../resources/new-menu-structure/simplified-menu-1.png)

![Simplified AKS cluster context menu](../resources/new-menu-structure/simplified-menu-2.png)

![Cloud explorer extension menu](../resources/right-click-menu.png)

![Cloud explorer extension menu](../resources/right-click-menu-workflow.png)

![Cloud explorer extension menu](../resources/right-click-menu-kubectl.png)

![Cloud explorer extension menu](../resources/right-click-menu-managedoperations.png)

![Cloud explorer extension menu](../resources/inspector-gadget-main-menu.png)

![Cloud explorer extension menu](../resources/right-click-subscription.png)

![Cloud explorer health check panel](../resources/kubectl-command-panel.png)

![Cloud explorer new inspektor gadget panel](../resources/inspector-gadget-1.png)

![Cloud explorer create cluster webview](../resources/create-cluster-webview.png)

![Cloud explorer tcp menu](../resources/right-click-tcp-dump-collect.png)

![Cloud explorer tcp dump webview](../resources/tcp-dump-linux-node.png)

![Cloud explorer tcp dump filter interface](../resources/tcp-dump-filter-interface.png)

![Cloud explorer tcp dump filter interface enhanced](../resources/tcp-dump-filter-interface1.png)
## AI and models

![AKS Show Properties webview](../resources/show-properties-reconcile.png)
- [Install and Deploy KAITO Models](./kaito-install-deploy.md)
- [Manage and Test KAITO Deployments](./kaito-manage-test.md)
- [AKS MCP Server](./aks-mcp-server-integration.md)
- [Kickstart Agent for AKS Automatic (Preview)](./kickstart-agent.md)
- [AKS Plugins for GitHub Copilot for Azure](./aks-plugins-github-copilot.md)

![Cloud Explorer Compare AKS Cluster](../resources/aks-compare-cluster-result.png)
## Fleet and configuration

![Cloud Explorer Run Retina Capture on AKS Cluster](../resources/retina-success-run-download.png)
- [AKS Fleet Manager](./aks-fleet-manager.md)
- [Simplified AKS Menu Structure](./simplified-menu-structure.md)
4 changes: 2 additions & 2 deletions docs/book/src/features/image-cleaner-eraser-tool.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Garbage collection Using Eraser Image Cleanup Tool

### Run Eraser Image Cleanup
## Run Eraser Image Cleanup

Right click on your AKS cluster and select **Run Eraser Image Cleanup** to deploy the [Eraser Tool](https://eraser-dev.github.io/eraser/docs/quick-start) to [auomatically clean images in a regular interval](https://eraser-dev.github.io/eraser/docs/quick-start#automatically-cleaning-images) for the selected AKS Cluster.
Right-click your AKS cluster > **Troubleshoot & Diagnose** > **Run Eraser Image Cleanup** to deploy the [Eraser Tool](https://eraser-dev.github.io/eraser/docs/quick-start) to [auomatically clean images in a regular interval](https://eraser-dev.github.io/eraser/docs/quick-start#automatically-cleaning-images) for the selected AKS Cluster.

![Step 1: Menu](../resources/right-click-run-eraser.png)

Expand Down
Loading
Loading