调用主机二进制文件

在某些情况下,您的扩展可能需要从主机调用某些命令。例如,您可能想要调用云提供商的 CLI 来创建新资源,或者您的扩展提供的工具的 CLI,甚至是您想要在主机上运行的 shell 脚本。

您可以通过使用扩展 SDK 从容器中执行 CLI 来实现此目的。但是这个 CLI 需要访问主机的文件系统,如果它在容器中运行,这既不简单也不快速。

然而,主机二进制文件从作为扩展的一部分提供并部署到主机的扩展可执行文件(作为二进制文件、shell 脚本)调用。由于扩展可以在多个平台上运行,这意味着您需要为您想要支持的所有平台提供可执行文件。

了解有关扩展架构的更多信息。

笔记

只有作为扩展的一部分提供的可执行文件才能使用 SDK 调用。

在此示例中,CLI 是一个简单的Hello world脚本,必须使用参数调用并返回一个字符串。

将可执行文件添加到扩展中


创建bash适用于 macOS 和 Linux 的脚本,在文件中binaries/unix/hello.sh包含以下内容:

#!/bin/sh
echo "Hello, $1!"

batch script在另一个文件中创建一个for Windowsbinaries/windows/hello.cmd并包含以下内容:

@echo off
echo "Hello, %1!"

然后更新Dockerfile以将binaries文件夹复制到扩展的容器文件系统中并使文件可执行。

# Copy the binaries into the right folder
COPY --chmod=0755 binaries/windows/hello.cmd /windows/hello.cmd
COPY --chmod=0755 binaries/unix/hello.sh /linux/hello.sh
COPY --chmod=0755 binaries/unix/hello.sh /darwin/hello.sh

从 UI 调用可执行文件

在您的扩展中,使用 Docker Desktop Client 对象 通过该函数调用扩展提供的 shell 脚本ddClient.extension.host.cli.exec()。在此示例中,result?.stdout一旦呈现扩展视图,二进制文件就会返回一个字符串作为结果,通过 获得。


export function App() {
  const ddClient = createDockerDesktopClient();
  const [hello, setHello] = useState("");

  useEffect(() => {
    const run = async () => {
      let binary = "hello.sh";
      if (ddClient.host.platform === 'win32') {
        binary = "hello.cmd";
      }

      const result = await ddClient.extension.host?.cli.exec(binary, ["world"]);
      setHello(result?.stdout);

    };
    run();
  }, [ddClient]);
    
  return (
    <div>
      {hello}
    </div>
  );
}

重要的

我们还没有 Vue 的示例。 填写表格 并告知我们您是否需要 Vue 示例。

重要的

我们还没有 Angular 的示例。 填写表格 并告知我们您是否需要 Angular 示例。

重要的

我们还没有 Svelte 的示例。 如果您想要 Svelte 样品,请填写表格并告诉我们。


配置元数据文件

必须在文件中指定主机二进制文件metadata.json,以便 Docker Desktop 在安装扩展时将它们复制到主机上。卸载扩展后,复制的二进制文件也会被删除。

{
  "vm": {
    ...
  },
  "ui": {
    ...
  },
  "host": {
    "binaries": [
      {
        "darwin": [
          {
            "path": "/darwin/hello.sh"
          }
        ],
        "linux": [
          {
            "path": "/linux/hello.sh"
          }
        ],
        "windows": [
          {
            "path": "/windows/hello.cmd"
          }
        ]
      }
    ]
  }
}

必须path引用容器内二进制文件的路径。