Skip to content

Commit 433ef24

Browse files
authored
Merge pull request #3083 from MicrosoftDocs/master636909473904461626
For protected CLA branch, push strategy should use PR and merge to target branch method to work around git push error
2 parents 0e6473a + 0042184 commit 433ef24

File tree

65 files changed

+494
-277
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+494
-277
lines changed

.openpublishing.redirection.json

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7339,6 +7339,36 @@
73397339
"source_path": "subscriptions/vscloud-renewals.md",
73407340
"redirect_url": "/visualstudio/subscriptions/vscloud-overview",
73417341
"redirect_document_id": false
7342+
},
7343+
{
7344+
"source_path": "docs/containers/docker-tools.md",
7345+
"redirect_url": "/visualstudio/containers/container-tools",
7346+
"redirect_document_id": true
7347+
},
7348+
{
7349+
"source_path": "docs/containers/visual-studio-tools-for-docker.md",
7350+
"redirect_url": "/visualstudio/containers/overview",
7351+
"redirect_document_id": true
7352+
},
7353+
{
7354+
"source_path": "docs/containers/vs-azure-tools-docker-edit-and-refresh.md",
7355+
"redirect_url": "/visualstudio/containers/edit-and-refresh",
7356+
"redirect_document_id": true
7357+
},
7358+
{
7359+
"source_path": "docs/containers/vs-azure-tools-docker-hosting-web-apps-in-docker.md",
7360+
"redirect_url": "/visualstudio/containers/hosting-web-apps-in-docker",
7361+
"redirect_document_id": true
7362+
},
7363+
{
7364+
"source_path": "docs/containers/docker-deploy-app-service.md",
7365+
"redirect_url": "/visualstudio/containers/deploy-app-service",
7366+
"redirect_document_id": true
7367+
},
7368+
{
7369+
"source_path": "docs/containers/vs-azure-tools-docker-troubleshooting-docker-errors.md",
7370+
"redirect_url": "/visualstudio/containers/troubleshooting-docker-errors",
7371+
"redirect_document_id": true
73427372
}
73437373
]
73447374
}
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: Configure Visual Studio Container Tools
3+
description: Configure the tools available in Visual Studio for working with Docker containers.
4+
author: ghogen
5+
ms.author: ghogen
6+
ms.topic: conceptual
7+
ms.date: 03/20/2019
8+
ms.technology: vs-azure
9+
---
10+
# How to configure Visual Studio Container Tools
11+
12+
Using Visual Studio settings, you can control some aspects of how Visual Studio works with Docker containers, including settings that affect performance and resource usage when working with Docker containers.
13+
14+
## Container Tools settings
15+
16+
From the main menu, choose **Tools > Options**, and expand **Container Tools > Settings**. The container tools settings appear.
17+
18+
::: moniker range="vs-2017"
19+
20+
![Visual Studio Container Tools options, showing: Automatically pull required Docker images on project load, Automatically start containers in background, Automatically kill containers on solution close, and Do not prompt for trusting SSL certificate.](./media/overview/visual-studio-docker-tools-options.png)
21+
::: moniker-end
22+
23+
::: moniker range=">=vs-2019"
24+
25+
Container Tools **General** settings:
26+
27+
![Visual Studio Container Tools options, showing: Install Docker Desktop if needed, and Trust ASP.NET Core SSL certificate.](./media/configure-container-tools/tools-options-1.png)
28+
29+
Container Tools **Single Project** and **Docker Compose** settings:
30+
31+
![Visual Studio Container Tools options, showing: Kill containers on project close, Pull required Docker images on project open, and Run containers on project open.](./media/configure-container-tools/tools-options-2.png)
32+
::: moniker-end
33+
34+
The following table might help you decide how to set these options.
35+
36+
::: moniker range="vs-2017"
37+
| Name | Default Setting | Applies To | Description |
38+
| -----|:---------------:|:----------:| ----------- |
39+
| Automatically pull required Docker images on project load | On | Docker Compose | For increased performance when loading projects, Visual Studio will start a Docker pull operation in the background so that when you're ready to run your code, the image is already downloaded or in the process of downloading. If you're just loading projects and browsing code, you can turn this off to avoid downloading container images you don't need. |
40+
| Automatically start containers in background | On | Docker Compose | Again for increased performance, Visual Studio creates a container with volume mounts ready for when you build and run your container. If you want to control when your container is created, turn this off. |
41+
| Automatically kill containers on solution close | On | Docker Compose | Turn this off if you would like containers for your solution to continue to run after closing the solution or closing Visual Studio. |
42+
| Do not prompt for trusting localhost SSL certificate | Off | ASP.NET Core 2.1 projects | If the localhost SSL certificate is not trusted, Visual Studio will prompt every time you run your project, unless this checkbox is checked. |
43+
::: moniker-end
44+
45+
::: moniker range=">=vs-2019"
46+
47+
The following table describes **General** settings:
48+
49+
| Name | Default Setting | Applies To | Description |
50+
| -----|:---------------:|:----------:| ----------- |
51+
| Install Docker Desktop if needed | Prompt Me | Single Project, Docker Compose | Choose whether you want to be prompted if Docker Desktop is not installed. |
52+
| Trust ASP.NET Core SSL certificate | Prompt Me | ASP.NET Core 2.x projects | When set to **Prompt Me**, if the localhost SSL certificate is not trusted, Visual Studio will prompt every time you run your project. |
53+
54+
The following table describes **Single Project** and **Docker Compose** settings:
55+
56+
| Name | Default Setting | Applies To | Description |
57+
| -----|:---------------:|:----------:| ----------- |
58+
| Pull required Docker images on project open | True | Single Project, Docker Compose | For increased performance when loading projects, Visual Studio will start a Docker pull operation in the background so that when you're ready to run your code, the image is already downloaded or in the process of downloading. If you're just loading projects and browsing code, you can set to **False** to avoid downloading container images you don't need. |
59+
| Run containers on project open | True | Single Project, Docker Compose | Again for increased performance, Visual Studio creates a container with volume mounts ready for when you build and run your container. If you want to control when your container is created, set to **False**. |
60+
| Kill containers on project close | True | Single Project and Docker Compose | Set to **False** if you would like containers for your solution to continue to run after closing the solution or closing Visual Studio. |
61+
62+
::: moniker-end
63+
> [!WARNING]
64+
> If the localhost SSL certificate is not trusted, and you check the box to suppress prompting, then HTTPS web requests might fail at runtime in your app or service. In that case, uncheck the **Do not prompt** checkbox, run your project, and indicate trust at the prompt.
65+
66+
## Next steps
67+
68+
Read more about working with containers in Visual Studio in this [overview](visual-studio-tools-for-docker.md).

docs/containers/container-tools.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Visual Studio Container Tools with ASP.NET Core
3+
author: ghogen
4+
description: Learn how to use Visual Studio Container Tools and Docker for Windows
5+
ms.author: ghogen
6+
ms.date: 02/01/2019
7+
ms.technology: vs-azure
8+
ms.topic: include
9+
---
10+
# Quickstart: Docker in Visual Studio
11+
12+
::: moniker range="vs-2017"
13+
14+
[!include[Visual Studio Container Tools](includes/vs-2017/container-tools.md)]
15+
16+
::: moniker-end
17+
18+
::: moniker range=">= vs-2019"
19+
20+
[!include[Visual Studio Container Tools](includes/vs-2019/container-tools.md)]
21+
22+
::: moniker-end
23+
24+
## Additional resources
25+
26+
* [Container development with Visual Studio](/visualstudio/containers)
27+
* [Troubleshoot Visual Studio 2017 development with Docker](troubleshooting-docker-errors.md)
28+
* [Visual Studio Container Tools GitHub repository](https://github.com/Microsoft/DockerTools)
29+
30+
[0]:media/hosting-web-apps-in-docker/vs-acr-provisioning-dialog.png

docs/containers/docker-deploy-app-service.md renamed to docs/containers/deploy-app-service.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Deploy an ASP.NET Core Docker container to Azure App Service | Microsoft Docs
3-
description: Learn how to use Visual Studio Tools for Docker to deploy an ASP.NET Core web app to Azure App Service
3+
description: Learn how to use Visual Studio Container Tools to deploy an ASP.NET Core web app to Azure App Service
44
author: ghogen
55
manager: jillfra
66
ms.technology: vs-azure
@@ -56,21 +56,21 @@ The following steps guide you through creating a basic ASP.NET Core app that wil
5656
1. On the publish target dialog, choose **App Service Linux**.
5757
1. You can publish only to App Service, or you can publish to both App Service and Azure Container Registry (ACR). To publish the container in an Azure Container Registry (ACR), choose **Create new App Service for containers**, and click **Publish**.
5858

59-
![Screenshot of publish dialog](media/docker-deploy-app-service/publish-app-service-linux.PNG)
59+
![Screenshot of publish dialog](media/deploy-app-service/publish-app-service-linux.PNG)
6060

6161
To publish only to an Azure App Service without using Azure Container Registry, choose **Create new**, and click **Publish**.
6262

6363
1. Check that you're signed in with the account that's associated with your Azure subscription, and choose a unique name, subscription, resource group, hosting plan, and container registry (if applicable), or accept the defaults.
6464

65-
![Screenshot of publish settings](media/docker-deploy-app-service/publish-app-service-linux2.png)
65+
![Screenshot of publish settings](media/deploy-app-service/publish-app-service-linux2.png)
6666

6767
1. Choose **Create**. Your container is deployed to Azure in the resource group and container registry you selected. This process takes a bit of time. When it's completed, the **Publish** tab shows information about what was published, including the site URL.
6868

69-
![Screenshot of publish tab](media/docker-deploy-app-service/publish-succeeded.PNG)
69+
![Screenshot of publish tab](media/deploy-app-service/publish-succeeded.PNG)
7070

7171
1. Click on the site link to verify your app works as expected in Azure.
7272

73-
![Screenshot of web application](media/docker-deploy-app-service/web-application-running.png)
73+
![Screenshot of web application](media/deploy-app-service/web-application-running.png)
7474

7575
1. The publishing profile is saved with all the details you selected, such as the resource group and container registry.
7676
1. To deploy again with the same publishing profile, use the **Publish** button, the **Publish** button on the **Web Publish Activity** window, or right-click on the project in **Solution Explorer** and choose the **Publish** item on the context-menu.

docs/containers/docker-tools.md

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

docs/containers/vs-azure-tools-docker-edit-and-refresh.md renamed to docs/containers/edit-and-refresh.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Often, changes will need further inspection, leveraging the debugging features o
9191
4. Hit F5 to start debugging and hit the breakpoint.
9292
5. Switch to Visual Studio to view the breakpoint, inspect values, and so on.
9393

94-
![Breakpoint](media/vs-azure-tools-docker-edit-and-refresh/breakpoint.png)
94+
![Breakpoint](media/edit-and-refresh/breakpoint.png)
9595

9696
## Summary
9797

@@ -100,7 +100,7 @@ with the production realism of developing within a Docker container.
100100

101101
## Troubleshooting
102102

103-
[Troubleshooting Visual Studio Docker Development](vs-azure-tools-docker-troubleshooting-docker-errors.md)
103+
[Troubleshooting Visual Studio Docker Development](troubleshooting-docker-errors.md)
104104

105105
## More about Docker with Visual Studio, Windows, and Azure
106106

docs/containers/vs-azure-tools-docker-hosting-web-apps-in-docker.md renamed to docs/containers/hosting-web-apps-in-docker.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Deploy an ASP.NET Docker container to Azure Container Registry (ACR) | Microsoft Docs
3-
description: Learn how to use Visual Studio Tools for Docker to deploy an ASP.NET Core web app to a container registry
3+
description: Learn how to use Visual Studio Container Tools to deploy an ASP.NET Core web app to a container registry
44
author: ghogen
55
manager: jillfra
66
ms.assetid: e5e81c5e-dd18-4d5a-a24d-a932036e78b9
@@ -55,7 +55,7 @@ The following steps guide you through creating a basic ASP.NET Core app that wil
5555
| **[SKU](https://docs.microsoft.com/azure/container-registry/container-registry-skus)** | Standard | Service tier of the container registry |
5656
| **Registry Location** | A location close to you | Choose a Location in a [region](https://azure.microsoft.com/regions/) near you or near other services that will use your container registry. |
5757

58-
![Visual Studio's create Azure Container Registry dialog](media/vs-azure-tools-docker-hosting-web-apps-in-docker/vs-acr-provisioning-dialog.png)
58+
![Visual Studio's create Azure Container Registry dialog](media/hosting-web-apps-in-docker/vs-acr-provisioning-dialog.png)
5959

6060
5. Click **Create**
6161

docs/containers/includes/vs-2017/docker-tools.md renamed to docs/containers/includes/vs-2017/container-tools.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Visual Studio Tools for Docker with ASP.NET Core
2+
title: Visual Studio Container Tools with ASP.NET Core
33
author: ghogen
44
description: Learn how to use Visual Studio 2017 tooling and Docker for Windows
55
ms.author: ghogen
@@ -14,7 +14,7 @@ With Visual Studio, you can easily build, debug, and run containerized ASP.NET C
1414

1515
* [Docker Desktop](https://hub.docker.com/editions/community/docker-ce-desktop-windows)
1616
* [Visual Studio 2017](https://visualstudio.microsoft.com/downloads/?utm_medium=microsoft&utm_source=docs.microsoft.com&utm_campaign=inline+link&utm_content=download+vs2017) with the **Web Development**, **Azure Tools** workload, and/or **.NET Core cross-platform development** workload installed
17-
* To publish to Azure Container Registry, an Azure subscription. [Sign up for a free trial](https://azure.microsoft.com/en-us/offers/ms-azr-0044p/).
17+
* To publish to Azure Container Registry, an Azure subscription. [Sign up for a free trial](https://azure.microsoft.com/offers/ms-azr-0044p/).
1818

1919
## Installation and setup
2020

@@ -29,7 +29,7 @@ For Docker installation, first review the information at [Docker Desktop for Win
2929
1. Select **Web Application**.
3030
1. Check the **Enable Docker Support** checkbox.
3131

32-
![Enable Docker Support check box](../../media/docker-tools/enable-docker-support.PNG)
32+
![Enable Docker Support check box](../../media/container-tools/enable-docker-support.PNG)
3333

3434
1. Select the type of container you want (Windows or Linux) and click **OK**.
3535

@@ -116,10 +116,4 @@ Once the develop and debug cycle of the app is completed, you can create a produ
116116

117117
You can now pull the container from the registry to any host capable of running Docker images, for example [Azure Container Instances](/azure/container-instances/container-instances-tutorial-deploy-app).
118118

119-
## Additional resources
120-
121-
* [Container development with Visual Studio](/visualstudio/containers)
122-
* [Troubleshoot Visual Studio 2017 development with Docker](../../vs-azure-tools-docker-troubleshooting-docker-errors.md)
123-
* [Visual Studio Tools for Docker GitHub repository](https://github.com/Microsoft/DockerTools)
124-
125-
[0]:../../media/vs-azure-tools-docker-hosting-web-apps-in-docker/vs-acr-provisioning-dialog.png
119+
[0]:../../media/hosting-web-apps-in-docker/vs-acr-provisioning-dialog.png

docs/containers/includes/vs-2019/docker-tools.md renamed to docs/containers/includes/vs-2019/container-tools.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ With Visual Studio, you can easily build, debug, and run containerized ASP.NET C
1616
* [Docker Desktop](https://hub.docker.com/editions/community/docker-ce-desktop-windows)
1717
* [Visual Studio 2019](https://visualstudio.microsoft.com/downloads/?utm_medium=microsoft&utm_source=docs.microsoft.com&utm_campaign=inline+link&utm_content=download+vs2019) with the **Web Development**, **Azure Tools** workload, and/or **.NET Core cross-platform development** workload installed
1818
* [.NET Core 2.2 Development Tools](https://dotnet.microsoft.com/download/dotnet-core/2.2) for development with .NET Core 2.2
19-
* To publish to Azure Container Registry, an Azure subscription. [Sign up for a free trial](https://azure.microsoft.com/en-us/offers/ms-azr-0044p/).
19+
* To publish to Azure Container Registry, an Azure subscription. [Sign up for a free trial](https://azure.microsoft.com/offers/ms-azr-0044p/).
2020

2121
## Installation and setup
2222

@@ -27,7 +27,7 @@ For Docker installation, first review the information at [Docker Desktop for Win
2727
1. Create a new project using the **ASP.NET Core Web Application** template.
2828
1. Select **Web Application**, and make sure the **Enable Docker Support** checkbox is selected.
2929

30-
![Enable Docker Support check box](../../media/docker-tools/vs-2019/create-new-web-application.PNG)
30+
![Enable Docker Support check box](../../media/container-tools/vs-2019/create-new-web-application.PNG)
3131

3232
1. Select the type of container you want (Windows or Linux) and click **Create**.
3333

@@ -110,16 +110,10 @@ Once the develop and debug cycle of the app is completed, you can create a produ
110110

111111
1. Click **Create**
112112

113-
![Screenshot showing successful publish](../../media/docker-tools/publish-succeeded.png)
113+
![Screenshot showing successful publish](../../media/container-tools/publish-succeeded.png)
114114

115115
## Next Steps
116116

117117
You can now pull the container from the registry to any host capable of running Docker images, for example [Azure Container Instances](/azure/container-instances/container-instances-tutorial-deploy-app).
118118

119-
## Additional resources
120-
121-
* [Container development with Visual Studio](/visualstudio/containers)
122-
* [Troubleshoot Visual Studio 2017 development with Docker](../../vs-azure-tools-docker-troubleshooting-docker-errors.md)
123-
* [Visual Studio Tools for Docker GitHub repository](https://github.com/Microsoft/DockerTools)
124-
125-
[0]:../../media/vs-azure-tools-docker-hosting-web-apps-in-docker/vs-acr-provisioning-dialog-2019.png
119+
[0]:../../media/hosting-web-apps-in-docker/vs-acr-provisioning-dialog-2019.png

docs/containers/index.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ sections:
2121
className: cardsM
2222
columns: 3
2323
items:
24-
- href: docker-tools.md
24+
- href: container-tools.md
2525
html: <p></p>
2626
image:
2727
src: https://docs.microsoft.com/media/logos/logo_docker.svg
@@ -67,7 +67,7 @@ sections:
6767
html: <p></p>
6868
image:
6969
src: https://docs.microsoft.com/media/common/i_web.svg
70-
title: ASP.NET Docker Tools
70+
title: ASP.NET Container Tools
7171
- href: https://docs.microsoft.com/azure/vs-azure-tools-docker-hosting-web-apps-in-docker
7272
html: <p></p>
7373
image:
Loading
Loading
Loading

0 commit comments

Comments
 (0)