Skip to content
Open
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
20 changes: 20 additions & 0 deletions src/frontend/src/content/docs/integrations/ai/github-models.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,26 @@ GitHub Models supports various AI models. Use the strongly-typed `GitHubModel` c

Check the [GitHub Models documentation](https://docs.github.com/github-models) for more information about these models and their capabilities.


### Connection properties

When you reference a GitHub Model resource using `WithReference`, the following connection properties are made available to the consuming project:

#### GitHub Model

The GitHub Model resource exposes the following connection properties:

| Property Name | Description |
|---------------|-------------|
| `Uri` | The GitHub Models inference endpoint URI, with the format `https://models.github.ai/inference` |
| `Key` | The API key (PAT or GitHub App token) for authentication |
| `Model` | The model identifier for inference requests, for instance `openai/gpt-4o-mini` |
| `Organization` | The organization attributed to the request (available when configured) |

<Aside type="note">
Aspire exposes each property as an environment variable named `[RESOURCE]_[PROPERTY]`. For instance, the `Uri` property of a resource called `chat` becomes `CHAT_URI`.
</Aside>

## Client integration

To get started with the Aspire GitHub Models client integration, you can use either the Azure AI Inference client or the OpenAI client, depending on your needs and model compatibility.
Expand Down
27 changes: 27 additions & 0 deletions src/frontend/src/content/docs/integrations/ai/openai.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,33 @@ The model name is case-insensitive, but we usually write it in lowercase.

For more information, see the [OpenAI models documentation](https://platform.openai.com/docs/models).


### Connection properties

When you reference an OpenAI resource using `WithReference`, the following connection properties are made available to the consuming project:

#### OpenAI

The OpenAI resource exposes the following connection properties:

| Property Name | Description |
|---------------|-------------|
| `Endpoint` | The base endpoint URI for the OpenAI API, with the format `https://api.openai.com/v1` |
| `Uri` | The endpoint URI (same as Endpoint), with the format `https://api.openai.com/v1` |
| `Key` | The API key for authentication |

#### OpenAI model

The OpenAI model resource combines the parent properties above and adds the following connection property:

| Property Name | Description |
|---------------|-------------|
| `Model` | The model identifier for inference requests, for instance `gpt-4o-mini` |

<Aside type="note">
Aspire exposes each property as an environment variable named `[RESOURCE]_[PROPERTY]`. For instance, the `Uri` property of a resource called `chat` becomes `CHAT_URI`.
</Aside>

## Client integration

To get started with the Aspire OpenAI client integration, install the [📦 Aspire.OpenAI](https://www.nuget.org/packages/Aspire.OpenAI) NuGet package:
Expand Down
20 changes: 20 additions & 0 deletions src/frontend/src/content/docs/integrations/caching/garnet.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,26 @@ var myService = builder.AddProject<Projects.ExampleProject>()

The preceding code adds persistence to the Garnet resource by taking snapshots of the data at a specified interval and threshold.


### Connection properties

When you reference a Garnet resource using `WithReference`, the following connection properties are made available to the consuming project:

#### Garnet

The Garnet resource exposes the following connection properties:

| Property Name | Description |
|---------------|-------------|
| `Host` | The hostname or IP address of the Garnet server |
| `Port` | The port number the Garnet server is listening on |
| `Password` | The password for authentication (available when a password parameter is configured) |
| `Uri` | The connection URI, with the format `redis://:{Password}@{Host}:{Port}` |

<Aside type="note">
Aspire exposes each property as an environment variable named `[RESOURCE]_[PROPERTY]`. For instance, the `Uri` property of a resource called `cache` becomes `CACHE_URI`.
</Aside>

### Hosting integration health checks

The Garnet hosting integration automatically adds a health check for the Garnet resource. The health check verifies that the Garnet instance is running and that a connection can be established to it.
Expand Down
20 changes: 20 additions & 0 deletions src/frontend/src/content/docs/integrations/caching/redis.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,26 @@ var myService = builder.AddProject<Projects.ExampleProject>()

The preceding code adds persistence to the Redis resource by taking snapshots of the Redis data at a specified interval and threshold.


### Connection properties

When you reference a Redis resource using `WithReference`, the following connection properties are made available to the consuming project:

#### Redis

The Redis resource exposes the following connection properties:

| Property Name | Description |
|---------------|-------------|
| `Host` | The hostname or IP address of the Redis server |
| `Port` | The port number the Redis server is listening on |
| `Password` | The password for authentication |
| `Uri` | The connection URI, with the format `redis://:{Password}@{Host}:{Port}` |

<Aside type="note">
Aspire exposes each property as an environment variable named `[RESOURCE]_[PROPERTY]`. For instance, the `Uri` property of a resource called `cache` becomes `CACHE_URI`.
</Aside>

### Hosting integration health checks

The Redis hosting integration automatically adds a health check for the Redis resource. The health check verifies that the Redis instance is running and that a connection can be established to it.
Expand Down
20 changes: 20 additions & 0 deletions src/frontend/src/content/docs/integrations/caching/valkey.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,26 @@ var myService = builder.AddProject<Projects.ExampleProject>()

The preceding code adds persistence to the Valkey resource by taking snapshots of the data at a specified interval and threshold.


### Connection properties

When you reference a Valkey resource using `WithReference`, the following connection properties are made available to the consuming project:

#### Valkey

The Valkey resource exposes the following connection properties:

| Property Name | Description |
|---------------|-------------|
| `Host` | The hostname or IP address of the Valkey server |
| `Port` | The port number the Valkey server is listening on |
| `Password` | The password for authentication |
| `Uri` | The connection URI, with the format `valkey://:{Password}@{Host}:{Port}` |

<Aside type="note">
Aspire exposes each property as an environment variable named `[RESOURCE]_[PROPERTY]`. For instance, the `Uri` property of a resource called `cache` becomes `CACHE_URI`.
</Aside>

### Hosting integration health checks

The Valkey hosting integration automatically adds a health check for the Valkey resource. The health check verifies that the Valkey instance is running and that a connection can be established to it.
Expand Down
28 changes: 28 additions & 0 deletions src/frontend/src/content/docs/integrations/databases/milvus.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,34 @@ var myService = builder.AddProject<Projects.ExampleProject>()

When you debug the Aspire solution, you'll see an Attu container listed in the resources. Select the resource's endpoint to open the GUI.


### Connection properties

When you reference a Milvus resource using `WithReference`, the following connection properties are made available to the consuming project:

#### Milvus server

The Milvus server resource exposes the following connection properties:

| Property Name | Description |
|---------------|-------------|
| `Host` | The hostname or IP address of the Milvus server |
| `Port` | The gRPC port exposed by the Milvus server |
| `Token` | The authentication token, with the format `root:{ApiKey}` |
| `Uri` | The gRPC endpoint URI, with the format `http://{Host}:{Port}` |

#### Milvus database

The Milvus database resource combines the server properties above and adds the following connection property:

| Property Name | Description |
|---------------|-------------|
| `Database` | The Milvus database name |

<Aside type="note">
Aspire exposes each property as an environment variable named `[RESOURCE]_[PROPERTY]`. For instance, the `Uri` property of a resource called `db1` becomes `DB1_URI`.
</Aside>

## Client integration

<Aside type="caution">
Expand Down
31 changes: 31 additions & 0 deletions src/frontend/src/content/docs/integrations/databases/mongodb.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,37 @@ The MongoDB Express resource is configured to connect to the MongoDB server reso

Additionally, the `WithMongoExpress` API exposes an optional `configureContainer` parameter that you use to configure the MongoDB Express container resource.


### Connection properties

When you reference a MongoDB resource using `WithReference`, the following connection properties are made available to the consuming project:

#### MongoDB server

The MongoDB server resource exposes the following connection properties:

| Property Name | Description |
|---------------|-------------|
| `Host` | The hostname or IP address of the MongoDB server |
| `Port` | The port number the MongoDB server is listening on |
| `Username` | The username for authentication |
| `Password` | The password for authentication (available when a password parameter is configured) |
| `AuthenticationDatabase` | The authentication database (available when a password parameter is configured) |
| `AuthenticationMechanism` | The authentication mechanism (available when a password parameter is configured) |
| `Uri` | The connection URI, with the format `mongodb://{Username}:{Password}@{Host}:{Port}/?authSource={AuthenticationDatabase}&authMechanism={AuthenticationMechanism}` |

#### MongoDB database

The MongoDB database resource combines the server properties above and adds the following connection property:

| Property Name | Description |
|---------------|-------------|
| `Database` | The MongoDB database name |

<Aside type="note">
Aspire exposes each property as an environment variable named `[RESOURCE]_[PROPERTY]`. For instance, the `Uri` property of a resource called `db1` becomes `DB1_URI`.
</Aside>

### Hosting integration health checks

The MongoDB hosting integration automatically adds a health check for the MongoDB server resource. The health check verifies that the MongoDB server resource is running and that a connection can be established to it.
Expand Down
32 changes: 32 additions & 0 deletions src/frontend/src/content/docs/integrations/databases/mysql.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,38 @@ var myService = builder.AddProject<Projects.ExampleProject>()

When you run the solution, the Aspire dashboard displays the phpMyAdmin resources with an endpoint. Select the link to the endpoint to view phpMyAdmin in a new browser tab.


### Connection properties

When you reference a MySQL resource using `WithReference`, the following connection properties are made available to the consuming project:

#### MySQL server

The MySQL server resource exposes the following connection properties:

| Property Name | Description |
|---------------|-------------|
| `Host` | The hostname or IP address of the MySQL server |
| `Port` | The port number the MySQL server is listening on |
| `Username` | The username for authentication |
| `Password` | The password for authentication |
| `Uri` | The connection URI, with the format `mysql://root:{Password}@{Host}:{Port}` |
| `JdbcConnectionString` | The JDBC connection string for MySQL, with the format `jdbc:mysql://{Host}:{Port}`. User and password credentials are provided as separate `Username` and `Password` properties. |

#### MySQL database

The MySQL database resource combines the server properties above and adds the following connection properties:

| Property Name | Description |
|---------------|-------------|
| `Database` | The MySQL database name |
| `Uri` | The database-specific URI, with the format `mysql://root:{Password}@{Host}:{Port}/{Database}` |
| `JdbcConnectionString` | The database-specific JDBC connection string, with the format `jdbc:mysql://{Host}:{Port}/{Database}`. User and password credentials are provided as separate `Username` and `Password` properties. |

<Aside type="note">
Aspire exposes each property as an environment variable named `[RESOURCE]_[PROPERTY]`. For instance, the `Uri` property of a resource called `db1` becomes `DB1_URI`.
</Aside>

### Hosting integration health checks

The MySQL hosting integration automatically adds a health check for the MySQL resource. The health check verifies that the MySQL server is running and that a connection can be established to it.
Expand Down
32 changes: 32 additions & 0 deletions src/frontend/src/content/docs/integrations/databases/oracle.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,38 @@ Data [bind mounts](https://docs.docker.com/engine/storage/bind-mounts/) have lim
Data bind mounts rely on the host machine's filesystem to persist the Oracle data across container restarts. The data bind mount is mounted at the `C:\Oracle\Data` on Windows (or `/Oracle/Data` on Unix) path on the host machine in the Oracle container. For more information on data bind mounts, see [Docker docs: Bind mounts](https://docs.docker.com/engine/storage/bind-mounts).
</Aside>


### Connection properties

When you reference an Oracle database resource using `WithReference`, the following connection properties are made available to the consuming project:

#### Oracle database server

The Oracle database server resource exposes the following connection properties:

| Property Name | Description |
|---------------|-------------|
| `Host` | The hostname or IP address of the Oracle server |
| `Port` | The port number the Oracle server is listening on |
| `Username` | The username for authentication |
| `Password` | The password for authentication |
| `Uri` | The connection URI in oracle:// format, with the format `oracle://{Username}:{Password}@{Host}:{Port}` |
| `JdbcConnectionString` | JDBC-format connection string, with the format `jdbc:oracle:thin:@//{Host}:{Port}`. User and password credentials are provided as separate `Username` and `Password` properties. |

#### Oracle database

The Oracle database resource inherits all properties from its parent `OracleDatabaseServerResource` and adds:

| Property Name | Description |
|---------------|-------------|
| `Uri` | The connection URI in oracle:// format, with the format `oracle://{Username}:{Password}@{Host}:{Port}/{DatabaseName}` |
| `JdbcConnectionString` | JDBC connection string with database name, with the format `jdbc:oracle:thin:@//{Host}:{Port}/{DatabaseName}`. User and password credentials are provided as separate `Username` and `Password` properties. |
| `Database` | The name of the database |

<Aside type="note">
Aspire exposes each property as an environment variable named `[RESOURCE]_[PROPERTY]`. For instance, the `Uri` property of a resource called `db1` becomes `DB1_URI`.
</Aside>

### Hosting integration health checks

The Oracle hosting integration automatically adds a health check for the Oracle resource. The health check verifies that the Oracle server is running and that a connection can be established to it.
Expand Down
32 changes: 32 additions & 0 deletions src/frontend/src/content/docs/integrations/databases/postgres.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,38 @@ var exampleProject = builder.AddProject<Projects.ExampleProject>()
// After adding all resources, run the app...
```


### Connection properties

When you reference a PostgreSQL resource using `WithReference`, the following connection properties are made available to the consuming project:

#### PostgreSQL server

The PostgreSQL server resource exposes the following connection properties:

| Property Name | Description |
|---------------|-------------|
| `Host` | The hostname or IP address of the PostgreSQL server |
| `Port` | The port number the PostgreSQL server is listening on |
| `Username` | The username for authentication |
| `Password` | The password for authentication |
| `Uri` | The connection URI in postgresql:// format, with the format `postgresql://{Username}:{Password}@{Host}:{Port}` |
| `JdbcConnectionString` | JDBC-format connection string, with the format `jdbc:postgresql://{Host}:{Port}`. User and password credentials are provided as separate `Username` and `Password` properties. |

#### PostgreSQL database

The PostgreSQL database resource inherits all properties from its parent `PostgresServerResource` and adds:

| Property Name | Description |
|---------------|-------------|
| `Uri` | The connection URI with the database name, with the format `postgresql://{Username}:{Password}@{Host}:{Port}/{DatabaseName}` |
| `JdbcConnectionString` | JDBC connection string with database name, with the format `jdbc:postgresql://{Host}:{Port}/{DatabaseName}`. User and password credentials are provided as separate `Username` and `Password` properties. |
| `DatabaseName` | The name of the database |

<Aside type="note">
Aspire exposes each property as an environment variable named `[RESOURCE]_[PROPERTY]`. For instance, the `Uri` property of a resource called `db1` becomes `DB1_URI`.
</Aside>

### Hosting integration health checks

The PostgreSQL hosting integration automatically adds a health check for the PostgreSQL server resource. The health check verifies that the PostgreSQL server is running and that a connection can be established to it.
Expand Down
23 changes: 23 additions & 0 deletions src/frontend/src/content/docs/integrations/databases/qdrant.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,29 @@ var myService = builder.AddProject<Projects.ExampleProject>()
Data bind mounts have limited functionality compared to volumes, and when you use a bind mount, a file or directory on the host machine is mounted into a container.
</Aside>


### Connection properties

When you reference a Qdrant resource using `WithReference`, the following connection properties are made available to the consuming project:

#### Qdrant server

The Qdrant server resource exposes the following connection properties:

| Property Name | Description |
|---------------|-------------|
| `GrpcHost` | The gRPC hostname of the Qdrant server |
| `GrpcPort` | The gRPC port of the Qdrant server |
| `HttpHost` | The HTTP hostname of the Qdrant server |
| `HttpPort` | The HTTP port of the Qdrant server |
| `ApiKey` | The API key for authentication |
| `Uri` | The gRPC connection URI, with the format `http://{GrpcHost}:{GrpcPort}` |
| `HttpUri` | The HTTP connection URI, with the format `http://{HttpHost}:{HttpPort}` |

<Aside type="note">
Aspire exposes each property as an environment variable named `[RESOURCE]_[PROPERTY]`. For instance, the `Uri` property of a resource called `db1` becomes `DB1_URI`.
</Aside>

### Hosting integration health checks

The Qdrant hosting integration automatically adds a health check for the Qdrant resource. The health check verifies that Qdrant is running and that a connection can be established to it.
Expand Down
Loading
Loading