You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|AdditionalComposeFilePaths|dcproj|Specifies additional compose files in a semicolon-delimited list to be sent out to docker-compose.exe for all commands. Relative paths from the Docker Compose project file (dcproj) are allowed.|-|
34
-
|DockerComposeBaseFilePath|dcproj|Specifies the first part of the filenames of the Docker Compose files, without the `.yml` extension. For example: <br>1. DockerComposeBaseFilePath = null/undefined: use the base file path `docker-compose`, and files will be named *docker-compose.yml* and *docker-compose.override.yml*.<br>2. DockerComposeBaseFilePath = *mydockercompose*: files will be named *mydockercompose.yml* and *mydockercompose.override.yml*.<br> 3. DockerComposeBaseFilePath = *..\mydockercompose*: files will be up one level. |`docker-compose`|
35
-
|DockerComposeBuildArguments|dcproj|Specifies the extra parameters to pass to the `docker-compose build` command. For example, `--parallel --pull`. |
36
-
|DockerComposeDownArguments|dcproj|Specifies the extra parameters to pass to the `docker-compose down` command. For example, `--timeout 500`.|-|
37
-
| DockerComposeEnvFilePath | dcproj | The relative path to an .env file that's passed to `docker compose` commands via `--env-file`. See [Use the env_file attribute](https://docs.docker.com/compose/how-tos/environment-variables/set-environment-variables/#use-the-env_file-attribute). | Empty |
38
-
|DockerComposeProjectName| dcproj | If specified, overrides the project name for a Docker Compose project. | "dockercompose" + auto-generated hash |
39
-
|DockerComposeProjectPath|csproj or vbproj|The relative path to the Docker Compose project (dcproj) file. Set this property when publishing the service project to find the associated image build settings stored in the docker-compose.yml file.|-|
40
-
|DockerComposeProjectsToIgnore|dcproj| Specifies projects to be ignored by Docker Compose tools during debug. This property can be used for any project. File paths can be specified one of two ways: <br> 1. Relative to dcproj. For example, `<DockerComposeProjectsToIgnore>path\to\AngularProject1.csproj</DockerComposeProjectsToIgnore>`. <br> 2. Absolute paths.<br> **Note**: The paths should be separated by the delimiter character `;`.|-|
41
-
|DockerComposeUpArguments|dcproj|Specifies the extra parameters to pass to the `docker-compose up` command. For example, `--timeout 500`.|-|
42
-
|DockerDevelopmentMode| dcproj | Controls whether the user project is built in the container. The allowed values of **Fast** or **Regular** control [which stages are built](https://aka.ms/containerfastmode) in a Dockerfile. The Debug configuration is Fast mode by default and Regular mode otherwise. | Fast |
43
-
|DockerLaunchAction| dcproj | Specifies the launch action to perform on F5 or Ctrl+F5. Allowed values are None, LaunchBrowser, and LaunchWCFTestClient. | None |
44
-
|DockerLaunchBrowser| dcproj | Indicates whether to launch the browser. Ignored if DockerLaunchAction is specified. | False |
45
-
|DockerServiceName| dcproj| If DockerLaunchAction or DockerLaunchBrowser are specified, then DockerServiceName specifies which service referenced in the `docker-compose` file gets launched.|-|
46
-
|DockerServiceUrl| dcproj | The URL to use when launching the browser. Valid replacement tokens are "{ServiceIPAddress}", "{ServicePort}", and "{Scheme}". For example: {Scheme}://{ServiceIPAddress}:{ServicePort}|-|
47
-
|DockerTargetOS| dcproj | The target OS used when building the Docker image.|-|
29
+
The following table shows the MSBuild properties available for Docker Compose projects (`.dcproj` files).
30
+
31
+
| Property name | Description |
32
+
|---------------|-------------|
33
+
|AdditionalComposeFilePaths|Specifies additional compose files in a semicolon-delimited list to be sent out to docker-compose.exe for all commands. Relative paths from the Docker Compose project file (dcproj) are allowed.|
34
+
|DependencyAwareStart|Enables a different way of launching the app that supports the Docker Compose properties [`depends_on`](https://docs.docker.com/reference/compose-file/services/#depends_on) and [`healthcheck`](https://docs.docker.com/reference/compose-file/services/#healthcheck), which control service startup order and health checks.<br/><br/>Requires Visual Studio 17.13 or later.<br/><br/>Default value: False |
35
+
|DockerComposeBaseFilePath|Specifies the first part of the filenames of the Docker Compose files, without the `.yml` extension. For example: <br>1. DockerComposeBaseFilePath = null/undefined: use the base file path `docker-compose`, and files will be named *docker-compose.yml* and *docker-compose.override.yml*.<br>2. DockerComposeBaseFilePath = *mydockercompose*: files will be named *mydockercompose.yml* and *mydockercompose.override.yml*.<br> 3. DockerComposeBaseFilePath = *..\mydockercompose*: files will be up one level.<br/><br/>Default value: `docker-compose`|
36
+
|DockerComposeBuildArguments|Specifies the extra parameters to pass to the `docker-compose build` command. For example, `--parallel --pull`. |
37
+
|DockerComposeDownArguments|Specifies the extra parameters to pass to the `docker-compose down` command. For example, `--timeout 500`.|
38
+
| DockerComposeEnvFilePath | The relative path to an .env file that's passed to `docker compose` commands via `--env-file`. See [Use the env_file attribute](https://docs.docker.com/compose/how-tos/environment-variables/set-environment-variables/#use-the-env_file-attribute).<br/><br/>Default value: Empty |
39
+
|DockerComposeProjectName | If specified, overrides the project name for a Docker Compose project. <br/><br/>Default value: "dockercompose" + auto-generated hash |
40
+
|DockerComposeProjectsToIgnore| Specifies projects to be ignored by Docker Compose tools during debug. This property can be used for any project. File paths can be specified one of two ways: <br> 1. Relative to dcproj. For example, `<DockerComposeProjectsToIgnore> path\to\AngularProject1.csproj </DockerComposeProjectsToIgnore>`. <br> 2. Absolute paths.<br> **Note**: The paths should be separated by the delimiter character `;`.|
41
+
|DockerComposeUpArguments|Specifies the extra parameters to pass to the `docker-compose up` command. For example, `--timeout 500`.|
42
+
|DockerDevelopmentMode | Controls whether the user project is built in the container. The allowed values of **Fast** or **Regular** control [which stages are built](https://aka.ms/containerfastmode) in a Dockerfile. The Debug configuration is Fast mode by default and Regular mode otherwise. <br/><br/>Default value: Fast |
43
+
|DockerLaunchAction | Specifies the launch action to perform on F5 or Ctrl+F5. Allowed values are None, LaunchBrowser, and LaunchWCFTestClient.<br/><br/>Default value: None |
44
+
|DockerLaunchBrowser | Indicates whether to launch the browser. Ignored if DockerLaunchAction is specified. <br/><br/>Default value: False |
45
+
|DockerServiceName| If DockerLaunchAction or DockerLaunchBrowser are specified, then DockerServiceName specifies which service referenced in the `docker-compose` file gets launched.|
46
+
|DockerServiceUrl | The URL to use when launching the browser. Valid replacement tokens are "{ServiceIPAddress}", "{ServicePort}", and "{Scheme}". For example: {Scheme}://{ServiceIPAddress}:{ServicePort}|
47
+
|DockerTargetOS | The target OS used when building the Docker image.|
48
+
49
+
In addition, the property `DockerComposeProjectPath` in a `.csproj` or `.vbproj` project file specifies the relative path to the Docker Compose project (`.dcproj`) file. Set this property when publishing the service project to find the associated image build settings stored in the *docker-compose.yml* file.
// mywebapi is the service name, as listed in docker-compose.yml.
@@ -312,14 +312,12 @@ Congratulations, you're running a Docker Compose application with a custom Docke
312
312
}
313
313
```
314
314
315
-
> [!NOTE]
316
-
> In real-world code, you shouldn't dispose `HttpClient` after every request. For best practices, see [Use HttpClientFactory to implement resilient HTTP requests](/dotnet/architecture/microservices/implement-resilient-applications/use-httpclientfactory-to-implement-resilient-http-requests).
317
-
318
-
The URI given references a service name defined in the *docker-compose.yml* file. Docker Compose sets up a default network for communication between containers using the listed service names as hosts.
315
+
> [!NOTE]
316
+
> In real-world code, you shouldn't dispose `HttpClient` after every request. For best practices, see [Use HttpClientFactory to implement resilient HTTP requests](/dotnet/architecture/microservices/implement-resilient-applications/use-httpclientfactory-to-implement-resilient-http-requests).
319
317
320
-
The code shown here works with .NET 8 and later, which sets up a user account in the Dockerfile without administrator privileges, and exposes port 8080 because the HTTP default port 80 is not accessible without elevated privilege.
318
+
The URI given references a service name defined in the *docker-compose.yml* file. Docker Compose sets up a default network for communication between containers using the listed service names as hosts.
321
319
322
-
The delay is used here as a workaround for .NET 8 only, because this example code could run immediately on application launch, before the MyWebAPI service is ready to receive web requests.
320
+
The code shown here works with .NET 8 and later, which sets up a user account in the Dockerfile without administrator privileges, and exposes port 8080 because the HTTP default port 80 is not accessible without elevated privilege.
323
321
324
322
1. In the `Index.cshtml` file, add a line to display `ViewData["Message"]` so that the file looks like the following code:
325
323
@@ -337,7 +335,7 @@ Congratulations, you're running a Docker Compose application with a custom Docke
337
335
</div>
338
336
```
339
337
340
-
This code displays the value of the counter returned from the Web API project.
338
+
This code displays the value of the counter returned from the Web API project. It increments every time the user accesses or refreshes the page.
341
339
342
340
## Add Docker Compose support
343
341
@@ -403,6 +401,61 @@ Congratulations, you're running a Docker Compose application with a custom Docke
403
401
404
402
Make sure the indentation is at the same level as the other two services.
405
403
404
+
1. (Visual Studio 17.13 or later) The dependent services demonstrate a common problem. The HTTP request in the front end's main page could run immediately on application launch, before the `mywebapi` service is ready to receive web requests. If you're using Visual Studio 17.13 or later, you can use the Docker Compose features `depends_on` and `healthcheck` in *docker-compose.yml* to make the projects start in the right sequence, and have them be ready to serve requests when required. See [Docker Compose - Startup order](https://docs.docker.com/compose/how-tos/startup-order/).
405
+
406
+
```yml
407
+
services:
408
+
webfrontend:
409
+
image: ${DOCKER_REGISTRY-}webfrontend
410
+
depends_on:
411
+
mywebapi:
412
+
condition: service_healthy
413
+
build:
414
+
context: .
415
+
dockerfile: WebFrontEnd/Dockerfile
416
+
417
+
mywebapi:
418
+
image: ${DOCKER_REGISTRY-}mywebapi
419
+
depends_on:
420
+
redis:
421
+
condition: service_started
422
+
healthcheck:
423
+
test: curl --fail http://mywebapi:8080/ || exit 1
424
+
interval: 20s
425
+
timeout: 20s
426
+
retries: 5
427
+
build:
428
+
context: .
429
+
dockerfile: MyWebAPI/Dockerfile
430
+
431
+
redis:
432
+
image: redis
433
+
```
434
+
435
+
In this example, the health check uses `curl` to verify that the service is ready to process requests. If the image you're using doesn't have `curl` installed, add lines to the `base` stage of the MyWebAPI Dockerfile to install it. This step requires elevated privileges, but you can restore the normal user privileges after installing it as shown here (for the Debian images used in this example):
436
+
437
+
```dockerfile
438
+
USER root
439
+
RUN apt-get update && apt-get install -y curl
440
+
USER $APP_UID
441
+
```
442
+
443
+
> [!NOTE]
444
+
> If you're using a Linux distro, like Alpine, that doesn't support `apt-get`, try `RUN apk --no-cache add curl` instead.
445
+
446
+
These Docker Compose features require a property setting in the Docker Compose project file (`.dcproj`). Set the property `DependencyAwareStart` to true:
447
+
448
+
```xml
449
+
<PropertyGroup>
450
+
<!-- existing properties -->
451
+
<DependencyAwareStart>true</DependencyAwareStart>
452
+
</PropertyGroup>
453
+
```
454
+
455
+
This property activates a different way of starting the containers for debugging that supports the service dependency features.
456
+
457
+
With these changes, the `webfrontend` service will not start until `mywebapi` starts and successfully handles a web request.
458
+
406
459
1. The first project that you add container orchestration to is set up to be launched when you run or debug. You can configure the launch action in the **Project Properties** for the Docker Compose project. On the Docker Compose project node, right-click to open the context menu, and then choose **Properties**, or use **Alt**+**Enter**. For example, you can change the page that is loaded by customizing the **Service URL** property.
407
460
408
461
Copy file name to clipboardExpand all lines: docs/get-started/tutorial-open-project-from-repo.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
title: "Tutorial: Open project from repo in Visual Studio"
3
3
description: In this tutorial, learn how to open a cloned project in a Git or Azure DevOps repository by using Visual Studio and view files in Solution Explorer.
4
4
ms.custom: vs-acquisition
5
-
ms.date: 12/02/2024
5
+
ms.date: 12/19/2024
6
6
ms.subservice: general-ide
7
7
ms.topic: tutorial
8
8
author: anandmeg
@@ -314,5 +314,7 @@ For more information, see:
314
314
::: moniker range="vs-2022"
315
315
316
316
-[About Git in Visual Studio](../version-control/git-with-visual-studio.md)
317
+
-[Brpwse a repo](../version-control/git-browse-repository.md)
318
+
-[Manage a repo](../version-control/git-manage-repository.md)
0 commit comments