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.

Sign up for GitHub

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

Jump to bottom

✅ Merge main into live #1402

Merged
merged 3 commits into from
Jul 24, 2024
Merged

✅ Merge main into live #1402

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eef49d2
Add missing resources from new hosting packages (#1399)
IEvangelist Jul 23, 2024
c95ad4c
Kafka UI mention. (#1401)
mitchdenny Jul 24, 2024
289b259
Taking ownership of some things (#1400)
CamSoper Jul 24, 2024
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
10 changes: 8 additions & 2 deletions docfx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,10 +103,16 @@
"docs/**/*.*": "csharp"
},
"author": {
"docs/**/*.*": "IEvangelist"
"docs/**/*.*": "IEvangelist",
"docs/database/**/*.*": "CamSoper",
"docs/storage/**/*.*": "CamSoper",
"docs/messaging/**/*.*": "CamSoper"
},
"ms.author": {
"docs/**/*.*": "dapine"
"docs/**/*.*": "dapine",
"docs/database/**/*.*": "casoper",
"docs/storage/**/*.*": "casoper",
"docs/messaging/**/*.*": "casoper"
},
"ms.collection": {
"docs/azureai/**/*.md": "ce-skilling-ai-copilot"
Expand Down
28 changes: 21 additions & 7 deletions docs/fundamentals/app-host-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Each resource must be uniquely named. This diagram shows each resource and the r

## Built-in resource types

.NET Aspire projects are made up of a set of resources. There are three base types of compute resources:
.NET Aspire projects are made up of a set of resources. There are three base types of compute resources from the primary [Aspire.Hosting.AppHost](https://www.nuget.org/packages/Aspire.Hosting.AppHost) Nuget package:

| Method | Resource type | Description |
|--|--|--|
Expand Down Expand Up @@ -189,31 +189,43 @@ Beyond the base resource types, <xref:Aspire.Hosting.ApplicationModel.ProjectRes

**Cloud-agnostic resources are available in the following NuGet packages:**

- [📦 Aspire.Hosting.Dapr](https://www.nuget.org/packages/Aspire.Hosting.Dapr)
- [📦 Aspire.Hosting.Elasticsearch](https://www.nuget.org/packages/Aspire.Hosting.Elasticsearch)
- [📦 Aspire.Hosting.Kafka](https://www.nuget.org/packages/Aspire.Hosting.Kafka)
- [📦 Aspire.Hosting.Keycloak](https://www.nuget.org/packages/Aspire.Hosting.Keycloak)
- [📦 Aspire.Hosting.Milvus](https://www.nuget.org/packages/Aspire.Hosting.Milvus)
- [📦 Aspire.Hosting.MongoDB](https://www.nuget.org/packages/Aspire.Hosting.MongoDB)
- [📦 Aspire.Hosting.MySql](https://www.nuget.org/packages/Aspire.Hosting.MySql)
- [📦 Aspire.Hosting.Nats](https://www.nuget.org/packages/Aspire.Hosting.Nats)
- [📦 Aspire.Hosting.NodeJs](https://www.nuget.org/packages/Aspire.Hosting.NodeJs)
- [📦 Aspire.Hosting.Oracle](https://www.nuget.org/packages/Aspire.Hosting.Oracle)
- [📦 Aspire.Hosting.Orleans](https://www.nuget.org/packages/Aspire.Hosting.Orleans)
- [📦 Aspire.Hosting.PostgreSQL](https://www.nuget.org/packages/Aspire.Hosting.PostgreSQL)
- [📦 Aspire.Hosting.Python](https://www.nuget.org/packages/Aspire.Hosting.Python)
- [📦 Aspire.Hosting.Qdrant](https://www.nuget.org/packages/Aspire.Hosting.Qdrant)
- [📦 Aspire.Hosting.RabbitMQ](https://www.nuget.org/packages/Aspire.Hosting.RabbitMQ)
- [📦 Aspire.Hosting.Redis](https://www.nuget.org/packages/Aspire.Hosting.Redis)
- [📦 Aspire.Hosting.Seq](https://www.nuget.org/packages/Aspire.Hosting.Seq)
- [📦 Aspire.Hosting.SqlServer](https://www.nuget.org/packages/Aspire.Hosting.SqlServer)
- [📦 Aspire.Hosting.Testing](https://www.nuget.org/packages/Aspire.Hosting.Testing)

| Method | Resource type | Description |
|--|--|--|
| `AddMongoDB(...)` | `MongoDBServerResource` | Adds a MongoDB server resource. |
| `AddMySql(...)` | `MySqlServerResource` | Adds a MySql server resource. |
| `AddNodeApp(...)` | `NodeAppResource` | Adds a Node.js app resource. |
| `AddNpmApp(...)` | `NodeAppResource` | Adds a Node.js app resource that wraps an [NPM](https://www.npmjs.com/) package. |
| `AddPostgres(...).`<xref:Aspire.Hosting.PostgresBuilderExtensions.AddDatabase%2A> | <xref:Aspire.Hosting.ApplicationModel.PostgresDatabaseResource> | Adds a Postgres database resource. |
| `AddSqlServer(...).`<xref:Aspire.Hosting.SqlServerBuilderExtensions.AddDatabase%2A> | <xref:Aspire.Hosting.ApplicationModel.SqlServerDatabaseResource> | Adds a SQL Server database resource. |
| <xref:Aspire.Hosting.ElasticsearchBuilderExtensions.AddElasticsearch*> | <xref:Aspire.Hosting.ApplicationModel.ElasticsearchResource> | Adds an Elasticsearch container resource to the application model. |
| <xref:Aspire.Hosting.KeycloakResourceBuilderExtensions.AddKeycloak*> | <xref:Aspire.Hosting.ApplicationModel.KeycloakResource> | Adds a Keycloak container to the application model. |
| <xref:Aspire.Hosting.MilvusBuilderExtensions.AddMilvus*> | <xref:Aspire.Hosting.Milvus.MilvusServerResource> | Adds a Milvus resource to the application. |
| <xref:Aspire.Hosting.MongoDBBuilderExtensions.AddMongoDB*> | <xref:Aspire.Hosting.ApplicationModel.MongoDBServerResource> | Adds a MongoDB server resource. |
| <xref:Aspire.Hosting.MySqlBuilderExtensions.AddMySql*> | <xref:Aspire.Hosting.ApplicationModel.MySqlServerResource> | Adds a MySql server resource. |
| <xref:Aspire.Hosting.NodeAppHostingExtension.AddNodeApp*> | <xref:Aspire.Hosting.NodeAppResource> | Adds a Node.js app resource. |
| <xref:Aspire.Hosting.NodeAppHostingExtension.AddNpmApp*> | <xref:Aspire.Hosting.NodeAppResource> | Adds a Node.js app resource that wraps an [NPM](https://www.npmjs.com/) package. |
| <xref:Aspire.Hosting.PostgresBuilderExtensions.AddPostgres%2A> | <xref:Aspire.Hosting.ApplicationModel.PostgresServerResource> | Adds a Postgres server resource. |
| `AddPostgres(...).`<xref:Aspire.Hosting.PostgresBuilderExtensions.AddDatabase%2A> | <xref:Aspire.Hosting.ApplicationModel.PostgresDatabaseResource> | Adds a Postgres database resource. |
| <xref:Aspire.Hosting.PythonProjectResourceBuilderExtensions.AddPythonProject*> | <xref:Aspire.Hosting.Python.PythonProjectResource> | Adds a python application with a virtual environment to the application model. |
| <xref:Aspire.Hosting.QdrantBuilderExtensions.AddQdrant*> | <xref:Aspire.Hosting.ApplicationModel.QdrantServerResource> | Adds a Qdrant server resource. |
| <xref:Aspire.Hosting.RabbitMQBuilderExtensions.AddRabbitMQ%2A> | <xref:Aspire.Hosting.ApplicationModel.RabbitMQServerResource> | Adds a RabbitMQ server resource. |
| <xref:Aspire.Hosting.RedisBuilderExtensions.AddRedis%2A> | <xref:Aspire.Hosting.ApplicationModel.RedisResource> | Adds a Redis container resource. |
| <xref:Aspire.Hosting.SqlServerBuilderExtensions.AddSqlServer%2A> | <xref:Aspire.Hosting.ApplicationModel.SqlServerServerResource> | Adds a SQL Server server resource. |
| `AddSqlServer(...).`<xref:Aspire.Hosting.SqlServerBuilderExtensions.AddDatabase%2A> | <xref:Aspire.Hosting.ApplicationModel.SqlServerDatabaseResource> | Adds a SQL Server database resource. |

**Azure specific resources are available in the following NuGet packages:**

Expand All @@ -233,6 +245,7 @@ Beyond the base resource types, <xref:Aspire.Hosting.ApplicationModel.ProjectRes
- [📦 Aspire.Hosting.Azure.SignalR](https://www.nuget.org/packages/Aspire.Hosting.Azure.SignalR)
- [📦 Aspire.Hosting.Azure.Sql](https://www.nuget.org/packages/Aspire.Hosting.Azure.Sql)
- [📦 Aspire.Hosting.Azure.Storage](https://www.nuget.org/packages/Aspire.Hosting.Azure.Storage)
- [📦 Aspire.Hosting.Azure.WebPubSub](https://www.nuget.org/packages/Aspire.Hosting.Azure.WebPubSub)

| Method | Resource type | Description |
|--|--|--|
Expand All @@ -245,6 +258,7 @@ Beyond the base resource types, <xref:Aspire.Hosting.ApplicationModel.ProjectRes
| `AddRedis(...)`.<xref:Aspire.Hosting.AzureRedisExtensions.AsAzureRedis%2A> | <xref:Aspire.Hosting.Azure.AzureRedisResource> | Configures resource to use Azure for local development and when doing a deployment via the Azure Developer CLI. |
| `AddSqlServer(...)`.<xref:Aspire.Hosting.AzureSqlExtensions.AsAzureSqlDatabase%2A> | <xref:Aspire.Hosting.Azure.AzureSqlServerResource> | Configures SQL Server resource to be deployed as Azure SQL Database (server). |
| <xref:Aspire.Hosting.AzureServiceBusExtensions.AddAzureServiceBus%2A> | <xref:Aspire.Hosting.Azure.AzureServiceBusResource> | Adds an Azure Service Bus resource. |
| <xref:Aspire.Hosting.AzureWebPubSubExtensions.AddAzureWebPubSub%2A> | <xref:Aspire.Hosting.ApplicationModel.AzureWebPubSubResource> | Adds an Azure Web PubSub resources. |

> [!IMPORTANT]
> The .NET Aspire Azure hosting libraries rely on `Azure.Provisioning.*` libraries to provision Azure resources. For more information, [Azure provisioning libraries](../deployment/azure/local-provisioning.md#azure-provisioning-libraries).
Expand Down
5 changes: 3 additions & 2 deletions docs/messaging/kafka-component.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,13 +71,14 @@ In your app host project, register a Kafka container and consume the connection
```csharp
var builder = DistributedApplication.CreateBuilder(args);

var messaging = builder.AddKafka("messaging");
var messaging = builder.AddKafka("messaging")
.WithKafkaUI();

var myService = builder.AddProject<Projects.MyService>()
.WithReference(messaging);
```

The `WithReference` method configures a connection in the `MyService` project named `messaging`. In the _:::no-loc text="Program.cs":::_ file of `MyService`, the Apache Kafka broker connection can be consumed using:
The `WithKafkaUI()` extension method which provides a web-based interface to view the state of the Kafka container instance. The `WithReference` method configures a connection in the `MyService` project named `messaging`. In the _:::no-loc text="Program.cs":::_ file of `MyService`, the Apache Kafka broker connection can be consumed using:

```csharp
builder.AddKafkaProducer<string, string>("messaging");
Expand Down
Loading