diff --git a/docs/fundamentals/setup-tooling.md b/docs/fundamentals/setup-tooling.md index d30c1f11ab..a4fb2e10ef 100644 --- a/docs/fundamentals/setup-tooling.md +++ b/docs/fundamentals/setup-tooling.md @@ -1,7 +1,7 @@ --- title: .NET Aspire tooling description: Learn about essential tooling concepts for .NET Aspire. -ms.date: 04/15/2025 +ms.date: 05/30/2025 zone_pivot_groups: dev-environment uid: dotnet/aspire/setup-tooling --- @@ -23,7 +23,9 @@ To work with .NET Aspire, you need the following installed locally: - [.NET 8.0](https://dotnet.microsoft.com/download/dotnet/8.0) or [.NET 9.0](https://dotnet.microsoft.com/download/dotnet/9.0). - An OCI compliant container runtime, such as: - - [Docker Desktop](https://www.docker.com/products/docker-desktop) or [Podman](https://podman.io/). For more information, see [Container runtime](#container-runtime). + - [Docker Desktop](https://www.docker.com/products/docker-desktop) + - [Podman](https://podman.io/) + - _For more information, see [Container runtime](#container-runtime)_. - An Integrated Developer Environment (IDE) or code editor, such as: - [Visual Studio 2022](https://visualstudio.microsoft.com/vs/) version 17.9 or higher (Optional) - [Visual Studio Code](https://code.visualstudio.com/) (Optional) @@ -102,7 +104,7 @@ dotnet new install Aspire.ProjectTemplates::9.3.0 :::zone pivot="visual-studio" -The .NET Aspire templates are installed automatically when you install Visual Studio 17.9 or later. To see what .NET Aspire templates are available, select **File** > **New** > **Project** in Visual Studio, and search for "Aspire" in the search bar (Alt+S). You'll see a list of available .NET Aspire project templates: +The .NET Aspire templates are installed automatically when you install Visual Studio 17.9 or later. To see what .NET Aspire templates are available, select **File** > **New** > **Project** in Visual Studio, and search for "Aspire" in the search bar (Alt+S). You see a list of available .NET Aspire project templates: :::image type="content" source="media/vs-create-dotnet-aspire-proj.png" alt-text="Visual Studio: Create new project and search for 'Aspire'." lightbox="media/vs-create-dotnet-aspire-proj.png"::: @@ -136,7 +138,12 @@ For more information, see [.NET Aspire templates](aspire-sdk-templates.md). ## Container runtime -.NET Aspire projects are designed to run in containers. You can use either Docker Desktop or Podman as your container runtime. [Docker Desktop](https://www.docker.com/products/docker-desktop/) is the most common container runtime. [Podman](https://podman.io/docs/installation) is an open-source daemonless alternative to Docker, that can build and run Open Container Initiative (OCI) containers. If your host environment has both Docker and Podman installed, .NET Aspire defaults to using Docker. You can instruct .NET Aspire to use Podman instead, by setting the `ASPIRE_CONTAINER_RUNTIME` environment variable to `podman`: +.NET Aspire can run containers using several OCI-compatible runtimes, including Docker Desktop and Podman. While some users have reported success using [Rancher Desktop](https://rancherdesktop.io/)—particularly when configured to use the Docker CLI—this isn't an officially supported or regularly tested scenario. It might be possible to use Rancher Desktop with the default installation, but it's not an officially supported or validated approach. If you encounter issues with Rancher Desktop, please let us know, but be aware that fixes might not be prioritized. + +- [Docker Desktop](https://www.docker.com/products/docker-desktop/) is the most popular container runtime among .NET Aspire developers, offering a familiar and widely supported environment for building and running containers. +- [Podman](https://podman.io/docs/installation) is an open-source, daemonless alternative to Docker. It supports building and running Open Container Initiative (OCI) containers, making it a flexible choice for developers who prefer a lightweight solution. + +If your host environment has a Docker and Podman installed, .NET Aspire defaults to using Docker. You can instruct .NET Aspire to use Podman instead, by setting the `DOTNET_ASPIRE_CONTAINER_RUNTIME` environment variable to `podman`: ## [Linux](#tab/linux) @@ -174,7 +181,7 @@ The .NET Aspire dashboard is also available in a standalone mode. For more infor ## Visual Studio tooling -Visual Studio provides additional features for working with .NET Aspire integrations and the App Host orchestrator project. Not all of these features are currently available in Visual Studio Code or through the CLI. +Visual Studio provides extra features for working with .NET Aspire integrations and the App Host orchestrator project. Not all of these features are currently available in Visual Studio Code or through the CLI. ### Add an integration package @@ -192,7 +199,7 @@ For more information on .NET Aspire integrations, see [.NET Aspire integrations ### Add hosting packages -.NET Aspire hosting packages are used to configure various resources and dependencies an app may depend on or consume. Hosting packages are differentiated from other integration packages in that they're added to the _*.AppHost_ project. To add a hosting package to your app, follow these steps: +.NET Aspire hosting packages are used to configure various resources and dependencies an app might depend on or consume. Hosting packages are differentiated from other integration packages in that they're added to the _*.AppHost_ project. To add a hosting package to your app, follow these steps: 1. In Visual Studio, right select on the _*.AppHost_ project and select **Add** > **.NET Aspire package...**. diff --git a/docs/index.yml b/docs/index.yml index 0364d53fab..ff0f19b752 100644 --- a/docs/index.yml +++ b/docs/index.yml @@ -11,7 +11,7 @@ metadata: description: Learn about .NET Aspire, a cloud-ready stack for building distributed applications. Browse API reference, tutorials, and more. ms.topic: hub-page ms.service: dotnet-aspire - ms.date: 02/25/2025 + ms.date: 05/30/2025 highlightedContent: items: @@ -360,7 +360,7 @@ additionalContent: items: - title: ".NET Aspire API reference" summary: API reference documentation for .NET Aspire - url: /dotnet/api?view=dotnet-aspire-9.2&preserve-view=true + url: /dotnet/api?view=dotnet-aspire-9.3&preserve-view=true - title: ".NET API reference" summary: API reference documentation for .NET url: /dotnet/api?view=net-9.0&preserve-view=true diff --git a/docs/toc.yml b/docs/toc.yml index 5d8802fc9f..4e4bdefe24 100644 --- a/docs/toc.yml +++ b/docs/toc.yml @@ -226,9 +226,9 @@ items: displayName: web pubsub,real-time,messaging href: messaging/azure-web-pubsub-integration.md - name: Aspire.Hosting.Azure API reference - href: /dotnet/api/?term=Aspire.Hosting.Azure&view=dotnet-aspire-9.2&preserve-view=true + href: /dotnet/api/?term=Aspire.Hosting.Azure&view=dotnet-aspire-9.3&preserve-view=true - name: Aspire.Azure API reference - href: /dotnet/api/?term=Aspire.Azure&view=dotnet-aspire-9.2&preserve-view=true + href: /dotnet/api/?term=Aspire.Azure&view=dotnet-aspire-9.3&preserve-view=true - name: Elasticsearch displayName: elasticsearch,search href: search/elasticsearch-integration.md @@ -371,7 +371,7 @@ items: - name: RavenDB href: community-toolkit/ravendb.md - name: Aspire.Hosting API reference - href: /dotnet/api/?term=Aspire.Hosting&view=dotnet-aspire-9.2&preserve-view=true + href: /dotnet/api/?term=Aspire.Hosting&view=dotnet-aspire-9.3&preserve-view=true - name: Custom integrations items: @@ -507,7 +507,7 @@ items: - name: Publishing to Azure APIs are experimental href: diagnostics/aspireazure001.md - name: .NET Aspire API reference - href: /dotnet/api?view=dotnet-aspire-9.2&preserve-view=true + href: /dotnet/api?view=dotnet-aspire-9.3&preserve-view=true - name: .NET Aspire FAQ displayName: iis,functions,deploy,azure,kubernetes href: reference/aspire-faq.yml