Skip to content

Commit db8de0c

Browse files
authored
Add Rancher Desktop details (#3672)
* WIP, backlog * Clarify rancher desktop support * Edit pass * Fix matrix * Remove dup section from bad rebase * Adjust text based on peer feedback * Update rancher support scenarios * Quick edit pass
1 parent a7616c8 commit db8de0c

File tree

3 files changed

+19
-12
lines changed

3 files changed

+19
-12
lines changed

docs/fundamentals/setup-tooling.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: .NET Aspire tooling
33
description: Learn about essential tooling concepts for .NET Aspire.
4-
ms.date: 04/15/2025
4+
ms.date: 05/30/2025
55
zone_pivot_groups: dev-environment
66
uid: dotnet/aspire/setup-tooling
77
---
@@ -23,7 +23,9 @@ To work with .NET Aspire, you need the following installed locally:
2323

2424
- [.NET 8.0](https://dotnet.microsoft.com/download/dotnet/8.0) or [.NET 9.0](https://dotnet.microsoft.com/download/dotnet/9.0).
2525
- An OCI compliant container runtime, such as:
26-
- [Docker Desktop](https://www.docker.com/products/docker-desktop) or [Podman](https://podman.io/). For more information, see [Container runtime](#container-runtime).
26+
- [Docker Desktop](https://www.docker.com/products/docker-desktop)
27+
- [Podman](https://podman.io/)
28+
- _For more information, see [Container runtime](#container-runtime)_.
2729
- An Integrated Developer Environment (IDE) or code editor, such as:
2830
- [Visual Studio 2022](https://visualstudio.microsoft.com/vs/) version 17.9 or higher (Optional)
2931
- [Visual Studio Code](https://code.visualstudio.com/) (Optional)
@@ -102,7 +104,7 @@ dotnet new install Aspire.ProjectTemplates::9.3.0
102104

103105
:::zone pivot="visual-studio"
104106

105-
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 (<kbd>Alt</kbd>+<kbd>S</kbd>). You'll see a list of available .NET Aspire project templates:
107+
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 (<kbd>Alt</kbd>+<kbd>S</kbd>). You see a list of available .NET Aspire project templates:
106108

107109
:::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":::
108110

@@ -136,7 +138,12 @@ For more information, see [.NET Aspire templates](aspire-sdk-templates.md).
136138

137139
## Container runtime
138140

139-
.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`:
141+
.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.
142+
143+
- [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.
144+
- [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.
145+
146+
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`:
140147

141148
## [Linux](#tab/linux)
142149

@@ -174,7 +181,7 @@ The .NET Aspire dashboard is also available in a standalone mode. For more infor
174181

175182
## Visual Studio tooling
176183

177-
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.
184+
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.
178185

179186
### Add an integration package
180187

@@ -192,7 +199,7 @@ For more information on .NET Aspire integrations, see [.NET Aspire integrations
192199

193200
### Add hosting packages
194201

195-
.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:
202+
.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:
196203

197204
1. In Visual Studio, right select on the _*.AppHost_ project and select **Add** > **.NET Aspire package...**.
198205

docs/index.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ metadata:
1111
description: Learn about .NET Aspire, a cloud-ready stack for building distributed applications. Browse API reference, tutorials, and more.
1212
ms.topic: hub-page
1313
ms.service: dotnet-aspire
14-
ms.date: 02/25/2025
14+
ms.date: 05/30/2025
1515

1616
highlightedContent:
1717
items:
@@ -360,7 +360,7 @@ additionalContent:
360360
items:
361361
- title: ".NET Aspire API reference"
362362
summary: API reference documentation for .NET Aspire
363-
url: /dotnet/api?view=dotnet-aspire-9.2&preserve-view=true
363+
url: /dotnet/api?view=dotnet-aspire-9.3&preserve-view=true
364364
- title: ".NET API reference"
365365
summary: API reference documentation for .NET
366366
url: /dotnet/api?view=net-9.0&preserve-view=true

docs/toc.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -226,9 +226,9 @@ items:
226226
displayName: web pubsub,real-time,messaging
227227
href: messaging/azure-web-pubsub-integration.md
228228
- name: Aspire.Hosting.Azure API reference
229-
href: /dotnet/api/?term=Aspire.Hosting.Azure&view=dotnet-aspire-9.2&preserve-view=true
229+
href: /dotnet/api/?term=Aspire.Hosting.Azure&view=dotnet-aspire-9.3&preserve-view=true
230230
- name: Aspire.Azure API reference
231-
href: /dotnet/api/?term=Aspire.Azure&view=dotnet-aspire-9.2&preserve-view=true
231+
href: /dotnet/api/?term=Aspire.Azure&view=dotnet-aspire-9.3&preserve-view=true
232232
- name: Elasticsearch
233233
displayName: elasticsearch,search
234234
href: search/elasticsearch-integration.md
@@ -371,7 +371,7 @@ items:
371371
- name: RavenDB
372372
href: community-toolkit/ravendb.md
373373
- name: Aspire.Hosting API reference
374-
href: /dotnet/api/?term=Aspire.Hosting&view=dotnet-aspire-9.2&preserve-view=true
374+
href: /dotnet/api/?term=Aspire.Hosting&view=dotnet-aspire-9.3&preserve-view=true
375375

376376
- name: Custom integrations
377377
items:
@@ -507,7 +507,7 @@ items:
507507
- name: Publishing to Azure APIs are experimental
508508
href: diagnostics/aspireazure001.md
509509
- name: .NET Aspire API reference
510-
href: /dotnet/api?view=dotnet-aspire-9.2&preserve-view=true
510+
href: /dotnet/api?view=dotnet-aspire-9.3&preserve-view=true
511511
- name: .NET Aspire FAQ
512512
displayName: iis,functions,deploy,azure,kubernetes
513513
href: reference/aspire-faq.yml

0 commit comments

Comments
 (0)