调用主机二进制文件

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

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

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

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

注意

只能调用作为扩展的一部分交付的可执行文件。

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

将可执行文件添加到扩展

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

@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 客户端对象 调用扩展提供的 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>
  );
}

配置元数据文件

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

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

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