Multi-Architecture for Containers Documentation #5174
Conversation
docs/remote/devcontainer-cli.md
Outdated
| @@ -11,6 +11,26 @@ DateApproved: 12/17/2021 | |||
|
|
|||
| Given the growing number of use cases for dev containers, there is a companion `devcontainer` command line interface (CLI) that can be used independent of the [Remote - Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) or GitHub Codespaces. This article will walk you through its installation and how to use it in different scenarios. | |||
|
|
|||
| ## Table of Contents | |||
There was a problem hiding this comment.
Hi @KanishkT123 We don't typically add a table of contents to the beginning of the VS Code topics but instead rely on the auto-generated right navigation, which displays the H2 headers.
If you think a section needs to be elevated to an H2 for discoverability, we can change the header level. For example, your new section "Building Multi-Architecture builds" may make sense as an H2.
I also think "Adding automation" and "devcontainer CLI build options" are discrete enough sections to be at their own H2 level.
There was a problem hiding this comment.
Makes perfect sense, I've made the changes you suggested. How should we track the WIP-ness of this PR? Would you like me to ping you when the WIP feature merges into the Remote repository?
There was a problem hiding this comment.
We would time the merge and publishing to when the extension is finally released. You can ping me when the feature is merged and I can coordinate with the extension publisher
|
Added |
Changes as per reviewer comments
Changes per reviewer comments.
There was a problem hiding this comment.
@KanishkT123 One minor fix to add. Preapproving. The rest looks great. Thanks for the solid work!
|
|
||
| 1. `devcontainer build`: As before, this invokes the devcontainer CLI build command. | ||
| 2. `--platform linux/amd64,linux/arm64`: This creates Docker images for the `linux/amd64` and `linux/arm64` architectures. Find other supported platforms [here](https://docs.docker.com/engine/install/) (all Docker supported platforms are supported) and [here](https://github.com/docker/buildx/blob/master/docs/reference/buildx_build.md#platform) on the Docker Buildx documentation page. | ||
| 4. `--image-name hubusername/multiarch-test:v1`: **This is mandatory when using `--platform` and optional otherwise.** This will tag the image and needs to follow container registry naming conventions to upload. |
There was a problem hiding this comment.
| 4. `--image-name hubusername/multiarch-test:v1`: **This is mandatory when using `--platform` and optional otherwise.** This will tag the image and needs to follow container registry naming conventions to upload. | |
| 3. `--image-name hubusername/multiarch-test:v1`: **This is mandatory when using `--platform` and optional otherwise.** This will tag the image and needs to follow container registry naming conventions to upload. |
|
|
||
| By default, the Devcontainer CLI **will push** to the container registry when multi-platform builds are specified. To run a multi-paltform build for local development purposes, append `--no-push` to the command as shown below: | ||
|
|
||
| ```bash |
There was a problem hiding this comment.
overall LGTM -- I did notice something appears to be affecting the '3-backtick-formatting' in this "No Push" section, since I see the 3-backtick chars displayed, even with the text fully "MD rendered" ?
|
Closing this PR as the devcontainer CLI topic will shortly be updated to reflect the new devcontainer CLI. |
Adding documentation changes for the multi-architecture update here: https://github.com/microsoft/vscode-remote-containers/pull/187