diff --git a/src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBExtensions.cs b/src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBExtensions.cs index 75c06dbb327..2f75161e4f2 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 00000000000..76be2a184c1 --- /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 7cf2dd6dd3c..2074fcb0d1b 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 a60f60193f6..f32e0982770 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 bc05dc4174c..347822fb0e6 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.Azure.Storage/StorageEmulatorContainerImageTags.cs b/src/Aspire.Hosting.Azure.Storage/StorageEmulatorContainerImageTags.cs index 5821df11c2e..312b7950d1c 100644 --- a/src/Aspire.Hosting.Azure.Storage/StorageEmulatorContainerImageTags.cs +++ b/src/Aspire.Hosting.Azure.Storage/StorageEmulatorContainerImageTags.cs @@ -5,12 +5,12 @@ namespace Aspire.Hosting.Azure.Storage; internal static class StorageEmulatorContainerImageTags { - /// mcr.microsoft.com + /// mcr.microsoft.com public const string Registry = "mcr.microsoft.com"; - /// azure-storage/azurite + /// azure-storage/azurite public const string Image = "azure-storage/azurite"; - /// 3.32.0 + /// 3.32.0 public const string Tag = "3.32.0"; } diff --git a/src/Aspire.Hosting.Elasticsearch/ElasticsearchBuilderExtensions.cs b/src/Aspire.Hosting.Elasticsearch/ElasticsearchBuilderExtensions.cs index 851ba675190..27e3ee3cf75 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.Elasticsearch/ElasticsearchContainerImageTags.cs b/src/Aspire.Hosting.Elasticsearch/ElasticsearchContainerImageTags.cs index cce4d2f6431..87cc7d07346 100644 --- a/src/Aspire.Hosting.Elasticsearch/ElasticsearchContainerImageTags.cs +++ b/src/Aspire.Hosting.Elasticsearch/ElasticsearchContainerImageTags.cs @@ -5,13 +5,13 @@ namespace Aspire.Hosting.Elasticsearch; internal static class ElasticsearchContainerImageTags { - /// docker.io + /// docker.io public const string Registry = "docker.io"; - /// library/elasticsearch + /// library/elasticsearch public const string Image = "library/elasticsearch"; - /// 8.15.2 + /// 8.15.2 public const string Tag = "8.15.2"; } diff --git a/src/Aspire.Hosting.Garnet/GarnetBuilderExtensions.cs b/src/Aspire.Hosting.Garnet/GarnetBuilderExtensions.cs index 7bb49daae67..3e419819c7a 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 8736f4f0d03..832130442af 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 8f5107b1780..5c4dff9aa46 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.Kafka/KafkaContainerImageTags.cs b/src/Aspire.Hosting.Kafka/KafkaContainerImageTags.cs index 4bfc52d6ef2..80fbb688c17 100644 --- a/src/Aspire.Hosting.Kafka/KafkaContainerImageTags.cs +++ b/src/Aspire.Hosting.Kafka/KafkaContainerImageTags.cs @@ -5,18 +5,18 @@ namespace Aspire.Hosting; internal static class KafkaContainerImageTags { - /// docker.io + /// docker.io public const string Registry = "docker.io"; - /// confluentinc/confluent-local + /// confluentinc/confluent-local public const string Image = "confluentinc/confluent-local"; - /// 7.7.1 + /// 7.7.1 public const string Tag = "7.7.1"; - /// provectuslabs/kafka-ui + /// provectuslabs/kafka-ui public const string KafkaUiImage = "provectuslabs/kafka-ui"; - /// v0.7.2 + /// v0.7.2 public const string KafkaUiTag = "v0.7.2"; } diff --git a/src/Aspire.Hosting.Keycloak/KeycloakContainerImageTags.cs b/src/Aspire.Hosting.Keycloak/KeycloakContainerImageTags.cs index 060abb8397c..493161891cc 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 241b6f913fe..8696fe25cc5 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 2f6b42d7b96..e6261e0beee 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.Milvus/MilvusContainerImageTags.cs b/src/Aspire.Hosting.Milvus/MilvusContainerImageTags.cs index dc44d21ef7a..5dd329274f9 100644 --- a/src/Aspire.Hosting.Milvus/MilvusContainerImageTags.cs +++ b/src/Aspire.Hosting.Milvus/MilvusContainerImageTags.cs @@ -5,19 +5,19 @@ namespace Aspire.Hosting.Milvus; internal static class MilvusContainerImageTags { - /// docker.io + /// docker.io public const string Registry = "docker.io"; - /// milvusdb/milvus + /// milvusdb/milvus public const string Image = "milvusdb/milvus"; - /// v2.4.12 + /// v2.4.12 public const string Tag = "v2.4.12"; - /// zilliz/attu + /// zilliz/attu public const string AttuImage = "zilliz/attu"; - /// v2.4 + /// v2.4 public const string AttuTag = "v2.4"; } diff --git a/src/Aspire.Hosting.MongoDB/MongoDBBuilderExtensions.cs b/src/Aspire.Hosting.MongoDB/MongoDBBuilderExtensions.cs index 1d708090a8a..f4d75399091 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.MongoDB/MongoDBContainerImageTags.cs b/src/Aspire.Hosting.MongoDB/MongoDBContainerImageTags.cs index 6a62070d644..755c5485da3 100644 --- a/src/Aspire.Hosting.MongoDB/MongoDBContainerImageTags.cs +++ b/src/Aspire.Hosting.MongoDB/MongoDBContainerImageTags.cs @@ -5,21 +5,21 @@ namespace Aspire.Hosting.MongoDB; internal static class MongoDBContainerImageTags { - /// docker.io + /// docker.io public const string Registry = "docker.io"; - /// library/mongo + /// library/mongo public const string Image = "library/mongo"; - /// 8.0 + /// 8.0 public const string Tag = "8.0"; - /// docker.io + /// docker.io public const string MongoExpressRegistry = "docker.io"; - /// library/mongo-express + /// library/mongo-express public const string MongoExpressImage = "library/mongo-express"; - /// 1.0 + /// 1.0 public const string MongoExpressTag = "1.0"; } diff --git a/src/Aspire.Hosting.MySql/MySqlBuilderExtensions.cs b/src/Aspire.Hosting.MySql/MySqlBuilderExtensions.cs index 3ba48efec9d..b44c0dd6bc9 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.MySql/MySqlContainerImageTags.cs b/src/Aspire.Hosting.MySql/MySqlContainerImageTags.cs index 54d43cc7d6b..e251f955589 100644 --- a/src/Aspire.Hosting.MySql/MySqlContainerImageTags.cs +++ b/src/Aspire.Hosting.MySql/MySqlContainerImageTags.cs @@ -5,18 +5,18 @@ namespace Aspire.Hosting.MySql; internal static class MySqlContainerImageTags { - /// docker.io + /// docker.io public const string Registry = "docker.io"; - /// library/mysql + /// library/mysql public const string Image = "library/mysql"; - /// 9.0 + /// 9.0 public const string Tag = "9.0"; - /// library/phpmyadmin + /// library/phpmyadmin public const string PhpMyAdminImage = "library/phpmyadmin"; - /// 5.2 + /// 5.2 public const string PhpMyAdminTag = "5.2"; } diff --git a/src/Aspire.Hosting.Nats/NatsBuilderExtensions.cs b/src/Aspire.Hosting.Nats/NatsBuilderExtensions.cs index 7a5f08040ad..9bb1d07da65 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 646339e3ac9..8e0f5ab4a8b 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/OracleContainerImageTags.cs b/src/Aspire.Hosting.Oracle/OracleContainerImageTags.cs index 04f71b57b5a..098e4cccf64 100644 --- a/src/Aspire.Hosting.Oracle/OracleContainerImageTags.cs +++ b/src/Aspire.Hosting.Oracle/OracleContainerImageTags.cs @@ -5,12 +5,12 @@ namespace Aspire.Hosting; internal static class OracleContainerImageTags { - /// container-registry.oracle.com + /// container-registry.oracle.com public const string Registry = "container-registry.oracle.com"; - /// database/free + /// database/free public const string Image = "database/free"; - /// 23.5.0.0 + /// 23.5.0.0 public const string Tag = "23.5.0.0"; } diff --git a/src/Aspire.Hosting.Oracle/OracleDatabaseBuilderExtensions.cs b/src/Aspire.Hosting.Oracle/OracleDatabaseBuilderExtensions.cs index 7e7b194cae5..4eb232e8952 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 824e31dc270..7ba25586460 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.PostgreSQL/PostgresContainerImageTags.cs b/src/Aspire.Hosting.PostgreSQL/PostgresContainerImageTags.cs index ecb83eb73ea..dc976e4d144 100644 --- a/src/Aspire.Hosting.PostgreSQL/PostgresContainerImageTags.cs +++ b/src/Aspire.Hosting.PostgreSQL/PostgresContainerImageTags.cs @@ -5,30 +5,30 @@ namespace Aspire.Hosting.Postgres; internal static class PostgresContainerImageTags { - /// docker.io + /// docker.io public const string Registry = "docker.io"; - /// library/postgres + /// library/postgres public const string Image = "library/postgres"; - /// 17.0 + /// 17.0 public const string Tag = "17.0"; - /// docker.io + /// docker.io public const string PgAdminRegistry = "docker.io"; - /// dpage/pgadmin4 + /// dpage/pgadmin4 public const string PgAdminImage = "dpage/pgadmin4"; - /// 8.11 + /// 8.12 public const string PgAdminTag = "8.12"; - /// docker.io + /// docker.io public const string PgWebRegistry = "docker.io"; - /// sosedoff/pgweb + /// sosedoff/pgweb public const string PgWebImage = "sosedoff/pgweb"; - /// 0.15.0 + /// 0.16.1.0 public const string PgWebTag = "0.16.1"; } diff --git a/src/Aspire.Hosting.Qdrant/QdrantBuilderExtensions.cs b/src/Aspire.Hosting.Qdrant/QdrantBuilderExtensions.cs index 4fbaceacc9f..de9f5c584b0 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.Qdrant/QdrantContainerImageTags.cs b/src/Aspire.Hosting.Qdrant/QdrantContainerImageTags.cs index 59b36341ddb..322e3a70cce 100644 --- a/src/Aspire.Hosting.Qdrant/QdrantContainerImageTags.cs +++ b/src/Aspire.Hosting.Qdrant/QdrantContainerImageTags.cs @@ -5,12 +5,12 @@ namespace Aspire.Hosting.Qdrant; internal static class QdrantContainerImageTags { - /// docker.io + /// docker.io public const string Registry = "docker.io"; - /// qdrant/qdrant + /// qdrant/qdrant public const string Image = "qdrant/qdrant"; - /// v1.11.5 + /// v1.11.5 public const string Tag = "v1.11.5"; } diff --git a/src/Aspire.Hosting.RabbitMQ/RabbitMQBuilderExtensions.cs b/src/Aspire.Hosting.RabbitMQ/RabbitMQBuilderExtensions.cs index eceb19e81e8..96c6c37e59b 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.RabbitMQ/RabbitMQContainerImageTags.cs b/src/Aspire.Hosting.RabbitMQ/RabbitMQContainerImageTags.cs index 5d779d3ea5d..3a11ca21219 100644 --- a/src/Aspire.Hosting.RabbitMQ/RabbitMQContainerImageTags.cs +++ b/src/Aspire.Hosting.RabbitMQ/RabbitMQContainerImageTags.cs @@ -5,15 +5,15 @@ namespace Aspire.Hosting.RabbitMQ; internal static class RabbitMQContainerImageTags { - /// docker.io + /// docker.io public const string Registry = "docker.io"; - /// library/rabbitmq + /// library/rabbitmq public const string Image = "library/rabbitmq"; - /// 4.0 + /// 4.0 public const string Tag = "4.0"; - /// -management + /// -management public const string ManagementTag = $"{Tag}-management"; } diff --git a/src/Aspire.Hosting.Redis/RedisBuilderExtensions.cs b/src/Aspire.Hosting.Redis/RedisBuilderExtensions.cs index 8e5b90fcdeb..07ea40bb665 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 83f4513c9d3..d6511607e9a 100644 --- a/src/Aspire.Hosting.Redis/RedisContainerImageTags.cs +++ b/src/Aspire.Hosting.Redis/RedisContainerImageTags.cs @@ -5,30 +5,30 @@ namespace Aspire.Hosting.Redis; internal static class RedisContainerImageTags { - /// docker.io + /// docker.io public const string Registry = "docker.io"; - /// library/redis + /// library/redis public const string Image = "library/redis"; - /// 7.4 + /// 7.4 public const string Tag = "7.4"; - /// RedisCommanderRegistry + /// RedisCommanderRegistry public const string RedisCommanderRegistry = "docker.io"; - /// rediscommander/redis-commander + /// rediscommander/redis-commander public const string RedisCommanderImage = "rediscommander/redis-commander"; - /// latest - public const string RedisCommanderTag = "latest"; + /// latest + public const string RedisCommanderTag = "latest"; // There isn't a better tag than 'latest' which is 3 years old. - /// docker.io + /// docker.io public const string RedisInsightRegistry = "docker.io"; - /// redis/redisinsight + /// redis/redisinsight public const string RedisInsightImage = "redis/redisinsight"; - /// 2.58 + /// 2.58 public const string RedisInsightTag = "2.58"; } diff --git a/src/Aspire.Hosting.Seq/SeqBuilderExtensions.cs b/src/Aspire.Hosting.Seq/SeqBuilderExtensions.cs index 6a169f67001..90693a12477 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 9caff923b6c..a8a9f8420eb 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 1262d6f8490..562db549d07 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 a197fd442f6..774e5bc6333 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 9342dbdfbdd..870f2d58dc3 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 53286fc3cea..93e58736be8 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"; }