快速入门

请按照本指南开始创建基本的 Docker 扩展。快速入门指南会自动为您生成样板文件。

先决条件

[!注意]

只有在按照快速入门指南创建扩展时才需要 NodeJS 和 Go。该指南使用 docker extension init 命令自动为您生成样板文件。该命令使用基于 ReactJS 和 Go 应用程序的模板。

在 Docker Desktop 设置中,请确保您可以安装正在开发的扩展。您可能需要导航到 Docker Desktop 设置中的 Extensions 选项卡,并取消选中 Allow only extensions distributed through the Docker Marketplace(仅允许通过 Docker Marketplace 分发的扩展)。

第一步:设置目录

要设置目录,请使用 init 子命令并为扩展提供一个名称。

$ docker extension init <my-extension>

该命令会询问一系列关于扩展的问题,例如名称、描述以及 Hub 仓库的名称。这有助于 CLI 为您生成一组样板文件以帮助您开始。它会将样板文件存储在 my-extension 目录中。

自动生成的扩展包含:

  • backend 文件夹中的 Go 后端服务,监听一个套接字。它有一个 /hello 端点,返回 JSON 负载。
  • frontend 文件夹中的 React 前端,可以调用后端并输出后端的响应。

有关构建 UI 的更多信息和指南,请参阅 设计和 UI 样式部分

第二步:构建扩展

要构建扩展,请进入新创建的目录并运行:

$ docker build -t <name-of-your-extension> .

docker build 会构建扩展并生成一个与所选 Hub 仓库同名的镜像。例如,如果您对以下问题的回答是 john/my-extension

? Hub repository (eg. namespace/repository on hub): john/my-extension`

docker build 会生成一个名为 john/my-extension 的镜像。

第三步:安装和预览扩展

要在 Docker Desktop 中安装扩展,请运行:

$ docker extension install <name-of-your-extension>

要在 Docker Desktop 中预览扩展,安装完成后,您应该会看到 Extensions 菜单下方有一个 Quickstart 项。选择该项会打开扩展的前端。

[!提示]

在 UI 开发过程中,使用热重载来测试更改而无需重建整个扩展会很有帮助。有关更多信息,请参阅 在开发 UI 时预览

您可能还想检查属于扩展的容器。默认情况下,扩展容器在 Docker Dashboard 中是隐藏的。您可以在 Settings 中更改此设置,有关更多信息,请参阅 如何显示扩展容器

第四步:提交并发布扩展到 Marketplace

如果您希望让所有 Docker Desktop 用户都能使用您的扩展,可以将其提交到 Marketplace 进行发布。有关更多信息,请参阅 发布

清理

要删除扩展,请运行:

$ docker extension rm <name-of-your-extension>

下一步