如何通过命令行将本地VS Code连接到Kubernetes Pod/容器？

需求说明 #

已具备Kubernetes全量RBAC权限，集群内有运行中的容器。需要实现自动化脚本，通过Deployment名称+容器名称定位目标容器，并自动将VS Code连接到这个支持VS Code Server的Dev Container。

VS Code图形界面可通过菜单操作完成连接（对应截图：），但原生code命令行工具的可用选项如下，未提供直接连接Kubernetes容器的功能：

Visual Studio Code 1.77.1

用法: code [选项][路径...]

如需从标准输入读取内容，追加 '-'（例如: 'ps aux | grep code | code -'）

选项
  -d --diff <文件> <文件>                    比较两个文件。
  -m --merge <路径1> <路径2> <基准文件> <结果文件> 执行三方合并，提供两个修改版本文件的路径、共同源文件路径及保存合并结果的输出文件路径。
  -a --add <文件夹>                          将文件夹添加到最后激活的窗口。
  -g --goto <文件:行[:字符]>                  打开指定路径的文件，并定位到指定行和字符位置。
  -n --new-window                            强制打开新窗口。
  -r --reuse-window                          强制在已打开的窗口中打开文件或文件夹。
  -w --wait                                  等待文件关闭后再返回。
  --locale <区域设置>                          使用的区域设置（例如: en-US 或 zh-TW）。
  --user-data-dir <目录>                      指定用户数据存储的目录，可用于打开多个独立的Code实例。
  --profile <配置文件名>                    使用指定配置文件打开文件夹或工作区，并将配置文件与工作区关联。如果配置文件不存在，将创建一个新的空配置文件。必须提供文件夹或工作区才能使配置文件生效。
  -h --help                                  打印用法信息。

扩展管理
  --extensions-dir <目录>              设置扩展的根路径。
  --list-extensions                   列出已安装的扩展。
  --show-versions                     使用 --list-extensions 时，显示已安装扩展的版本。
  --category <分类>                   使用 --list-extensions 时，按指定分类筛选已安装的扩展。
  --install-extension <扩展ID | 路径> 安装或更新扩展。参数可以是扩展ID或VSIX文件路径。扩展ID格式为 '${发布者}.${名称}'。使用 '--force' 参数可更新到最新版本。如需安装特定版本，添加 '@${版本}'，例如: 'vscode.csharp@1.2.3'。
  --pre-release                       使用 --install-extension 时，安装扩展的预发布版本。
  --uninstall-extension <扩展ID>      卸载扩展。
  --enable-proposed-api <扩展ID>      为扩展启用提议的API功能。可传入一个或多个扩展ID单独启用。

故障排查
  -v --version                    打印版本信息。
  --verbose                       打印详细输出（隐含 --wait）。
  --log <级别>                   使用的日志级别。默认是 'info'。允许的值包括 'critical', 'error', 'warn', 'info', 'debug', 'trace', 'off'。也可以通过以下格式配置扩展的日志级别: '${发布者}.${名称}:${日志级别}'，例如: 'vscode.csharp:trace'。可传入一个或多个此类配置项。
  -s --status                     打印进程使用情况和诊断信息。
  --prof-startup                  在启动期间运行CPU分析器。
  --disable-extensions            禁用所有已安装的扩展。此选项不会持久化，仅在命令打开新窗口时生效。
  --disable-extension <扩展ID>    禁用指定的扩展。此选项不会持久化，仅在命令打开新窗口时生效。
  --sync <on | off>               开启或关闭同步功能。
  --inspect-extensions <端口>     允许调试和分析扩展。在开发者工具中查看连接URI。
  --inspect-brk-extensions <端口> 允许调试和分析扩展，扩展主机启动后暂停。在开发者工具中查看连接URI。
  --disable-gpu                   禁用GPU硬件加速。
  --max-memory <内存>           窗口的最大内存大小（单位：MB）。
  --telemetry                     显示VS Code收集的所有遥测事件。

子命令
  tunnel       通过安全隧道使当前机器可从vscode.dev或其他机器访问

实现方案 #

VS Code连接Kubernetes容器的功能依赖Dev Containers扩展（原Remote - Containers），需通过该扩展提供的CLI能力实现，而非原生code命令。具体步骤如下：

1. 确认安装Dev Containers扩展 #

先检查是否已安装：

code --list-extensions | grep ms-vscode-remote.remote-containers

若未安装，执行：

code --install-extension ms-vscode-remote.remote-containers

2. 自动化脚本示例 #

编写bash脚本，实现从Deployment+容器名定位Pod并连接VS Code：

#!/bin/bash

# 接收参数：第一个为Deployment名称，第二个为容器名称
DEPLOYMENT=$1
CONTAINER=$2

# 参数校验
if [ -z "$DEPLOYMENT" ] || [ -z "$CONTAINER" ]; then
    echo "使用方式: $0 <Deployment名称> <容器名称>"
    exit 1
fi

# 获取对应Deployment的第一个运行中Pod
POD=$(kubectl get pods -l app=$DEPLOYMENT -o jsonpath='{.items[0].metadata.name}' --field-selector=status.phase=Running)

if [ -z "$POD" ]; then
    echo "未找到Deployment [$DEPLOYMENT]对应的运行中Pod"
    exit 1
fi

# 连接到容器（默认命名空间为default，若需指定其他命名空间，修改最后一段的default为目标命名空间）
code --folder-uri "vscode-remote://k8s-container/$CONTAINER/$POD/default"

3. 脚本使用说明 #

1. 给脚本添加执行权限：

chmod +x connect-k8s-container.sh

2. 运行脚本，传入Deployment和容器名称：

./connect-k8s-container.sh my-app-deployment my-app-container

3. 若Pod不在default命名空间，修改脚本中vscode-remote://k8s-container/$CONTAINER/$POD/default的default为实际命名空间即可。

内容的提问来源于stack exchange，提问作者Rohit Mistry