Docker

Docker 对象

▸列表容器( options?): Promise< unknown>

获取容器列表：

const containers = await ddClient.docker.listContainers();

▸列表图像( options?): Promise< unknown>

获取本地容器镜像列表：

const images = await ddClient.docker.listImages();

有关这些方法的详细信息，请参阅 Docker API 参考。

已弃用对 Docker 对象的访问

以下方法已弃用，并将在未来版本中删除。使用上面指定的方法。

const containers = await window.ddClient.listContainers();

const images = await window.ddClient.listImages();

Docker 命令

扩展也可以直接执行docker命令行。

▸执行( cmd, args): Promise< ExecResult>

const result = await ddClient.docker.cli.exec("info", [
  "--format",
  '"{{ json . }}"',
]);

结果包含执行命令的标准输出和标准错误：

{
  "stderr": "...",
  "stdout": "..."
}

在此示例中，命令输出为 JSON。为了方便起见，命令结果对象还具有轻松解析它的方法：

  • result.lines(): string[]分割输出线。
  • result.parseJsonObject(): any解析格式良好的 json 输出。
  • result.parseJsonLines(): any[]将每个输出行解析为 json 对象。

▸执行( cmd, args, options):void

上面的命令将输出作为执行 Docker 命令的结果进行流式传输。如果您需要以流形式获取输出或者命令的输出太长，这非常有用。

await ddClient.docker.cli.exec("logs", ["-f", "..."], {
  stream: {
    onOutput(data) {
      if (data.stdout) {
        console.error(data.stdout);
      } else {
        console.log(data.stderr);
      }
    },
    onError(error) {
      console.error(error);
    },
    onClose(exitCode) {
      console.log("onClose with exit code " + exitCode);
    },
    splitOutputLines: true,
  },
});

SIGTERM当您关闭 Docker Desktop 中的仪表板或退出扩展 UI 时，扩展创建的子进程将自动终止 ( )。如果需要，您还可以使用调用结果exec(streamOptions)来终止 ( SIGTERM) 进程。

const logListener = await ddClient.docker.cli.exec("logs", ["-f", "..."], {
  stream: {
    // ...
  },
});

// when done listening to logs or before starting a new one, kill the process
logListener.close();

该exec(streamOptions)API还可以用于监听docker事件：

await ddClient.docker.cli.exec(
  "events",
  ["--format", "{{ json . }}", "--filter", "container=my-container"],
  {
    stream: {
      onOutput(data) {
        if (data.stdout) {
          const event = JSON.parse(data.stdout);
          console.log(event);
        } else {
          console.log(data.stderr);
        }
      },
      onClose(exitCode) {
        console.log("onClose with exit code " + exitCode);
      },
      splitOutputLines: true,
    },
  }
);

笔记

您不能使用它在单个exec()调用中链接命令（例如docker kill $(docker ps -q)或在命令之间使用管道）。

您需要调用exec()每个命令并解析结果，以便根据需要将参数传递给下一个命令。

有关这些方法的详细信息，请参阅 Exec API 参考。

不推荐执行 Docker 命令

此方法已弃用，并将在未来版本中删除。使用下面指定的一个。

const output = await window.ddClient.execDockerCmd(
  "info",
  "--format",
  '"{{ json . }}"'
);

window.ddClient.spawnDockerCmd("logs", ["-f", "..."], (data, error) => {
  console.log(data.stdout);
});