快速入门

目录

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

先决条件

注意

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

在 Docker Desktop 设置中，确保你可以安装你正在开发的扩展。你可能需要导航到 Docker Desktop 设置中的“扩展”选项卡，然后取消选择“仅允许通过 Docker 市场分发的扩展”。

步骤一：设置你的目录

要设置你的目录，请使用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 中预览扩展，一旦安装完成，你应该在“扩展”菜单下看到一个“快速入门”项。选择此项将打开扩展的前端。

提示

在 UI 开发过程中，使用热重载来测试你的更改而无需重新构建整个扩展非常有用。有关更多信息，请参阅在开发 UI 时预览。

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

步骤四：提交并发布你的扩展到市场

如果你想让你的扩展对所有 Docker Desktop 用户可用，你可以将其提交到市场以供发布。有关更多信息，请参阅发布。

清理

要删除扩展，请运行

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

下一步