Docker

目录

Docker对象

▸ listContainers(options?): Promise<unknown>

获取容器列表

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

▸ listImages(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命令行。

▸ exec(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对象。

▸ exec(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,
  },
});

当您关闭Docker Desktop中的仪表盘或退出扩展UI时，扩展创建的子进程将自动终止（SIGTERM）。如果需要，您也可以使用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);
});