Skip to content

Commit d9d65b9

Browse files
authored
Update docs for new Container Tools extension (#8289)
* Update docs outside of `docs\containers` * Update docs with new Container Tools extension * One more doc * Finish the docs/containers files * A few missed things * Replace images/app-service images and cleanup * Replace images/devenv images * Replace images/compose images and clean up * Replace (mostly) images/overview images * Replace images/quickstarts * Replace some external images * Replace images/registries images * Replace images in devcontainers\images\containers * Replace images in api\working-witih-extensions\images\publishing-extension * Replace images in images\overview (temporary)
1 parent 7bf9b92 commit d9d65b9

95 files changed

Lines changed: 395 additions & 423 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 2 additions & 2 deletions
Loading

api/working-with-extensions/publishing-extension.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ To create a publisher:
104104
- **ID**: the **unique** identifier for your publisher in Marketplace that will be used in your extension URLs. ID cannot be changed once created.
105105
- **Name**: the **unique** name of your publisher that will be displayed in Marketplace with your extensions. This can be your company or brand name.
106106

107-
Below is an example of publisher identifier and name for the Docker extension:
107+
Below is an example of publisher identifier and name for the Python extension:
108108

109109
![Example of publisher identifier and name](images/publishing-extension/publisher-id-and-name.png)
110110

docs/azure/containers.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
Order: 4
3+
Area: azure
4+
TOCTitle: Containers
5+
ContentId: 42F8B9F8-BD03-4159-9479-17C5BDE30531
6+
PageTitle: Working with containers in Visual Studio Code
7+
DateApproved: 02/1/2024
8+
MetaDescription: Working with containers in Visual Studio Code.
9+
---
10+
# Working with Containers
11+
12+
This page is redirected to /docs/containers/overview.md and only exists to keep the "Containers" TOC item.

docs/azure/docker.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/azure/kubernetes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ To install the Kubernetes extension, open the Extensions view (`kb(workbench.vie
2929

3030
## Containerize and publish the application
3131

32-
You can follow the [Working with Docker](/docs/azure/docker.md) tutorial to build your project, generate a Docker image, and push it to a public or private container registry through the Microsoft [Docker Extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker).
32+
You can follow the [Working with Docker](/docs/azure/docker.md) tutorial to build your project, generate a Docker image, and push it to a public or private container registry through the Microsoft [Container Tools Extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-containers).
3333

3434
## Create and config a Kubernetes cluster
3535

docs/configure/profiles.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ VS Code comes with a predefined set of profile templates that you can use to cus
194194
The Python profile is a good starting point for Python development. It comes with Python specific snippets and has the following extensions:
195195

196196
* [autoDocstring](https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring) - Generate Python docstrings automatically.
197-
* [Docker](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker) - Create, manage, and debug containerized applications.
197+
* [Container Tools](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-containers) - Create, manage, and debug containerized applications.
198198
* [Even Better TOML](https://marketplace.visualstudio.com/items?itemName=tamasfe.even-better-toml) - Fully-featured TOML support for e.g. `pyproject.toml` files.
199199
* [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python) - IntelliSense, environment management, debugging, refactoring.
200200
* [Python Environments](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-python-envs) - Manage Python environments and packages using your preferred environment manager.
@@ -285,11 +285,11 @@ This profile also sets the following settings:
285285

286286
The Node.js profile is a good starting point for all Node.js work. It comes with the following extensions:
287287

288-
* [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) - Integrates ESLint JavaScript into VS Code.
288+
* [Container Tools](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-containers) - Create, manage, and debug containerized applications.
289289
* [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) - Create custom development environments inside a Docker container.
290-
* [Docker](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker) - Create, manage, and debug containerized applications.
291290
* [DotENV](https://marketplace.visualstudio.com/items?itemName=mikestead.dotenv) - Support for dotenv file syntax.
292291
* [EditorConfig for VS Code](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig) - EditorConfig Support for Visual Studio Code.
292+
* [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) - Integrates ESLint JavaScript into VS Code.
293293
* [JavaScript (ES6) code snippets](https://marketplace.visualstudio.com/items?itemName=xabikos.JavaScriptSnippets) - Code snippets for JavaScript in ES6 syntax.
294294
* [Jest](https://marketplace.visualstudio.com/items?itemName=Orta.vscode-jest) - Use Facebook's [jest](https://jestjs.io) testing framework.
295295
* [Microsoft Edge Tools for VS Code](https://marketplace.visualstudio.com/items?itemName=ms-edgedevtools.vscode-edge-devtools) - Use the Microsoft Edge Tools from within VS Code.

docs/containers/app-service.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ In this guide you will learn how to:
1818
## Prerequisites
1919

2020
- An Azure subscription.
21-
- [Docker](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker) and [Azure App Service](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azureappservice) extensions must be installed.
22-
- A [**web** application](https://learn.microsoft.com/azure/app-service/tutorial-custom-container) that produces a docker image. You could also follow [Create a sample ASP .NET Core application](/docs/containers/quickstart-aspnet-core.md) to create such application.
21+
- The [Container Tools](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-containers) and [Azure App Service](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azureappservice) extensions must be installed.
22+
- A [**web** application](https://learn.microsoft.com/azure/app-service/tutorial-custom-container) that produces a container image. You could also follow [Create a sample ASP .NET Core application](/docs/containers/quickstart-aspnet-core.md) to create such application.
2323
- You need a [Docker Hub](https://hub.docker.com/) account or an instance of [Azure Container Registry (ACR)](https://learn.microsoft.com/azure/container-registry/container-registry-get-started-portal).
2424

2525
## Create the application image
@@ -28,35 +28,35 @@ If you already have an image, skip this step and proceed to [Push the image to a
2828

2929
1. Open the application folder in VS Code.
3030

31-
2. Open Command Palette (`kb(workbench.action.showCommands)`) and use **Docker Images: Build Image...** command to build the image.
31+
2. Open Command Palette (`kb(workbench.action.showCommands)`) and use **Container Images: Build Image...** command to build the image.
3232

3333
![Build container image](images/app-service/command-build-image.png)
3434

35-
You can find the image name in the output of the Build Image command, the same can be found in the Images pane of the Docker Explorer.
35+
You can find the image name in the output of the Build Image command, the same can be found in the Images pane of the Container Explorer.
3636

3737
![Build image output](images/app-service/terminal-output-build-image.png)
3838

3939
## Push the image to a container registry
4040

4141
Before deploying the image to an App Service or a Container App, the image must be uploaded to a container registry. The image can be uploaded to either [Azure Container Registry (ACR)](https://learn.microsoft.com/azure/container-registry/container-registry-get-started-portal) or [Docker Hub](https://hub.docker.com/).
4242

43-
1. Open the Docker Explorer and select **Connect Registry...** icon under **Registries** group and follow the prompt. Choose the provider (Azure or Docker Hub) and provide the credential to connect to the registry.
43+
1. Open the Container Explorer and select **Connect Registry...** icon under **Registries** group and follow the prompt. Choose the provider (Azure or Docker Hub) and provide the credential to connect to the registry.
4444

4545
![Connect to Registry](images/app-service/explorer-connect-registry.png)
4646

4747
2. Now the registry will be visible under Registries.
4848

4949
![Registries](images/app-service/explorer-registries.png)
5050

51-
3. Optionally, tag the image. In order to upload an image to a registry, the image needs to be tagged with registry name so that the docker push will upload it to the right registry.
52-
- To create a registry in Azure ACR, open the **Registries** section of the Docker view, sign in to Azure if not already signed in, and then right-click on the subscription you want to use, and choose **Create Registry**.
53-
- The image built in previous section will appear in the Docker Explorer under Images section. Right-click and choose **Tag...**.
51+
3. Optionally, tag the image. In order to upload an image to a registry, the image needs to be tagged with registry name so that the `docker push` command will upload it to the right registry.
52+
- To create a registry in Azure ACR, open the **Registries** section of the Container Explorer, sign in to Azure if not already signed in, and then right-click on the subscription you want to use, and choose **Create Registry**.
53+
- The image built in previous section will appear in the Container Explorer under Images section. Right-click and choose **Tag...**.
5454

5555
![Tag image](images/app-service/explorer-tag-image.png)
5656
- Specify the new name `<your registry or username>/<image name>:<tag>` and complete the
5757
tag action. For example, new image name for ACR named WebApp6 would be 'webapp6.azurecr.io/webapp6:latest' and for Docker Hub it would be 'myusername/webapp6:latest'.
5858

59-
4. The image will show up in the Docker Explorer under the registry that the image tag points to. Select this image and choose **Push**. If the image has not yet been tagged, you will be prompted to choose a registry to push to, and the image will be tagged based on the selection.
59+
4. The image will show up in the Container Explorer under the registry that the image tag points to. Select this image and choose **Push**. If the image has not yet been tagged, you will be prompted to choose a registry to push to, and the image will be tagged based on the selection.
6060

6161
![Push image](images/app-service/explorer-push-image.png)
6262

@@ -68,7 +68,7 @@ Before deploying the image to an App Service or a Container App, the image must
6868

6969
In the previous section, the image is pushed to a remote container registry. Now deploy this image to Azure App Service or Azure Container Apps.
7070

71-
1. In Docker Explorer, navigate to your image under Registries, right-click on the tag, and select **Deploy Image To Azure App Service...** or **Deploy Image to Azure Container Apps...**.
71+
1. In Container Explorer, navigate to your image under Registries, right-click on the tag, and select **Deploy Image To Azure App Service...** or **Deploy Image to Azure Container Apps...**.
7272

7373
![Deploy to Azure App Service](images/app-service/explorer-deploy-to-app-service.png)
7474

@@ -81,7 +81,7 @@ In the previous section, the image is pushed to a remote container registry. Now
8181

8282
![Deployment complete notification](images/app-service/notification-appservice-deployment.png)
8383

84-
4. You can also see the results in the Output panel of Visual Studio Code, in the Docker section.
84+
4. You can also see the results in the Output panel of Visual Studio Code, in the Container Tools section.
8585

8686
![Deployment complete output](images/app-service/output-appservice-deployment.png)
8787

docs/containers/choosing-dev-environment.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The second important choice is whether to debug your service running as an ordin
2828

2929
1. Debugging your service running in a container is possible, but brings additional complexity. Use normal debugging by default, and debugging in the container when you need it.
3030

31-
> The Docker extension natively supports container debugging for .NET-, Node.js-, and Python-based services.
31+
> The Container Tools extension natively supports container debugging for .NET-, Node.js-, and Python-based services.
3232
3333
## Enabling Docker CLI inside a remote development environment
3434

@@ -86,11 +86,11 @@ After Docker is installed and working on the remote machine, you can use VS Code
8686

8787
1. A new VS Code window opens, running in the context of the target machine. If you're using password authentication, the password will be prompted here. We strongly recommend that you set up [SSH key authentication](https://www.ssh.com/ssh/public-key-authentication), for ease of use.
8888

89-
1. In the Extensions view, install the Docker extension (on the remote host) (a reload may be required after this step):
89+
1. In the Extensions view, install the Container Tools extension (on the remote host) (a reload may be required after this step):
9090

91-
![Screenshot - Installing the Docker extension](images/devenv/install-in-ssh.png)
91+
![Screenshot - Installing the Container Tools extension](images/devenv/install-in-ssh.png)
9292

93-
>**Note**: If you are using the Docker extension to build Docker images and have source code, the approach above probably means you have your source enlistment on the remote host, rather than on your developer workstation. If you are just using the Docker extension for the Docker Explorer features, then you can disregard this.
93+
>**Note**: If you are using the Container Tools extension to build container images and have source code, the approach above probably means you have your source enlistment on the remote host, rather than on your developer workstation. If you are just using the Container Tools extension for the Container Explorer features, then you can disregard this.
9494
9595
### Local Linux VM
9696

@@ -100,7 +100,7 @@ Alternatively, you can install just the Docker CLI inside your development envir
100100

101101
## Debugging in a container
102102

103-
The Docker extension supports debugging .NET and Node.js-based services running inside a container. Other programming languages are not supported at this time.
103+
The Container Tools extension supports debugging .NET and Node.js-based services running inside a container. Other programming languages are not supported at this time.
104104

105105
Debugging in a container may be harder to set up than regular debugging because a container is a stronger isolation mechanism than a process. In particular:
106106

@@ -109,7 +109,7 @@ Debugging in a container may be harder to set up than regular debugging because
109109

110110
Because of the concerns above, it is generally recommended to use regular debugging, and employ debugging in a container when necessary.
111111

112-
For more information about how to set up debugging inside a container see [ASP.NET Core quickstart](/docs/containers/quickstart-aspnet-core.md), [Node.js quickstart](/docs/containers/quickstart-node.md), and [Docker extension task properties](/docs/containers/reference.md) (`docker-build` and `docker-run` tasks).
112+
For more information about how to set up debugging inside a container see [ASP.NET Core quickstart](/docs/containers/quickstart-aspnet-core.md), [Node.js quickstart](/docs/containers/quickstart-node.md), and [Container Tools extension task properties](/docs/containers/reference.md) (`docker-build` and `docker-run` tasks).
113113

114114
## Next steps
115115

0 commit comments

Comments
 (0)