diff --git a/playground/AspireEventHub/EventHubsConsumer/Consumer.cs b/playground/AspireEventHub/EventHubsConsumer/Consumer.cs index f8c3c5a08c..fc2b531d58 100644 --- a/playground/AspireEventHub/EventHubsConsumer/Consumer.cs +++ b/playground/AspireEventHub/EventHubsConsumer/Consumer.cs @@ -11,7 +11,7 @@ namespace EventHubsConsumer; /// production scenario, as it offers a much more robust experience with higher throughput. /// /// It is important to note that this method does not guarantee fairness amongst the partitions during iteration; each of the partitions compete to publish -/// events to be read by the enumerator. Depending on service communication, there may be a clustering of events per partition and/or there may be a noticeable +/// events to be read by the enumerator. Depending on service communication, there may be a clustering of events per partition and/or there may be a noticeable /// bias for a given partition or subset of partitions. /// /// Each reader of events is presented with an independent iterator; if there are multiple readers, each receive their own copy of an event to diff --git a/src/Aspire.Dashboard/Authentication/AspirePolicyEvaluator.cs b/src/Aspire.Dashboard/Authentication/AspirePolicyEvaluator.cs index e34edb21d6..613ed72a31 100644 --- a/src/Aspire.Dashboard/Authentication/AspirePolicyEvaluator.cs +++ b/src/Aspire.Dashboard/Authentication/AspirePolicyEvaluator.cs @@ -30,11 +30,11 @@ public AspirePolicyEvaluator(IAuthorizationService authorization) /// /// Does authentication for and sets the resulting - /// to . If no schemes are set, this is a no-op. + /// to . If no schemes are set, this is a no-op. /// /// The . /// The . - /// unless all schemes specified by failed to authenticate. + /// unless all schemes specified by failed to authenticate. public virtual async Task AuthenticateAsync(AuthorizationPolicy policy, HttpContext context) { if (policy.AuthenticationSchemes != null && policy.AuthenticationSchemes.Count > 0) diff --git a/src/Aspire.Hosting.Azure.Storage/AzureStorageExtensions.cs b/src/Aspire.Hosting.Azure.Storage/AzureStorageExtensions.cs index 2cb198c8f0..cb4bd9e957 100644 --- a/src/Aspire.Hosting.Azure.Storage/AzureStorageExtensions.cs +++ b/src/Aspire.Hosting.Azure.Storage/AzureStorageExtensions.cs @@ -4,6 +4,7 @@ using System.Diagnostics.CodeAnalysis; using Aspire.Hosting.ApplicationModel; using Aspire.Hosting.Azure; +using Aspire.Hosting.Azure.Storage; using Aspire.Hosting.Utils; using Azure.Provisioning; using Azure.Provisioning.Storage; @@ -16,7 +17,7 @@ namespace Aspire.Hosting; public static class AzureStorageExtensions { /// - /// Adds an Azure Storage resource to the application model.This resource can be used to create Azure blob, table, and queue resources. + /// Adds an Azure Storage resource to the application model. This resource can be used to create Azure blob, table, and queue resources. /// /// The builder for the distributed application. /// The name of the resource. @@ -29,7 +30,7 @@ public static IResourceBuilder AddAzureStorage(this IDistr } /// - /// Adds an Azure Storage resource to the application model.This resource can be used to create Azure blob, table, and queue resources. + /// Adds an Azure Storage resource to the application model. This resource can be used to create Azure blob, table, and queue resources. /// /// The builder for the distributed application. /// The name of the resource. @@ -92,7 +93,7 @@ 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 the package defaults to version 3.29.0 of the mcr.microsoft.com/azure-storage/azurite 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. @@ -109,9 +110,9 @@ public static IResourceBuilder RunAsEmulator(this IResourc .WithEndpoint(name: "table", targetPort: 10002) .WithAnnotation(new ContainerImageAnnotation { - Registry = "mcr.microsoft.com", - Image = "azure-storage/azurite", - Tag = "3.31.0" + Registry = StorageEmulatorContainerImageTags.Registry, + Image = StorageEmulatorContainerImageTags.Image, + Tag = StorageEmulatorContainerImageTags.Tag }); if (configureContainer != null) diff --git a/src/Aspire.Hosting.Azure.Storage/StorageEmulatorContainerImageTags.cs b/src/Aspire.Hosting.Azure.Storage/StorageEmulatorContainerImageTags.cs new file mode 100644 index 0000000000..a0c780ddf1 --- /dev/null +++ b/src/Aspire.Hosting.Azure.Storage/StorageEmulatorContainerImageTags.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.Storage; + +internal static class StorageEmulatorContainerImageTags +{ + /// mcr.microsoft.com + public const string Registry = "mcr.microsoft.com"; + + /// azure-storage/azurite + public const string Image = "azure-storage/azurite"; + + /// 3.31.0 + public const string Tag = "3.31.0"; +} diff --git a/src/Aspire.Hosting.Kafka/KafkaBuilderExtensions.cs b/src/Aspire.Hosting.Kafka/KafkaBuilderExtensions.cs index ff082a9fb9..840f2bb0cc 100644 --- a/src/Aspire.Hosting.Kafka/KafkaBuilderExtensions.cs +++ b/src/Aspire.Hosting.Kafka/KafkaBuilderExtensions.cs @@ -21,7 +21,7 @@ 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 the package defaults to the 7.6.1 tag of the confluentinc/confluent-local 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 @@ -77,7 +77,7 @@ public static IResourceBuilder AddKafka(this IDistributedAp } /// - /// Adds a Kafka UI container to the application. This version of the package defaults to the 0.7.2 tag of the provectuslabs/kafka-ui 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. diff --git a/src/Aspire.Hosting.Kafka/KafkaContainerImageTags.cs b/src/Aspire.Hosting.Kafka/KafkaContainerImageTags.cs index 5883e70341..e5151e9f08 100644 --- a/src/Aspire.Hosting.Kafka/KafkaContainerImageTags.cs +++ b/src/Aspire.Hosting.Kafka/KafkaContainerImageTags.cs @@ -5,9 +5,18 @@ namespace Aspire.Hosting; internal static class KafkaContainerImageTags { + /// docker.io public const string Registry = "docker.io"; + + /// confluentinc/confluent-local public const string Image = "confluentinc/confluent-local"; + + /// 7.7.0 public const string Tag = "7.7.0"; + + /// provectuslabs/kafka-ui public const string KafkaUiImage = "provectuslabs/kafka-ui"; + + /// v0.7.2 public const string KafkaUiTag = "v0.7.2"; } diff --git a/src/Aspire.Hosting.Milvus/MilvusBuilderExtensions.cs b/src/Aspire.Hosting.Milvus/MilvusBuilderExtensions.cs index 9eb1260c90..74110349e5 100644 --- a/src/Aspire.Hosting.Milvus/MilvusBuilderExtensions.cs +++ b/src/Aspire.Hosting.Milvus/MilvusBuilderExtensions.cs @@ -36,7 +36,7 @@ public static class MilvusBuilderExtensions /// /// /// - /// This version the package defaults to the 2.3-latest tag of the milvusdb/milvus container image. + /// 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 . /// @@ -172,7 +172,7 @@ public static IResourceBuilder AddDatabase(this IResourc } /// - /// Adds an administration and development platform for Milvus to the application model using Attu. This version the package defaults to the 2.3-latest tag of the attu 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 ae3ebe3c0e..9477597248 100644 --- a/src/Aspire.Hosting.Milvus/MilvusContainerImageTags.cs +++ b/src/Aspire.Hosting.Milvus/MilvusContainerImageTags.cs @@ -5,11 +5,19 @@ namespace Aspire.Hosting.Milvus; internal static class MilvusContainerImageTags { + /// docker.io public const string Registry = "docker.io"; + + /// milvusdb/milvus public const string Image = "milvusdb/milvus"; + + /// v2.4.10 public const string Tag = "v2.4.10"; + /// zilliz/attu public const string AttuImage = "zilliz/attu"; + + /// 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 421dccd19a..70858408cc 100644 --- a/src/Aspire.Hosting.MongoDB/MongoDBBuilderExtensions.cs +++ b/src/Aspire.Hosting.MongoDB/MongoDBBuilderExtensions.cs @@ -17,7 +17,7 @@ public static class MongoDBBuilderExtensions private const int DefaultContainerPort = 27017; /// - /// 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. + /// 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. @@ -76,7 +76,7 @@ public static IResourceBuilder AddDatabase(this IResour } /// - /// Adds a MongoExpress administration and development platform for MongoDB to the application model. This version the package defaults to the 1.0.2-20 tag of the mongo-express 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. diff --git a/src/Aspire.Hosting.MongoDB/MongoDBContainerImageTags.cs b/src/Aspire.Hosting.MongoDB/MongoDBContainerImageTags.cs index 453d207112..155204cf9c 100644 --- a/src/Aspire.Hosting.MongoDB/MongoDBContainerImageTags.cs +++ b/src/Aspire.Hosting.MongoDB/MongoDBContainerImageTags.cs @@ -5,10 +5,21 @@ namespace Aspire.Hosting.MongoDB; internal static class MongoDBContainerImageTags { + /// docker.io public const string Registry = "docker.io"; + + /// library/mongo public const string Image = "library/mongo"; + + /// 7.0 public const string Tag = "7.0"; + + /// docker.io public const string MongoExpressRegistry = "docker.io"; + + /// library/mongo-express public const string MongoExpressImage = "library/mongo-express"; + + /// 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 f916a7ee43..6d9cd0bb2e 100644 --- a/src/Aspire.Hosting.MySql/MySqlBuilderExtensions.cs +++ b/src/Aspire.Hosting.MySql/MySqlBuilderExtensions.cs @@ -16,7 +16,7 @@ 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 the package defaults to the 8.3.0 tag of the mysql 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. @@ -112,7 +112,7 @@ public static IResourceBuilder AddDatabase(this IResource } /// - /// Adds a phpMyAdmin administration and development platform for MySql to the application model. This version the package defaults to the 5.2 tag of the phpmyadmin 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. diff --git a/src/Aspire.Hosting.MySql/MySqlContainerImageTags.cs b/src/Aspire.Hosting.MySql/MySqlContainerImageTags.cs index fa86dc6ae1..54d43cc7d6 100644 --- a/src/Aspire.Hosting.MySql/MySqlContainerImageTags.cs +++ b/src/Aspire.Hosting.MySql/MySqlContainerImageTags.cs @@ -5,10 +5,18 @@ namespace Aspire.Hosting.MySql; internal static class MySqlContainerImageTags { + /// docker.io public const string Registry = "docker.io"; + + /// library/mysql public const string Image = "library/mysql"; + + /// 9.0 public const string Tag = "9.0"; + /// library/phpmyadmin public const string PhpMyAdminImage = "library/phpmyadmin"; + + /// 5.2 public const string PhpMyAdminTag = "5.2"; } diff --git a/src/Aspire.Hosting.Oracle/OracleContainerImageTags.cs b/src/Aspire.Hosting.Oracle/OracleContainerImageTags.cs index 82d08b6ddd..04f71b57b5 100644 --- a/src/Aspire.Hosting.Oracle/OracleContainerImageTags.cs +++ b/src/Aspire.Hosting.Oracle/OracleContainerImageTags.cs @@ -5,7 +5,12 @@ namespace Aspire.Hosting; internal static class OracleContainerImageTags { + /// container-registry.oracle.com public const string Registry = "container-registry.oracle.com"; + + /// database/free public const string Image = "database/free"; + + /// 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 2faa624e5a..59465784e9 100644 --- a/src/Aspire.Hosting.Oracle/OracleDatabaseBuilderExtensions.cs +++ b/src/Aspire.Hosting.Oracle/OracleDatabaseBuilderExtensions.cs @@ -15,7 +15,7 @@ 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 the package defaults to the 23.3.0.0 tag of the container-registry.oracle.com/database/free 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. diff --git a/src/Aspire.Hosting.PostgreSQL/PostgresBuilderExtensions.cs b/src/Aspire.Hosting.PostgreSQL/PostgresBuilderExtensions.cs index a097297fca..0f2b866d56 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 the package defaults to the 16.2 tag of the postgres container image + /// 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 /// /// The . /// The name of the resource. This name will be used as the connection string name when referenced in a dependency. @@ -153,7 +153,7 @@ public static IResourceBuilder AddDatabase(this IResou } /// - /// Adds a pgAdmin 4 administration and development platform for PostgreSQL to the application model. This version the package defaults to the 8.8 tag of the dpage/pgadmin4 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. @@ -289,7 +289,7 @@ public static IResourceBuilder WithHostPort(this IResour /// /// /// - /// This version the package defaults to the 0.15.0 tag of the sosedoff/pgweb container image. + /// 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 35b74e8562..f003a428c2 100644 --- a/src/Aspire.Hosting.PostgreSQL/PostgresContainerImageTags.cs +++ b/src/Aspire.Hosting.PostgreSQL/PostgresContainerImageTags.cs @@ -5,13 +5,30 @@ namespace Aspire.Hosting.Postgres; internal static class PostgresContainerImageTags { + /// docker.io public const string Registry = "docker.io"; + + /// library/postgres public const string Image = "library/postgres"; + + /// 16.4 public const string Tag = "16.4"; + + /// docker.io public const string PgAdminRegistry = "docker.io"; + + /// dpage/pgadmin4 public const string PgAdminImage = "dpage/pgadmin4"; + + /// 8.11 public const string PgAdminTag = "8.11"; + + /// docker.io public const string PgWebRegistry = "docker.io"; + + /// sosedoff/pgweb public const string PgWebImage = "sosedoff/pgweb"; + + /// 0.15.0 public const string PgWebTag = "0.15.0"; } diff --git a/src/Aspire.Hosting.Qdrant/QdrantBuilderExtensions.cs b/src/Aspire.Hosting.Qdrant/QdrantBuilderExtensions.cs index 74174ca588..99d78452d9 100644 --- a/src/Aspire.Hosting.Qdrant/QdrantBuilderExtensions.cs +++ b/src/Aspire.Hosting.Qdrant/QdrantBuilderExtensions.cs @@ -21,7 +21,7 @@ public static class QdrantBuilderExtensions /// Adds a Qdrant resource to the application. A container is used for local development. /// /// - /// This version the package defaults to the v1.8.4 tag of the qdrant/qdrant container image. + /// 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. /// /// The . diff --git a/src/Aspire.Hosting.Qdrant/QdrantContainerImageTags.cs b/src/Aspire.Hosting.Qdrant/QdrantContainerImageTags.cs index ef843c1e9a..37025365a1 100644 --- a/src/Aspire.Hosting.Qdrant/QdrantContainerImageTags.cs +++ b/src/Aspire.Hosting.Qdrant/QdrantContainerImageTags.cs @@ -5,7 +5,12 @@ namespace Aspire.Hosting.Qdrant; internal static class QdrantContainerImageTags { + /// docker.io public const string Registry = "docker.io"; + + /// qdrant/qdrant public const string Image = "qdrant/qdrant"; + + /// v1.11.3 public const string Tag = "v1.11.3"; } diff --git a/src/Aspire.Hosting.Sdk/SDK/Sdk.in.targets b/src/Aspire.Hosting.Sdk/SDK/Sdk.in.targets index 3987bf6732..575953163f 100644 --- a/src/Aspire.Hosting.Sdk/SDK/Sdk.in.targets +++ b/src/Aspire.Hosting.Sdk/SDK/Sdk.in.targets @@ -79,7 +79,7 @@ <_AppHostVersion>@VERSION@ - + @@ -90,4 +90,4 @@ - \ No newline at end of file + diff --git a/src/Components/Aspire.Azure.Messaging.ServiceBus/AzureMessagingServiceBusSettings.cs b/src/Components/Aspire.Azure.Messaging.ServiceBus/AzureMessagingServiceBusSettings.cs index 3b3e15c0f4..ed623a2ae2 100644 --- a/src/Components/Aspire.Azure.Messaging.ServiceBus/AzureMessagingServiceBusSettings.cs +++ b/src/Components/Aspire.Azure.Messaging.ServiceBus/AzureMessagingServiceBusSettings.cs @@ -53,7 +53,7 @@ public sealed class AzureMessagingServiceBusSettings : IConnectionStringSettings /// Or by setting "AZURE_EXPERIMENTAL_ENABLE_ACTIVITY_SOURCE" environment variable to "true". /// /// - /// The default value is . + /// The default value is . /// public bool DisableTracing { diff --git a/src/Tools/ConfigurationSchemaGenerator/RuntimeSource/Roslyn/GetBestTypeByMetadataName.cs b/src/Tools/ConfigurationSchemaGenerator/RuntimeSource/Roslyn/GetBestTypeByMetadataName.cs index e78668b979..92d54557a7 100644 --- a/src/Tools/ConfigurationSchemaGenerator/RuntimeSource/Roslyn/GetBestTypeByMetadataName.cs +++ b/src/Tools/ConfigurationSchemaGenerator/RuntimeSource/Roslyn/GetBestTypeByMetadataName.cs @@ -99,7 +99,7 @@ private static SymbolVisibility GetResultantVisibility(this ISymbol symbol) switch (symbol.Kind) { case SymbolKind.Alias: - // Aliases are uber private. They're only visible in the same file that they + // Aliases are uber private. They're only visible in the same file that they // were declared in. return SymbolVisibility.Private;