From a4c2edc5a50d74ebcd0e0723c9e63b3e6821a2ad Mon Sep 17 00:00:00 2001 From: Suneha Bose Date: Wed, 5 Aug 2026 13:20:21 -0700 Subject: [PATCH 1/7] docs: fix broken links, restore missing Development page, drop duplicate copies The published Development section rendered as a bare heading because SUMMARY.md linked to ./development.md, which did not exist. mdBook's create-missing default silently generated an empty stub instead of failing, so this went unnoticed. Add the page and set create-missing = false. Three pages under docs/ were stale forks of their docs/book/src/ counterparts, and docs/README.md linked only to the forks: docs/webview-development.md missing the Custom UI Elements section docs/package-scripts.md missing the Local VSIX Sharing section docs/maintenance/README.md last updated 2021; missing the pinned third-party versions section entirely Delete them and rewrite docs/README.md as an index into book/. The release skill instructed maintainers to mirror releasing.md into docs/maintenance/README.md, which is why that fork stayed alive; update it to name book/src/ as the single source of truth. Also fixed: - ../package.json and ../webview-ui/ links resolved outside the book - dev-webview / build-webview are not real npm scripts (dev:webview, build:webview) - webpack-ui typo for webview-ui - SUMMARY.md nav labels disagreed with the pages' own titles - bin/ ignored; make -C docs/book build writes mdBook binaries to the repo root because the Makefile uses $(PWD) rather than $(CURDIR) --- .../vscode-aks-tools-release-pr/SKILL.md | 4 +- .gitignore | 1 + docs/README.md | 18 ++++++--- docs/book/book.toml | 5 +++ docs/book/src/SUMMARY.md | 4 +- docs/book/src/development.md | 6 +++ docs/book/src/development/development.md | 6 +-- .../src/development/webview-development.md | 4 +- docs/maintenance/README.md | 24 ------------ docs/package-scripts.md | 25 ------------- docs/webview-development.md | 37 ------------------- 11 files changed, 35 insertions(+), 99 deletions(-) create mode 100644 docs/book/src/development.md delete mode 100644 docs/maintenance/README.md delete mode 100644 docs/package-scripts.md delete mode 100644 docs/webview-development.md diff --git a/.agents/skills/vscode-aks-tools-release-pr/SKILL.md b/.agents/skills/vscode-aks-tools-release-pr/SKILL.md index 2758cff53..bf91a7b1f 100644 --- a/.agents/skills/vscode-aks-tools-release-pr/SKILL.md +++ b/.agents/skills/vscode-aks-tools-release-pr/SKILL.md @@ -290,7 +290,9 @@ grep -rn "What's New in " docs/ # must return zero matches Update it only if the user explicitly says the process changed (e.g., new pipeline, new required step, new secret). -`docs/maintenance/README.md` currently mirrors `releasing.md`. If you update one, mirror the change to the other and tell the user. +`docs/book/src/release/releasing.md` is the only copy of the release process. A duplicate +at `docs/maintenance/README.md` was deleted; do not recreate it. `docs/book/src/` is the +single source of truth for all documentation. ### 10. CHANGELOG.md — DO NOT UPDATE diff --git a/.gitignore b/.gitignore index b1f4e2814..f84cd90c7 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,4 @@ vsix *.vsix .DS_Store planning/ +bin/ diff --git a/docs/README.md b/docs/README.md index 6b1e18c83..730747fb5 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,8 +1,16 @@ -# Visual Studio Code AKS Tools +# Visual Studio Code AKS Tools — Documentation -## Maintenance +The docs are an [mdBook](https://rust-lang.github.io/mdBook/) under [`book/`](./book/), +published to GitHub Pages by [`website.yaml`](../.github/workflows/website.yaml). -* [How to release](maintenance/README.md) -* [Webview Development](./webview-development.md) -* [Package Scripts](./package-scripts.md) +`book/src/` is the single source of truth. Do not copy pages elsewhere. +Navigation is [`book/src/SUMMARY.md`](./book/src/SUMMARY.md); a page not listed there is not published. +```sh +make -C docs/book build # build into docs/book/book/ +make -C docs/book serve # live preview +``` + +Do not bump `MDBOOK_VERSION` in [`book/Makefile`](./book/Makefile) without updating +[`book/book.toml`](./book/book.toml) — later mdBook releases dropped `multilingual` and +renamed `curly-quotes`. diff --git a/docs/book/book.toml b/docs/book/book.toml index aa928583a..649fde956 100644 --- a/docs/book/book.toml +++ b/docs/book/book.toml @@ -6,6 +6,11 @@ src = "src" title = "Visual Studio Code AKS Tools" description = "Display Azure Kubernetes Services within VS Code" +# Fail the build when SUMMARY.md references a page that does not exist. Without this, +# mdBook silently creates a stub and publishes a blank page. +[build] +create-missing = false + [preprocessor.toc] command = "mdbook-toc" diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md index 304f096ab..1a43214d0 100644 --- a/docs/book/src/SUMMARY.md +++ b/docs/book/src/SUMMARY.md @@ -3,8 +3,8 @@ - [Introduction](./README.md) - [Installation / Quick Start](./installation.md) - [Development](./development.md) - - [Development](./development/development.md) - - [Webview Settings](./development/webview-development.md) + - [Package Scripts](./development/development.md) + - [Webview Development](./development/webview-development.md) - [Features](./features/features.md) - [Add AKS clusters to kubeconfig](./features/merge-save-kubeconfig.md) - [Perform AKS Diagnostics checks on your AKS cluster](./features/aks-diagnostics.md) diff --git a/docs/book/src/development.md b/docs/book/src/development.md new file mode 100644 index 000000000..f81a70cbf --- /dev/null +++ b/docs/book/src/development.md @@ -0,0 +1,6 @@ +# Development + +Guidance for working on the extension itself. + +- [Package Scripts](./development/development.md) — `npm` scripts to build, run, and test. +- [Webview Development](./development/webview-development.md) — developing the `webview-ui` front end. diff --git a/docs/book/src/development/development.md b/docs/book/src/development/development.md index 18907b4bd..c629cd511 100644 --- a/docs/book/src/development/development.md +++ b/docs/book/src/development/development.md @@ -1,6 +1,6 @@ # Package Scripts -This gives an overview of the `npm` scripts available for development and release of the extension. See the `scripts` block in [package.json](../package.json). +This gives an overview of the `npm` scripts available for development and release of the extension. See the `scripts` block in [package.json](../../../../package.json). These can all be run from the command line in the root of the repository (with `npm` installed), using `npm run {script-name}`. @@ -10,8 +10,8 @@ These can all be run from the command line in the root of the repository (with ` ## Development and Testing -- [`dev-webview`](./webview-development.md#developing-the-ui): for concurrent development/debugging of webview UX. -- `build-webview`: bundles and minifies the webview UX for consumption by the extension. +- [`dev:webview`](./webview-development.md#developing-the-ui): for concurrent development/debugging of webview UX. +- `build:webview`: bundles and minifies the webview UX for consumption by the extension. - `webpack`: builds and packages the extension. - `test`: runs automated tests. diff --git a/docs/book/src/development/webview-development.md b/docs/book/src/development/webview-development.md index 0c9558a9b..1598e2806 100644 --- a/docs/book/src/development/webview-development.md +++ b/docs/book/src/development/webview-development.md @@ -1,6 +1,6 @@ # Webview Development -For commands that require a webview (see [guidance](https://code.visualstudio.com/api/extension-guides/webview#should-i-use-a-webview) on where this is appropriate), the [`webview-ui`](../webview-ui/) project provides the necessary tooling to develop the front end. +For commands that require a webview (see [guidance](https://code.visualstudio.com/api/extension-guides/webview#should-i-use-a-webview) on where this is appropriate), the [`webview-ui`](../../../../webview-ui/) project provides the necessary tooling to develop the front end. ## Initial Setup @@ -47,4 +47,4 @@ These components help us maintain a clean, unified look without relying on exter ## Building for release -The process for this is unaffected by the webview setup. The `npm run webpack` and `vsce package` commands will ensure the `webpack-ui` project is built and bundled. +The process for this is unaffected by the webview setup. The `npm run webpack` and `vsce package` commands will ensure the `webview-ui` project is built and bundled. diff --git a/docs/maintenance/README.md b/docs/maintenance/README.md deleted file mode 100644 index 6ed7b6319..000000000 --- a/docs/maintenance/README.md +++ /dev/null @@ -1,24 +0,0 @@ -## How to Release - -To make a new release and publish it to the marketplace you have to follow the following steps. - -1. Create a branch `publish-x.y.z` -2. Update `package.json` with the new version -3. Add a section to `CHANGELOG.md` with the header `## [x.y.z]` (N.B: make sure to write the new version in square brackets as the `changelog-reader` action only works if the `CHANGELOG.md` file follows the [Keep a Changelog standard](https://github.com/olivierlacan/keep-a-changelog)) -4. Create a new PR, get approval and merge -5. Run the `Build & Publish` workflow manually from the GH Actions tab - -### Build & Publish - -The `Build & Publish` workflow allows to create a new release, package it in a VSIX file and publish to the VSCode marketplace with a single click. - -The only requirement needed to run the workflow is to have a secret named `VS_MARKETPLACE_TOKEN` containing the Personal Access Token of the publisher. You can find more infos about how to create a publisher/token in the [official documentation](https://code.visualstudio.com/api/working-with-extensions/publishing-extension#create-a-publisher) - -Once everything is set up and you followed all first 4 steps in the previous section, you are ready to trigger the `Build & Publish` workflow. -This is what it actually does: - -1. Install all dependencies and build the project -2. Check if the `CHANGELOG.md` contains a section related to the new version -3. Create a new release -4. Create the VSIX file and publish it to the marketplace -5. Attach the VSIX file to the new release \ No newline at end of file diff --git a/docs/package-scripts.md b/docs/package-scripts.md deleted file mode 100644 index c44e87c89..000000000 --- a/docs/package-scripts.md +++ /dev/null @@ -1,25 +0,0 @@ -# Package Scripts - -This gives an overview of the `npm` scripts available for development and release of the extension. See the `scripts` block in [package.json](../package.json). - -These can all be run from the command line in the root of the repository (with `npm` installed), using `npm run {script-name}`. - -## Environment Initialization - -- `install:all`: Installs `npm` dependencies for both the main extension project and the `webview-ui` sub-project. It's recommended to use this instead of `npm install`, which will only install dependencies for the main project. - -## Development and Testing - -- [`dev-webview`](./webview-development.md#developing-the-ui): for concurrent development/debugging of webview UX. -- `build-webview`: bundles and minifies the webview UX for consumption by the extension. -- `webpack`: builds and packages the extension. -- `test`: runs automated tests. - -## Not for Running Directly - -Some scripts are invoked by other scripts or tools, so need not be run directly, or are otherwise not required for general development tasks: - -- `vscode:prepublish`: used by the `vsce` command for packaging the extension into a `vsix` file for distribution. -- `webpack-dev`: builds the `webview-ui` project and then bundles the extension code in development mode (`--watch`). This is the `preLaunchTask` for the `Extension` debug profile (F5). -- `test-compile`: compiles the extension typescript (after building the `webview-ui` project) without webpacking it. This is a prerequisite to running automated tests. It _could_ be moved into `test`, but keeping it separate would allow it to be used in the future as a prelaunch task for debugging the extension without webpacking it. -- `watch`: not currently used as part of any workflow I'm aware of, but could potentially be useful for editing while debugging. diff --git a/docs/webview-development.md b/docs/webview-development.md deleted file mode 100644 index 7e7a62781..000000000 --- a/docs/webview-development.md +++ /dev/null @@ -1,37 +0,0 @@ -# Webview Development - -For commands that require a webview (see [guidance](https://code.visualstudio.com/api/extension-guides/webview#should-i-use-a-webview) on where this is appropriate), the [`webview-ui`](../webview-ui/) project provides the necessary tooling to develop the front end. - -## Initial Setup - -Run `npm run install:all` to install package dependencies for both the extension and webview project. - -## Development/Debugging - -### File structure - -- Webview source files are under `/webview-ui/src`. -- When built, bundled/minified webview assets are output to `/webview-ui/dist`. - -When the extension is run (both in development and production), the webview assets are read from `/webview-ui/dist`. - -### Developing the UI - -If you like to use your browser development tools for debugging, or you wish to open the web application in an existing browser window: -1. Run `npm run dev:webview` to start the development server. -2. Navigate to `http://localhost:3000` in your browser. - -Alternatively, if you are developing in VS Code and wish to use the inbuilt debugging functionality: -1. Hit `F5` to launch the `Webview UI` debug profile in a new browser window. This will automatically run the development server and attach a debugger. - -### Developing the VS Code commands that launch the UI - -> **Prerequisite:** Run `npm run install:all` at least once before debugging (see [Initial Setup](#initial-setup)). A plain `npm install` does **not** install the `webview-ui` dependencies, so the webview build produces no assets and panels render blank. - -To debug the extension itself, hit `F5` to launch the `Extension` debug profile in a new VS Code Window. This will automatically build the `webview-ui` project (via `npm run build:webview`) and bundle the extension, so the assets in `/webview-ui/dist` are always present. - -The extension will not automatically update itself in response to code changes as you are debugging, so the best workflow here is to stop debugging, make changes, and launch the debugger again. - -## Building for release - -The process for this is unaffected by the webview setup. The `npm run webpack` and `vsce package` commands will ensure the `webpack-ui` project is built and bundled. From ebb9f49268ea5516521ff2d4f8c3f5ee250a77c2 Mon Sep 17 00:00:00 2001 From: Suneha Bose Date: Wed, 5 Aug 2026 15:52:02 -0700 Subject: [PATCH 2/7] docs: add generated reference section and fix feature navigation Adds reference/ pages generated from package.json by scripts/generate-docs-reference.js, carrying a DO NOT EDIT header: commands with their menu placement, settings, and pinned versions. SUMMARY.md listed show-properties-azureportal-start-stop.md four times and inspektor-gadget.md twice, so three sidebar entries led to a page that did not match the label clicked. Collapsed to one entry each; no URLs change. features.md was a stale 2.1.0 release spotlight that linked to 2 of its 25 feature pages. Rewritten as an index. This orphans 5 classic-menu screenshots, removed in a later PR. --- docs/book/src/SUMMARY.md | 15 +- docs/book/src/features/features.md | 90 +++++------- docs/book/src/reference.md | 9 ++ docs/book/src/reference/commands.md | 155 +++++++++++++++++++++ docs/book/src/reference/pinned-versions.md | 37 +++++ docs/book/src/reference/settings.md | 32 +++++ 6 files changed, 278 insertions(+), 60 deletions(-) create mode 100644 docs/book/src/reference.md create mode 100644 docs/book/src/reference/commands.md create mode 100644 docs/book/src/reference/pinned-versions.md create mode 100644 docs/book/src/reference/settings.md diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md index 1a43214d0..4db5da4b0 100644 --- a/docs/book/src/SUMMARY.md +++ b/docs/book/src/SUMMARY.md @@ -10,15 +10,11 @@ - [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) @@ -36,6 +32,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) diff --git a/docs/book/src/features/features.md b/docs/book/src/features/features.md index c7caa365e..bda0fe412 100644 --- a/docs/book/src/features/features.md +++ b/docs/book/src/features/features.md @@ -1,65 +1,49 @@ -## Features +# 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. +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). -## Release spotlight +For the full list of commands and where each one lives, see the +[command reference](../reference/commands.md). -This release adds two configurable experiences: +## Cluster access and properties -- [Container Assist Integration (Preview)](./container-assist-integration.md) -- [Simplified AKS Menu Structure (Feature Flag)](./simplified-menu-structure.md) +- [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) -These can be enabled independently: +## Troubleshooting and diagnostics -```json -{ - "aks.containerAssistEnabledPreview": true, - "aks.simplifiedMenuStructure": true -} -``` +- [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) -From `2.1.0`, `aks.containerAssistEnabledPreview` is enabled by default. +## Develop and deploy -Container Assist release screenshots: +- [Run Kubectl Commands](./run-kubectl-command.md) +- [Install Azure Service Operator](./install-azureserviceoperator.md) +- [Deployment Tools: Draft Tool Integration](./draft-integration.md) +- [Create GitHub Workflow](./create-gh-workflow.md) (deprecated) +- [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) -![Container Assist menu in AKS cluster context menu](../resources/container-assist/container-assist-commands-1.png) +## AI and models -![Container Assist workspace menu entry](../resources/container-assist/container-assist-workspacemenu.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) +- [AKS Plugins for GitHub Copilot for Azure](./aks-plugins-github-copilot.md) -Menu simplification release screenshots: +## Fleet and configuration -![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) - -![AKS Show Properties webview](../resources/show-properties-reconcile.png) - -![Cloud Explorer Compare AKS Cluster](../resources/aks-compare-cluster-result.png) - -![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) diff --git a/docs/book/src/reference.md b/docs/book/src/reference.md new file mode 100644 index 000000000..d384e6307 --- /dev/null +++ b/docs/book/src/reference.md @@ -0,0 +1,9 @@ +# Reference + +Generated from `package.json` on every change, so these pages do not drift from the shipped extension. + +- [Commands](./reference/commands.md) — every command, its ID, and where it appears in the menus +- [Settings](./reference/settings.md) — every setting, its type and default +- [Pinned versions](./reference/pinned-versions.md) — third-party tool and GitHub Actions versions + +The feature guides link here rather than restating command IDs and menu paths. diff --git a/docs/book/src/reference/commands.md b/docs/book/src/reference/commands.md new file mode 100644 index 000000000..a0ed19478 --- /dev/null +++ b/docs/book/src/reference/commands.md @@ -0,0 +1,155 @@ + + +# Commands + +Every command the extension contributes, with where it appears in the tree-view menus. + +The menu layout depends on the `aks.simplifiedMenuStructure` setting, which defaults to `true`. +The **Default menu** column reflects that default; **Classic menu** applies when the setting is `false`. +A dash means the command has no entry in that menu and is reachable only from the Command Palette. + +## Command Palette + +63 of 66 commands are available from the Command Palette (`Ctrl+Shift+P` / `Cmd+Shift+P`). + +| Title | Command ID | Shown when | +|---|---|---| +| AKS Quick Actions | `aks.quickActions` | always | +| AKS: AKS: Configure Kickstart Cluster | `aks.kickstartCluster` | `aks.kickstartEnabledPreview` | +| AKS: AKS: Launch Kickstart Agent | `aks.kickstart.launchExperience` | `aks.kickstartEnabledPreview` | +| AKS: Apply Argo CD Application to Cluster | `aks.argoCDApplyApp` | a YAML file in the active editor, `aks.argoCDEnabled` | +| AKS: Argo CD Post-Deploy Actions | `aks.argoCDPostApplyActions` | `aks.argoCDEnabled` | +| AKS: Attach ACR to Cluster | `aks.attachAcrToCluster` | always | +| AKS: Check Argo CD Status | `aks.argoCDCheckStatus` | `aks.argoCDEnabled` | +| AKS: Check Deployment Permissions | `aks.checkDeploymentPermissions` | always | +| AKS: Check Role Assignment Permissions | `aks.checkRoleAssignmentPermissions` | always | +| AKS: Create a GitHub Workflow | `aks.draftWorkflow` | an open workspace folder | +| AKS: Create Argo CD GitOps Pipeline | `aks.draftArgoCDDeployment` | an open workspace folder, `aks.argoCDEnabled` | +| AKS: Deploy App with Automated Pipeline | `aks.deployAppWithAutomatedPipeline` | always | +| AKS: Deploy application to AKS (Preview) | `aks.runContainerAssist` | always | +| AKS: Generate Dockerfiles and K8s Manifests for App | `aks.containerizeApp` | always | +| AKS: Migrate Application to AKS | `aks.migrateAndModernizeApp` | always | +| AKS: Run Deployment Safeguards YAML Validation | `aks.aksDraftValidate` | always | +| AKS: Select cluster... | `aks.clusterFilter` | always | +| AKS: Select subscriptions... | `aks.selectSubscriptions` | always | +| AKS: Select Tenant... | `aks.selectTenant` | always | +| AKS: Set GitHub Actions Secrets (Preview) | `aks.setGitHubActionsSecrets` | an open workspace folder, `aks.containerAssistEnabledPreview` | +| AKS: Setup OIDC for GitHub Actions (Preview) | `aks.setupOIDCForGitHub` | an open workspace folder, `aks.containerAssistEnabledPreview` | +| AKS: Sign in to Azure... | `aks.signInToAzure` | always | +| AKS: Switch to Classic Menu | `aks.switchToClassicMenu` | `aks.simplifiedMenuStructure` | +| AKS: Switch to Grouped Menu | `aks.switchToStructuredMenu` | not `aks.simplifiedMenuStructure` | +| Best Practices | `aks.aksBestPracticesDiagnostics` | always | +| Cluster and Control Plane Availability and Performance | `aks.aksCCPAvailabilityPerformanceDiagnostics` | always | +| Collect TCP Dumps | `aks.aksTCPDump` | always | +| Command to create an AKS cluster | `aks.aksCreateClusterFromCopilot` | always | +| Compare AKS Cluster | `aks.compareCluster` | always | +| Create Cluster From Azure Portal | `aks.createClusterNavToAzurePortal` | always | +| Create Cluster From VS Code | `aks.createCluster` | always | +| Create Fleet | `aks.aksCreateFleet` | always | +| Create KAITO Workspace | `aks.aksKaitoGenerateYaml` | always | +| Create KAITO Workspace | `aks.aksKaitoCreateCRD` | always | +| Create, Upgrade, Delete and Scale | `aks.aksCRUDDiagnostics` | always | +| Delete Cluster | `aks.aksDeleteCluster` | always | +| Deploy application manifest from Github Copilot Chat | `aks.aksDeployManifest` | always | +| Deploy KAITO Workspace | `aks.aksKaitoDeployCRD` | always | +| Download Artifacts Locally | `aks.aksDownloadRetinaCapture` | always | +| Identify Block I/O intensive processes | `aks.aksTopBlockIO` | always | +| Identify files being read and written to | `aks.aksTopFile` | always | +| Identity and Security | `aks.aksIdentitySecurityDiagnostics` | always | +| Install Azure Service Operator | `aks.installAzureServiceOperator` | always | +| Install KAITO | `aks.aksKaito` | always | +| Investigate DNS | `aks.aksInvestigateDns` | always | +| Manage KAITO Models | `aks.aksKaitoManage` | always | +| Network Connectivity Issues | `aks.aksCategoryConnectivity` | always | +| Node Health | `aks.aksNodeHealthDiagnostics` | always | +| Profile CPU | `aks.aksProfileCpu` | always | +| Real-time TCP Monitoring | `aks.aksRealTimeTcpMonitoring` | always | +| Reconcile Cluster | `aks.aksReconcileCluster` | always | +| Rotate Cluster Certificate | `aks.aksRotateClusterCert` | always | +| Run Eraser Image Cleanup | `aks.eraserTool` | always | +| Run Kubectl Commands | `aks.aksRunKubectlCommands` | always | +| Run Kubectl Commands from Github Copilot Chat | `aks.aksOpenKubectlPanel` | always | +| Show Fleet Properties | `aks.aksFleetProperties` | always | +| Show In Azure Portal | `aks.showInPortal` | always | +| Show Inspektor Gadget | `aks.aksInspektorGadgetShow` | always | +| Show Properties | `aks.clusterProperties` | always | +| Storage | `aks.aksStorageDiagnostics` | always | +| Test KAITO models | `aks.aksKaitoTest` | always | +| Upload Artifacts to Blob Storage | `aks.aksUploadRetinaCapture` | always | +| View processes executed in the kernel | `aks.aksTraceExec` | always | + +Hidden from the palette (invoked from a menu or another command): `aks.refreshSubscription`, `aks.containerizeAppFromTree`, `aks.deployAppWithAutomatedPipelineFromTree`. + +## Menu placement + +| Title | Command ID | Default menu | Classic menu | Requires | +|---|---|---|---|---| +| Best Practices | `aks.aksBestPracticesDiagnostics` | AKS cluster node > Troubleshoot & Diagnose > Run AKS Diagnostics | AKS cluster node > Run AKS Diagnostics | — | +| Network Connectivity Issues | `aks.aksCategoryConnectivity` | AKS cluster node > Troubleshoot & Diagnose > Run AKS Diagnostics | AKS cluster node > Run AKS Diagnostics | — | +| Cluster and Control Plane Availability and Performance | `aks.aksCCPAvailabilityPerformanceDiagnostics` | AKS cluster node > Troubleshoot & Diagnose > Run AKS Diagnostics | AKS cluster node > Run AKS Diagnostics | — | +| Command to create an AKS cluster | `aks.aksCreateClusterFromCopilot` | — | — | — | +| Create Fleet | `aks.aksCreateFleet` | Subscription node > Fleet Manager | Subscription node > Fleet Manager | — | +| Create, Upgrade, Delete and Scale | `aks.aksCRUDDiagnostics` | AKS cluster node > Troubleshoot & Diagnose > Run AKS Diagnostics | AKS cluster node > Run AKS Diagnostics | — | +| Delete Cluster | `aks.aksDeleteCluster` | AKS cluster node > Manage Cluster | AKS cluster node > Managed Cluster Operations | — | +| Deploy application manifest from Github Copilot Chat | `aks.aksDeployManifest` | — | — | — | +| Download Artifacts Locally | `aks.aksDownloadRetinaCapture` | AKS cluster node > Troubleshoot & Diagnose > Troubleshoot Network Health > Run Retina Capture | AKS cluster node > Troubleshoot Network Health > Run Retina Capture | — | +| AKS: Run Deployment Safeguards YAML Validation | `aks.aksDraftValidate` | AKS cluster node > Develop & Deploy | — | — | +| Show Fleet Properties | `aks.aksFleetProperties` | Fleet node | Fleet node | — | +| Identity and Security | `aks.aksIdentitySecurityDiagnostics` | AKS cluster node > Troubleshoot & Diagnose > Run AKS Diagnostics | AKS cluster node > Run AKS Diagnostics | — | +| Show Inspektor Gadget | `aks.aksInspektorGadgetShow` | AKS cluster node > Troubleshoot & Diagnose | AKS cluster node | — | +| Investigate DNS | `aks.aksInvestigateDns` | AKS cluster node > Troubleshoot & Diagnose > Troubleshoot Network Health | AKS cluster node > Troubleshoot Network Health | — | +| Install KAITO | `aks.aksKaito` | AKS cluster node > Develop & Deploy > Deploy a LLM with KAITO | AKS cluster node > Deploy a LLM with KAITO | — | +| Create KAITO Workspace | `aks.aksKaitoCreateCRD` | AKS cluster node > Develop & Deploy > Deploy a LLM with KAITO | AKS cluster node > Deploy a LLM with KAITO | — | +| Deploy KAITO Workspace | `aks.aksKaitoDeployCRD` | — | — | — | +| Create KAITO Workspace | `aks.aksKaitoGenerateYaml` | — | — | — | +| Manage KAITO Models | `aks.aksKaitoManage` | AKS cluster node > Develop & Deploy > Deploy a LLM with KAITO | AKS cluster node > Deploy a LLM with KAITO | — | +| Test KAITO models | `aks.aksKaitoTest` | — | — | — | +| Node Health | `aks.aksNodeHealthDiagnostics` | AKS cluster node > Troubleshoot & Diagnose > Run AKS Diagnostics | AKS cluster node > Run AKS Diagnostics | — | +| Run Kubectl Commands from Github Copilot Chat | `aks.aksOpenKubectlPanel` | — | — | — | +| Profile CPU | `aks.aksProfileCpu` | AKS cluster node > Troubleshoot & Diagnose > Troubleshoot Resource Utilization | AKS cluster node > Troubleshoot Resource Utilization | — | +| Real-time TCP Monitoring | `aks.aksRealTimeTcpMonitoring` | AKS cluster node > Troubleshoot & Diagnose > Troubleshoot Network Health | AKS cluster node > Troubleshoot Network Health | — | +| Reconcile Cluster | `aks.aksReconcileCluster` | AKS cluster node > Manage Cluster | AKS cluster node > Managed Cluster Operations | — | +| Rotate Cluster Certificate | `aks.aksRotateClusterCert` | AKS cluster node > Manage Cluster | AKS cluster node > Managed Cluster Operations | — | +| Run Kubectl Commands | `aks.aksRunKubectlCommands` | AKS cluster node > Develop & Deploy
Kubernetes explorer cluster node | AKS cluster node
Kubernetes explorer cluster node | — | +| Storage | `aks.aksStorageDiagnostics` | AKS cluster node > Troubleshoot & Diagnose > Run AKS Diagnostics | AKS cluster node > Run AKS Diagnostics | — | +| Collect TCP Dumps | `aks.aksTCPDump` | AKS cluster node > Troubleshoot & Diagnose > Troubleshoot Network Health | AKS cluster node > Troubleshoot Network Health | — | +| Identify Block I/O intensive processes | `aks.aksTopBlockIO` | AKS cluster node > Troubleshoot & Diagnose > Troubleshoot Resource Utilization > Investigate Block I/O | AKS cluster node > Troubleshoot Resource Utilization > Investigate Block I/O | — | +| Identify files being read and written to | `aks.aksTopFile` | AKS cluster node > Troubleshoot & Diagnose > Troubleshoot Resource Utilization | AKS cluster node > Troubleshoot Resource Utilization | — | +| View processes executed in the kernel | `aks.aksTraceExec` | AKS cluster node > Troubleshoot & Diagnose > Improve security of my cluster | AKS cluster node > Improve security of my cluster | — | +| Upload Artifacts to Blob Storage | `aks.aksUploadRetinaCapture` | AKS cluster node > Troubleshoot & Diagnose > Troubleshoot Network Health > Run Retina Capture | AKS cluster node > Troubleshoot Network Health > Run Retina Capture | — | +| AKS: Apply Argo CD Application to Cluster | `aks.argoCDApplyApp` | — | — | — | +| AKS: Check Argo CD Status | `aks.argoCDCheckStatus` | AKS cluster node > Develop & Deploy | AKS cluster node > Deployment Tools | `aks.argoCDEnabled` | +| AKS: Argo CD Post-Deploy Actions | `aks.argoCDPostApplyActions` | — | — | — | +| Attach ACR to Cluster | `aks.attachAcrToCluster` | AKS cluster node > Develop & Deploy | AKS cluster node > Deployment Tools | — | +| Check Deployment Permissions | `aks.checkDeploymentPermissions` | — | — | — | +| Check Role Assignment Permissions | `aks.checkRoleAssignmentPermissions` | — | — | — | +| Select cluster... | `aks.clusterFilter` | Subscription node | Subscription node | — | +| Show Properties | `aks.clusterProperties` | AKS cluster node > Manage Cluster
AKS cluster node | AKS cluster node | — | +| Compare AKS Cluster | `aks.compareCluster` | Subscription node | Subscription node | — | +| AKS: Generate Dockerfiles and K8s Manifests for App | `aks.containerizeApp` | — | — | — | +| AKS: Generate Dockerfiles and K8s Manifests for App | `aks.containerizeAppFromTree` | AKS cluster node > Develop & Deploy | AKS cluster node | `aks.containerAssistEnabledPreview`, an open workspace folder | +| Create Cluster From VS Code | `aks.createCluster` | Subscription node > Create Cluster | Subscription node > Create Cluster | — | +| Create Cluster From Azure Portal | `aks.createClusterNavToAzurePortal` | Subscription node > Create Cluster | Subscription node > Create Cluster | — | +| AKS: Deploy App with Automated Pipeline | `aks.deployAppWithAutomatedPipeline` | — | — | — | +| AKS: Deploy App with Automated Pipeline | `aks.deployAppWithAutomatedPipelineFromTree` | AKS cluster node > Develop & Deploy | AKS cluster node | `aks.containerAssistEnabledPreview`, an open workspace folder | +| AKS: Create Argo CD GitOps Pipeline | `aks.draftArgoCDDeployment` | — | — | — | +| Create a GitHub Workflow | `aks.draftWorkflow` | AKS cluster node > Develop & Deploy | AKS cluster node > Deployment Tools | an open workspace folder | +| Run Eraser Image Cleanup | `aks.eraserTool` | AKS cluster node > Troubleshoot & Diagnose
Kubernetes explorer cluster node | AKS cluster node
Kubernetes explorer cluster node | — | +| Install Azure Service Operator | `aks.installAzureServiceOperator` | AKS cluster node > Develop & Deploy
Kubernetes explorer cluster node | AKS cluster node
Kubernetes explorer cluster node | — | +| AKS: Launch Kickstart Agent | `aks.kickstart.launchExperience` | — | — | — | +| AKS: Configure Kickstart Cluster | `aks.kickstartCluster` | — | — | — | +| AKS: Migrate Application to AKS | `aks.migrateAndModernizeApp` | AKS cluster node > Develop & Deploy | AKS cluster node | `aks.containerAssistEnabledPreview` | +| AKS Quick Actions | `aks.quickActions` | AKS cluster node | — | — | +| Refresh Subscription | `aks.refreshSubscription` | Subscription node | Subscription node | — | +| AKS: Deploy application to AKS (Preview) | `aks.runContainerAssist` | — | — | — | +| Select subscriptions... | `aks.selectSubscriptions` | Azure (Cloud Explorer root) | Azure (Cloud Explorer root) | — | +| Select Tenant... | `aks.selectTenant` | — | — | — | +| AKS: Set GitHub Actions Secrets (Preview) | `aks.setGitHubActionsSecrets` | — | — | — | +| AKS: Setup OIDC for GitHub Actions (Preview) | `aks.setupOIDCForGitHub` | — | — | — | +| Show In Azure Portal | `aks.showInPortal` | AKS cluster node > Manage Cluster
AKS cluster node | AKS cluster node | — | +| Sign in to Azure... | `aks.signInToAzure` | — | — | — | +| Switch to Classic Menu | `aks.switchToClassicMenu` | AKS cluster node | — | — | +| Switch to Grouped Menu | `aks.switchToStructuredMenu` | — | AKS cluster node | — | diff --git a/docs/book/src/reference/pinned-versions.md b/docs/book/src/reference/pinned-versions.md new file mode 100644 index 000000000..130077d90 --- /dev/null +++ b/docs/book/src/reference/pinned-versions.md @@ -0,0 +1,37 @@ + + +# Pinned versions + +Third-party versions the extension pins. + +## Tools + +Each is overridable in settings. + +| Setting | Pinned version | +|---|---| +| `aks.aksmcpserver.releaseTag` | `v0.0.19` | +| `aks.drafttool.releaseTag` | `v0.17.14` | +| `aks.retinatool.releaseTag` | `v1.2.2` | +| `azure.kubectlgadget.releaseTag` | `v0.53.2` | +| `azure.kubelogin.releaseTag` | `v0.2.19` | + +## GitHub Actions in generated workflows + +Actions pinned to a commit SHA are shown with the tag from their trailing comment. + +| Action | Version | Pin | Template | +|---|---|---|---| +| `actions/checkout` | `v3` | tag | `resources/draft/workflow-helm.yml`
`resources/draft/workflow-manifests.yml` | +| `actions/checkout` | `v7.0.0` | SHA | `resources/yaml/aks-deploy-managed-ns.template.yaml`
`resources/yaml/aks-deploy.template.yaml`
`resources/yaml/workflow-multi-build-job.template.yaml`
`resources/yaml/workflow-multi-deploy-job-managed-ns.template.yaml`
`resources/yaml/workflow-multi-deploy-job.template.yaml` | +| `azure/aks-set-context` | `v3` | tag | `resources/draft/workflow-helm.yml`
`resources/draft/workflow-manifests.yml` | +| `azure/aks-set-context` | `v5.0.0` | SHA | `resources/yaml/aks-deploy.template.yaml`
`resources/yaml/workflow-multi-deploy-job.template.yaml` | +| `Azure/k8s-deploy` | `v4` | tag | `resources/draft/workflow-manifests.yml` | +| `Azure/k8s-deploy` | `v6.0.0` | SHA | `resources/yaml/aks-deploy-managed-ns.template.yaml`
`resources/yaml/aks-deploy.template.yaml`
`resources/yaml/workflow-multi-deploy-job-managed-ns.template.yaml`
`resources/yaml/workflow-multi-deploy-job.template.yaml` | +| `azure/login` | `v1.4.6` | SHA | `resources/draft/workflow-helm.yml`
`resources/draft/workflow-manifests.yml` | +| `azure/login` | `v3.0.0` | SHA | `resources/yaml/aks-deploy-managed-ns.template.yaml`
`resources/yaml/aks-deploy.template.yaml`
`resources/yaml/workflow-multi-build-job.template.yaml`
`resources/yaml/workflow-multi-deploy-job-managed-ns.template.yaml`
`resources/yaml/workflow-multi-deploy-job.template.yaml` | +| `azure/use-kubelogin` | `v1` | tag | `resources/draft/workflow-helm.yml`
`resources/draft/workflow-manifests.yml` | +| `azure/use-kubelogin` | `v1.3` | SHA | `resources/yaml/aks-deploy-managed-ns.template.yaml`
`resources/yaml/aks-deploy.template.yaml`
`resources/yaml/workflow-multi-deploy-job-managed-ns.template.yaml`
`resources/yaml/workflow-multi-deploy-job.template.yaml` | diff --git a/docs/book/src/reference/settings.md b/docs/book/src/reference/settings.md new file mode 100644 index 000000000..7a47ab081 --- /dev/null +++ b/docs/book/src/reference/settings.md @@ -0,0 +1,32 @@ + + +# Settings + +Configure these in **Settings** (`Ctrl+,` / `Cmd+,`) or in `settings.json`. + +| Setting | Type | Default | Description | +|---|---|---|---| +| `aks.aksmcpserver.enabledComponents` | string | `"az_cli,monitor,fleet,network,compute,detectors,advisor,inspektorgadget,kubectl"` | Comma-separated list of enabled components (empty means all components enabled). Available: az_cli, monitor, fleet, network, compute, detectors, advisor, inspektorgadget, kubectl, helm, cilium, hubble. Some components require local CLI tools (e.g. helm, cilium, hubble). | +| `aks.aksmcpserver.releaseTag` | string | `"v0.0.19"` | Release tag for the stable AKS MCP Server tool release. | +| `aks.argoCDEnabled` | boolean | `true` | Enable Argo CD GitOps integration commands (Create Argo CD GitOps Pipeline, Apply Argo CD Application, Check Argo CD Status, Post-Deploy Actions). Requires reload after changing. | +| `aks.containerAssist.enableGitHubIntegration` | boolean | `true` | Enable Git staging and GitHub PR creation for generated container and K8s files. | +| `aks.containerAssist.k8sManifestFolder` | string | `"k8s"` | Folder name for generated Kubernetes manifests (relative to project root). | +| `aks.containerAssist.modelFamily` | string | `"gpt-5.2-codex"` | Default language model family for Container Assist (e.g. gpt-5.2, claude-sonnet). | +| `aks.containerAssist.modelVendor` | string | `"copilot"` | Default language model vendor for Container Assist (e.g. copilot). | +| `aks.containerAssist.prCreateAsDraft` | boolean | `true` | Create Pull Requests as draft by default. | +| `aks.containerAssist.prDefaultBranch` | string | `"main"` | Default base branch for Pull Requests created from Container Assist. | +| `aks.containerAssist.promptForPullRequest` | boolean | `true` | Prompt before creating a Pull Request after staging generated files. | +| `aks.containerAssistEnabledPreview` | boolean | `true` | Set to true to enable deployment related file generation capability using AI tool. (Preview feature) | +| `aks.copilotEnabledPreview` | boolean | `true` | Set to true to enable GH Copilot hook. (Preview feature) | +| `aks.drafttool.releaseTag` | string | `"v0.17.14"` | Release tag for the stable Draft tool release. | +| `aks.kickstartEnabledPreview` | boolean | `false` | Set to true to enable the Kickstart agent for AI-guided AKS Automatic deployment onboarding. (Preview feature) | +| `aks.retinatool.releaseTag` | string | `"v1.2.2"` | Release tag for the stable Retina tool release. | +| `aks.selectedClusters` | array | — | Selected Azure Clusters | +| `aks.selectedSubscriptions` | array | — | Selected Azure subscriptions | +| `aks.simplifiedMenuStructure` | boolean | `true` | Use the grouped AKS menu (Develop & Deploy, Troubleshoot & Diagnose, Manage Cluster). When disabled, the classic menu layout is shown. Requires reload after changing. You can also toggle this via the commands 'AKS: Switch to Classic Menu' and 'AKS: Switch to Grouped Menu'. | +| `azure.customkubectl.commands` | array | `[]` | All the custom kubectl commands | +| `azure.kubectlgadget.releaseTag` | string | `"v0.53.2"` | Release tag for the stable kubectl-gadget tool. | +| `azure.kubelogin.releaseTag` | string | `"v0.2.19"` | Release tag for the stable kubelogin tool release. This value is also substituted into generated GitHub Actions workflows for the azure/use-kubelogin action's kubelogin-version input. | From 502cbcf1ba429ed4d394d3e75274ba0657bcc607 Mon Sep 17 00:00:00 2001 From: Suneha Bose Date: Wed, 5 Aug 2026 15:52:11 -0700 Subject: [PATCH 3/7] docs: correct cluster menu paths in feature guides aks.simplifiedMenuStructure has defaulted to true since #2168, grouping cluster commands under Develop & Deploy, Troubleshoot & Diagnose, and Manage Cluster. The guides still described the classic flat menu, so readers were told to look for items that are now one level down. Paths come from the generated menu reference, not from reading the UI, and are written as "Right-click your AKS cluster > Submenu > Command" so docs-check can validate them. Guides describe the default menu; the classic layout is covered once, in simplified-menu-structure.md. Also corrected: - aks-compare-cluster is on the subscription node, not the cluster node - "Managed Cluster Operations" is the classic label; the default is "Manage Cluster" - the KAITO submenu is "Deploy a LLM with KAITO", not "an LLM" - container-assist pointed at AKS: Run Container Assist (Preview), which has no menu contribution; replaced with the three real commands - inspektor-gadget claimed the command had moved to the main context menu, which described the classic layout and was backwards - "Abort Last Operation" is a webview action in ClusterPropertiesPanel.ts, not a command, so it is no longer listed as a menu operation - simplified-menu-structure.md advised keeping the default false while stating above that it was true merge-save-kubeconfig.md is left alone: those commands belong to ms-kubernetes-tools.vscode-kubernetes-tools. --- docs/book/src/features/aks-compare-cluster.md | 2 +- docs/book/src/features/aks-diagnostics.md | 2 +- .../src/features/argocd-gitops-integration.md | 4 +-- .../features/container-assist-integration.md | 10 +++----- docs/book/src/features/create-gh-workflow.md | 2 +- .../src/features/image-cleaner-eraser-tool.md | 2 +- docs/book/src/features/inspektor-gadget.md | 6 ++--- .../features/install-azureserviceoperator.md | 2 +- .../src/features/k8s-api-health-points.md | 2 +- .../book/src/features/kaito-install-deploy.md | 4 +-- docs/book/src/features/kaito-manage-test.md | 2 +- .../src/features/manage-cluster-operations.md | 9 ++++--- docs/book/src/features/retina-capture.md | 6 ++--- docs/book/src/features/run-kubectl-command.md | 2 +- .../show-properties-azureportal-start-stop.md | 10 ++++---- .../src/features/simplified-menu-structure.md | 25 +++++-------------- docs/book/src/features/tcp-dumps.md | 2 +- 17 files changed, 39 insertions(+), 53 deletions(-) diff --git a/docs/book/src/features/aks-compare-cluster.md b/docs/book/src/features/aks-compare-cluster.md index 33d1eefd3..a07194542 100644 --- a/docs/book/src/features/aks-compare-cluster.md +++ b/docs/book/src/features/aks-compare-cluster.md @@ -2,7 +2,7 @@ ### 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) diff --git a/docs/book/src/features/aks-diagnostics.md b/docs/book/src/features/aks-diagnostics.md index de37ca4ea..20b910806 100644 --- a/docs/book/src/features/aks-diagnostics.md +++ b/docs/book/src/features/aks-diagnostics.md @@ -2,7 +2,7 @@ ### 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 diff --git a/docs/book/src/features/argocd-gitops-integration.md b/docs/book/src/features/argocd-gitops-integration.md index e673d3bc4..d089e72fa 100644 --- a/docs/book/src/features/argocd-gitops-integration.md +++ b/docs/book/src/features/argocd-gitops-integration.md @@ -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 | --- @@ -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. diff --git a/docs/book/src/features/container-assist-integration.md b/docs/book/src/features/container-assist-integration.md index b3b42842a..d87c52a03 100644 --- a/docs/book/src/features/container-assist-integration.md +++ b/docs/book/src/features/container-assist-integration.md @@ -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 diff --git a/docs/book/src/features/create-gh-workflow.md b/docs/book/src/features/create-gh-workflow.md index 610aaea54..4c8350243 100644 --- a/docs/book/src/features/create-gh-workflow.md +++ b/docs/book/src/features/create-gh-workflow.md @@ -6,7 +6,7 @@ This command has been superseded by the [Draft Workflow command](./draft-integra ### Create GitHub Workflow -Right click on your AKS cluster and click on **Create GitHub Workflow** to easily open and create a workflow starter template. This helps in quick generation of the workflow templates with pre populates resource and clustername for: +Right-click your AKS cluster > **Develop & Deploy** > **Create a GitHub Workflow** to easily open and create a workflow starter template. This helps in quick generation of the workflow templates with pre populates resource and clustername for: - [Starter Workflow](https://github.com/actions/starter-workflows/blob/main/deployments/azure-kubernetes-service.yml) - [Helm Workflow](https://github.com/actions/starter-workflows/blob/main/deployments/azure-kubernetes-service-helm.yml) diff --git a/docs/book/src/features/image-cleaner-eraser-tool.md b/docs/book/src/features/image-cleaner-eraser-tool.md index 810a5935b..f2e6c2be8 100644 --- a/docs/book/src/features/image-cleaner-eraser-tool.md +++ b/docs/book/src/features/image-cleaner-eraser-tool.md @@ -2,7 +2,7 @@ ### 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) diff --git a/docs/book/src/features/inspektor-gadget.md b/docs/book/src/features/inspektor-gadget.md index 408b409ee..9d40d7578 100644 --- a/docs/book/src/features/inspektor-gadget.md +++ b/docs/book/src/features/inspektor-gadget.md @@ -2,13 +2,13 @@ ### Deploy and Undeploy InspektorGadget -Right click on your AKS cluster and select **Show Inspektor Gadget** to easily deploy gadget into your cluster. The Show Inspektor Gadget command has been moved to the main context menu for easier access. Users can easily one-click deploy and undeploy gadget from this feature. +Right-click your AKS cluster > **Troubleshoot & Diagnose** > **Show Inspektor Gadget** to deploy the gadget into your cluster. You can deploy and undeploy the gadget from this page. ![Inspektor Gadget main menu access](../resources/inspector-gadget-main-menu.png) ### Profile, Top, Trace and Snapshot Inspektor Gadget Commands -Right-click on your AKS cluster and select **Show Inspektor Gadget** and choose **Gadget Commands** to easily use non-interactive Top, Trace, Profile or Snapshot commands for your cluster. +Right-click your AKS cluster > **Troubleshoot & Diagnose** > **Show Inspektor Gadget**, then choose **Gadget Commands** to use non-interactive Top, Trace, Profile or Snapshot commands for your cluster. ![Cloud explorer extension menu](../resources/inspector-gadget-1.png) @@ -27,7 +27,7 @@ Depending on the context, the appropriate gadget will be selected automatically ![Inspektor Gadget dialog](../resources/ig-gadget-dialog.png) ### Investigate DNS -Right-click on your AKS cluster and select **Investigate DNS** to troubleshoot DNS-related issues in your cluster. This provides specialized tools for monitoring DNS queries and identifying connectivity problems. +Right-click your AKS cluster > **Troubleshoot & Diagnose** > **Troubleshoot Network Health** > **Investigate DNS** to troubleshoot DNS-related issues in your cluster. This provides specialized tools for monitoring DNS queries and identifying connectivity problems. ![DNS investigation menu](../resources/inspector-gadget-dns.png) diff --git a/docs/book/src/features/install-azureserviceoperator.md b/docs/book/src/features/install-azureserviceoperator.md index f3bd6a35b..4df4e0032 100644 --- a/docs/book/src/features/install-azureserviceoperator.md +++ b/docs/book/src/features/install-azureserviceoperator.md @@ -2,7 +2,7 @@ ### Install Azure Service Operator -Right click on your AKS cluster and click on **Install Azure Service Operator** to easily deploy the latest version of Azure Service Operator (ASO) on your AKS cluster and provision and connect applications to Azure resources within Kubernetes. When you select this option, you'll be prompted for a service principal for ASO to use when performing Azure resource operations. This service principal must have appropriate permissions (typically Contributor at suitable scope). Fill out the service principal details and click **Submit** to kick off the installation of Azure Service Operator. +Right-click your AKS cluster > **Develop & Deploy** > **Install Azure Service Operator** to easily deploy the latest version of Azure Service Operator (ASO) on your AKS cluster and provision and connect applications to Azure resources within Kubernetes. When you select this option, you'll be prompted for a service principal for ASO to use when performing Azure resource operations. This service principal must have appropriate permissions (typically Contributor at suitable scope). Fill out the service principal details and click **Submit** to kick off the installation of Azure Service Operator. > Install Azure Service Operator can only be performed on an AKS cluster that has never had ASO installed before. If you have already initiated the installation manually, follow the instructions on [Azure Service Operator](https://azure.github.io/azure-service-operator/#installation) to complete. diff --git a/docs/book/src/features/k8s-api-health-points.md b/docs/book/src/features/k8s-api-health-points.md index f1e1b613d..ee8a717d0 100644 --- a/docs/book/src/features/k8s-api-health-points.md +++ b/docs/book/src/features/k8s-api-health-points.md @@ -2,7 +2,7 @@ ### Run Kubernetes API Health Endpoints -Right click on your AKS cluster and click on **Run Kubectl Commands**. Select and run health check commands from the *Health* section as shown in the image below. Currently we provide: +Right-click your AKS cluster > **Develop & Deploy** > **Run Kubectl Commands**. Select and run health check commands from the *Health* section as shown in the image below. Currently we provide: - Healthz - Livez diff --git a/docs/book/src/features/kaito-install-deploy.md b/docs/book/src/features/kaito-install-deploy.md index 7accae895..b4f972c79 100644 --- a/docs/book/src/features/kaito-install-deploy.md +++ b/docs/book/src/features/kaito-install-deploy.md @@ -4,7 +4,7 @@ The KAITO integration enables seamless installation of KAITO onto your clusters, ### Install KAITO -Right click on your desired AKS cluster and select **Deploy an LLM with KAITO** and then click on **Install KAITO** to open up the KAITO installation page. +Right-click your AKS cluster > **Develop & Deploy** > **Deploy a LLM with KAITO** > **Install KAITO** to open the KAITO installation page. ![Installation Page](../resources/kaito-installation-page.png) @@ -14,7 +14,7 @@ Once on the page, click **Install KAITO** and the KAITO installation process wil ### Deploy a model -Right click on an AKS cluster that has KAITO successfully installed and select **Deploy an LLM with KAITO** and then click on **Create KAITO Workspace** to open the KAITO model deployment page. +On a cluster that already has KAITO installed, right-click the cluster > **Develop & Deploy** > **Deploy a LLM with KAITO** > **Create KAITO Workspace** to open the KAITO model deployment page. ![Deployment Page](../resources/kaito-deploy-page.png) diff --git a/docs/book/src/features/kaito-manage-test.md b/docs/book/src/features/kaito-manage-test.md index 6d9b92434..7b3d08dc0 100644 --- a/docs/book/src/features/kaito-manage-test.md +++ b/docs/book/src/features/kaito-manage-test.md @@ -4,7 +4,7 @@ Actively monitor the the status of all KAITO deployments on the cluster, retriev ### Manage KAITO Deployments -Right click on your desired AKS cluster and select **Deploy an LLM with KAITO** and then click on **Manage KAITO Models**. +Right-click your AKS cluster > **Develop & Deploy** > **Deploy a LLM with KAITO** > **Manage KAITO Models**. ![Manage Page](../resources/kaito-manage-page.png) diff --git a/docs/book/src/features/manage-cluster-operations.md b/docs/book/src/features/manage-cluster-operations.md index 0a8e676d1..0d4393710 100644 --- a/docs/book/src/features/manage-cluster-operations.md +++ b/docs/book/src/features/manage-cluster-operations.md @@ -1,10 +1,11 @@ -# Run Managed Cluster Operations +# Manage Cluster Operations -### Run Managed Cluster Operations from your AKS cluster +### Run cluster operations from your AKS cluster -Right click on your AKS cluster and click on **Managed Cluster Operations** to easily run few managed cluster operations on your cluster. Currently we have enable following operations: +Right-click your AKS cluster > **Manage Cluster** to run cluster operations: -- Abort Last Operation - Delete Cluster - Reconcile Cluster - Rotate Cluster Certificate + +To abort an in-progress operation, open **Show Properties** and use the abort action on the cluster or agent pool. diff --git a/docs/book/src/features/retina-capture.md b/docs/book/src/features/retina-capture.md index 745757640..9e1149656 100644 --- a/docs/book/src/features/retina-capture.md +++ b/docs/book/src/features/retina-capture.md @@ -2,13 +2,13 @@ ## Run Retina Capture -Right click on your AKS cluster and select **Troubleshoot Network Health** and then click on **Run Retina Capture** to capture logs like iptables-rules, [ip-resrouces.txt and other key distributed captures form this azure networking tool](https://retina.sh/docs/captures/cli#file-and-directory-structure-inside-the-tarball) for any Linux nodes in yout AKS cluster. +Right-click your AKS cluster > **Troubleshoot & Diagnose** > **Troubleshoot Network Health** > **Run Retina Capture** to capture logs like iptables-rules, [ip-resrouces.txt and other key distributed captures form this azure networking tool](https://retina.sh/docs/captures/cli#file-and-directory-structure-inside-the-tarball) for any Linux nodes in yout AKS cluster. There are two options to run the capture: ### Download the capture locally -#### Step 1: Right-click on your AKS cluster and select **Troubleshoot Network Health** > **Run Retina Capture** > **Download Artifacts Locally** +#### Step 1: Right-click your AKS cluster > **Troubleshoot & Diagnose** > **Troubleshoot Network Health** > **Run Retina Capture** > **Download Artifacts Locally** ![Step 1: Menu](../resources/right-click-download-retina-capture.png) @@ -30,7 +30,7 @@ Before uploading the capture to Azure Storage, ensure the following prerequisite 3. A container is created within the storage account to store the capture. -#### Step 1: Right-click on your AKS cluster and select **Troubleshoot Network Health** > **Run Retina Capture** > **Upload Artifacts to Blob Storage** +#### Step 1: Right-click your AKS cluster > **Troubleshoot & Diagnose** > **Troubleshoot Network Health** > **Run Retina Capture** > **Upload Artifacts to Blob Storage** ![Step 1: Menu](../resources/right-click-upload-retina-capture.png) diff --git a/docs/book/src/features/run-kubectl-command.md b/docs/book/src/features/run-kubectl-command.md index 5ddab82d3..db9640fd8 100644 --- a/docs/book/src/features/run-kubectl-command.md +++ b/docs/book/src/features/run-kubectl-command.md @@ -2,7 +2,7 @@ ### Run Kubectl Commands from your AKS cluster -Right click on your AKS cluster and click on **Run Kubectl Commands** to easily run few known kubectl commands on your cluster. Currently we have enable following kubectl commands for the AKS cluster: +Right-click your AKS cluster > **Develop & Deploy** > **Run Kubectl Commands** to easily run few known kubectl commands on your cluster. Currently we have enable following kubectl commands for the AKS cluster: - Describe Services - Get All Pods diff --git a/docs/book/src/features/show-properties-azureportal-start-stop.md b/docs/book/src/features/show-properties-azureportal-start-stop.md index f96eac21a..22d0baa0b 100644 --- a/docs/book/src/features/show-properties-azureportal-start-stop.md +++ b/docs/book/src/features/show-properties-azureportal-start-stop.md @@ -2,11 +2,11 @@ ### Show in Azure Portal -Right click on your AKS cluster and click on **Show in Azure Portal** to easily navigate to AKS cluster overview page in Azure Portal. +Right-click your AKS cluster > **Show in Azure Portal** to navigate to AKS cluster overview page in Azure Portal. ### Show Properties -Right click on your AKS cluster and click on **Show Properties** to display the AKS cluster and agent pool properties like provisioning state, fqdn, k8s version, along with node properties like node version, vm type, vm size, o/s type, o/s disk size and nodes provisioning state. +Right-click your AKS cluster > **Show Properties** to display the AKS cluster and agent pool properties like provisioning state, fqdn, k8s version, along with node properties like node version, vm type, vm size, o/s type, o/s disk size and nodes provisioning state. This page also enables some useful cluster and node pool level operations like `Abort Last Operation` (at cluster and agent pool level) and `Reconcile`. @@ -18,11 +18,11 @@ This page now also enable information box for the users to quickly see available ### Create cluster from Azure Portal -Right click on your AKS sunscription and click on **Create cluster from Azure Portal** to easily navigate to AKS create cluster page in Azure Portal. +Right-click your Azure subscription > **Create Cluster** > **Create Cluster From Azure Portal** to navigate to AKS create cluster page in Azure Portal. ### Create cluster -Right click on your AKS subscription and click on **Create Cluster** and select **Create Standard Cluster** which will start a 2-step wizard for you to enter a valid cluster name and select an existing resource group. The VS Code experience will then notify user with the deployment progress and present you with the **Navigate to Portal** link when it completes successfully. +Right-click your Azure subscription > **Create Cluster** > **Create Cluster From VS Code**, which starts a 2-step wizard for you to enter a valid cluster name and select an existing resource group. The VS Code experience will then notify user with the deployment progress and present you with the **Navigate to Portal** link when it completes successfully. ![Step 1: Create Cluster Name](../resources/vscode-create-cluster-step-1.png) @@ -34,6 +34,6 @@ Right click on your AKS subscription and click on **Create Cluster** and select ### Start or Stop AKS cluster -Right click on your AKS cluster and click on **Show Properties** to display the AKS cluster properties, within the page there will be **Stop/Start Cluster** button to perform the start or stop the cluster operation. +Right-click your AKS cluster > **Show Properties** to display the AKS cluster properties. Within the page there will be **Stop/Start Cluster** button to perform the start or stop the cluster operation. ![Start or Stop Cluster From Properties Webview](../resources/aks-startstop-cluster.png) diff --git a/docs/book/src/features/simplified-menu-structure.md b/docs/book/src/features/simplified-menu-structure.md index 0553f6a80..72d53639c 100644 --- a/docs/book/src/features/simplified-menu-structure.md +++ b/docs/book/src/features/simplified-menu-structure.md @@ -22,27 +22,22 @@ Instead of many top-level commands, cluster actions are grouped into three subme - `Troubleshoot & Diagnose` - `Manage Cluster` -Direct commands `Show In Azure Portal` and `Show Properties` remain available. +These stay top-level: `Show In Azure Portal`, `Show Properties`, `AKS Quick Actions`, and `Switch to Classic Menu`. ## Menu grouping overview `Develop & Deploy` -: Run Kubectl commands, Container Assist (preview), Attach ACR, Create GitHub Workflow, KAITO submenu, Install Azure Service Operator. +: Run Kubectl Commands, Attach ACR to Cluster, Create a GitHub Workflow, Run Deployment Safeguards YAML Validation, Install Azure Service Operator, the **Deploy a LLM with KAITO** submenu, Check Argo CD Status (with `aks.argoCDEnabled`), and the Container Assist commands (with `aks.containerAssistEnabledPreview`). `Troubleshoot & Diagnose` -: AKS Diagnostics submenu, Inspektor Gadget, network troubleshooting submenu, resource utilization submenu, Eraser Tool, security submenu. +: The **Run AKS Diagnostics**, **Troubleshoot Network Health**, **Troubleshoot Resource Utilization**, and **Improve security of my cluster** submenus, plus Show Inspektor Gadget and Run Eraser Image Cleanup. `Manage Cluster` -: Show properties, show in portal, delete cluster, rotate certificate, reconcile cluster. +: Show Properties, Show In Azure Portal, Delete Cluster, Rotate Cluster Certificate, Reconcile Cluster. ## Container Assist in the new menu -When both feature flags are enabled: - -- `aks.simplifiedMenuStructure = true` -- `aks.containerAssistEnabledPreview = true` (default in `2.1.0`) - -and a workspace folder is open, `AKS: Run Container Assist (Preview)` appears under `Develop & Deploy`. +With `aks.containerAssistEnabledPreview` enabled (the default), `AKS: Migrate Application to AKS` appears under `Develop & Deploy`. With a workspace folder also open, `AKS: Generate Dockerfiles and K8s Manifests for App` and `AKS: Deploy App with Automated Pipeline` appear alongside it. ## Switching between Classic and Grouped menus @@ -63,15 +58,7 @@ After running either command, VS Code prompts you to reload the window. The new ## Backward compatibility -When `aks.simplifiedMenuStructure` is `false`, the previous menu organization stays active. -This allows gradual rollout, internal validation, and user feedback collection without breaking existing workflows. - -## Suggested rollout plan - -1. Keep default `false` for broad compatibility. -2. Enable in dogfood or preview cohorts. -3. Collect feedback on discoverability and click depth. -4. Promote to default once validated. +Setting `aks.simplifiedMenuStructure` to `false` restores the classic menu, where every command sits at the top level of the cluster context menu. ## Screenshots diff --git a/docs/book/src/features/tcp-dumps.md b/docs/book/src/features/tcp-dumps.md index 36f3031a1..0b44e2555 100644 --- a/docs/book/src/features/tcp-dumps.md +++ b/docs/book/src/features/tcp-dumps.md @@ -2,7 +2,7 @@ ### Collect TCP Dumps -Right click on your AKS cluster and select **Troubleshoot Network Health** and then select **Collect TCP Dumps** to capture TCP dumps for any Linux node and download them to your local machine with ease. +Right-click your AKS cluster > **Troubleshoot & Diagnose** > **Troubleshoot Network Health** > **Collect TCP Dumps** to capture TCP dumps for any Linux node and download them to your local machine with ease. Added filters to the TCP Dump functionality, so that you can target traffic capture to specific network interfaces, ports or protocols, to or from specific pods, or craft custom [pcap filter strings](https://www.tcpdump.org/manpages/pcap-filter.7.html). From 3eb3edbf1f8babf3f081cd41397514ea61506627 Mon Sep 17 00:00:00 2001 From: Suneha Bose Date: Wed, 5 Aug 2026 15:52:18 -0700 Subject: [PATCH 4/7] docs: normalise heading levels Mechanical. Only the number of leading '#' changes; heading text is untouched, so every anchor still resolves. 17 pages had a broken hierarchy: 12 jumped from '#' straight to '###', and 5 had no top-level heading at all. Each file's levels were remapped to a contiguous sequence starting at 1, and where that left more than one h1 the later ones were demoted so each page has a single title. Sidebar labels come from SUMMARY.md so navigation was unaffected, but skipped levels are a problem for screen readers. --- docs/book/src/features/aks-compare-cluster.md | 2 +- docs/book/src/features/aks-diagnostics.md | 2 +- docs/book/src/features/aks-fleet-manager.md | 2 +- .../src/features/aks-mcp-server-integration.md | 10 +++++----- .../src/features/image-cleaner-eraser-tool.md | 2 +- docs/book/src/features/inspektor-gadget.md | 16 ++++++++-------- .../src/features/install-azureserviceoperator.md | 4 ++-- docs/book/src/features/k8s-api-health-points.md | 4 ++-- docs/book/src/features/kaito-install-deploy.md | 4 ++-- docs/book/src/features/kaito-manage-test.md | 4 ++-- .../src/features/manage-cluster-operations.md | 2 +- docs/book/src/features/merge-save-kubeconfig.md | 4 ++-- docs/book/src/features/run-kubectl-command.md | 2 +- .../show-properties-azureportal-start-stop.md | 10 +++++----- docs/book/src/features/tcp-dumps.md | 2 +- docs/book/src/installation.md | 2 +- docs/book/src/release/releasing.md | 10 +++++----- 17 files changed, 41 insertions(+), 41 deletions(-) diff --git a/docs/book/src/features/aks-compare-cluster.md b/docs/book/src/features/aks-compare-cluster.md index a07194542..fa8ef7bf0 100644 --- a/docs/book/src/features/aks-compare-cluster.md +++ b/docs/book/src/features/aks-compare-cluster.md @@ -1,6 +1,6 @@ # Compare 2 AKS Cluster within Same Subscription -### Compare AKS Clusters +## Compare AKS Clusters Right-click your Azure subscription > **Compare AKS Cluster** to use VS Code diff to compare json object of 2 AKS clusters. diff --git a/docs/book/src/features/aks-diagnostics.md b/docs/book/src/features/aks-diagnostics.md index 20b910806..26898a37a 100644 --- a/docs/book/src/features/aks-diagnostics.md +++ b/docs/book/src/features/aks-diagnostics.md @@ -1,6 +1,6 @@ # AKS Diagnostics -### AKS Diagnostics +## AKS Diagnostics Right-click your AKS cluster > **Troubleshoot & Diagnose** > **Run AKS Diagnostics** to display diagnostics information based on your AKS cluster's backend telemetry for: diff --git a/docs/book/src/features/aks-fleet-manager.md b/docs/book/src/features/aks-fleet-manager.md index 2e97c4718..a5deffbbe 100644 --- a/docs/book/src/features/aks-fleet-manager.md +++ b/docs/book/src/features/aks-fleet-manager.md @@ -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**. diff --git a/docs/book/src/features/aks-mcp-server-integration.md b/docs/book/src/features/aks-mcp-server-integration.md index b6a5426c0..486271cb9 100644 --- a/docs/book/src/features/aks-mcp-server-integration.md +++ b/docs/book/src/features/aks-mcp-server-integration.md @@ -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. @@ -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. @@ -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//`; 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. diff --git a/docs/book/src/features/image-cleaner-eraser-tool.md b/docs/book/src/features/image-cleaner-eraser-tool.md index f2e6c2be8..95ca53e18 100644 --- a/docs/book/src/features/image-cleaner-eraser-tool.md +++ b/docs/book/src/features/image-cleaner-eraser-tool.md @@ -1,6 +1,6 @@ # Garbage collection Using Eraser Image Cleanup Tool -### Run Eraser Image Cleanup +## Run Eraser Image Cleanup 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. diff --git a/docs/book/src/features/inspektor-gadget.md b/docs/book/src/features/inspektor-gadget.md index 9d40d7578..5f5e6780b 100644 --- a/docs/book/src/features/inspektor-gadget.md +++ b/docs/book/src/features/inspektor-gadget.md @@ -1,12 +1,12 @@ -### Inspektor Gadget +# Inspektor Gadget -### Deploy and Undeploy InspektorGadget +## Deploy and Undeploy InspektorGadget Right-click your AKS cluster > **Troubleshoot & Diagnose** > **Show Inspektor Gadget** to deploy the gadget into your cluster. You can deploy and undeploy the gadget from this page. ![Inspektor Gadget main menu access](../resources/inspector-gadget-main-menu.png) -### Profile, Top, Trace and Snapshot Inspektor Gadget Commands +## Profile, Top, Trace and Snapshot Inspektor Gadget Commands Right-click your AKS cluster > **Troubleshoot & Diagnose** > **Show Inspektor Gadget**, then choose **Gadget Commands** to use non-interactive Top, Trace, Profile or Snapshot commands for your cluster. @@ -16,7 +16,7 @@ Right-click your AKS cluster > **Troubleshoot & Diagnose** > **Show Inspektor Ga ![Cloud explorer extension menu](../resources/inspector-gadget-3.png) -### New Troubleshooting Menu Items +## New Troubleshooting Menu Items The Inspektor Gadget integration now includes specialized menu items for common troubleshooting scenarios. If Inspektor Gadget is not deployed, the extension will prompt you to deploy it as below. @@ -26,17 +26,17 @@ Depending on the context, the appropriate gadget will be selected automatically ![Inspektor Gadget dialog](../resources/ig-gadget-dialog.png) -### Investigate DNS +## Investigate DNS Right-click your AKS cluster > **Troubleshoot & Diagnose** > **Troubleshoot Network Health** > **Investigate DNS** to troubleshoot DNS-related issues in your cluster. This provides specialized tools for monitoring DNS queries and identifying connectivity problems. ![DNS investigation menu](../resources/inspector-gadget-dns.png) -### Real-time TCP Monitoring +## Real-time TCP Monitoring Select **Real-time TCP Monitoring** to monitor TCP connections and network traffic in real-time. This helps identify network bottlenecks and connection issues. ![Real-time TCP monitoring](../resources/inspector-gadget-tcp.png) -### Troubleshoot Resource Utilization +## Troubleshoot Resource Utilization Use **Troubleshoot Resource Utilization** to analyze CPU, memory, and other resource usage patterns across your cluster. This helps identify resource constraints and optimization opportunities. ![Resource utilization troubleshooting](../resources/ig-resource-utilization-troubleshooting.png) @@ -47,7 +47,7 @@ The Troubleshoot Resource Utilization menu includes the following sub-options: - **Investigate Block I/O intensive processes**: Detect processes with high disk usage to identify potential performance bottlenecks. - **Profile CPU**: Take samples of stack traces to analyze performance issues and identify resource-intensive processes. -### Improve Security of My Cluster +## Improve Security of My Cluster Select **Improve Security of My Cluster** to access the `trace_exec` gadget under the hood to monitor when new processes are executed. ![Security improvement tools](../resources/ig-improve-security.png) \ No newline at end of file diff --git a/docs/book/src/features/install-azureserviceoperator.md b/docs/book/src/features/install-azureserviceoperator.md index 4df4e0032..8ccf4c3f6 100644 --- a/docs/book/src/features/install-azureserviceoperator.md +++ b/docs/book/src/features/install-azureserviceoperator.md @@ -1,6 +1,6 @@ -### Install Azure Service Operator +# Install Azure Service Operator -### Install Azure Service Operator +## Install Azure Service Operator Right-click your AKS cluster > **Develop & Deploy** > **Install Azure Service Operator** to easily deploy the latest version of Azure Service Operator (ASO) on your AKS cluster and provision and connect applications to Azure resources within Kubernetes. When you select this option, you'll be prompted for a service principal for ASO to use when performing Azure resource operations. This service principal must have appropriate permissions (typically Contributor at suitable scope). Fill out the service principal details and click **Submit** to kick off the installation of Azure Service Operator. diff --git a/docs/book/src/features/k8s-api-health-points.md b/docs/book/src/features/k8s-api-health-points.md index ee8a717d0..ee019f3fb 100644 --- a/docs/book/src/features/k8s-api-health-points.md +++ b/docs/book/src/features/k8s-api-health-points.md @@ -1,6 +1,6 @@ -### Kubernetes API Health Endpoints +# Kubernetes API Health Endpoints -### Run Kubernetes API Health Endpoints +## Run Kubernetes API Health Endpoints Right-click your AKS cluster > **Develop & Deploy** > **Run Kubectl Commands**. Select and run health check commands from the *Health* section as shown in the image below. Currently we provide: diff --git a/docs/book/src/features/kaito-install-deploy.md b/docs/book/src/features/kaito-install-deploy.md index b4f972c79..191cac672 100644 --- a/docs/book/src/features/kaito-install-deploy.md +++ b/docs/book/src/features/kaito-install-deploy.md @@ -2,7 +2,7 @@ The KAITO integration enables seamless installation of KAITO onto your clusters, empowering you to deploy AI models, manage workflows, and test deployments with ease and precision. -### Install KAITO +## Install KAITO Right-click your AKS cluster > **Develop & Deploy** > **Deploy a LLM with KAITO** > **Install KAITO** to open the KAITO installation page. @@ -12,7 +12,7 @@ Once on the page, click **Install KAITO** and the KAITO installation process wil ![Successfull Installation](../resources/kaito-installation-success.png) -### Deploy a model +## Deploy a model On a cluster that already has KAITO installed, right-click the cluster > **Develop & Deploy** > **Deploy a LLM with KAITO** > **Create KAITO Workspace** to open the KAITO model deployment page. diff --git a/docs/book/src/features/kaito-manage-test.md b/docs/book/src/features/kaito-manage-test.md index 7b3d08dc0..06d5bc89d 100644 --- a/docs/book/src/features/kaito-manage-test.md +++ b/docs/book/src/features/kaito-manage-test.md @@ -2,7 +2,7 @@ Actively monitor the the status of all KAITO deployments on the cluster, retrieve logs, test the inference servers, and delete/redeploy models. -### Manage KAITO Deployments +## Manage KAITO Deployments Right-click your AKS cluster > **Develop & Deploy** > **Deploy a LLM with KAITO** > **Manage KAITO Models**. @@ -14,7 +14,7 @@ For your selected deployment, click **Get Logs** to access the latest logs from To delete a model, select **Delete Workspace** (or **Cancel** for ongoing deployments). For failed deployments, choose **Re-deploy Default CRD** to remove the current deployment and restart the model deployment process from scratch. -### Test a Model +## Test a Model On your desired model, select **Test** to access the model testing page. diff --git a/docs/book/src/features/manage-cluster-operations.md b/docs/book/src/features/manage-cluster-operations.md index 0d4393710..ea7271d97 100644 --- a/docs/book/src/features/manage-cluster-operations.md +++ b/docs/book/src/features/manage-cluster-operations.md @@ -1,6 +1,6 @@ # Manage Cluster Operations -### Run cluster operations from your AKS cluster +## Run cluster operations from your AKS cluster Right-click your AKS cluster > **Manage Cluster** to run cluster operations: diff --git a/docs/book/src/features/merge-save-kubeconfig.md b/docs/book/src/features/merge-save-kubeconfig.md index 4f4a93515..fcfbd34d5 100644 --- a/docs/book/src/features/merge-save-kubeconfig.md +++ b/docs/book/src/features/merge-save-kubeconfig.md @@ -1,10 +1,10 @@ # Merge and Save Into Kubeconfig -### Merge into Kubeconfig +## Merge into Kubeconfig Right click on your AKS cluster and click on **Merge into Kubeconfig** to add the selected AKS cluster to the kubeconfig file. -### Save Kubeconfig +## Save Kubeconfig Right click on your AKS cluster and click on **Save Kubeconfig** to save the kubeconfig of the selected AKS cluster. diff --git a/docs/book/src/features/run-kubectl-command.md b/docs/book/src/features/run-kubectl-command.md index db9640fd8..660e8fb90 100644 --- a/docs/book/src/features/run-kubectl-command.md +++ b/docs/book/src/features/run-kubectl-command.md @@ -1,6 +1,6 @@ # Run Kubectl Commands -### Run Kubectl Commands from your AKS cluster +## Run Kubectl Commands from your AKS cluster Right-click your AKS cluster > **Develop & Deploy** > **Run Kubectl Commands** to easily run few known kubectl commands on your cluster. Currently we have enable following kubectl commands for the AKS cluster: diff --git a/docs/book/src/features/show-properties-azureportal-start-stop.md b/docs/book/src/features/show-properties-azureportal-start-stop.md index 22d0baa0b..08d886cdf 100644 --- a/docs/book/src/features/show-properties-azureportal-start-stop.md +++ b/docs/book/src/features/show-properties-azureportal-start-stop.md @@ -1,10 +1,10 @@ # Show Properties, Show in Azure Portal -### Show in Azure Portal +## Show in Azure Portal Right-click your AKS cluster > **Show in Azure Portal** to navigate to AKS cluster overview page in Azure Portal. -### Show Properties +## Show Properties Right-click your AKS cluster > **Show Properties** to display the AKS cluster and agent pool properties like provisioning state, fqdn, k8s version, along with node properties like node version, vm type, vm size, o/s type, o/s disk size and nodes provisioning state. @@ -16,11 +16,11 @@ This page now also enable information box for the users to quickly see available ![Reconcile operation](../resources/show-properties-reconcile.png) ![Kuberentes version information](../resources/show-properties-page-k8s-available-versions.png) -### Create cluster from Azure Portal +## Create cluster from Azure Portal Right-click your Azure subscription > **Create Cluster** > **Create Cluster From Azure Portal** to navigate to AKS create cluster page in Azure Portal. -### Create cluster +## Create cluster Right-click your Azure subscription > **Create Cluster** > **Create Cluster From VS Code**, which starts a 2-step wizard for you to enter a valid cluster name and select an existing resource group. The VS Code experience will then notify user with the deployment progress and present you with the **Navigate to Portal** link when it completes successfully. @@ -32,7 +32,7 @@ Right-click your Azure subscription > **Create Cluster** > **Create Cluster From ![Successful Creation](../resources/vscode-creation-successful.png) -### Start or Stop AKS cluster +## Start or Stop AKS cluster Right-click your AKS cluster > **Show Properties** to display the AKS cluster properties. Within the page there will be **Stop/Start Cluster** button to perform the start or stop the cluster operation. diff --git a/docs/book/src/features/tcp-dumps.md b/docs/book/src/features/tcp-dumps.md index 0b44e2555..0a218d7d1 100644 --- a/docs/book/src/features/tcp-dumps.md +++ b/docs/book/src/features/tcp-dumps.md @@ -1,6 +1,6 @@ # Collect TCP Dumps from AKS Cluster Linux Nodes -### Collect TCP Dumps +## Collect TCP Dumps Right-click your AKS cluster > **Troubleshoot & Diagnose** > **Troubleshoot Network Health** > **Collect TCP Dumps** to capture TCP dumps for any Linux node and download them to your local machine with ease. diff --git a/docs/book/src/installation.md b/docs/book/src/installation.md index d56d980a4..e6fabe0d2 100644 --- a/docs/book/src/installation.md +++ b/docs/book/src/installation.md @@ -1,4 +1,4 @@ -## Installation +# Installation 1. Download and install the [Azure Kubernetes Service extension](https://marketplace.visualstudio.com/items?itemName=ms-kubernetes-tools.vscode-aks-tools) for Visual Studio Code. diff --git a/docs/book/src/release/releasing.md b/docs/book/src/release/releasing.md index 15d39fc9b..a5c77b40c 100644 --- a/docs/book/src/release/releasing.md +++ b/docs/book/src/release/releasing.md @@ -1,4 +1,4 @@ -## How to Release +# How to Release To make a new release and publish it to the marketplace you have to follow the following steps. @@ -9,11 +9,11 @@ To make a new release and publish it to the marketplace you have to follow the f 5. Create a new PR, get approval and merge 6. Run the `Build & Publish` workflow manually from the GH Actions tab -### Pinned third-party versions +## Pinned third-party versions Two independent sets of external versions are baked into this extension. Both drift silently between releases and should be reviewed each cut. -#### CLI binaries downloaded on demand +### CLI binaries downloaded on demand Defaults live in `package.json` under `contributes.configuration`. `azure.kubelogin.releaseTag` is the single source of truth for both the locally-downloaded kubelogin AND the `kubelogin-version` input in every generated GitHub Actions workflow — `workflowTemplate.ts` substitutes the setting value at generation time. @@ -33,7 +33,7 @@ done Before bumping, verify the target release actually has uploaded platform assets (`curl -sI` on a representative download URL and expect `HTTP/2 200`). -#### GitHub Actions pinned in workflow templates +### GitHub Actions pinned in workflow templates The templates under `resources/yaml/*.template.yaml` pin these action majors. Major tags receive minor/patch fixes automatically — bumping is only needed when a new major ships. When bumping, update all template files that reference the action and the corresponding assertions in `src/tests/suite/containerAssist/workflowTemplate.test.ts`. @@ -58,7 +58,7 @@ Skim the release notes of the target major before bumping. Recent Azure/* action **Do not bump a version without a smoke test** — generate a workflow via the extension, push it to a real branch on a real AKS cluster, and confirm the run succeeds. Bumping blindly is worse than staying pinned. -### Build & Publish +## Build & Publish The `Build & Publish` workflow allows to create a new release, package it in a VSIX file and publish to the VSCode marketplace with a single click. From 8a22c01137c03f6153d56a076df9079d9c8ba8a2 Mon Sep 17 00:00:00 2001 From: Suneha Bose Date: Tue, 11 Aug 2026 17:04:17 -0700 Subject: [PATCH 5/7] docs: fix doubled AKS prefix in palette, drop deprecated workflow page Two commands set both `category: "AKS"` and an `AKS: ` prefix in their title, so VS Code rendered them as "AKS: AKS: Launch Kickstart Agent" and "AKS: AKS: Configure Kickstart Cluster" in the Command Palette. VS Code composes the palette entry as `category: title`, so the prefix belongs in exactly one of the two. Dropped it from the titles. No localized `package.nls.*.json` files exist and `l10n/bundle.l10n.json` does not carry these strings, so no translations are affected. The rendered palette text is unchanged from what the docs already describe. `generate-docs-reference.js` already reports this class of problem ("title repeats its category"); that finding is now clear. Regenerated `reference/commands.md` in the same commit so the generated output cannot disagree with `package.json`. Removed `create-gh-workflow.md`. It described the retired `actions/starter-workflows` templates, while the live command (`aks.draftWorkflow`) scaffolds via Draft and is documented in `draft-integration.md`. `README.md` re-listed all 25 feature pages by hand, a third copy after SUMMARY.md and features.md. It had drifted: four entries pointed at the same page under different labels, and the Container Assist sub-pages and Copilot plugin page were missing. Replaced with pointers to the Features index and the generated Reference. --- docs/book/src/README.md | 30 ++++---------------- docs/book/src/SUMMARY.md | 1 - docs/book/src/features/create-gh-workflow.md | 14 --------- docs/book/src/features/features.md | 1 - docs/book/src/reference/commands.md | 8 +++--- package.json | 4 +-- 6 files changed, 11 insertions(+), 47 deletions(-) delete mode 100644 docs/book/src/features/create-gh-workflow.md diff --git a/docs/book/src/README.md b/docs/book/src/README.md index 1db7b0ff0..23df952db 100644 --- a/docs/book/src/README.md +++ b/docs/book/src/README.md @@ -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) \ No newline at end of file diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md index 4db5da4b0..5550e5381 100644 --- a/docs/book/src/SUMMARY.md +++ b/docs/book/src/SUMMARY.md @@ -9,7 +9,6 @@ - [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 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) - [Manage Cluster Operations](./features/manage-cluster-operations.md) diff --git a/docs/book/src/features/create-gh-workflow.md b/docs/book/src/features/create-gh-workflow.md deleted file mode 100644 index 4c8350243..000000000 --- a/docs/book/src/features/create-gh-workflow.md +++ /dev/null @@ -1,14 +0,0 @@ -# Create GitHub Workflow - -## Deprecation note - -This command has been superseded by the [Draft Workflow command](./draft-integration.md). - -### Create GitHub Workflow - -Right-click your AKS cluster > **Develop & Deploy** > **Create a GitHub Workflow** to easily open and create a workflow starter template. This helps in quick generation of the workflow templates with pre populates resource and clustername for: - -- [Starter Workflow](https://github.com/actions/starter-workflows/blob/main/deployments/azure-kubernetes-service.yml) -- [Helm Workflow](https://github.com/actions/starter-workflows/blob/main/deployments/azure-kubernetes-service-helm.yml) -- [Kompose Workflow](https://github.com/actions/starter-workflows/blob/main/deployments/azure-kubernetes-service-kompose.yml) -- [Kustomize Workflow](https://github.com/actions/starter-workflows/blob/main/deployments/azure-kubernetes-service-kustomize.yml) \ No newline at end of file diff --git a/docs/book/src/features/features.md b/docs/book/src/features/features.md index bda0fe412..88feea328 100644 --- a/docs/book/src/features/features.md +++ b/docs/book/src/features/features.md @@ -29,7 +29,6 @@ For the full list of commands and where each one lives, see the - [Run Kubectl Commands](./run-kubectl-command.md) - [Install Azure Service Operator](./install-azureserviceoperator.md) - [Deployment Tools: Draft Tool Integration](./draft-integration.md) -- [Create GitHub Workflow](./create-gh-workflow.md) (deprecated) - [Argo CD GitOps Integration](./argocd-gitops-integration.md) - [Container Assist (Preview)](./container-assist-integration.md) - [Azure Resources and Permissions](./container-assist-azure-resources.md) diff --git a/docs/book/src/reference/commands.md b/docs/book/src/reference/commands.md index a0ed19478..02950886e 100644 --- a/docs/book/src/reference/commands.md +++ b/docs/book/src/reference/commands.md @@ -18,19 +18,19 @@ A dash means the command has no entry in that menu and is reachable only from th | Title | Command ID | Shown when | |---|---|---| | AKS Quick Actions | `aks.quickActions` | always | -| AKS: AKS: Configure Kickstart Cluster | `aks.kickstartCluster` | `aks.kickstartEnabledPreview` | -| AKS: AKS: Launch Kickstart Agent | `aks.kickstart.launchExperience` | `aks.kickstartEnabledPreview` | | AKS: Apply Argo CD Application to Cluster | `aks.argoCDApplyApp` | a YAML file in the active editor, `aks.argoCDEnabled` | | AKS: Argo CD Post-Deploy Actions | `aks.argoCDPostApplyActions` | `aks.argoCDEnabled` | | AKS: Attach ACR to Cluster | `aks.attachAcrToCluster` | always | | AKS: Check Argo CD Status | `aks.argoCDCheckStatus` | `aks.argoCDEnabled` | | AKS: Check Deployment Permissions | `aks.checkDeploymentPermissions` | always | | AKS: Check Role Assignment Permissions | `aks.checkRoleAssignmentPermissions` | always | +| AKS: Configure Kickstart Cluster | `aks.kickstartCluster` | `aks.kickstartEnabledPreview` | | AKS: Create a GitHub Workflow | `aks.draftWorkflow` | an open workspace folder | | AKS: Create Argo CD GitOps Pipeline | `aks.draftArgoCDDeployment` | an open workspace folder, `aks.argoCDEnabled` | | AKS: Deploy App with Automated Pipeline | `aks.deployAppWithAutomatedPipeline` | always | | AKS: Deploy application to AKS (Preview) | `aks.runContainerAssist` | always | | AKS: Generate Dockerfiles and K8s Manifests for App | `aks.containerizeApp` | always | +| AKS: Launch Kickstart Agent | `aks.kickstart.launchExperience` | `aks.kickstartEnabledPreview` | | AKS: Migrate Application to AKS | `aks.migrateAndModernizeApp` | always | | AKS: Run Deployment Safeguards YAML Validation | `aks.aksDraftValidate` | always | | AKS: Select cluster... | `aks.clusterFilter` | always | @@ -139,8 +139,8 @@ Hidden from the palette (invoked from a menu or another command): `aks.refreshSu | Create a GitHub Workflow | `aks.draftWorkflow` | AKS cluster node > Develop & Deploy | AKS cluster node > Deployment Tools | an open workspace folder | | Run Eraser Image Cleanup | `aks.eraserTool` | AKS cluster node > Troubleshoot & Diagnose
Kubernetes explorer cluster node | AKS cluster node
Kubernetes explorer cluster node | — | | Install Azure Service Operator | `aks.installAzureServiceOperator` | AKS cluster node > Develop & Deploy
Kubernetes explorer cluster node | AKS cluster node
Kubernetes explorer cluster node | — | -| AKS: Launch Kickstart Agent | `aks.kickstart.launchExperience` | — | — | — | -| AKS: Configure Kickstart Cluster | `aks.kickstartCluster` | — | — | — | +| Launch Kickstart Agent | `aks.kickstart.launchExperience` | — | — | — | +| Configure Kickstart Cluster | `aks.kickstartCluster` | — | — | — | | AKS: Migrate Application to AKS | `aks.migrateAndModernizeApp` | AKS cluster node > Develop & Deploy | AKS cluster node | `aks.containerAssistEnabledPreview` | | AKS Quick Actions | `aks.quickActions` | AKS cluster node | — | — | | Refresh Subscription | `aks.refreshSubscription` | Subscription node | Subscription node | — | diff --git a/package.json b/package.json index 30575302b..47a2c6398 100644 --- a/package.json +++ b/package.json @@ -503,12 +503,12 @@ }, { "command": "aks.kickstart.launchExperience", - "title": "AKS: Launch Kickstart Agent", + "title": "Launch Kickstart Agent", "category": "AKS" }, { "command": "aks.kickstartCluster", - "title": "AKS: Configure Kickstart Cluster", + "title": "Configure Kickstart Cluster", "category": "AKS" } ], From 7bab4bc38a9bcd8ffefdc47bcd99624d41acf885 Mon Sep 17 00:00:00 2001 From: Suneha Bose Date: Tue, 11 Aug 2026 17:06:08 -0700 Subject: [PATCH 6/7] docs: regenerate reference after Argo CD command rename Rebased onto main, which renamed aks.draftArgoCDDeployment to "AKS: Create Argo CD Application" in #2353. Regenerated so the committed reference matches package.json; otherwise docs:reference:check would fail once #2371 lands. --- docs/book/src/reference/commands.md | 4 ++-- docs/book/src/reference/settings.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/book/src/reference/commands.md b/docs/book/src/reference/commands.md index 02950886e..1624f0f8b 100644 --- a/docs/book/src/reference/commands.md +++ b/docs/book/src/reference/commands.md @@ -26,7 +26,7 @@ A dash means the command has no entry in that menu and is reachable only from th | AKS: Check Role Assignment Permissions | `aks.checkRoleAssignmentPermissions` | always | | AKS: Configure Kickstart Cluster | `aks.kickstartCluster` | `aks.kickstartEnabledPreview` | | AKS: Create a GitHub Workflow | `aks.draftWorkflow` | an open workspace folder | -| AKS: Create Argo CD GitOps Pipeline | `aks.draftArgoCDDeployment` | an open workspace folder, `aks.argoCDEnabled` | +| AKS: Create Argo CD Application | `aks.draftArgoCDDeployment` | an open workspace folder, `aks.argoCDEnabled` | | AKS: Deploy App with Automated Pipeline | `aks.deployAppWithAutomatedPipeline` | always | | AKS: Deploy application to AKS (Preview) | `aks.runContainerAssist` | always | | AKS: Generate Dockerfiles and K8s Manifests for App | `aks.containerizeApp` | always | @@ -135,7 +135,7 @@ Hidden from the palette (invoked from a menu or another command): `aks.refreshSu | Create Cluster From Azure Portal | `aks.createClusterNavToAzurePortal` | Subscription node > Create Cluster | Subscription node > Create Cluster | — | | AKS: Deploy App with Automated Pipeline | `aks.deployAppWithAutomatedPipeline` | — | — | — | | AKS: Deploy App with Automated Pipeline | `aks.deployAppWithAutomatedPipelineFromTree` | AKS cluster node > Develop & Deploy | AKS cluster node | `aks.containerAssistEnabledPreview`, an open workspace folder | -| AKS: Create Argo CD GitOps Pipeline | `aks.draftArgoCDDeployment` | — | — | — | +| AKS: Create Argo CD Application | `aks.draftArgoCDDeployment` | — | — | — | | Create a GitHub Workflow | `aks.draftWorkflow` | AKS cluster node > Develop & Deploy | AKS cluster node > Deployment Tools | an open workspace folder | | Run Eraser Image Cleanup | `aks.eraserTool` | AKS cluster node > Troubleshoot & Diagnose
Kubernetes explorer cluster node | AKS cluster node
Kubernetes explorer cluster node | — | | Install Azure Service Operator | `aks.installAzureServiceOperator` | AKS cluster node > Develop & Deploy
Kubernetes explorer cluster node | AKS cluster node
Kubernetes explorer cluster node | — | diff --git a/docs/book/src/reference/settings.md b/docs/book/src/reference/settings.md index 7a47ab081..15528e9cf 100644 --- a/docs/book/src/reference/settings.md +++ b/docs/book/src/reference/settings.md @@ -11,7 +11,7 @@ Configure these in **Settings** (`Ctrl+,` / `Cmd+,`) or in `settings.json`. |---|---|---|---| | `aks.aksmcpserver.enabledComponents` | string | `"az_cli,monitor,fleet,network,compute,detectors,advisor,inspektorgadget,kubectl"` | Comma-separated list of enabled components (empty means all components enabled). Available: az_cli, monitor, fleet, network, compute, detectors, advisor, inspektorgadget, kubectl, helm, cilium, hubble. Some components require local CLI tools (e.g. helm, cilium, hubble). | | `aks.aksmcpserver.releaseTag` | string | `"v0.0.19"` | Release tag for the stable AKS MCP Server tool release. | -| `aks.argoCDEnabled` | boolean | `true` | Enable Argo CD GitOps integration commands (Create Argo CD GitOps Pipeline, Apply Argo CD Application, Check Argo CD Status, Post-Deploy Actions). Requires reload after changing. | +| `aks.argoCDEnabled` | boolean | `true` | Enable Argo CD GitOps integration commands (Create Argo CD Application, Apply Argo CD Application, Check Argo CD Status, Post-Deploy Actions). Requires reload after changing. | | `aks.containerAssist.enableGitHubIntegration` | boolean | `true` | Enable Git staging and GitHub PR creation for generated container and K8s files. | | `aks.containerAssist.k8sManifestFolder` | string | `"k8s"` | Folder name for generated Kubernetes manifests (relative to project root). | | `aks.containerAssist.modelFamily` | string | `"gpt-5.2-codex"` | Default language model family for Container Assist (e.g. gpt-5.2, claude-sonnet). | From b1ec43087a61e3dc87fc7051452434da6b608198 Mon Sep 17 00:00:00 2001 From: Suneha Bose Date: Thu, 27 Aug 2026 13:37:31 -0700 Subject: [PATCH 7/7] docs: correct the case of Show In Azure Portal The command title is "Show In Azure Portal"; the page wrote "Show in". menu-paths did not report it. A bold chain is only treated as a menu path when at least one segment names a real command or submenu, so a label that is almost right matches nothing and the whole breadcrumb is discarded as ordinary prose. The path is now checked rather than skipped. --- .../book/src/features/show-properties-azureportal-start-stop.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/book/src/features/show-properties-azureportal-start-stop.md b/docs/book/src/features/show-properties-azureportal-start-stop.md index 08d886cdf..013130135 100644 --- a/docs/book/src/features/show-properties-azureportal-start-stop.md +++ b/docs/book/src/features/show-properties-azureportal-start-stop.md @@ -2,7 +2,7 @@ ## Show in Azure Portal -Right-click your AKS cluster > **Show in Azure Portal** to navigate to AKS cluster overview page in Azure Portal. +Right-click your AKS cluster > **Show In Azure Portal** to navigate to AKS cluster overview page in Azure Portal. ## Show Properties