Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✅ Merge main into live #126

Merged
merged 4 commits into from
Dec 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,21 @@ updates:
interval: "weekly"
day: "wednesday"
open-pull-requests-limit: 5
- package-ecosystem: "nuget"
directory: "/docs/storage/snippets/tutorial/AspireStorage/AspireStorage.AppHost" #AspireStorage.AppHost.csproj
schedule:
interval: "weekly"
day: "wednesday"
open-pull-requests-limit: 5
- package-ecosystem: "nuget"
directory: "/docs/storage/snippets/tutorial/AspireStorage/AspireStorage.ServiceDefaults" #AspireStorage.ServiceDefaults.csproj
schedule:
interval: "weekly"
day: "wednesday"
open-pull-requests-limit: 5
- package-ecosystem: "nuget"
directory: "/docs/storage/snippets/tutorial/AspireStorage/AspireStorage.Worker" #AspireStorage.Worker.csproj
schedule:
interval: "weekly"
day: "wednesday"
open-pull-requests-limit: 5
4 changes: 3 additions & 1 deletion docs/components-overview.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
---
title: .NET Aspire components overview
description: Explore the fundamental concepts of .NET Aspire components and learn how to integrate them into your apps.
ms.date: 11/15/2023
ms.date: 12/03/2023
ms.topic: conceptual
---

# .NET Aspire components overview

.NET Aspire components are a curated suite of NuGet packages specifically selected to facilitate the integration of cloud-native applications with prominent services and platforms, including but not limited to Redis and PostgreSQL. Each component furnishes essential cloud-native functionalities through either automatic provisioning or standardized configuration patterns.

For more information on working with .NET Aspire components in Visual Studio, see [Visual Studio tooling](setup-tooling.md#visual-studio-tooling).

## Available components

The following table lists the .NET Aspire components currently available for use:
Expand Down
2 changes: 1 addition & 1 deletion docs/deployment/azure/includes/aca-deployment-azd.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,6 @@ Once AZD has been initialized, the provisioning and deployment process can be ex

Once `provision` is complete, `azd deploy` will take place. During this phase, the projects are pushed as containers into an Azure Container Registry instance, and then used to create new revisions of Azure Container Apps in which the code will be hosted.

:::image type="content" source="../media/aspire-azd-06.png" lightbox="../media/aspire-azd-07.png" alt-text="AZD deploying the application code":::
:::image type="content" source="../media/aspire-azd-07.png" lightbox="../media/aspire-azd-07.png" alt-text="AZD deploying the application code":::

At this point the app has been deployed and configured, and you can open the Azure portal and explore the resources.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 17 additions & 5 deletions docs/setup-tooling.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: .NET Aspire tooling
description: Learn about essential tooling concepts for .NET Aspire.
ms.date: 12/01/2023
ms.date: 12/04/2023
---

# .NET Aspire setup and tooling
Expand All @@ -26,7 +26,7 @@ To work with .NET Aspire, you'll need the following installed locally:
- [Visual Studio 2022 Preview](https://visualstudio.microsoft.com/vs/preview/) version 17.9 or higher (Optional)
- [Visual Studio Code](https://code.visualstudio.com/) (Optional)

The .NET Aspire workload installs internal dependencies and makes available other tooling, such as project templates and Visual Studio features. There are two ways to install the .NET Aspire workload. If you prefer to use Visual Studio Code, following the .NET CLI instructions:
The .NET Aspire workload installs internal dependencies and makes available other tooling, such as project templates and Visual Studio features. There are two ways to install the .NET Aspire workload. If you prefer to use Visual Studio Code, follow the .NET CLI instructions:

# [Visual Studio](#tab/visual-studio)

Expand Down Expand Up @@ -135,24 +135,34 @@ Visual Studio provides additional features for working with .NET Aspire componen

### Enable .NET Aspire preview support

In Visual Studio, you can enable preview support for .NET Aspire components and project templates. To enable preview support, select **Tools** > **Options** > and in the **Search Settings** textbox enter "aspire", then ensure that the **Enable .NET Aspire preview support** is checked:
In Visual Studio, you can enable preview support for .NET Aspire components and project templates. To enable preview support, select **Tools** > **Options** > and in the **Search Settings** textbox enter "aspire", then ensure that the **Enable support for .NET Aspire** is checked:

:::image type="content" source="media/visual-studio-tools-options-aspire.png" lightbox="media/visual-studio-tools-options-aspire.png" alt-text="Visual Studio 2022, enable .NET Aspire preview support.":::

Likewise, you can disable preview support by unchecking the **Enable .NET Aspire preview support** option.

### Add a component

You can add .NET Aspire components to your app like any other NuGet package using Visual Studio. However, Visual Studio also provides UI options to add .NET Aspire components directly.
You add .NET Aspire components to your app like any other NuGet package using Visual Studio. However, Visual Studio also provides UI options to add .NET Aspire components directly. You need to first enable preview support for .NET Aspire components in Visual Studio. For information see, [Enable .NET Aspire preview support](#enable-net-aspire-preview-support).

1. In Visual Studio, right click on the project you want to add an .NET Aspire component to and select **Add** > **.NET Aspire Component...**.
1. The package manager will open with search results pre-configured for .NET Aspire components, allowing you to easily browse and select the desired component.

:::image type="content" source="media/visual-studio-add-aspire-component.png" lightbox="media/visual-studio-add-aspire-component.png" alt-text="The Visual Studio context menu displaying the Add .NET Aspire Component option.":::

1. The package manager will open with search results pre-configured (populating filter criteria) for .NET Aspire components, allowing you to easily browse and select the desired component. The **Include prerelease** checkbox needs to be checked to see preview components.

:::image type="content" source="media/visual-studio-add-aspire-comp-nuget.png" lightbox="media/visual-studio-add-aspire-comp-nuget.png" alt-text="The Visual Studio context menu displaying the Add .NET Aspire options.":::

For more information on .NET Aspire components, see [.NET Aspire components overview](components-overview.md).

### Add orchestration projects

You can add .NET Aspire orchestration projects to an existing app using the following steps:

1. In Visual Studio, right click on an existing project and select **Add** > **.NET Aspire Orchestrator Support..**.

:::image type="content" source="media/visual-studio-add-aspire-orchestrator.png" lightbox="media/visual-studio-add-aspire-orchestrator.png" alt-text="The Visual Studio context menu displaying the Add .NET Aspire Orchestrator Support option.":::

1. A dialog window will open with a summary of the **.AppHost** and **.ServiceDefaults** projects that will be added to your solution.

:::image type="content" source="media/add-orchestrator-app.png" alt-text="A screenshot showing the Visual Studio add .NET Aspire orchestration summary.":::
Expand All @@ -163,6 +173,8 @@ You can add .NET Aspire orchestration projects to an existing app using the foll
- A call to `builder.AddServiceDefaults` will be added to the _Program.cs_ file of your original project.
- A reference to your original project will be added to the _Program.cs_ file of the **.AppHost** project.

For more information on .NET Aspire orchestration, see [.NET Aspire orchestration overview](app-host-overview.md).

### Enlist in orchestration

Visual Studio provides the option to **Enlist in Aspire orchestration** during the new project workflow. Select this option to have Visual Studio create **.AppHost** and **.ServiceDefault** projects alongside your selected project template.
Expand Down
Loading