从扩展与 Kubernetes 交互

扩展 SDK 不会提供任何直接与 Docker Desktop 管理的 Kubernetes 集群或使用其他工具（例如 KinD）创建的任何其他集群交互的 API 方法。但是，此页面提供了一种方法，您可以使用其他 SDK API 间接与扩展中的 Kubernetes 集群交互。

要请求直接与 Docker Desktop 管理的 Kubernetes 交互的 API，您可以点赞此问题在扩展 SDK GitHub 存储库中。

您可以使用 Docker Desktop 中的内置 Kubernetes 启动 Kubernetes 单节点集群。kubeconfig 文件用于在与 kubectl 命令行工具或其他客户端结合使用时配置对 Kubernetes 的访问。Docker Desktop 方便地为用户提供了位于用户主目录中的本地预配置 kubeconfig 文件和 kubectl 命令。对于希望从 Docker Desktop 利用 Kubernetes 的用户来说，这是一种快速跟踪访问的便捷方式。

将 `kubectl` 作为扩展的一部分提供

如果您的扩展需要与 Kubernetes 集群交互，建议您将 kubectl 命令行工具作为扩展的一部分包含在内。通过这样做，安装您的扩展的用户会在其主机上安装 kubectl。

要了解如何将 kubectl 命令行工具作为 Docker 扩展镜像的一部分提供给多个平台，请参阅构建多架构扩展。

示例

以下代码片段已在 Kubernetes 示例扩展中整理。它展示了如何通过提供 kubectl 命令行工具来与 Kubernetes 集群交互。

检查 Kubernetes API 服务器是否可达

将 kubectl 命令行工具添加到 Dockerfile 中的扩展镜像后，并在 metadata.json 中定义后，扩展框架会在安装扩展时将 kubectl 部署到用户的主机上。

您可以使用 JS API ddClient.extension.host?.cli.exec 向 kubectl 命令发出命令，例如，检查 Kubernetes API 服务器在特定上下文的情况下是否可达

const output = await ddClient.extension.host?.cli.exec("kubectl", [
  "cluster-info",
  "--request-timeout",
  "2s",
  "--context",
  "docker-desktop",
]);

列出 Kubernetes 上下文

const output = await ddClient.extension.host?.cli.exec("kubectl", [
  "config",
  "view",
  "-o",
  "jsonpath='{.contexts}'",
]);

列出 Kubernetes 命名空间

const output = await ddClient.extension.host?.cli.exec("kubectl", [
  "get",
  "namespaces",
  "--no-headers",
  "-o",
  'custom-columns=":metadata.name"',
  "--context",
  "docker-desktop",
]);

持久化 kubeconfig 文件

下面介绍了从主机文件系统持久化和读取 kubeconfig 文件的不同方法。用户可以随时向 kubeconfig 文件添加、编辑或删除 Kubernetes 上下文。

警告
kubeconfig 文件非常敏感，如果被攻击者找到，可能会授予攻击者对 Kubernetes 集群的管理访问权限。

扩展的后端容器

如果您的扩展需要在读取 kubeconfig 文件后持久化该文件，您可以使用后端容器，该容器会公开 HTTP POST 端点以将文件内容存储在内存中或容器文件系统中的某个位置。这样，如果用户从扩展导航到 Docker Desktop 的其他部分，然后返回，您就不需要再次读取 kubeconfig 文件。

export const updateKubeconfig = async () => {
  const kubeConfig = await ddClient.extension.host?.cli.exec("kubectl", [
    "config",
    "view",
    "--raw",
    "--minify",
    "--context",
    "docker-desktop",
  ]);
  if (kubeConfig?.stderr) {
    console.log("error", kubeConfig?.stderr);
    return false;
  }

  // call backend container to store the kubeconfig retrieved into the container's memory or filesystem
  try {
    await ddClient.extension.vm?.service?.post("/store-kube-config", {
      data: kubeConfig?.stdout,
    });
  } catch (err) {
    console.log("error", JSON.stringify(err));
  }
};

Docker 卷

卷是用于持久化 Docker 容器生成和使用的首选机制。您可以利用它们来持久化 kubeconfig 文件。通过在卷中持久化 kubeconfig，您无需在扩展窗格关闭时再次读取 kubeconfig 文件。这使其成为在从扩展导航到 Docker Desktop 的其他部分时持久化数据的理想选择。

const kubeConfig = await ddClient.extension.host?.cli.exec("kubectl", [
  "config",
  "view",
  "--raw",
  "--minify",
  "--context",
  "docker-desktop",
]);
if (kubeConfig?.stderr) {
  console.log("error", kubeConfig?.stderr);
  return false;
}

await ddClient.docker.cli.exec("run", [
  "--rm",
  "-v",
  "my-vol:/tmp",
  "alpine",
  "/bin/sh",
  "-c",
  `"touch /tmp/.kube/config && echo '${kubeConfig?.stdout}' > /tmp/.kube/config"`,
]);

扩展的 `localStorage`

localStorage 是浏览器 Web 存储机制之一。它允许用户将数据以键值对的形式保存在浏览器中，以便以后使用。localStorage 在浏览器（扩展窗格）关闭时不会清除数据。这使其成为在从扩展导航到 Docker Desktop 的其他部分时持久化数据的理想选择。

localStorage.setItem("kubeconfig", kubeConfig);

localStorage.getItem("kubeconfig");