开发容器 CLI
2022 年 5 月 18 日,作者 Brigit Murtaugh,@BrigitMurtaugh
TL;DR
通过开发容器 CLI,随时随地获得一致的环境
Microsoft 和 GitHub 的开发容器团队很高兴发布一个开源命令行界面 (CLI),作为新 开发容器规范 的一部分。我们很乐意在 此问题 中,或在 devcontainers/cli 仓库中提出新问题和拉取请求,以便获得您的反馈。
一致性 = 快乐
一个一致、可预测的环境是实现高效愉快的软件开发体验的关键。
容器历来用于在部署应用程序时实现标准化,但它们也为支持其他场景提供了巨大机会,包括持续集成 (CI)、测试自动化和全功能编码环境。开发容器提供了这种全功能编码环境,并确保您的项目拥有所需的工具和软件,无论它是复杂且分布式的,还是只有几个需求。
自 2019 年 发布 开发容器扩展 以来,Visual Studio Code 中就一直支持开发容器,最近 GitHub Codespaces 也提供了支持。此支持由 devcontainer.json 提供支持,这是一种带有注释的结构化 JSON (jsonc) 元数据格式,用于配置容器化环境。
随着生产工作负载的容器化变得司空见惯,开发容器已广泛应用于 VS Code 之外的场景。我们很高兴宣布 开发容器规范 的工作已经开始,它使任何工具中的任何人都可以配置一致的开发环境。此外,今天我们很高兴分享此规范的一个主要组件,您现在可以尝试它,即 开发容器 CLI。
什么是开发容器 CLI?
开发容器 CLI 是开发容器规范的参考实现。
当 VS Code 和 Codespaces 等工具在用户的项目中检测到 devcontainer.json
文件时,它们会使用 CLI 来配置开发容器。我们现在将此 CLI 作为参考实现开放,以便个人用户和其他工具可以读取 devcontainer.json
元数据并从中创建开发容器。
此 CLI 可以直接使用或集成到产品体验中,类似于它目前与开发容器和 Codespaces 集成的方式。它目前支持简单的单容器选项,并与 Docker Compose 集成,用于多容器场景。
此 CLI 已在新的 devcontainers/cli 仓库中可供审查,您可以在 规范仓库中的此问题 中阅读更多关于其开发的信息。
我如何尝试它?
我们很乐意您尝试使用开发容器 CLI 并告诉我们您的想法。您只需几个简单的步骤即可快速尝试,无论是通过安装其 npm 包还是从源代码构建 CLI 仓库。
您可以在 CLI 仓库的 README 中了解更多关于从源代码构建的信息。在本文中,我们将重点介绍如何使用 npm 包。
要安装 npm 包,您需要安装 Python、Node.js(版本 14 或更高版本)和 C/C++,才能构建其中一个依赖项。VS Code 如何贡献 wiki 中有关于推荐工具集的详细信息。
npm install
npm install -g @devcontainers/cli
验证您是否可以运行 CLI 并查看其帮助文本
devcontainer <command>
Commands:
devcontainer up Create and run dev container
devcontainer build [path] Build a dev container image
devcontainer run-user-commands Run user commands
devcontainer read-configuration Read configuration
devcontainer exec <cmd> [args..] Execute a command on a running dev container
Options:
--help Show help [boolean]
--version Show version number [boolean]
尝试 CLI
拥有 CLI 后,您可以使用示例项目进行尝试,例如此 Rust 示例。
将 Rust 示例克隆到您的机器上,并使用 CLI 的 up
命令启动一个开发容器
git clone https://github.com/microsoft/vscode-remote-try-rust
devcontainer up --workspace-folder <path-to-vscode-remote-try-rust>
这将从容器注册表下载容器镜像并启动容器。您的 Rust 容器现在应该正在运行
[88 ms] dev-containers-cli 0.1.0.
[165 ms] Start: Run: docker build -f /home/node/vscode-remote-try-rust/.devcontainer/Dockerfile -t vsc-vscode-remote-try-rust-89420ad7399ba74f55921e49cc3ecfd2 --build-arg VARIANT=bullseye /home/node/vscode-remote-try-rust/.devcontainer
[+] Building 0.5s (5/5) FINISHED
=> [internal] load build definition from Dockerfile 0.0s
=> => transferring dockerfile: 38B 0.0s
=> [internal] load .dockerignore 0.0s
=> => transferring context: 2B 0.0s
=> [internal] load metadata for mcr.microsoft.com/vscode/devcontainers/r 0.4s
=> CACHED [1/1] FROM mcr.microsoft.com/vscode/devcontainers/rust:1-bulls 0.0s
=> exporting to image 0.0s
=> => exporting layers 0.0s
=> => writing image sha256:39873ccb81e6fb613975e11e37438eee1d49c963a436d 0.0s
=> => naming to docker.io/library/vsc-vscode-remote-try-rust-89420ad7399 0.0s
[1640 ms] Start: Run: docker run --sig-proxy=false -a STDOUT -a STDERR --mount type=bind,source=/home/node/vscode-remote-try-rust,target=/workspaces/vscode-remote-try-rust -l devcontainer.local_folder=/home/node/vscode-remote-try-rust --cap-add=SYS_PTRACE --security-opt seccomp=unconfined --entrypoint /bin/sh vsc-vscode-remote-try-rust-89420ad7399ba74f55921e49cc3ecfd2-uid -c echo Container started
Container started
{"outcome":"success","containerId":"f0a055ff056c1c1bb99cc09930efbf3a0437c54d9b4644695aa23c1d57b4bd11","remoteUser":"vscode","remoteWorkspaceFolder":"/workspaces/vscode-remote-try-rust"}
然后您可以在此开发容器中运行命令
devcontainer exec --workspace-folder <path-to-vscode-remote-try-rust> cargo run
这将编译并运行 Rust 示例,输出
[33 ms] dev-containers-cli 0.1.0.
Compiling hello_remote_world v0.1.0 (/workspaces/vscode-remote-try-rust)
Finished dev [unoptimized + debuginfo] target(s) in 1.06s
Running `target/debug/hello_remote_world`
Hello, VS Code Dev Containers!
{"outcome":"success"}
恭喜,您刚刚运行了开发容器 CLI 并看到了它的实际效果!
这些步骤也已在 CLI 仓库的 README 中提供。
我如何参与?
您的反馈对于塑造和扩展规范非常有帮助,我们很乐意听取您对 CLI 的反馈。请查看 CLI 并告诉我们您的想法。我们专门 开设了一个问题,供大家留下评论和问题,您也可以像其他开源项目一样,在仓库中开设新问题或 PR。
CLI 和整体规范正在积极开发中(规范 仍在进行中,尚未发布),敬请期待令人兴奋的新进展。我们欢迎您对 目前 CLI 的反馈,我们将继续提供关于您可以何时尝试哪些内容的更新,例如规范何时可用。
我们对基于容器的开发的未来感到非常兴奋,迫不及待地想听到您的反馈。我们期待为各种工具和用户提供一个通用、高效的格式。
编码愉快!
Brigit Murtaugh, @BrigitMurtaugh