Update more links to dev container spec
This commit is contained in:
gregvanl
Родитель
c1c5bdffcc
Коммит
f8d39ed224
|
|
@ -156,7 +156,7 @@ Variables we'd recommend starting off with in a `devcontainer.json` for educatio
|
|||
|
||||
Setting up a handful of variables in this file will save your class time in the long run. For example, you can use the `extensions` variable to ensure all your students automatically get the same set of extensions installed. Setting paths can also be challenging or lead to issues on students' computers, but by specifying path information via the `settings` variable, you'll save your class time and ensure their computers' path variables aren't harmed in the process.
|
||||
|
||||
There is a table in the [devcontainer.json reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) of all available properties you can include in this configuration file.
|
||||
There are tables in the [devcontainer.json reference](https://containers.dev/implementors/json_reference) of all available properties you can include in this configuration file.
|
||||
|
||||
#### Dockerfile
|
||||
|
||||
|
|
|
|||
|
|
@ -850,11 +850,6 @@
|
|||
<changefreq>weekly</changefreq>
|
||||
<priority>0.8</priority>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://code.visualstudio.com/docs/remote/devcontainerjson-reference</loc>
|
||||
<changefreq>weekly</changefreq>
|
||||
<priority>0.8</priority>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://code.visualstudio.com/docs/remote/attach-container</loc>
|
||||
<changefreq>weekly</changefreq>
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ DateApproved: 9/1/2022
|
|||
---
|
||||
# Attach to a running container
|
||||
|
||||
Visual Studio Code can create and start containers for you but that may not match your workflow and you may prefer to "attach" VS Code to an already running Docker container - regardless of how it was started. Once attached, you can install extensions, edit, and debug like you can when you open a folder in a container using [devcontainer.json](/docs/remote/devcontainerjson-reference.md).
|
||||
Visual Studio Code can create and start containers for you but that may not match your workflow and you may prefer to "attach" VS Code to an already running Docker container - regardless of how it was started. Once attached, you can install extensions, edit, and debug like you can when you open a folder in a container using [devcontainer.json](https://containers.dev/implementors/json_reference).
|
||||
|
||||
## Attach to a Docker container
|
||||
|
||||
|
|
@ -55,7 +55,7 @@ Both of these files support a subset of `devcontainer.json` properties:
|
|||
}
|
||||
```
|
||||
|
||||
See the [attached container config reference](/docs/remote/devcontainerjson-reference.md#attached-container-configuration-reference) for a complete list of properties and their uses.
|
||||
See the [attached container config reference](#attached-container-configuration-reference) for a complete list of properties and their uses.
|
||||
|
||||
Once saved, whenever you open a container for the first time with the same image / container name, these properties will be used to configure the environment.
|
||||
|
||||
|
|
@ -63,6 +63,31 @@ Once saved, whenever you open a container for the first time with the same image
|
|||
|
||||
Finally, if you have extensions you want installed regardless of the container you attach to, you can update `settings.json` to specify a list of [extensions that should always be installed](/docs/remote/containers.md#always-installed-extensions).
|
||||
|
||||
## Attached container configuration reference
|
||||
|
||||
Attached container configuration files are similar to [devcontainer.json](https://containers.dev/implementors/json_reference) and supports a subset of its properties.
|
||||
|
||||
| Property | Type | Description |
|
||||
|----------|------|-------------|
|
||||
| `workspaceFolder` | string | Sets the default path that VS Code should open when connecting to the container (which is often the path to a volume mount where the source code can be found in the container). Not set by default (an empty window is opened). |
|
||||
| `extensions` | array | An array of extension IDs that specify the extensions that should be installed inside the container when it is created. Defaults to `[]`. |
|
||||
| `settings` | object | Adds default `settings.json` values into a container/machine specific settings file. |
|
||||
| `forwardPorts` | array | A list of ports that should be forwarded from inside the container to the local machine. |
|
||||
| `portsAttributes` | object | Object that maps a port number, `"host:port"` value, range, or regular expression to a set of default options. See [port attributes](https://containers.dev/implementors/json_reference/#port-attributes) for available options. For example: <br />`"portsAttributes": {"3000": {"label": "Application port"}}` |
|
||||
| `otherPortsAttributes` | object | Default options for ports, port ranges, and hosts that aren't configured using `portsAttributes`. See [port attributes](https://containers.dev/implementors/json_reference/#port-attributes) for available options. For example: <br /> `"otherPortsAttributes": {"onAutoForward": "silent"}` |
|
||||
| `remoteEnv` | object | A set of name-value pairs that sets or overrides environment variables for VS Code (or sub-processes like terminals) but not the container as a whole. Environment and [pre-defined variables](#variables-in-attached-container-configuration-files) may be referenced in the values.<br>For example: `"remoteEnv": { "PATH": "${containerEnv:PATH}:/some/other/path" }` |
|
||||
| `remoteUser` | string | Overrides the user that VS Code runs as in the container (along with sub-processes like terminals, tasks, or debugging). Defaults to the user the container as a whole is running as (often `root`). |
|
||||
| `userEnvProbe` | enum | Indicates the type of shell to use to "probe" for user environment variables to include in VS Code or other connected tool's processes: `none`, `interactiveShell`, `loginShell`, or `loginInteractiveShell` (default). The specific shell used is based on the default shell for the user (typically bash). For example, bash interactive shells will typically include variables set in `/etc/bash.bashrc` and `~/.bashrc` while login shells usually include variables from `/etc/profile` and `~/.profile`. Setting this property to `loginInteractiveShell` will get variables from all four files. |
|
||||
| `postAttachCommand` | string,<br>array | A command string or list of command arguments to run after VS Code attaches to the container. Use `&&` in a string to execute multiple commands. For example, `"yarn install"` or `"apt-get update && apt-get install -y curl"`. The array syntax `["yarn", "install"]` will invoke the command (in this case `yarn`) directly without using a shell. Not set by default. <br>Note that the array syntax will execute the command without a shell. You can [learn more](https://containers.dev/implementors/json_reference/#formatting-string-vs-array-properties) about formatting string vs array properties. |
|
||||
|
||||
### Variables in attached container configuration files
|
||||
|
||||
Variables can be referenced in certain string values in attached configuration files in the following format: **${variableName}**. The following table is a list of available variables you can use.
|
||||
|
||||
| Variable | Properties | Description |
|
||||
|----------|---------|----------------------|
|
||||
| `${containerEnv:VAR_NAME}` | `remoteEnv` | Value of an existing environment variable inside the container (in this case, `VAR_NAME`) once it is up and running. For example: `"remoteEnv": { "PATH": "${containerEnv:PATH}:/some/other/path" }` |
|
||||
|
||||
## Attach to a container in a Kubernetes cluster
|
||||
|
||||
To attach to a container in a Kubernetes cluster, first install the [Kubernetes extension](https://marketplace.visualstudio.com/items?itemName=ms-kubernetes-tools.vscode-kubernetes-tools) and `kubectl` along with the Remote - Containers extension. Then select the Kubernetes explorer from the Activity bar and expand the cluster and Pod where the container you want to attach to resides. Finally, right-click on the container and select **Attach Visual Studio Code** from context menu.
|
||||
|
|
@ -75,4 +100,4 @@ To attach to a container in a Kubernetes cluster, first install the [Kubernetes
|
|||
|
||||
* [Create a Development Container](/docs/remote/create-dev-container.md) - Create a custom container for your work environment.
|
||||
* [Advanced Containers](/remote/advancedcontainers/overview.md) - Find solutions to advanced container scenarios.
|
||||
* [devcontainer.json reference](/docs/remote/devcontainerjson-reference.md) - Review the `devcontainer.json` schema.
|
||||
* [devcontainer.json reference](https://containers.dev/implementors/json_reference) - Review the `devcontainer.json` schema.
|
||||
|
|
|
|||
|
|
@ -160,7 +160,7 @@ The above example is taken from the `vscode-remote-try-node` repo we used in the
|
|||
| `postCreateCommand` | A command string or list of command arguments to run after the container is created. |
|
||||
| `remoteUser` | Overrides the user that VS Code runs as in the container (along with sub-processes). Defaults to the `containerUser`. |
|
||||
|
||||
[Full list](/docs/remote/devcontainerjson-reference.md) of `devcontainer.json` options.
|
||||
[Full list](https://containers.dev/implementors/json_reference) of `devcontainer.json` options.
|
||||
|
||||
### Congratulations
|
||||
|
||||
|
|
|
|||
|
|
@ -236,7 +236,7 @@ This implies trusting [the machine the Docker daemon runs on](/remote/advancedco
|
|||
|
||||
## Create a devcontainer.json file
|
||||
|
||||
VS Code's container configuration is stored in a [devcontainer.json](/docs/remote/devcontainerjson-reference.md) file. This file is similar to the `launch.json` file for debugging configurations, but is used for launching (or attaching to) your development container instead. You can also specify any extensions to install once the container is running or post-create commands to prepare the environment. The dev container configuration is either located under `.devcontainer/devcontainer.json` or stored as a `.devcontainer.json` file (note the dot-prefix) in the root of your project.
|
||||
VS Code's container configuration is stored in a [devcontainer.json](https://containers.dev/implementors/json_reference) file. This file is similar to the `launch.json` file for debugging configurations, but is used for launching (or attaching to) your development container instead. You can also specify any extensions to install once the container is running or post-create commands to prepare the environment. The dev container configuration is either located under `.devcontainer/devcontainer.json` or stored as a `.devcontainer.json` file (note the dot-prefix) in the root of your project.
|
||||
|
||||
You can use any image, Dockerfile, or set of Docker Compose files as a starting point. Here is a simple example that uses one of the pre-built [VS Code Development Container images](https://hub.docker.com/_/microsoft-vscode-devcontainers):
|
||||
|
||||
|
|
@ -262,11 +262,11 @@ To learn more about creating `devcontainer.json` files, see [Create a Developmen
|
|||
|
||||
## Dev Container Features (preview)
|
||||
|
||||
Development container "Features" are self-contained, shareable units of installation code and dev container configuration. The name comes from the idea that referencing one of them allows you to quickly and easily add more tooling, runtime, or library "Features" into your development container for you or your collaborators to use.
|
||||
Development container "Features" are self-contained, shareable units of installation code and dev container configuration. The name comes from the idea that referencing one of them allows you to quickly and easily add more tooling, runtime, or library "Features" into your development container for use by you or your collaborators.
|
||||
|
||||
When you use **Remote-Containers: Add Development Container Configuration Files**, you're presented a list of scripts to customize the existing dev container configurations, such as installing Git or the Azure CLI:
|
||||
|
||||
|
||||
|
||||
|
||||
When you rebuild and reopen in your container, the Features you selected will be available in your `devcontainer.json`:
|
||||
|
||||
|
|
@ -284,11 +284,11 @@ You'll get IntelliSense when editing the `"features"` property in the `devcontai
|
|||
|
||||
The **Remote-Containers: Configure Container Features** command allows you to update an existing configuration.
|
||||
|
||||
The Features sourced in VS Code UI come from the [`devcontainers/features` repository](https://github.com/devcontainers/features).
|
||||
The Features sourced in VS Code UI come from the [devcontainers/features repository](https://github.com/devcontainers/features).
|
||||
|
||||
### Creating your own feature
|
||||
|
||||
It's also easy to create and publish your own Dev Container Features. Published Features can be stored and shared as [OCI Artifacts](https://github.com/opencontainers/artifacts) from any supporting public or private container registry. You can see the list of current published Features on [containers.dev](https://containers.dev/features.html).
|
||||
It's also easy to create and publish your own Dev Container Features. Published Features can be stored and shared as [OCI Artifacts](https://github.com/opencontainers/artifacts) from any supporting public or private container registry. You can see the list of current published Features on [containers.dev](https://containers.dev/features).
|
||||
|
||||
A Feature is a self contained entity in a folder with at least a `devcontainer-feature.json` and `install.sh` entrypoint script:
|
||||
|
||||
|
|
@ -299,11 +299,11 @@ A Feature is a self contained entity in a folder with at least a `devcontainer-f
|
|||
| +-- (other files)
|
||||
```
|
||||
|
||||
See the [latest template](https://github.com/devcontainers/feature-template) for instructions on using the dev container CLI to publish your own public or private Features!
|
||||
See the [latest template](https://github.com/devcontainers/feature-template) for instructions on using the dev container CLI to publish your own public or private Features.
|
||||
|
||||
### Features proposal and distribution
|
||||
|
||||
Features are an active proposal in the open dev container specification. You can review the [Features proposal](https://github.com/devcontainers/spec/issues/61), along with [greater information about how Features work](https://containers.dev/implementors/features/) and their [distribution](https://containers.dev/implementors/features-distribution/).
|
||||
Features are an active proposal in the open-source [Development Containers Specification](https://containers.dev). You can review the [Features proposal](https://github.com/devcontainers/spec/issues/61), along with [more information about how Features work](https://containers.dev/implementors/features) and their [distribution](https://containers.dev/implementors/features-distribution).
|
||||
|
||||
## Pre-building dev container images
|
||||
|
||||
|
|
@ -614,8 +614,7 @@ See the [Advanced container configuration](/remote/advancedcontainers/overview.m
|
|||
|
||||
## devcontainer.json reference
|
||||
|
||||
There is a full [devcontainer.json reference](/docs/remote/devcontainerjson-reference.md), where you can review
|
||||
the file schema to help you customize your development containers and control how you attach to running containers.
|
||||
There is a full [devcontainer.json reference](https://containers.dev/implementors/json_reference), where you can review the file schema to help you customize your development containers and control how you attach to running containers.
|
||||
|
||||
## Known limitations
|
||||
|
||||
|
|
@ -710,9 +709,9 @@ The following articles may help answer your question:
|
|||
|
||||
### Can I use dev containers outside of VS Code?
|
||||
|
||||
As containerizing production workloads becomes commonplace, dev containers have become broadly useful for scenarios beyond VS Code. We're creating the **Development Containers Specification** to empower anyone in any tool to configure a consistent dev environment. It seeks to find ways to enrich existing formats with common development specific settings, tools, and configuration while still providing a simplified, un-orchestrated single container option – so that they can be used as coding environments or for continuous integration and testing.
|
||||
As containerizing production workloads becomes commonplace, dev containers have become useful for scenarios beyond VS Code. We're creating the [Development Container Specification](https://containers.dev/implementors/spec) to empower anyone in any tool to configure a consistent development environment. It seeks to find ways to enrich existing formats with common development specific settings, tools, and configurations while still providing a simplified, un-orchestrated single container option – so that they can be used as coding environments or for continuous integration and testing.
|
||||
|
||||
You can learn more and review the spec on [containers.dev](https://containers.dev), and you can review active proposals and contribute to the spec in the [devcontainers/spec](https://github.com/devcontainers/spec) repository on GitHub.
|
||||
You can learn more and review the specification at [containers.dev](https://containers.dev), and you can review active proposals and contribute to the specification in the [devcontainers/spec](https://github.com/devcontainers/spec) repository on GitHub.
|
||||
|
||||
## Questions or feedback
|
||||
|
||||
|
|
@ -729,4 +728,4 @@ You can learn more and review the spec on [containers.dev](https://containers.de
|
|||
* [Attach to a Running Container](/docs/remote/attach-container.md) - Attach to an already running Docker container.
|
||||
* [Create a Development Container](/docs/remote/create-dev-container.md) - Create a custom container for your work environment.
|
||||
* [Advanced Containers](/remote/advancedcontainers/overview.md) - Find solutions to advanced container scenarios.
|
||||
* [devcontainer.json reference](https://containers.dev/implementors/json_reference/) - Review the `devcontainer.json` schema.
|
||||
* [devcontainer.json reference](https://containers.dev/implementors/json_reference) - Review the `devcontainer.json` schema.
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ After any of the steps above, you'll have a fully functioning dev container, and
|
|||
|
||||
## Create a devcontainer.json file
|
||||
|
||||
VS Code's container configuration is stored in a [devcontainer.json](/docs/remote/devcontainerjson-reference.md) file. This file is similar to the `launch.json` file for debugging configurations, but is used for launching (or attaching to) your development container instead. The dev container configuration is either located under `.devcontainer/devcontainer.json` or stored as a `.devcontainer.json` file (note the dot-prefix) in the root of your project.
|
||||
VS Code's container configuration is stored in a [devcontainer.json](https://containers.dev/implementors/json_reference) file. This file is similar to the `launch.json` file for debugging configurations, but is used for launching (or attaching to) your development container instead. The dev container configuration is either located under `.devcontainer/devcontainer.json` or stored as a `.devcontainer.json` file (note the dot-prefix) in the root of your project.
|
||||
|
||||
You can use an image as a starting point for your `devcontainer.json`. An image is like a mini-disk drive with various tools and an operating system pre-installed. You can pull images from a container registry, which is a collection of repositories that store images. Here is a simple example `devcontainer.json` that uses a pre-built TypeScript and Node.js VS Code Development Container image from the popular container registry [Docker Hub](https://hub.docker.com/_/microsoft-vscode-devcontainers):
|
||||
|
||||
|
|
@ -279,7 +279,7 @@ For example:
|
|||
}
|
||||
```
|
||||
|
||||
See the [devcontainer.json reference](/docs/remote/devcontainerjson-reference.md) for information other available properties such as the `workspaceFolder` and `shutdownAction`.
|
||||
See the [devcontainer.json reference](https://containers.dev/implementors/json_reference) for information other available properties such as the `workspaceFolder` and `shutdownAction`.
|
||||
|
||||
Once you have added a `.devcontainer/devcontainer.json` file to your folder, run the **Remote-Containers: Reopen in Container** command (or **Remote-Containers: Open Folder in Container...** if you are not yet in a container) from the Command Palette (`kbstyle(F1)`).
|
||||
|
||||
|
|
@ -327,7 +327,7 @@ user: your-user-name-here
|
|||
|
||||
If you aren't creating a custom Dockerfile for development, you may want to install additional developer tools such as `curl` inside the service's container. While less efficient than adding these tools to the container image, you can also use the `postCreateCommand` property for this purpose.
|
||||
|
||||
See [install additional software](#install-additional-software) for more information on installing software and the [devcontainer.json reference](/docs/remote/devcontainerjson-reference.md) for more information about the `postCreateCommand` property.
|
||||
See [install additional software](#install-additional-software) for more information on installing software and the [devcontainer.json reference](https://containers.dev/implementors/json_reference) for more information about the `postCreateCommand` property.
|
||||
|
||||
If your application was built using C++, Go, or Rust, or another language that uses a ptrace-based debugger, you will also need to add the following settings to your Docker Compose file:
|
||||
|
||||
|
|
@ -489,4 +489,4 @@ The path used for looking up the configuration is derived from the output of `gi
|
|||
|
||||
* [Attach to a Running Container](/docs/remote/attach-container.md) - Attach to an already running Docker container.
|
||||
* [Advanced Containers](/remote/advancedcontainers/overview.md) - Find solutions to advanced container scenarios.
|
||||
* [devcontainer.json reference](https://containers.dev/implementors/json_reference/) - Review the `devcontainer.json` schema.
|
||||
* [devcontainer.json reference](https://containers.dev/implementors/json_reference) - Review the `devcontainer.json` schema.
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ Containers (for example [Docker](https://www.docker.com) containers) have histor
|
|||
|
||||
|
||||
|
||||
Development containers are supported in Visual Studio Code via the [Remote - Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) and in [GitHub Codespaces](https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers). This support is backed by [devcontainer.json](/docs/remote/devcontainerjson-reference.md), a structured JSON with Comments (jsonc) metadata format to configure a containerized environment.
|
||||
Development containers are supported in Visual Studio Code via the [Remote - Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) and in [GitHub Codespaces](https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers). This support is backed by [devcontainer.json](https://containers.dev/implementors/json_reference), a structured JSON with Comments (jsonc) metadata format to configure a containerized environment.
|
||||
|
||||
As containerizing production workloads becomes commonplace, dev containers have become broadly useful for scenarios beyond VS Code. To promote dev containers in any environment, work has started on the [Development Containers Specification](https://github.com/devcontainers/spec), which empowers anyone in any tool to configure a consistent dev environment. The open-source **dev container CLI** serves as the reference implementation of the specification.
|
||||
|
||||
|
|
@ -128,7 +128,7 @@ If you'd like to use the dev container CLI in your CI/CD builds or test automati
|
|||
|
||||
## Pre-building
|
||||
|
||||
The `devcontainer build` command allows you to build quickly build dev container image following the same steps the Remote - Containers extension or GitHub Codespaces will. This is particularly useful when you want to pre-build a dev container image using a CI or DevOps product like GitHub Actions.
|
||||
The `devcontainer build` command allows you to quickly build a dev container image following the same steps as used by the Remote - Containers extension or GitHub Codespaces. This is particularly useful when you want to pre-build a dev container image using a CI or DevOps product like GitHub Actions.
|
||||
|
||||
`build` accepts a path to the folder containing a `.devcontainer` folder or `.devcontainer.json` file. For example, `devcontainer build --workspace-folder <my_repo>` will build the container image for `my_repo`.
|
||||
|
||||
|
|
@ -138,7 +138,7 @@ For example, you may want to pre-build a number of images that you then reuse ac
|
|||
|
||||
1. [Create](/docs/editor/versioncontrol.md#initialize-a-repository) a source code repository.
|
||||
|
||||
1. Create dev container configuration for each image you want to pre-build, customizing as you wish (including [dev container Features](#dev-container-features-preview)). For example, consider this devcontainer.json file:
|
||||
1. Create dev container configuration for each image you want to pre-build, customizing as you wish (including [dev container Features](/docs/remote/containers.md#dev-container-features-preview)). For example, consider this `devcontainer.json` file:
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
@ -153,26 +153,26 @@ For example, you may want to pre-build a number of images that you then reuse ac
|
|||
}
|
||||
```
|
||||
|
||||
1. Use the `devcontainer build` command to build the image and [push](https://docs.docker.com/engine/reference/commandline/push/) it to your image registry. See documentation for your image registry (like the [Azure Container Registry](https://docs.microsoft.com/azure/container-registry/container-registry-get-started-docker-cli?tabs=azure-cli), [GitHub Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#pushing-container-images), or [Docker Hub](https://docs.docker.com/engine/reference/commandline/push)) for information on image naming and additional steps like authentication.
|
||||
1. Use the `devcontainer build` command to build the image and [push](https://docs.docker.com/engine/reference/commandline/push/) it to your image registry. See documentation for your image registry (such as [Azure Container Registry](https://docs.microsoft.com/azure/container-registry/container-registry-get-started-docker-cli?tabs=azure-cli), [GitHub Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#pushing-container-images), or [Docker Hub](https://docs.docker.com/engine/reference/commandline/push)) for information on image naming and additional steps like authentication.
|
||||
|
||||
```bash
|
||||
devcontainer build --workspace-folder <my_repo> --push true --image-name <my_image_name>:<optional_image_version>
|
||||
```
|
||||
|
||||
1. Create a simplified devcontainer.json in repositories where you'd like to use the image - the devcontainer.json should either use the `image` property or reference the image in an associated Docker Compose file. Include any dev container Features you added in your pre-build configuration. For example:
|
||||
1. Create a simplified `devcontainer.json` file in repositories where you'd like to use the image - the `devcontainer.json` should either use the `image` property or reference the image in an associated Docker Compose file. Include any dev container Features you added in your pre-build configuration. For example:
|
||||
|
||||
```json
|
||||
{
|
||||
"image": "ghcr.io/your-org/your-image-name",
|
||||
"features": {
|
||||
"ghcr.io/devcontainers/features/docker-in-docker:1": {
|
||||
"version": "latest"
|
||||
}
|
||||
}
|
||||
```json
|
||||
{
|
||||
"image": "ghcr.io/your-org/your-image-name",
|
||||
"features": {
|
||||
"ghcr.io/devcontainers/features/docker-in-docker:1": {
|
||||
"version": "latest"
|
||||
}
|
||||
}
|
||||
```
|
||||
}
|
||||
```
|
||||
|
||||
On the other hand, if you only intend to use the pre-built image from one repository, you can use the `cacheFrom` property in devcontainer.json or `cache_from` in a related Docker Compose file instead. This will download the image and treat its image layers like a local cache even if this is the first time you've created the Dockerfile on your machine. Like the option above, be sure to include any dev container Features. For example:
|
||||
On the other hand, if you only intend to use the pre-built image from one repository, you can use the `cacheFrom` property in `devcontainer.json` or `cache_from` in a related Docker Compose file instead. This will download the image and treat its image layers like a local cache even if this is the first time you've created the Dockerfile on your machine. Like the option above, be sure to include any dev container Features. For example:
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
@ -184,10 +184,11 @@ On the other hand, if you only intend to use the pre-built image from one reposi
|
|||
"ghcr.io/devcontainers/features/docker-in-docker:1": {}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Avoiding problems with images built using Docker
|
||||
|
||||
Given Dockerfiles and Docker Compose files can be used without VS Code or the `devcontainer` CLI, you may want to let users know that they should not try to build the image directly. You may learn more in the [advanced dev container documentation](../../remote/advancedcontainers/reduce-docker-warnings.md#avoiding-problems-with-images-built-using-docker).
|
||||
Given Dockerfiles and Docker Compose files can be used without VS Code or the `devcontainer` CLI, you may want to let users know that they should not try to build the image directly. You may learn more in the [advanced dev container documentation](/remote/advancedcontainers/reduce-docker-warnings.md#avoiding-problems-with-images-built-using-docker).
|
||||
|
||||
## Feedback
|
||||
|
||||
|
|
@ -196,6 +197,6 @@ The dev container CLI and specification are under active development and we welc
|
|||
## Next steps
|
||||
|
||||
* [Dev container specification repository](https://github.com/devcontainers/spec) - Read and contribute to the open specification.
|
||||
* [devcontainer.json reference](https://containers.dev/implementors/json_reference/) - Review the `devcontainer.json` schema.
|
||||
* [devcontainer.json reference](https://containers.dev/implementors/json_reference) - Review the `devcontainer.json` schema.
|
||||
* [Create a Development Container](/docs/remote/create-dev-container.md) - Create a custom container for your work environment.
|
||||
* [Advanced Containers](/remote/advancedcontainers/overview.md) - Find solutions to advanced container scenarios.
|
||||
|
|
|
|||
|
|
@ -9,18 +9,18 @@ DateApproved: 9/1/2022
|
|||
---
|
||||
# devcontainer.json reference
|
||||
|
||||
**TL;DR - This document has moved to the [dev container spec site](https://containers.dev/implementors/json_reference/)! This page simply now exists as a redirect to the spec site, which will contain the latest information.**
|
||||
**TL;DR - This document has moved to the [Development Containers Specification](https://containers.dev/implementors/json_reference) site! This page now exists as a redirect to the specification site, which contains the latest information.**
|
||||
|
||||
## Dev container specification
|
||||
|
||||
As mentioned in the main [Remote - Containers documentation](/docs/remote/containers.md), we're creating the **Development Containers Specification** to empower anyone in any tool to configure a consistent dev environment.
|
||||
|
||||
The devcontainer.json reference is [now hosted on the specification site](https://containers.dev/implementors/json_reference/). Here you may also review the [devcontainer.json schema](https://containers.dev/implementors/json_schema/).
|
||||
The `devcontainer.json` reference is [hosted on the specification site](https://containers.dev/implementors/json_reference). Here you can also review the [devcontainer.json schema](https://containers.dev/implementors/json_schema).
|
||||
|
||||
You may also review the spec documents and latest proposals in the [devcontainers/spec](https://github.com/devcontainers/spec/tree/main/docs/specs) repository.
|
||||
You can also review the specification documents and latest proposals in the [devcontainers/spec](https://github.com/devcontainers/spec/tree/main/docs/specs) repository.
|
||||
|
||||
## Additional resources
|
||||
|
||||
[Create a development container](/docs/remote/create-dev-container.md) has more information on configuring a dev container, or you can use the **Remote-Containers: Add Development Container Configuration Files...** or **Codespaces: Add Development Container Configuration Files...** commands from the Command Palette (`kbstyle(F1)`) to add a wide variety of base configurations.
|
||||
|
||||
> **Tip:** If you've already built a container and connected to it, be sure to run **Remote-Containers: Rebuild Container** or **Codespaces: Rebuild Container** from the Command Palette (`kbstyle(F1)`) to pick up any changes you make.
|
||||
> **Tip:** If you've already built a container and connected to it, be sure to run **Remote-Containers: Rebuild Container** or **Codespaces: Rebuild Container** from the Command Palette (`kbstyle(F1)`) to pick up any changes you make.
|
||||
|
|
|
|||
|
|
@ -295,7 +295,7 @@ There are new topics for working with Containers in VS Code:
|
|||
|
||||
* [Attach to Container](https://code.visualstudio.com/docs/remote/attach-container) - Attach to an already running Docker Container.
|
||||
* [Create a Dev Container](https://code.visualstudio.com/docs/remote/create-dev-container) - Create a custom container matching your development environment.
|
||||
* [devcontainer.json reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) - Control container creation through `devcontainer.json` properties.
|
||||
* [devcontainer.json reference](https://containers.dev/implementors/json_reference) - Control container creation through `devcontainer.json` properties.
|
||||
|
||||
And check out this blog post on using [Dev Containers in Education](https://code.visualstudio.com/blogs/2020/07/27/containers-edu) to help educators and students create stable, reproducible classroom setups.
|
||||
|
||||
|
|
|
|||
|
|
@ -56,15 +56,18 @@ RUN apt-get -y install --no-install-recommends apt-utils dialog 2>&1
|
|||
If the command fails, you will still be able to see the errors but they won't be in red.
|
||||
|
||||
## Avoiding problems with images built using Docker
|
||||
|
||||
Given Dockerfiles and Docker Compose files can be used without VS Code or the `devcontainer` CLI, you may want to let users know that they should not try to build the image directly if it will not work as expected. To solve this problem, you can add a build argument that needs to be specified for things to work.
|
||||
|
||||
For example, you could add the following to your Dockerfile:
|
||||
|
||||
```bash
|
||||
ARG vscode
|
||||
RUN if [[ -z "$devcontainercli" ]] ; then printf "\nERROR: This Dockerfile needs to be built with VS Code !" && exit 1; else printf "VS Code is detected: $devcontainercli"; fi
|
||||
```
|
||||
|
||||
And the following in your `devcontainer.json`:
|
||||
|
||||
```json
|
||||
"build": {
|
||||
"dockerfile": "Dockerfile",
|
||||
|
|
@ -75,4 +78,4 @@ And the following in your `devcontainer.json`:
|
|||
}
|
||||
```
|
||||
|
||||
In the Docker Compose case, you can add this argument to a separate [override file to extend your configuration](https://github.com/microsoft/vscode-docs/blob/a55ae5b286196b495e2b3ea9f0b3e211beb7c925/docs/remote/create-dev-container.md#extend-your-docker-compose-file-for-development) that is located in a different place in your source tree than the primary Docker Compose file.
|
||||
In the Docker Compose case, you can add this argument to a separate [override file to extend your configuration](https://github.com/microsoft/vscode-docs/blob/a55ae5b286196b495e2b3ea9f0b3e211beb7c925/docs/remote/create-dev-container.md#extend-your-docker-compose-file-for-development) that is located in a different place in your source tree than the primary Docker Compose file.
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче