调用主机二进制文件

目录

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

您可以通过从带有扩展 SDK 的容器中执行 CLI 来实现。但如果 CLI 在容器中运行，它需要访问主机的 filesystem，这既不容易也不快。

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

了解更多关于扩展的架构。

注意

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

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

将可执行文件添加到扩展

为 macOS 和 Linux 创建一个 bash 脚本，文件路径为 binaries/unix/hello.sh，内容如下

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

为 Windows 创建一个 batch 脚本，文件路径为 binaries/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 对象通过 ddClient.extension.host.cli.exec() 函数调用扩展提供的 shell 脚本。在本例中，二进制文件会返回一个字符串作为结果，通过 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 必须引用容器内的二进制文件路径。

页面选项