从扩展与 Kubernetes 交互

扩展 SDK 不提供任何 API 方法，无法直接与 Docker Desktop 托管的 Kubernetes 集群或使用 KinD 等其他工具创建的任何其他集群进行交互。但是，此页面提供了一种使用其他 SDK API 从扩展间接与 Kubernetes 集群交互的方法。

要请求直接与 Docker Desktop 托管的 Kubernetes 交互的 API，您可以在 Extensions SDK GitHub 存储库中对此问题投赞成票。

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

运送`kubectl`作为扩展的一部分

如果您的扩展需要与 Kubernetes 集群交互，建议您包含kubectl命令行工具作为扩展的一部分。通过执行此作，安装扩展的用户将获得kubectl安装在他们的主机上。

要了解如何寄送kubectl命令行工具作为 Docker 扩展镜像的一部分，请参阅构建多架构扩展。

例子

以下代码片段已汇总在 Kubernetes 示例扩展中。它展示了如何通过提供kubectl命令行工具。

检查 Kubernetes API 服务器是否可访问

一旦kubectl命令行工具已添加到 Extension Image 的Dockerfile，并在metadata.json，扩展框架将部署kubectl添加到用户的主机中。

您可以使用 JS APIddClient.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文件。

警告
这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在卷中，您不需要读取kubeconfigfile （文件）。这使得它非常适合在从扩展导航到 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");