快速开始

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

先决条件

笔记

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

第一步：设置您的目录

要设置目录，请使用init子命令并为您的扩展提供名称。

$ docker extension init <my-extension>

该命令会询问一系列有关您的扩展的问题，例如其名称、描述和 Hub 存储库的名称。这有助于 CLI 生成一组样板文件以供您入门。它将样板文件存储在my-extension目录中。

自动生成的扩展包含：

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

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

第二步：构建扩展

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

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

docker build构建扩展并生成一个与所选中心存储库名称相同的映像。例如，如果您输入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 中预览扩展，安装完成后，您应该在“扩展”菜单下看到一个“快速启动”项。选择此项将打开扩展程序的前端。

提示

在 UI 开发过程中，使用热重载来测试您的更改而不需要重建整个扩展会很有帮助。有关详细信息，请参阅 开发 UI 时的预览。

您可能还想检查属于扩展的容器。默认情况下，扩展容器在 Docker 仪表板中隐藏。您可以在设置中更改此设置，请参阅 如何显示扩展容器以获取更多信息。

第四步：将您的扩展提交并发布到 Marketplace

如果您想让所有 Docker Desktop 用户都可以使用您的扩展，您可以将其提交到 Marketplace 中发布。有关更多信息，请参阅发布。

清理

要删除扩展，请运行：

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

下一步是什么