diff --git a/src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBExtensions.cs b/src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBExtensions.cs index 75c06dbb32..2f75161e4f 100644 --- a/src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBExtensions.cs +++ b/src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBExtensions.cs @@ -98,14 +98,15 @@ public static IResourceBuilder AddAzureCosmosDB(this IDis /// /// Configures an Azure Cosmos DB resource to be emulated using the Azure Cosmos DB emulator with the NoSQL API. This resource requires an to be added to the application model. - /// For more information on the Azure Cosmos DB emulator, see + /// For more information on the Azure Cosmos DB emulator, see . /// /// The Azure Cosmos DB resource builder. /// Callback that exposes underlying container used for emulation to allow for customization. /// A reference to the . /// /// When using the Azure Cosmos DB emulator, the container requires a TLS/SSL certificate. - /// For more information, see + /// For more information, see . + /// This version of the package defaults to the tag of the / container image. /// public static IResourceBuilder RunAsEmulator(this IResourceBuilder builder, Action>? configureContainer = null) { @@ -117,9 +118,9 @@ public static IResourceBuilder RunAsEmulator(this IResour builder.WithEndpoint(name: "emulator", targetPort: 8081) .WithAnnotation(new ContainerImageAnnotation { - Registry = "mcr.microsoft.com", - Image = "cosmosdb/linux/azure-cosmos-emulator", - Tag = "latest" + Registry = CosmosDBEmulatorContainerImageTags.Registry, + Image = CosmosDBEmulatorContainerImageTags.Image, + Tag = CosmosDBEmulatorContainerImageTags.Tag }); CosmosClient? cosmosClient = null; diff --git a/src/Aspire.Hosting.Azure.CosmosDB/CosmosDBEmulatorContainerImageTags.cs b/src/Aspire.Hosting.Azure.CosmosDB/CosmosDBEmulatorContainerImageTags.cs new file mode 100644 index 0000000000..eaee6b581d --- /dev/null +++ b/src/Aspire.Hosting.Azure.CosmosDB/CosmosDBEmulatorContainerImageTags.cs @@ -0,0 +1,16 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +namespace Aspire.Hosting.Azure.Cosmos; + +internal static class CosmosDBEmulatorContainerImageTags +{ + /// mcr.microsoft.com + public const string Registry = "mcr.microsoft.com"; + + /// cosmosdb/linux/azure-cosmos-emulator + public const string Image = "cosmosdb/linux/azure-cosmos-emulator"; + + /// latest + public const string Tag = "latest"; +} diff --git a/src/Aspire.Hosting.Azure.EventHubs/AzureEventHubsExtensions.cs b/src/Aspire.Hosting.Azure.EventHubs/AzureEventHubsExtensions.cs index 7cf2dd6dd3..2074fcb0d1 100644 --- a/src/Aspire.Hosting.Azure.EventHubs/AzureEventHubsExtensions.cs +++ b/src/Aspire.Hosting.Azure.EventHubs/AzureEventHubsExtensions.cs @@ -78,6 +78,9 @@ public static IResourceBuilder AddAzureEventHubs( /// /// Adds an Azure Event Hubs hub resource to the application model. This resource requires an to be added to the application model. /// + /// + /// This version of the package defaults to the tag of the / container image. + /// /// The Azure Event Hubs resource builder. /// The name of the Event Hub. public static IResourceBuilder AddEventHub(this IResourceBuilder builder, [ResourceName] string name) diff --git a/src/Aspire.Hosting.Azure.EventHubs/EventHubsEmulatorContainerImageTags.cs b/src/Aspire.Hosting.Azure.EventHubs/EventHubsEmulatorContainerImageTags.cs index a60f60193f..8a50e3ab20 100644 --- a/src/Aspire.Hosting.Azure.EventHubs/EventHubsEmulatorContainerImageTags.cs +++ b/src/Aspire.Hosting.Azure.EventHubs/EventHubsEmulatorContainerImageTags.cs @@ -5,7 +5,12 @@ namespace Aspire.Hosting.Azure.EventHubs; internal static class EventHubsEmulatorContainerImageTags { + /// mcr.microsoft.com public const string Registry = "mcr.microsoft.com"; + + /// azure-messaging/eventhubs-emulator public const string Image = "azure-messaging/eventhubs-emulator"; - public const string Tag = "latest"; + + /// latest + public const string Tag = "latest"; // latest is the only arch-agnostic tag } diff --git a/src/Aspire.Hosting.Azure.Storage/AzureStorageExtensions.cs b/src/Aspire.Hosting.Azure.Storage/AzureStorageExtensions.cs index bc05dc4174..347822fb0e 100644 --- a/src/Aspire.Hosting.Azure.Storage/AzureStorageExtensions.cs +++ b/src/Aspire.Hosting.Azure.Storage/AzureStorageExtensions.cs @@ -79,8 +79,11 @@ public static IResourceBuilder AddAzureStorage(this IDistr } /// - /// Configures an Azure Storage resource to be emulated using Azurite. This resource requires an to be added to the application model. This version of the package defaults to the tag of the / container image. + /// Configures an Azure Storage resource to be emulated using Azurite. This resource requires an to be added to the application model. /// + /// + /// This version of the package defaults to the tag of the / container image. + /// /// The Azure storage resource builder. /// Callback that exposes underlying container used for emulation to allow for customization. /// A reference to the . diff --git a/src/Aspire.Hosting.Elasticsearch/ElasticsearchBuilderExtensions.cs b/src/Aspire.Hosting.Elasticsearch/ElasticsearchBuilderExtensions.cs index 851ba67519..27e3ee3cf7 100644 --- a/src/Aspire.Hosting.Elasticsearch/ElasticsearchBuilderExtensions.cs +++ b/src/Aspire.Hosting.Elasticsearch/ElasticsearchBuilderExtensions.cs @@ -20,10 +20,10 @@ public static class ElasticsearchBuilderExtensions private const int ElasticsearchInternalPort = 9300; /// - /// Adds an Elasticsearch container resource to the application model. This version of the package defaults to the tag of the container image. + /// Adds an Elasticsearch container resource to the application model. /// /// - /// The default image is "elasticsearch" and the tag is "8.15.1". + /// This version of the package defaults to the tag of the container image. /// /// The . /// The name of the resource. This name will be used as the connection string name when referenced in a dependency. @@ -38,8 +38,8 @@ public static class ElasticsearchBuilderExtensions /// var elasticsearch = builder.AddElasticsearch("elasticsearch"); /// var api = builder.AddProject<Projects.Api>("api") /// .WithReference(elasticsearch); - /// - /// builder.Build().Run(); + /// + /// builder.Build().Run(); /// /// public static IResourceBuilder AddElasticsearch( @@ -109,8 +109,8 @@ public static IResourceBuilder AddElasticsearch( /// .WithDataVolume(); /// var api = builder.AddProject<Projects.Api>("api") /// .WithReference(elasticsearch); - /// - /// builder.Build().Run(); + /// + /// builder.Build().Run(); /// /// public static IResourceBuilder WithDataVolume(this IResourceBuilder builder, string? name = null) @@ -136,8 +136,8 @@ public static IResourceBuilder WithDataVolume(this IResou /// .WithDataBindMount("./data/elasticsearch/data"); /// var api = builder.AddProject<Projects.Api>("api") /// .WithReference(elasticsearch); - /// - /// builder.Build().Run(); + /// + /// builder.Build().Run(); /// /// public static IResourceBuilder WithDataBindMount(this IResourceBuilder builder, string source) diff --git a/src/Aspire.Hosting.Garnet/GarnetBuilderExtensions.cs b/src/Aspire.Hosting.Garnet/GarnetBuilderExtensions.cs index 7bb49daae6..3e419819c7 100644 --- a/src/Aspire.Hosting.Garnet/GarnetBuilderExtensions.cs +++ b/src/Aspire.Hosting.Garnet/GarnetBuilderExtensions.cs @@ -19,6 +19,9 @@ public static class GarnetBuilderExtensions /// /// Adds a Garnet container to the application model. /// + /// + /// This version of the package defaults to the tag of the / container image. + /// /// /// Use in application host /// @@ -27,8 +30,8 @@ public static class GarnetBuilderExtensions /// var garnet = builder.AddGarnet("garnet"); /// var api = builder.AddProject<Projects.Api>("api) /// .WithReference(garnet); - /// - /// builder.Build().Run(); + /// + /// builder.Build().Run(); /// /// /// @@ -39,7 +42,7 @@ public static class GarnetBuilderExtensions /// /// var multiplexer = builder.Services.BuildServiceProvider() /// .GetRequiredService<IConnectionMultiplexer>(); - /// + /// /// var db = multiplexer.GetDatabase(); /// db.HashSet("key", [new HashEntry("hash", "value")]); /// var value = db.HashGet("key", "hash"); diff --git a/src/Aspire.Hosting.Garnet/GarnetContainerImageTags.cs b/src/Aspire.Hosting.Garnet/GarnetContainerImageTags.cs index 8736f4f0d0..7b39443c05 100644 --- a/src/Aspire.Hosting.Garnet/GarnetContainerImageTags.cs +++ b/src/Aspire.Hosting.Garnet/GarnetContainerImageTags.cs @@ -5,7 +5,12 @@ namespace Aspire.Hosting.Garnet; internal static class GarnetContainerImageTags { + /// ghcr.io public const string Registry = "ghcr.io"; + + /// microsoft/garnet public const string Image = "microsoft/garnet"; + + /// 1.0 public const string Tag = "1.0"; } diff --git a/src/Aspire.Hosting.Kafka/KafkaBuilderExtensions.cs b/src/Aspire.Hosting.Kafka/KafkaBuilderExtensions.cs index 8f5107b178..5c4dff9aa4 100644 --- a/src/Aspire.Hosting.Kafka/KafkaBuilderExtensions.cs +++ b/src/Aspire.Hosting.Kafka/KafkaBuilderExtensions.cs @@ -21,8 +21,11 @@ public static class KafkaBuilderExtensions private const string Target = "/var/lib/kafka/data"; /// - /// Adds a Kafka resource to the application. A container is used for local development. This version of the package defaults to the tag of the container image. + /// Adds a Kafka resource to the application. A container is used for local development. /// + /// + /// This version of the package defaults to the tag of the container image. + /// /// The . /// The name of the resource. This name will be used as the connection string name when referenced in a dependency /// The host port of Kafka broker. @@ -77,8 +80,11 @@ public static IResourceBuilder AddKafka(this IDistributedAp } /// - /// Adds a Kafka UI container to the application. This version of the package defaults to the tag of the container image. + /// Adds a Kafka UI container to the application. /// + /// + /// This version of the package defaults to the tag of the container image. + /// /// The Kafka server resource builder. /// Configuration callback for KafkaUI container resource. /// The name of the container (Optional). diff --git a/src/Aspire.Hosting.Keycloak/KeycloakContainerImageTags.cs b/src/Aspire.Hosting.Keycloak/KeycloakContainerImageTags.cs index 060abb8397..1a35464dab 100644 --- a/src/Aspire.Hosting.Keycloak/KeycloakContainerImageTags.cs +++ b/src/Aspire.Hosting.Keycloak/KeycloakContainerImageTags.cs @@ -1,11 +1,16 @@ -// Licensed to the .NET Foundation under one or more agreements. +// Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. namespace Aspire.Hosting.Keycloak; internal static class KeycloakContainerImageTags { + /// quay.io public const string Registry = "quay.io"; + + /// keycloak/keycloak public const string Image = "keycloak/keycloak"; + + /// 25.0 public const string Tag = "25.0"; } diff --git a/src/Aspire.Hosting.Keycloak/KeycloakResourceBuilderExtensions.cs b/src/Aspire.Hosting.Keycloak/KeycloakResourceBuilderExtensions.cs index 241b6f913f..8696fe25cc 100644 --- a/src/Aspire.Hosting.Keycloak/KeycloakResourceBuilderExtensions.cs +++ b/src/Aspire.Hosting.Keycloak/KeycloakResourceBuilderExtensions.cs @@ -27,8 +27,8 @@ public static class KeycloakResourceBuilderExtensions /// The parameter used as the admin password for the Keycloak resource. If a default password will be used. /// A reference to the . /// - /// The container is based on the quay.io/keycloak/keycloak container image. - /// The default tag is 24.0. The container exposes port 8080 by default. + /// The container exposes port 8080 by default. + /// This version of the package defaults to the tag of the / container image. /// /// /// Use in application host diff --git a/src/Aspire.Hosting.Milvus/MilvusBuilderExtensions.cs b/src/Aspire.Hosting.Milvus/MilvusBuilderExtensions.cs index 2f6b42d7b9..e6261e0bee 100644 --- a/src/Aspire.Hosting.Milvus/MilvusBuilderExtensions.cs +++ b/src/Aspire.Hosting.Milvus/MilvusBuilderExtensions.cs @@ -21,7 +21,7 @@ public static class MilvusBuilderExtensions private const int MilvusPortGrpc = 19530; /// - /// Adds a Milvus resource to the application. A container is used for local development. + /// Adds a Milvus container resource to the application model. /// /// /// Use in application host @@ -36,9 +36,9 @@ public static class MilvusBuilderExtensions /// /// /// - /// This version of the package defaults to the tag of the container image. /// The .NET client library uses the gRPC port by default to communicate and this resource exposes that endpoint. /// A web-based administration tool for Milvus can also be added using . + /// This version of the package defaults to the tag of the container image. /// /// The . /// The name of the resource. This name will be used as the connection string name when referenced in a dependency @@ -133,8 +133,11 @@ public static IResourceBuilder AddDatabase(this IResourc } /// - /// Adds an administration and development platform for Milvus to the application model using Attu. This version of the package defaults to the tag of the container image. + /// Adds an administration and development platform for Milvus to the application model using Attu. /// + /// + /// This version of the package defaults to the tag of the container image. + /// /// /// Use in application host with a Milvus resource /// diff --git a/src/Aspire.Hosting.MongoDB/MongoDBBuilderExtensions.cs b/src/Aspire.Hosting.MongoDB/MongoDBBuilderExtensions.cs index 1d708090a8..f4d7539909 100644 --- a/src/Aspire.Hosting.MongoDB/MongoDBBuilderExtensions.cs +++ b/src/Aspire.Hosting.MongoDB/MongoDBBuilderExtensions.cs @@ -22,8 +22,11 @@ public static class MongoDBBuilderExtensions private const string PasswordEnvVarName = "MONGO_INITDB_ROOT_PASSWORD"; /// - /// Adds a MongoDB resource to the application model. A container is used for local development. This version of the package defaults to the tag of the container image. + /// Adds a MongoDB resource to the application model. A container is used for local development. /// + /// + /// This version of the package defaults to the tag of the container image. + /// /// The . /// The name of the resource. This name will be used as the connection string name when referenced in a dependency. /// The host port for MongoDB. @@ -34,7 +37,7 @@ public static IResourceBuilder AddMongoDB(this IDistribut } /// - /// Adds a MongoDB resource to the application model. A container is used for local development. This version the package defaults to the 7.0.8 tag of the mongo container image. + /// /// /// The . /// The name of the resource. This name will be used as the connection string name when referenced in a dependency. @@ -121,8 +124,11 @@ public static IResourceBuilder AddDatabase(this IResour } /// - /// Adds a MongoExpress administration and development platform for MongoDB to the application model. This version of the package defaults to the tag of the container image + /// Adds a MongoExpress administration and development platform for MongoDB to the application model. /// + /// + /// This version of the package defaults to the tag of the container image. + /// /// The MongoDB server resource builder. /// Configuration callback for Mongo Express container resource. /// The name of the container (Optional). diff --git a/src/Aspire.Hosting.MySql/MySqlBuilderExtensions.cs b/src/Aspire.Hosting.MySql/MySqlBuilderExtensions.cs index 3ba48efec9..b44c0dd6bc 100644 --- a/src/Aspire.Hosting.MySql/MySqlBuilderExtensions.cs +++ b/src/Aspire.Hosting.MySql/MySqlBuilderExtensions.cs @@ -16,8 +16,11 @@ public static class MySqlBuilderExtensions private const string PasswordEnvVarName = "MYSQL_ROOT_PASSWORD"; /// - /// Adds a MySQL server resource to the application model. For local development a container is used. This version of the package defaults to the tag of the container image. + /// Adds a MySQL server resource to the application model. For local development a container is used. /// + /// + /// This version of the package defaults to the tag of the container image. + /// /// The . /// The name of the resource. This name will be used as the connection string name when referenced in a dependency. /// The parameter used to provide the root password for the MySQL resource. If a random password will be generated. @@ -79,8 +82,11 @@ public static IResourceBuilder AddDatabase(this IResource } /// - /// Adds a phpMyAdmin administration and development platform for MySql to the application model. This version of the package defaults to the tag of the container image. + /// Adds a phpMyAdmin administration and development platform for MySql to the application model. /// + /// + /// This version of the package defaults to the tag of the container image. + /// /// The MySql server resource builder. /// Callback to configure PhpMyAdmin container resource. /// The name of the container (Optional). diff --git a/src/Aspire.Hosting.Nats/NatsBuilderExtensions.cs b/src/Aspire.Hosting.Nats/NatsBuilderExtensions.cs index 7a5f08040a..9bb1d07da6 100644 --- a/src/Aspire.Hosting.Nats/NatsBuilderExtensions.cs +++ b/src/Aspire.Hosting.Nats/NatsBuilderExtensions.cs @@ -20,6 +20,9 @@ public static class NatsBuilderExtensions /// /// Adds a NATS server resource to the application model. A container is used for local development. /// + /// + /// This version of the package defaults to the tag of the container image. + /// /// The . /// The name of the resource. This name will be used as the connection string name when referenced in a dependency. /// The host port for NATS server. diff --git a/src/Aspire.Hosting.Nats/NatsContainerImageTags.cs b/src/Aspire.Hosting.Nats/NatsContainerImageTags.cs index 646339e3ac..e0ff096581 100644 --- a/src/Aspire.Hosting.Nats/NatsContainerImageTags.cs +++ b/src/Aspire.Hosting.Nats/NatsContainerImageTags.cs @@ -5,7 +5,12 @@ namespace Aspire.Hosting.Nats; internal static class NatsContainerImageTags { + /// docker.io public const string Registry = "docker.io"; + + /// library/nats public const string Image = "library/nats"; + + /// 2.10 public const string Tag = "2.10"; } diff --git a/src/Aspire.Hosting.Oracle/OracleDatabaseBuilderExtensions.cs b/src/Aspire.Hosting.Oracle/OracleDatabaseBuilderExtensions.cs index 7e7b194cae..4eb232e895 100644 --- a/src/Aspire.Hosting.Oracle/OracleDatabaseBuilderExtensions.cs +++ b/src/Aspire.Hosting.Oracle/OracleDatabaseBuilderExtensions.cs @@ -15,8 +15,11 @@ public static class OracleDatabaseBuilderExtensions private const string PasswordEnvVarName = "ORACLE_PWD"; /// - /// Adds a Oracle Server resource to the application model. A container is used for local development. This version of the package defaults to the tag of the / container image. + /// Adds a Oracle Server resource to the application model. A container is used for local development. /// + /// + /// This version of the package defaults to the tag of the / container image. + /// /// The . /// The name of the resource. This name will be used as the connection string name when referenced in a dependency. /// The parameter used to provide the administrator password for the Oracle Server resource. If a random password will be generated. diff --git a/src/Aspire.Hosting.PostgreSQL/PostgresBuilderExtensions.cs b/src/Aspire.Hosting.PostgreSQL/PostgresBuilderExtensions.cs index 824e31dc27..7ba2558646 100644 --- a/src/Aspire.Hosting.PostgreSQL/PostgresBuilderExtensions.cs +++ b/src/Aspire.Hosting.PostgreSQL/PostgresBuilderExtensions.cs @@ -19,7 +19,7 @@ public static class PostgresBuilderExtensions private const string PasswordEnvVarName = "POSTGRES_PASSWORD"; /// - /// Adds a PostgreSQL resource to the application model. A container is used for local development. This version of the package defaults to the tag of the container image. + /// Adds a PostgreSQL resource to the application model. A container is used for local development. /// /// The . /// The name of the resource. This name will be used as the connection string name when referenced in a dependency. @@ -34,6 +34,7 @@ public static class PostgresBuilderExtensions /// extension method then the dependent resource will wait until the Postgres resource is able to service /// requests. /// + /// This version of the package defaults to the tag of the container image. /// public static IResourceBuilder AddPostgres(this IDistributedApplicationBuilder builder, [ResourceName] string name, @@ -120,8 +121,11 @@ public static IResourceBuilder AddDatabase(this IResou } /// - /// Adds a pgAdmin 4 administration and development platform for PostgreSQL to the application model. This version of the package defaults to the tag of the container image. + /// Adds a pgAdmin 4 administration and development platform for PostgreSQL to the application model. /// + /// + /// This version of the package defaults to the tag of the container image. + /// /// The PostgreSQL server resource builder. /// Callback to configure PgAdmin container resource. /// The name of the container (Optional). @@ -238,6 +242,9 @@ public static IResourceBuilder WithHostPort(this IResour /// /// Adds an administration and development platform for PostgreSQL to the application model using pgweb. /// + /// + /// This version of the package defaults to the tag of the container image. + /// /// The Postgres server resource builder. /// Configuration callback for pgweb container resource. /// The name of the container (Optional). @@ -256,9 +263,6 @@ public static IResourceBuilder WithHostPort(this IResour /// builder.Build().Run(); /// /// - /// - /// This version of the package defaults to the tag of the container image. - /// /// A reference to the . public static IResourceBuilder WithPgWeb(this IResourceBuilder builder, Action>? configureContainer = null, string? containerName = null) { diff --git a/src/Aspire.Hosting.Qdrant/QdrantBuilderExtensions.cs b/src/Aspire.Hosting.Qdrant/QdrantBuilderExtensions.cs index 4fbaceacc9..de9f5c584b 100644 --- a/src/Aspire.Hosting.Qdrant/QdrantBuilderExtensions.cs +++ b/src/Aspire.Hosting.Qdrant/QdrantBuilderExtensions.cs @@ -25,8 +25,8 @@ public static class QdrantBuilderExtensions /// Adds a Qdrant resource to the application. A container is used for local development. /// /// - /// This version of the package defaults to the tag of the container image. /// The .NET client library uses the gRPC port by default to communicate and this resource exposes that endpoint. + /// This version of the package defaults to the tag of the container image. /// /// The . /// The name of the resource. This name will be used as the connection string name when referenced in a dependency diff --git a/src/Aspire.Hosting.RabbitMQ/RabbitMQBuilderExtensions.cs b/src/Aspire.Hosting.RabbitMQ/RabbitMQBuilderExtensions.cs index eceb19e81e..96c6c37e59 100644 --- a/src/Aspire.Hosting.RabbitMQ/RabbitMQBuilderExtensions.cs +++ b/src/Aspire.Hosting.RabbitMQ/RabbitMQBuilderExtensions.cs @@ -14,10 +14,10 @@ namespace Aspire.Hosting; public static class RabbitMQBuilderExtensions { /// - /// Adds a RabbitMQ container to the application model. This version of the package defaults to the tag of the container image. + /// Adds a RabbitMQ container to the application model. /// /// - /// The default image and tag are "rabbitmq" and "3.13". + /// This version of the package defaults to the tag of the container image. /// /// The . /// The name of the resource. This name will be used as the connection string name when referenced in a dependency. @@ -106,11 +106,12 @@ public static IResourceBuilder WithDataBindMount(this IR } /// - /// Configures the RabbitMQ container resource to enable the RabbitMQ management plugin. This version of the package defaults to the tag of the container image. + /// Configures the RabbitMQ container resource to enable the RabbitMQ management plugin. /// /// /// This method only supports custom tags matching the default RabbitMQ ones for the corresponding management tag to be inferred automatically, e.g. 4, 4.0-alpine, 4.0.2-management-alpine, etc.
/// Calling this method on a resource configured with an unrecognized image registry, name, or tag will result in a being thrown. + /// This version of the package defaults to the tag of the container image. /// /// The resource builder. /// The . diff --git a/src/Aspire.Hosting.Redis/RedisBuilderExtensions.cs b/src/Aspire.Hosting.Redis/RedisBuilderExtensions.cs index 8e5b90fcde..07ea40bb66 100644 --- a/src/Aspire.Hosting.Redis/RedisBuilderExtensions.cs +++ b/src/Aspire.Hosting.Redis/RedisBuilderExtensions.cs @@ -19,7 +19,7 @@ namespace Aspire.Hosting; public static class RedisBuilderExtensions { /// - /// Adds a Redis container to the application model. This version of the package defaults to the tag of the container image. + /// Adds a Redis container to the application model. /// /// The . /// The name of the resource. This name will be used as the connection string name when referenced in a dependency. @@ -32,6 +32,7 @@ public static class RedisBuilderExtensions /// extension method then the dependent resource will wait until the Redis resource is able to service /// requests. /// + /// This version of the package defaults to the tag of the container image. /// public static IResourceBuilder AddRedis(this IDistributedApplicationBuilder builder, [ResourceName] string name, int? port = null) { @@ -63,8 +64,10 @@ public static IResourceBuilder AddRedis(this IDistributedApplicat /// /// Configures a container resource for Redis Commander which is pre-configured to connect to the that this method is used on. - /// This version of the package defaults to the tag of the container image. /// + /// + /// This version of the package defaults to the tag of the container image. + /// /// The for the . /// Configuration callback for Redis Commander container resource. /// Override the container name used for Redis Commander. @@ -126,8 +129,10 @@ public static IResourceBuilder WithRedisCommander(this IResourceB /// /// Configures a container resource for Redis Insight which is pre-configured to connect to the that this method is used on. - /// This version of the package defaults to the tag of the container image. /// + /// + /// This version of the package defaults to the tag of the container image. + /// /// The for the . /// Configuration callback for Redis Insight container resource. /// Override the container name used for Redis Insight. diff --git a/src/Aspire.Hosting.Redis/RedisContainerImageTags.cs b/src/Aspire.Hosting.Redis/RedisContainerImageTags.cs index 83f4513c9d..902c127fff 100644 --- a/src/Aspire.Hosting.Redis/RedisContainerImageTags.cs +++ b/src/Aspire.Hosting.Redis/RedisContainerImageTags.cs @@ -21,7 +21,7 @@ internal static class RedisContainerImageTags public const string RedisCommanderImage = "rediscommander/redis-commander"; /// latest - public const string RedisCommanderTag = "latest"; + public const string RedisCommanderTag = "latest"; // There isn't a better tag than 'latest' which is 3 years old. /// docker.io public const string RedisInsightRegistry = "docker.io"; diff --git a/src/Aspire.Hosting.Seq/SeqBuilderExtensions.cs b/src/Aspire.Hosting.Seq/SeqBuilderExtensions.cs index 6a169f6700..90693a1247 100644 --- a/src/Aspire.Hosting.Seq/SeqBuilderExtensions.cs +++ b/src/Aspire.Hosting.Seq/SeqBuilderExtensions.cs @@ -17,6 +17,9 @@ public static class SeqBuilderExtensions /// /// Adds a Seq server resource to the application model. A container is used for local development. /// + /// + /// This version of the package defaults to the tag of the container image. + /// /// The . /// The name to give the resource. /// The host port for the Seq server. diff --git a/src/Aspire.Hosting.Seq/SeqContainerImageTags.cs b/src/Aspire.Hosting.Seq/SeqContainerImageTags.cs index 9caff923b6..7f6f7e299d 100644 --- a/src/Aspire.Hosting.Seq/SeqContainerImageTags.cs +++ b/src/Aspire.Hosting.Seq/SeqContainerImageTags.cs @@ -5,7 +5,12 @@ namespace Aspire.Hosting; internal static class SeqContainerImageTags { + /// docker.io public const string Registry = "docker.io"; + + /// datalust/seq public const string Image = "datalust/seq"; + + /// 2024.3 public const string Tag = "2024.3"; } diff --git a/src/Aspire.Hosting.SqlServer/SqlServerBuilderExtensions.cs b/src/Aspire.Hosting.SqlServer/SqlServerBuilderExtensions.cs index 1262d6f849..562db549d0 100644 --- a/src/Aspire.Hosting.SqlServer/SqlServerBuilderExtensions.cs +++ b/src/Aspire.Hosting.SqlServer/SqlServerBuilderExtensions.cs @@ -15,6 +15,9 @@ public static class SqlServerBuilderExtensions /// /// Adds a SQL Server resource to the application model. A container is used for local development. /// + /// + /// This version of the package defaults to the tag of the / container image. + /// /// The . /// The name of the resource. This name will be used as the connection string name when referenced in a dependency. /// The parameter used to provide the administrator password for the SQL Server resource. If a random password will be generated. diff --git a/src/Aspire.Hosting.SqlServer/SqlServerContainerImageTags.cs b/src/Aspire.Hosting.SqlServer/SqlServerContainerImageTags.cs index a197fd442f..f9e1239df4 100644 --- a/src/Aspire.Hosting.SqlServer/SqlServerContainerImageTags.cs +++ b/src/Aspire.Hosting.SqlServer/SqlServerContainerImageTags.cs @@ -5,7 +5,12 @@ namespace Aspire.Hosting; internal static class SqlServerContainerImageTags { + /// mcr.microsoft.com public const string Registry = "mcr.microsoft.com"; + + /// mssql/server public const string Image = "mssql/server"; + + /// 2022-latest public const string Tag = "2022-latest"; } diff --git a/src/Aspire.Hosting.Valkey/ValkeyBuilderExtensions.cs b/src/Aspire.Hosting.Valkey/ValkeyBuilderExtensions.cs index 9342dbdfbd..870f2d58dc 100644 --- a/src/Aspire.Hosting.Valkey/ValkeyBuilderExtensions.cs +++ b/src/Aspire.Hosting.Valkey/ValkeyBuilderExtensions.cs @@ -19,6 +19,9 @@ public static class ValkeyBuilderExtensions /// /// Adds a Valkey container to the application model. /// + /// + /// This version of the package defaults to the tag of the container image. + /// /// The . /// The name of the resource. This name will be used as the connection string name when referenced in a dependency. /// The host port to bind the underlying container to. @@ -30,8 +33,8 @@ public static class ValkeyBuilderExtensions /// var valkey = builder.AddValkey("valkey"); /// var api = builder.AddProject<Projects.Api>("api) /// .WithReference(valkey); - /// - /// builder.Build().Run(); + /// + /// builder.Build().Run(); /// /// /// @@ -42,7 +45,7 @@ public static class ValkeyBuilderExtensions /// /// var multiplexer = builder.Services.BuildServiceProvider() /// .GetRequiredService<IConnectionMultiplexer>(); - /// + /// /// var db = multiplexer.GetDatabase(); /// db.HashSet("key", [new HashEntry("hash", "value")]); /// var value = db.HashGet("key", "hash"); diff --git a/src/Aspire.Hosting.Valkey/ValkeyContainerImageTags.cs b/src/Aspire.Hosting.Valkey/ValkeyContainerImageTags.cs index 53286fc3ce..0f49070ce4 100644 --- a/src/Aspire.Hosting.Valkey/ValkeyContainerImageTags.cs +++ b/src/Aspire.Hosting.Valkey/ValkeyContainerImageTags.cs @@ -5,7 +5,12 @@ namespace Aspire.Hosting.Valkey; internal static class ValkeyContainerImageTags { + /// docker.io public const string Registry = "docker.io"; + + /// valkey/valkey public const string Image = "valkey/valkey"; + + /// 8.0 public const string Tag = "8.0"; }