From 8ab819dd2cc8135d5cd2c6bee27e12db66f712fe Mon Sep 17 00:00:00 2001 From: IEvangelist Date: Mon, 28 Sep 2026 12:55:15 -0500 Subject: [PATCH 1/4] Refresh stable Aspire Dashboard README content Replace generic .NET boilerplate with a standalone dashboard quickstart and curated Aspire guidance. Preserve the stable image namespace, publication configuration, and unrelated image documentation. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --- .../docker-hub/README.aspire-dashboard.md | 141 ++++-------------- .../mar/README.aspire-dashboard.portal.md | 140 ++++------------- README.aspire-dashboard.md | 141 ++++-------------- .../About.aspire-dashboard.md | 4 +- eng/readme-templates/About.md | 4 +- eng/readme-templates/DefaultLayout.md | 5 +- eng/readme-templates/README.mcr.md | 7 +- eng/readme-templates/Support.md | 16 +- eng/readme-templates/Use.aspire-dashboard.md | 87 +++-------- eng/readme-templates/Use.md | 3 +- 10 files changed, 141 insertions(+), 407 deletions(-) diff --git a/.portal-docs/docker-hub/README.aspire-dashboard.md b/.portal-docs/docker-hub/README.aspire-dashboard.md index 33e2714f3f..4b43e9297b 100644 --- a/.portal-docs/docker-hub/README.aspire-dashboard.md +++ b/.portal-docs/docker-hub/README.aspire-dashboard.md @@ -5,144 +5,65 @@ # About -This image contains the Aspire Dashboard. +The [Aspire Dashboard](https://aspire.dev/dashboard/standalone/) is a standalone viewer for logs, traces, and metrics from OpenTelemetry-enabled applications in any language. No Aspire AppHost or .NET application is required. Source code is available in [microsoft/aspire](https://github.com/microsoft/aspire). -Watch [discussions](https://github.com/dotnet/dotnet-docker/discussions/categories/announcements) for Docker-related .NET announcements. +For preview builds, see the [nightly Aspire Dashboard image](https://mcr.microsoft.com/artifact/mar/aspire/nightly/dashboard/about). # Usage -The Aspire Dashboard is a browser-based app to view run-time information about your distributed application. +Run the dashboard locally: -The dashboard shows: +```console +docker run --rm -d --name aspire-dashboard -p 127.0.0.1:18888:18888 -p 127.0.0.1:4317:18889 -p 127.0.0.1:4318:18890 mcr.microsoft.com/dotnet/aspire-dashboard:13 +``` -* Resources that make up your app, such as .NET projects, executables and containers. -* Live console logs of resources. -* Live telemetry, such as structured logs, traces and metrics. +Open . To sign in, use the login URL or token printed in the container logs: -## Configuration +```console +docker logs aspire-dashboard +``` -The dashboard must be configured when it is started. The configuration is done via environment variables. The following environment variables are supported: +This example keeps browser-token authentication enabled and binds the published ports to the host's loopback interface. Incoming OTLP telemetry is unauthenticated by default in standalone mode; the browser token does not secure telemetry ingestion. Only accept telemetry from trusted applications; configure HTTPS, authentication, and network controls before exposing the dashboard beyond your machine. See [dashboard security guidance](https://aspire.dev/dashboard/security-considerations/). -* `ASPNETCORE_URLS` specifies one or more HTTP endpoints through which the dashboard frontend is served. The frontend endpoint is used to view the dashboard in a browser. Defaults to `http://localhost:18888`. -* `DOTNET_DASHBOARD_OTLP_ENDPOINT_URL` specifies the [OTLP/gRPC](https://opentelemetry.io/docs/specs/otlp/#otlpgrpc) endpoint. This endpoint hosts an OTLP service and receives telemetry using gRPC. When the dashboard is launched by the Aspire app host this address is secured with HTTPS. Securing the dashboard with HTTPS is recommended. Defaults to `http://localhost:18889`. -* `DOTNET_DASHBOARD_OTLP_HTTP_ENDPOINT_URL` specifies the [OTLP/HTTP](https://opentelemetry.io/docs/specs/otlp/#otlphttp) endpoint. This endpoint hosts an OTLP service and receives telemetry using Protobuf over HTTP. Defaults to `http://localhost:18890`. -* `ASPIRE_DASHBOARD_MCP_ENDPOINT_URL` specifies the Aspire MCP endpoint. When this value isn't specified then the MCP server is hosted with an `ASPNETCORE_URLS` endpoint. The MCP server can be disabled by configuring `Dashboard:Mcp:Disabled` to `true`. Defaults to `http://localhost:18891`. -* `DOTNET_DASHBOARD_UNSECURED_ALLOW_ANONYMOUS` specifies the dashboard doesn't use authentication and accepts anonymous access. This setting is a shortcut to configuring `Dashboard:Frontend:AuthMode`, `Dashboard:Otlp:AuthMode` and `Dashboard:Mcp:AuthMode` to `Unsecured`. -* `DOTNET_DASHBOARD_CONFIG_FILE_PATH` specifies the path for an optional JSON configuration file. +## Send telemetry -### Frontend authentication +Instrument your application with its language's OpenTelemetry SDK and configure an OTLP exporter with the matching protocol and endpoint. Starting the dashboard does not instrument your application automatically. For applications running on the host, use: -The dashboard's frontend supports OpenID Connect (OIDC). Set `Dashboard__Frontend__AuthMode` to `OpenIdConnect`, then add the following configuration: +* OTLP/gRPC: `http://localhost:4317` (mapped to container port `18889`). +* OTLP/HTTP: `http://localhost:4318` (mapped to container port `18890`). -* `Authentication__Schemes__OpenIdConnect__Authority` — URL to the identity provider (IdP) -* `Authentication__Schemes__OpenIdConnect__ClientId` — Identity of the relying party (RP) -* `Authentication__Schemes__OpenIdConnect__ClientSecret`— A secret that only the real RP would know -* Other properties of [`OpenIdConnectOptions`](https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.builder.openidconnectoptions) specified in configuration container `Authentication__Schemes__OpenIdConnect__*` +For applications in other containers, use the dashboard container's name and port (`18889` or `18890`) on a shared Docker network, not their own `localhost`. -It may also be run unsecured. Set `Dashboard__Frontend__AuthMode` to `Unsecured`. The frontend endpoint will allow anonymous access. This setting is used during local development, but is not recommended if you attempt to host the dashboard in other settings. +## Operational notes -## OTLP authentication +* Telemetry is stored in memory with configurable limits and is lost when the dashboard restarts. The dashboard is intended for development and short-term diagnostics, not durable telemetry storage. +* Standalone mode displays telemetry without an AppHost. Resource listings and captured console logs require a configured [resource service](https://aspire.dev/dashboard/configuration/#resources). -The OTLP endpoint can be secured with [client certificate](https://learn.microsoft.com/aspnet/core/security/authentication/certauth) or API key authentication. - -For client certification authentication, set `Dashboard__Otlp__AuthMode` to `Certificate`. - -For API key authentication, set `Dashboard__Otlp__AuthMode` to `ApiKey`, then add the following configuration: - -* `Dashboard__Otlp__PrimaryApiKey` specifies the primary API key. (required, string) -* `Dashboard__Otlp__SecondaryApiKey` specifies the secondary API key. (optional, string) - -It may also be run unsecured. Set `Dashboard__Otlp__AuthMode` to `Unsecured`. The OTLP endpoint will allow anonymous access. This setting is used during local development, but is not recommended if you attempt to host the dashboard in other settings. - -## Resources - -* `Dashboard__ResourceServiceClient__Url` specifies the gRPC endpoint to which the dashboard connects for its data. There's no default. If this variable is unspecified, the dashboard shows OTEL data but no resource list or console logs. - -The resource service client supports certificates. Set `Dashboard__ResourceServiceClient__AuthMode` to `Certificate`, then add the following configuration: - -* `Dashboard__ResourceServiceClient__ClientCertificate__Source` (required) one of: - * `File` to load the cert from a file path, configured with: - * `Dashboard__ResourceServiceClient__ClientCertificate__FilePath` (required, string) - * `Dashboard__ResourceServiceClient__ClientCertificate__Password` (optional, string) - * `KeyStore` to load the cert from a key store, configured with: - * `Dashboard__ResourceServiceClient__ClientCertificate__Subject` (required, string) - * `Dashboard__ResourceServiceClient__ClientCertificate__Store` (optional, [`StoreName`](https://learn.microsoft.com/dotnet/api/system.security.cryptography.x509certificates.storename), defaults to `My`) - * `Dashboard__ResourceServiceClient__ClientCertificate__Location` (optional, [`StoreLocation`](https://learn.microsoft.com/dotnet/api/system.security.cryptography.x509certificates.storelocation), defaults to `CurrentUser`) - -To opt-out of authentication, set `Dashboard__ResourceServiceClient__AuthMode` to `Unsecured`. This completely disables all security for the resource service client. This setting is used during local development, but is not recommended if you attempt to host the dashboard in other settings. - -### Telemetry Limits - -Telemetry is stored in-memory. To avoid excessive memory usage, the dashboard has limits on the count and size of stored telemetry. When a count limit is reached, new telemetry is added, and the oldest telemetry is removed. When a size limit is reached, data is truncated to the limit. - -* `Dashboard__TelemetryLimits__MaxLogCount` specifies the maximum number of log entries. Defaults to 10,000. -* `Dashboard__TelemetryLimits__MaxTraceCount` specifies the maximum number of traces. Defaults to 10,000. -* `Dashboard__TelemetryLimits__MaxMetricsCount` specifies the maximum number of metric data points. Defaults to 50,000. -* `Dashboard__TelemetryLimits__MaxAttributeCount` specifies the maximum number of attributes on telemetry. Defaults to 128. -* `Dashboard__TelemetryLimits__MaxAttributeLength` specifies the maximum length of attributes. Defaults to unlimited. -* `Dashboard__TelemetryLimits__MaxSpanEventCount` specifies the maximum number of events on span attributes. Defaults to unlimited. - -Limits are per-resource. For example, a `MaxLogCount` value of 10,000 configures the dashboard to store up to 10,000 log entries per-resource. - -## Other - -* `Dashboard__ApplicationName` specifies the application name to be displayed in the UI. This applies only when no resource service URL is specified. When a resource service exists, the service specifies the application name. - -# Related Repositories - -.NET: - -* [dotnet](https://hub.docker.com/r/microsoft/dotnet/): .NET -* [dotnet/sdk](https://hub.docker.com/r/microsoft/dotnet-sdk/): .NET SDK -* [dotnet/aspnet](https://hub.docker.com/r/microsoft/dotnet-aspnet/): ASP.NET Core Runtime -* [dotnet/runtime](https://hub.docker.com/r/microsoft/dotnet-runtime/): .NET Runtime -* [dotnet/runtime-deps](https://hub.docker.com/r/microsoft/dotnet-runtime-deps/): .NET Runtime Dependencies -* [dotnet/monitor](https://hub.docker.com/r/microsoft/dotnet-monitor/): .NET Monitor Tool -* [dotnet/nightly/aspire-dashboard](https://hub.docker.com/r/microsoft/dotnet-nightly-aspire-dashboard/): Aspire Dashboard (Preview) -* [dotnet/samples](https://hub.docker.com/r/microsoft/dotnet-samples/): .NET Samples - -.NET Framework: - -* [dotnet/framework](https://hub.docker.com/r/microsoft/dotnet-framework/): .NET Framework, ASP.NET and WCF -* [dotnet/framework/samples](https://hub.docker.com/r/microsoft/dotnet-framework-samples/): .NET Framework, ASP.NET and WCF Samples +## Documentation and examples +* [Run the standalone dashboard](https://aspire.dev/dashboard/standalone/). +* [Python telemetry tutorial](https://aspire.dev/dashboard/standalone-for-python/). +* [JavaScript and Node.js telemetry tutorial](https://aspire.dev/dashboard/standalone-for-nodejs/). +* [Standalone dashboard sample (C#)](https://github.com/microsoft/aspire-samples/tree/main/samples/standalone-dashboard). +* [Dashboard configuration reference](https://aspire.dev/dashboard/configuration/). # Full Tag Listing View the current tags at the [Microsoft Artifact Registry portal](https://mcr.microsoft.com/artifact/mar/dotnet/aspire-dashboard/tags) or on [GitHub](https://github.com/dotnet/dotnet-docker/blob/main/README.aspire-dashboard.md#full-tag-listing). # Support -## Lifecycle - -* [Microsoft Support for .NET](https://github.com/dotnet/core/blob/main/support.md) -* [Supported Container Platforms Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-platforms.md) -* [Supported Tags Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-tags.md) - -## Image Update Policy - -* **Base Image Updates:** Images are re-built within 12 hours of any updates to their base images (e.g. debian:bookworm-slim, windows/nanoserver:ltsc2022, etc.). -* **.NET Releases:** Images are re-built as part of releasing new .NET versions. This includes new major versions, minor versions, and servicing releases. -* **Critical CVEs:** Images are re-built to pick up critical CVE fixes as described by the CVE Update Policy below. -* **Monthly Re-builds:** Images are re-built monthly, typically on the second Tuesday of the month, in order to pick up lower-severity CVE fixes. -* **Out-Of-Band Updates:** Images can sometimes be re-built when out-of-band updates are necessary to address critical issues. If this happens, new fixed version tags will be updated according to the [Fixed version tags documentation](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-tags.md#fixed-version-tags). - -### CVE Update Policy - -.NET container images are regularly monitored for the presence of CVEs. A given image will be rebuilt to pick up fixes for a CVE when: - -* We detect the image contains a CVE with a [CVSS](https://nvd.nist.gov/vuln-metrics/cvss) score of "Critical" -* **AND** the CVE is in a package that is added in our Dockerfile layers (meaning the CVE is in a package we explicitly install or any transitive dependencies of those packages) -* **AND** there is a CVE fix for the package available in the affected base image's package repository. +See the [Aspire support policy](https://aspire.dev/support/) for supported versions and lifecycle information. Container images are also covered by the [Supported Container Platforms Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-platforms.md), [Supported Tags Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-tags.md), and [Image Update Policy](https://github.com/dotnet/dotnet-docker/blob/main/README.md#image-update-policy). -Please refer to the [Security Policy](https://github.com/dotnet/dotnet-docker/blob/main/SECURITY.md) and [Container Vulnerability Workflow](https://github.com/dotnet/dotnet-docker/blob/main/documentation/vulnerability-reporting.md) for more detail about what to do when a CVE is encountered in a .NET image. +For container security and vulnerability reporting, see the [Security Policy](https://github.com/dotnet/dotnet-docker/blob/main/SECURITY.md) and [Container Vulnerability Workflow](https://github.com/dotnet/dotnet-docker/blob/main/documentation/vulnerability-reporting.md). ## Feedback -* [File an issue](https://github.com/dotnet/dotnet-docker/issues/new/choose) -* [Contact Microsoft Support](https://support.microsoft.com/contactus/) +* [Dashboard issues and feature requests](https://github.com/microsoft/aspire/issues). +* [Container image issues](https://github.com/dotnet/dotnet-docker/issues/new/choose). +* [Contact Microsoft Support](https://support.microsoft.com/contactus/). # License * Legal Notice: [Container License Information](https://aka.ms/mcr/osslegalnotice) -* [.NET license](https://github.com/dotnet/dotnet-docker/blob/main/LICENSE) +* [Aspire MIT license](https://github.com/microsoft/aspire/blob/main/LICENSE.TXT) * [Discover licensing for Linux image contents](https://github.com/dotnet/dotnet-docker/blob/main/documentation/image-artifact-details.md) diff --git a/.portal-docs/mar/README.aspire-dashboard.portal.md b/.portal-docs/mar/README.aspire-dashboard.portal.md index 6202b665ee..b2e569a6f7 100644 --- a/.portal-docs/mar/README.aspire-dashboard.portal.md +++ b/.portal-docs/mar/README.aspire-dashboard.portal.md @@ -1,144 +1,66 @@ ## About -This image contains the Aspire Dashboard. +The [Aspire Dashboard](https://aspire.dev/dashboard/standalone/) is a standalone viewer for logs, traces, and metrics from OpenTelemetry-enabled applications in any language. No Aspire AppHost or .NET application is required. Source code is available in [microsoft/aspire](https://github.com/microsoft/aspire). -Watch [discussions](https://github.com/dotnet/dotnet-docker/discussions/categories/announcements) for Docker-related .NET announcements. +For preview builds, see the [nightly Aspire Dashboard image](https://mcr.microsoft.com/artifact/mar/aspire/nightly/dashboard/about). ## Featured Tags * `13` * `docker pull mcr.microsoft.com/dotnet/aspire-dashboard:13` -## Related Repositories - -.NET: - -* [dotnet](https://mcr.microsoft.com/catalog?search=dotnet): .NET -* [dotnet/sdk](https://mcr.microsoft.com/artifact/mar/dotnet/sdk/about): .NET SDK -* [dotnet/aspnet](https://mcr.microsoft.com/artifact/mar/dotnet/aspnet/about): ASP.NET Core Runtime -* [dotnet/runtime](https://mcr.microsoft.com/artifact/mar/dotnet/runtime/about): .NET Runtime -* [dotnet/runtime-deps](https://mcr.microsoft.com/artifact/mar/dotnet/runtime-deps/about): .NET Runtime Dependencies -* [dotnet/monitor](https://mcr.microsoft.com/artifact/mar/dotnet/monitor/about): .NET Monitor Tool -* [dotnet/nightly/aspire-dashboard](https://mcr.microsoft.com/artifact/mar/dotnet/nightly/aspire-dashboard/about): Aspire Dashboard (Preview) -* [dotnet/samples](https://mcr.microsoft.com/artifact/mar/dotnet/samples/about): .NET Samples - -.NET Framework: - -* [dotnet/framework](https://mcr.microsoft.com/catalog?search=dotnet/framework): .NET Framework, ASP.NET and WCF -* [dotnet/framework/samples](https://mcr.microsoft.com/artifact/mar/dotnet/framework/samples/about): .NET Framework, ASP.NET and WCF Samples - ## Usage -The Aspire Dashboard is a browser-based app to view run-time information about your distributed application. - -The dashboard shows: - -* Resources that make up your app, such as .NET projects, executables and containers. -* Live console logs of resources. -* Live telemetry, such as structured logs, traces and metrics. - -### Configuration - -The dashboard must be configured when it is started. The configuration is done via environment variables. The following environment variables are supported: - -* `ASPNETCORE_URLS` specifies one or more HTTP endpoints through which the dashboard frontend is served. The frontend endpoint is used to view the dashboard in a browser. Defaults to `http://localhost:18888`. -* `DOTNET_DASHBOARD_OTLP_ENDPOINT_URL` specifies the [OTLP/gRPC](https://opentelemetry.io/docs/specs/otlp/#otlpgrpc) endpoint. This endpoint hosts an OTLP service and receives telemetry using gRPC. When the dashboard is launched by the Aspire app host this address is secured with HTTPS. Securing the dashboard with HTTPS is recommended. Defaults to `http://localhost:18889`. -* `DOTNET_DASHBOARD_OTLP_HTTP_ENDPOINT_URL` specifies the [OTLP/HTTP](https://opentelemetry.io/docs/specs/otlp/#otlphttp) endpoint. This endpoint hosts an OTLP service and receives telemetry using Protobuf over HTTP. Defaults to `http://localhost:18890`. -* `ASPIRE_DASHBOARD_MCP_ENDPOINT_URL` specifies the Aspire MCP endpoint. When this value isn't specified then the MCP server is hosted with an `ASPNETCORE_URLS` endpoint. The MCP server can be disabled by configuring `Dashboard:Mcp:Disabled` to `true`. Defaults to `http://localhost:18891`. -* `DOTNET_DASHBOARD_UNSECURED_ALLOW_ANONYMOUS` specifies the dashboard doesn't use authentication and accepts anonymous access. This setting is a shortcut to configuring `Dashboard:Frontend:AuthMode`, `Dashboard:Otlp:AuthMode` and `Dashboard:Mcp:AuthMode` to `Unsecured`. -* `DOTNET_DASHBOARD_CONFIG_FILE_PATH` specifies the path for an optional JSON configuration file. - -#### Frontend authentication - -The dashboard's frontend supports OpenID Connect (OIDC). Set `Dashboard__Frontend__AuthMode` to `OpenIdConnect`, then add the following configuration: - -* `Authentication__Schemes__OpenIdConnect__Authority` — URL to the identity provider (IdP) -* `Authentication__Schemes__OpenIdConnect__ClientId` — Identity of the relying party (RP) -* `Authentication__Schemes__OpenIdConnect__ClientSecret`— A secret that only the real RP would know -* Other properties of [`OpenIdConnectOptions`](https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.builder.openidconnectoptions) specified in configuration container `Authentication__Schemes__OpenIdConnect__*` +Run the dashboard locally: -It may also be run unsecured. Set `Dashboard__Frontend__AuthMode` to `Unsecured`. The frontend endpoint will allow anonymous access. This setting is used during local development, but is not recommended if you attempt to host the dashboard in other settings. +```console +docker run --rm -d --name aspire-dashboard -p 127.0.0.1:18888:18888 -p 127.0.0.1:4317:18889 -p 127.0.0.1:4318:18890 mcr.microsoft.com/dotnet/aspire-dashboard:13 +``` -### OTLP authentication +Open . To sign in, use the login URL or token printed in the container logs: -The OTLP endpoint can be secured with [client certificate](https://learn.microsoft.com/aspnet/core/security/authentication/certauth) or API key authentication. +```console +docker logs aspire-dashboard +``` -For client certification authentication, set `Dashboard__Otlp__AuthMode` to `Certificate`. +This example keeps browser-token authentication enabled and binds the published ports to the host's loopback interface. Incoming OTLP telemetry is unauthenticated by default in standalone mode; the browser token does not secure telemetry ingestion. Only accept telemetry from trusted applications; configure HTTPS, authentication, and network controls before exposing the dashboard beyond your machine. See [dashboard security guidance](https://aspire.dev/dashboard/security-considerations/). -For API key authentication, set `Dashboard__Otlp__AuthMode` to `ApiKey`, then add the following configuration: +### Send telemetry -* `Dashboard__Otlp__PrimaryApiKey` specifies the primary API key. (required, string) -* `Dashboard__Otlp__SecondaryApiKey` specifies the secondary API key. (optional, string) +Instrument your application with its language's OpenTelemetry SDK and configure an OTLP exporter with the matching protocol and endpoint. Starting the dashboard does not instrument your application automatically. For applications running on the host, use: -It may also be run unsecured. Set `Dashboard__Otlp__AuthMode` to `Unsecured`. The OTLP endpoint will allow anonymous access. This setting is used during local development, but is not recommended if you attempt to host the dashboard in other settings. +* OTLP/gRPC: `http://localhost:4317` (mapped to container port `18889`). +* OTLP/HTTP: `http://localhost:4318` (mapped to container port `18890`). -### Resources +For applications in other containers, use the dashboard container's name and port (`18889` or `18890`) on a shared Docker network, not their own `localhost`. -* `Dashboard__ResourceServiceClient__Url` specifies the gRPC endpoint to which the dashboard connects for its data. There's no default. If this variable is unspecified, the dashboard shows OTEL data but no resource list or console logs. +### Operational notes -The resource service client supports certificates. Set `Dashboard__ResourceServiceClient__AuthMode` to `Certificate`, then add the following configuration: +* Telemetry is stored in memory with configurable limits and is lost when the dashboard restarts. The dashboard is intended for development and short-term diagnostics, not durable telemetry storage. +* Standalone mode displays telemetry without an AppHost. Resource listings and captured console logs require a configured [resource service](https://aspire.dev/dashboard/configuration/#resources). -* `Dashboard__ResourceServiceClient__ClientCertificate__Source` (required) one of: - * `File` to load the cert from a file path, configured with: - * `Dashboard__ResourceServiceClient__ClientCertificate__FilePath` (required, string) - * `Dashboard__ResourceServiceClient__ClientCertificate__Password` (optional, string) - * `KeyStore` to load the cert from a key store, configured with: - * `Dashboard__ResourceServiceClient__ClientCertificate__Subject` (required, string) - * `Dashboard__ResourceServiceClient__ClientCertificate__Store` (optional, [`StoreName`](https://learn.microsoft.com/dotnet/api/system.security.cryptography.x509certificates.storename), defaults to `My`) - * `Dashboard__ResourceServiceClient__ClientCertificate__Location` (optional, [`StoreLocation`](https://learn.microsoft.com/dotnet/api/system.security.cryptography.x509certificates.storelocation), defaults to `CurrentUser`) +### Documentation and examples -To opt-out of authentication, set `Dashboard__ResourceServiceClient__AuthMode` to `Unsecured`. This completely disables all security for the resource service client. This setting is used during local development, but is not recommended if you attempt to host the dashboard in other settings. - -#### Telemetry Limits - -Telemetry is stored in-memory. To avoid excessive memory usage, the dashboard has limits on the count and size of stored telemetry. When a count limit is reached, new telemetry is added, and the oldest telemetry is removed. When a size limit is reached, data is truncated to the limit. - -* `Dashboard__TelemetryLimits__MaxLogCount` specifies the maximum number of log entries. Defaults to 10,000. -* `Dashboard__TelemetryLimits__MaxTraceCount` specifies the maximum number of traces. Defaults to 10,000. -* `Dashboard__TelemetryLimits__MaxMetricsCount` specifies the maximum number of metric data points. Defaults to 50,000. -* `Dashboard__TelemetryLimits__MaxAttributeCount` specifies the maximum number of attributes on telemetry. Defaults to 128. -* `Dashboard__TelemetryLimits__MaxAttributeLength` specifies the maximum length of attributes. Defaults to unlimited. -* `Dashboard__TelemetryLimits__MaxSpanEventCount` specifies the maximum number of events on span attributes. Defaults to unlimited. - -Limits are per-resource. For example, a `MaxLogCount` value of 10,000 configures the dashboard to store up to 10,000 log entries per-resource. - -### Other - -* `Dashboard__ApplicationName` specifies the application name to be displayed in the UI. This applies only when no resource service URL is specified. When a resource service exists, the service specifies the application name. +* [Run the standalone dashboard](https://aspire.dev/dashboard/standalone/). +* [Python telemetry tutorial](https://aspire.dev/dashboard/standalone-for-python/). +* [JavaScript and Node.js telemetry tutorial](https://aspire.dev/dashboard/standalone-for-nodejs/). +* [Standalone dashboard sample (C#)](https://github.com/microsoft/aspire-samples/tree/main/samples/standalone-dashboard). +* [Dashboard configuration reference](https://aspire.dev/dashboard/configuration/). ## Support -### Lifecycle - -* [Microsoft Support for .NET](https://github.com/dotnet/core/blob/main/support.md) -* [Supported Container Platforms Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-platforms.md) -* [Supported Tags Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-tags.md) - -### Image Update Policy - -* **Base Image Updates:** Images are re-built within 12 hours of any updates to their base images (e.g. debian:bookworm-slim, windows/nanoserver:ltsc2022, etc.). -* **.NET Releases:** Images are re-built as part of releasing new .NET versions. This includes new major versions, minor versions, and servicing releases. -* **Critical CVEs:** Images are re-built to pick up critical CVE fixes as described by the CVE Update Policy below. -* **Monthly Re-builds:** Images are re-built monthly, typically on the second Tuesday of the month, in order to pick up lower-severity CVE fixes. -* **Out-Of-Band Updates:** Images can sometimes be re-built when out-of-band updates are necessary to address critical issues. If this happens, new fixed version tags will be updated according to the [Fixed version tags documentation](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-tags.md#fixed-version-tags). - -#### CVE Update Policy - -.NET container images are regularly monitored for the presence of CVEs. A given image will be rebuilt to pick up fixes for a CVE when: - -* We detect the image contains a CVE with a [CVSS](https://nvd.nist.gov/vuln-metrics/cvss) score of "Critical" -* **AND** the CVE is in a package that is added in our Dockerfile layers (meaning the CVE is in a package we explicitly install or any transitive dependencies of those packages) -* **AND** there is a CVE fix for the package available in the affected base image's package repository. +See the [Aspire support policy](https://aspire.dev/support/) for supported versions and lifecycle information. Container images are also covered by the [Supported Container Platforms Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-platforms.md), [Supported Tags Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-tags.md), and [Image Update Policy](https://github.com/dotnet/dotnet-docker/blob/main/README.md#image-update-policy). -Please refer to the [Security Policy](https://github.com/dotnet/dotnet-docker/blob/main/SECURITY.md) and [Container Vulnerability Workflow](https://github.com/dotnet/dotnet-docker/blob/main/documentation/vulnerability-reporting.md) for more detail about what to do when a CVE is encountered in a .NET image. +For container security and vulnerability reporting, see the [Security Policy](https://github.com/dotnet/dotnet-docker/blob/main/SECURITY.md) and [Container Vulnerability Workflow](https://github.com/dotnet/dotnet-docker/blob/main/documentation/vulnerability-reporting.md). ### Feedback -* [File an issue](https://github.com/dotnet/dotnet-docker/issues/new/choose) -* [Contact Microsoft Support](https://support.microsoft.com/contactus/) +* [Dashboard issues and feature requests](https://github.com/microsoft/aspire/issues). +* [Container image issues](https://github.com/dotnet/dotnet-docker/issues/new/choose). +* [Contact Microsoft Support](https://support.microsoft.com/contactus/). ## License * Legal Notice: [Container License Information](https://aka.ms/mcr/osslegalnotice) -* [.NET license](https://github.com/dotnet/dotnet-docker/blob/main/LICENSE) +* [Aspire MIT license](https://github.com/microsoft/aspire/blob/main/LICENSE.TXT) * [Discover licensing for Linux image contents](https://github.com/dotnet/dotnet-docker/blob/main/documentation/image-artifact-details.md) diff --git a/README.aspire-dashboard.md b/README.aspire-dashboard.md index fa987013ec..ff7eaeb1f5 100644 --- a/README.aspire-dashboard.md +++ b/README.aspire-dashboard.md @@ -7,107 +7,47 @@ ## About -This image contains the Aspire Dashboard. +The [Aspire Dashboard](https://aspire.dev/dashboard/standalone/) is a standalone viewer for logs, traces, and metrics from OpenTelemetry-enabled applications in any language. No Aspire AppHost or .NET application is required. Source code is available in [microsoft/aspire](https://github.com/microsoft/aspire). -Watch [discussions](https://github.com/dotnet/dotnet-docker/discussions/categories/announcements) for Docker-related .NET announcements. +For preview builds, see the [nightly Aspire Dashboard image](https://mcr.microsoft.com/artifact/mar/aspire/nightly/dashboard/about). ## Usage -The Aspire Dashboard is a browser-based app to view run-time information about your distributed application. +Run the dashboard locally: -The dashboard shows: +```console +docker run --rm -d --name aspire-dashboard -p 127.0.0.1:18888:18888 -p 127.0.0.1:4317:18889 -p 127.0.0.1:4318:18890 mcr.microsoft.com/dotnet/aspire-dashboard:13 +``` -* Resources that make up your app, such as .NET projects, executables and containers. -* Live console logs of resources. -* Live telemetry, such as structured logs, traces and metrics. +Open . To sign in, use the login URL or token printed in the container logs: -### Configuration +```console +docker logs aspire-dashboard +``` -The dashboard must be configured when it is started. The configuration is done via environment variables. The following environment variables are supported: +This example keeps browser-token authentication enabled and binds the published ports to the host's loopback interface. Incoming OTLP telemetry is unauthenticated by default in standalone mode; the browser token does not secure telemetry ingestion. Only accept telemetry from trusted applications; configure HTTPS, authentication, and network controls before exposing the dashboard beyond your machine. See [dashboard security guidance](https://aspire.dev/dashboard/security-considerations/). -* `ASPNETCORE_URLS` specifies one or more HTTP endpoints through which the dashboard frontend is served. The frontend endpoint is used to view the dashboard in a browser. Defaults to `http://localhost:18888`. -* `DOTNET_DASHBOARD_OTLP_ENDPOINT_URL` specifies the [OTLP/gRPC](https://opentelemetry.io/docs/specs/otlp/#otlpgrpc) endpoint. This endpoint hosts an OTLP service and receives telemetry using gRPC. When the dashboard is launched by the Aspire app host this address is secured with HTTPS. Securing the dashboard with HTTPS is recommended. Defaults to `http://localhost:18889`. -* `DOTNET_DASHBOARD_OTLP_HTTP_ENDPOINT_URL` specifies the [OTLP/HTTP](https://opentelemetry.io/docs/specs/otlp/#otlphttp) endpoint. This endpoint hosts an OTLP service and receives telemetry using Protobuf over HTTP. Defaults to `http://localhost:18890`. -* `ASPIRE_DASHBOARD_MCP_ENDPOINT_URL` specifies the Aspire MCP endpoint. When this value isn't specified then the MCP server is hosted with an `ASPNETCORE_URLS` endpoint. The MCP server can be disabled by configuring `Dashboard:Mcp:Disabled` to `true`. Defaults to `http://localhost:18891`. -* `DOTNET_DASHBOARD_UNSECURED_ALLOW_ANONYMOUS` specifies the dashboard doesn't use authentication and accepts anonymous access. This setting is a shortcut to configuring `Dashboard:Frontend:AuthMode`, `Dashboard:Otlp:AuthMode` and `Dashboard:Mcp:AuthMode` to `Unsecured`. -* `DOTNET_DASHBOARD_CONFIG_FILE_PATH` specifies the path for an optional JSON configuration file. +### Send telemetry -#### Frontend authentication +Instrument your application with its language's OpenTelemetry SDK and configure an OTLP exporter with the matching protocol and endpoint. Starting the dashboard does not instrument your application automatically. For applications running on the host, use: -The dashboard's frontend supports OpenID Connect (OIDC). Set `Dashboard__Frontend__AuthMode` to `OpenIdConnect`, then add the following configuration: +* OTLP/gRPC: `http://localhost:4317` (mapped to container port `18889`). +* OTLP/HTTP: `http://localhost:4318` (mapped to container port `18890`). -* `Authentication__Schemes__OpenIdConnect__Authority` — URL to the identity provider (IdP) -* `Authentication__Schemes__OpenIdConnect__ClientId` — Identity of the relying party (RP) -* `Authentication__Schemes__OpenIdConnect__ClientSecret`— A secret that only the real RP would know -* Other properties of [`OpenIdConnectOptions`](https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.builder.openidconnectoptions) specified in configuration container `Authentication__Schemes__OpenIdConnect__*` +For applications in other containers, use the dashboard container's name and port (`18889` or `18890`) on a shared Docker network, not their own `localhost`. -It may also be run unsecured. Set `Dashboard__Frontend__AuthMode` to `Unsecured`. The frontend endpoint will allow anonymous access. This setting is used during local development, but is not recommended if you attempt to host the dashboard in other settings. +### Operational notes -### OTLP authentication +* Telemetry is stored in memory with configurable limits and is lost when the dashboard restarts. The dashboard is intended for development and short-term diagnostics, not durable telemetry storage. +* Standalone mode displays telemetry without an AppHost. Resource listings and captured console logs require a configured [resource service](https://aspire.dev/dashboard/configuration/#resources). -The OTLP endpoint can be secured with [client certificate](https://learn.microsoft.com/aspnet/core/security/authentication/certauth) or API key authentication. - -For client certification authentication, set `Dashboard__Otlp__AuthMode` to `Certificate`. - -For API key authentication, set `Dashboard__Otlp__AuthMode` to `ApiKey`, then add the following configuration: - -* `Dashboard__Otlp__PrimaryApiKey` specifies the primary API key. (required, string) -* `Dashboard__Otlp__SecondaryApiKey` specifies the secondary API key. (optional, string) - -It may also be run unsecured. Set `Dashboard__Otlp__AuthMode` to `Unsecured`. The OTLP endpoint will allow anonymous access. This setting is used during local development, but is not recommended if you attempt to host the dashboard in other settings. - -### Resources - -* `Dashboard__ResourceServiceClient__Url` specifies the gRPC endpoint to which the dashboard connects for its data. There's no default. If this variable is unspecified, the dashboard shows OTEL data but no resource list or console logs. - -The resource service client supports certificates. Set `Dashboard__ResourceServiceClient__AuthMode` to `Certificate`, then add the following configuration: - -* `Dashboard__ResourceServiceClient__ClientCertificate__Source` (required) one of: - * `File` to load the cert from a file path, configured with: - * `Dashboard__ResourceServiceClient__ClientCertificate__FilePath` (required, string) - * `Dashboard__ResourceServiceClient__ClientCertificate__Password` (optional, string) - * `KeyStore` to load the cert from a key store, configured with: - * `Dashboard__ResourceServiceClient__ClientCertificate__Subject` (required, string) - * `Dashboard__ResourceServiceClient__ClientCertificate__Store` (optional, [`StoreName`](https://learn.microsoft.com/dotnet/api/system.security.cryptography.x509certificates.storename), defaults to `My`) - * `Dashboard__ResourceServiceClient__ClientCertificate__Location` (optional, [`StoreLocation`](https://learn.microsoft.com/dotnet/api/system.security.cryptography.x509certificates.storelocation), defaults to `CurrentUser`) - -To opt-out of authentication, set `Dashboard__ResourceServiceClient__AuthMode` to `Unsecured`. This completely disables all security for the resource service client. This setting is used during local development, but is not recommended if you attempt to host the dashboard in other settings. - -#### Telemetry Limits - -Telemetry is stored in-memory. To avoid excessive memory usage, the dashboard has limits on the count and size of stored telemetry. When a count limit is reached, new telemetry is added, and the oldest telemetry is removed. When a size limit is reached, data is truncated to the limit. - -* `Dashboard__TelemetryLimits__MaxLogCount` specifies the maximum number of log entries. Defaults to 10,000. -* `Dashboard__TelemetryLimits__MaxTraceCount` specifies the maximum number of traces. Defaults to 10,000. -* `Dashboard__TelemetryLimits__MaxMetricsCount` specifies the maximum number of metric data points. Defaults to 50,000. -* `Dashboard__TelemetryLimits__MaxAttributeCount` specifies the maximum number of attributes on telemetry. Defaults to 128. -* `Dashboard__TelemetryLimits__MaxAttributeLength` specifies the maximum length of attributes. Defaults to unlimited. -* `Dashboard__TelemetryLimits__MaxSpanEventCount` specifies the maximum number of events on span attributes. Defaults to unlimited. - -Limits are per-resource. For example, a `MaxLogCount` value of 10,000 configures the dashboard to store up to 10,000 log entries per-resource. - -### Other - -* `Dashboard__ApplicationName` specifies the application name to be displayed in the UI. This applies only when no resource service URL is specified. When a resource service exists, the service specifies the application name. - -## Related Repositories - -.NET: - -* [dotnet](https://github.com/dotnet/dotnet-docker/blob/main/README.md): .NET -* [dotnet/sdk](https://github.com/dotnet/dotnet-docker/blob/main/README.sdk.md): .NET SDK -* [dotnet/aspnet](https://github.com/dotnet/dotnet-docker/blob/main/README.aspnet.md): ASP.NET Core Runtime -* [dotnet/runtime](https://github.com/dotnet/dotnet-docker/blob/main/README.runtime.md): .NET Runtime -* [dotnet/runtime-deps](https://github.com/dotnet/dotnet-docker/blob/main/README.runtime-deps.md): .NET Runtime Dependencies -* [dotnet/monitor](https://github.com/dotnet/dotnet-docker/blob/main/README.monitor.md): .NET Monitor Tool -* [dotnet/nightly/aspire-dashboard](https://github.com/dotnet/dotnet-docker/blob/nightly/README.aspire-dashboard.md): Aspire Dashboard (Preview) -* [dotnet/samples](https://github.com/dotnet/dotnet-docker/blob/main/README.samples.md): .NET Samples - -.NET Framework: - -* [dotnet/framework](https://github.com/microsoft/dotnet-framework-docker/blob/main/README.md): .NET Framework, ASP.NET and WCF -* [dotnet/framework/samples](https://github.com/microsoft/dotnet-framework-docker/blob/main/README.samples.md): .NET Framework, ASP.NET and WCF Samples +### Documentation and examples +* [Run the standalone dashboard](https://aspire.dev/dashboard/standalone/). +* [Python telemetry tutorial](https://aspire.dev/dashboard/standalone-for-python/). +* [JavaScript and Node.js telemetry tutorial](https://aspire.dev/dashboard/standalone-for-nodejs/). +* [Standalone dashboard sample (C#)](https://github.com/microsoft/aspire-samples/tree/main/samples/standalone-dashboard). +* [Dashboard configuration reference](https://aspire.dev/dashboard/configuration/). ## Full Tag Listing ### Linux amd64 Tags @@ -128,37 +68,18 @@ Tags | Dockerfile | OS Version ## Support -### Lifecycle - -* [Microsoft Support for .NET](https://github.com/dotnet/core/blob/main/support.md) -* [Supported Container Platforms Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-platforms.md) -* [Supported Tags Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-tags.md) - -### Image Update Policy - -* **Base Image Updates:** Images are re-built within 12 hours of any updates to their base images (e.g. debian:bookworm-slim, windows/nanoserver:ltsc2022, etc.). -* **.NET Releases:** Images are re-built as part of releasing new .NET versions. This includes new major versions, minor versions, and servicing releases. -* **Critical CVEs:** Images are re-built to pick up critical CVE fixes as described by the CVE Update Policy below. -* **Monthly Re-builds:** Images are re-built monthly, typically on the second Tuesday of the month, in order to pick up lower-severity CVE fixes. -* **Out-Of-Band Updates:** Images can sometimes be re-built when out-of-band updates are necessary to address critical issues. If this happens, new fixed version tags will be updated according to the [Fixed version tags documentation](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-tags.md#fixed-version-tags). - -#### CVE Update Policy - -.NET container images are regularly monitored for the presence of CVEs. A given image will be rebuilt to pick up fixes for a CVE when: - -* We detect the image contains a CVE with a [CVSS](https://nvd.nist.gov/vuln-metrics/cvss) score of "Critical" -* **AND** the CVE is in a package that is added in our Dockerfile layers (meaning the CVE is in a package we explicitly install or any transitive dependencies of those packages) -* **AND** there is a CVE fix for the package available in the affected base image's package repository. +See the [Aspire support policy](https://aspire.dev/support/) for supported versions and lifecycle information. Container images are also covered by the [Supported Container Platforms Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-platforms.md), [Supported Tags Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-tags.md), and [Image Update Policy](https://github.com/dotnet/dotnet-docker/blob/main/README.md#image-update-policy). -Please refer to the [Security Policy](https://github.com/dotnet/dotnet-docker/blob/main/SECURITY.md) and [Container Vulnerability Workflow](https://github.com/dotnet/dotnet-docker/blob/main/documentation/vulnerability-reporting.md) for more detail about what to do when a CVE is encountered in a .NET image. +For container security and vulnerability reporting, see the [Security Policy](https://github.com/dotnet/dotnet-docker/blob/main/SECURITY.md) and [Container Vulnerability Workflow](https://github.com/dotnet/dotnet-docker/blob/main/documentation/vulnerability-reporting.md). ### Feedback -* [File an issue](https://github.com/dotnet/dotnet-docker/issues/new/choose) -* [Contact Microsoft Support](https://support.microsoft.com/contactus/) +* [Dashboard issues and feature requests](https://github.com/microsoft/aspire/issues). +* [Container image issues](https://github.com/dotnet/dotnet-docker/issues/new/choose). +* [Contact Microsoft Support](https://support.microsoft.com/contactus/). ## License * Legal Notice: [Container License Information](https://aka.ms/mcr/osslegalnotice) -* [.NET license](https://github.com/dotnet/dotnet-docker/blob/main/LICENSE) +* [Aspire MIT license](https://github.com/microsoft/aspire/blob/main/LICENSE.TXT) * [Discover licensing for Linux image contents](https://github.com/dotnet/dotnet-docker/blob/main/documentation/image-artifact-details.md) diff --git a/eng/readme-templates/About.aspire-dashboard.md b/eng/readme-templates/About.aspire-dashboard.md index 767c957485..960e072b3c 100644 --- a/eng/readme-templates/About.aspire-dashboard.md +++ b/eng/readme-templates/About.aspire-dashboard.md @@ -1 +1,3 @@ -This image contains the Aspire Dashboard. +The [Aspire Dashboard](https://aspire.dev/dashboard/standalone/) is a standalone viewer for logs, traces, and metrics from OpenTelemetry-enabled applications in any language. No Aspire AppHost or .NET application is required. Source code is available in [microsoft/aspire](https://github.com/microsoft/aspire). + +For preview builds, see the [nightly Aspire Dashboard image](https://mcr.microsoft.com/artifact/mar/aspire/nightly/dashboard/about). diff --git a/eng/readme-templates/About.md b/eng/readme-templates/About.md index d2e20f9007..4b4d6b7721 100644 --- a/eng/readme-templates/About.md +++ b/eng/readme-templates/About.md @@ -12,6 +12,6 @@ "leading-line-break": "true", "readme-host": ARGS["readme-host"] ])}}}} -{{InsertTemplate(join(["About", templateQualifier, "md"], "."), [ "top-header": ARGS["top-header"], "readme-host": ARGS["readme-host"] ])}} +{{InsertTemplate(join(["About", templateQualifier, "md"], "."), [ "top-header": ARGS["top-header"], "readme-host": ARGS["readme-host"] ])}}{{if templateQualifier != "aspire-dashboard": -Watch [discussions](https://github.com/dotnet/dotnet-docker/discussions/categories/announcements) for Docker-related .NET announcements. +Watch [discussions](https://github.com/dotnet/dotnet-docker/discussions/categories/announcements) for Docker-related .NET announcements.}} diff --git a/eng/readme-templates/DefaultLayout.md b/eng/readme-templates/DefaultLayout.md index e8d138b7db..a70ff6f8f5 100644 --- a/eng/readme-templates/DefaultLayout.md +++ b/eng/readme-templates/DefaultLayout.md @@ -9,6 +9,7 @@ }} ^ set isNightlyRepo to match(split(REPO, "/")[1], "nightly") ^ + set isAspireDashboard to SHORT_REPO = "aspire-dashboard" || (split(REPO, "/")[0] = "aspire" && SHORT_REPO = "dashboard") ^ set readmeRepoName to when(PARENT_REPO = "monitor", cat("monitor-", SHORT_REPO), SHORT_REPO) }}{{insertReposListTemplate("Announcement.md", [ "trailing-line-break": "true" ])}}{{ @@ -20,10 +21,10 @@ if !IS_PRODUCT_FAMILY:{{InsertTemplate("FeaturedTags.md", commonArgs)}} {{InsertTemplate("Use.md", commonArgs)}}{{if (find(REPO, "monitor") < 0 && find(REPO, "aspire") < 0 && find(REPO, "yarp") < 0): -{{InsertTemplate("About.variants.md", commonArgs)}}}} +{{InsertTemplate("About.variants.md", commonArgs)}}}}{{if !isAspireDashboard: {{insertReposListTemplate("RelatedRepos.md")}} -{{if !IS_PRODUCT_FAMILY: +}}{{if !IS_PRODUCT_FAMILY: {{ARGS["top-header"]}} Full Tag Listing {{if ARGS["readme-host"] = "github": *Tags not listed in the table above are not supported. See the [Supported Tags Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-tags.md). See the [full list of tags](https://mcr.microsoft.com/v2/{{REPO}}/tags/list) for all supported and unsupported tags.* diff --git a/eng/readme-templates/README.mcr.md b/eng/readme-templates/README.mcr.md index f3d8006bb5..f898147acc 100644 --- a/eng/readme-templates/README.mcr.md +++ b/eng/readme-templates/README.mcr.md @@ -1,12 +1,13 @@ {{ - set commonArgs to [ "top-header": "##", "readme-host": "mar" ] + set commonArgs to [ "top-header": "##", "readme-host": "mar" ] ^ + set isAspireDashboard to SHORT_REPO = "aspire-dashboard" || (split(REPO, "/")[0] = "aspire" && SHORT_REPO = "dashboard") }}{{InsertTemplate("About.md", commonArgs)}} {{InsertTemplate("FeaturedTags.md", commonArgs)}} -{{InsertTemplate("ReposProvider.md", union([ "template": "RelatedRepos.md" ], commonArgs))}} +{{if !isAspireDashboard:{{InsertTemplate("ReposProvider.md", union([ "template": "RelatedRepos.md" ], commonArgs))}} -{{InsertTemplate("Use.md", commonArgs)}}{{if (find(REPO, "monitor") < 0 && find(REPO, "aspire") < 0 && find(REPO, "yarp") < 0): +}}{{InsertTemplate("Use.md", commonArgs)}}{{if (find(REPO, "monitor") < 0 && find(REPO, "aspire") < 0 && find(REPO, "yarp") < 0): {{InsertTemplate("About.variants.md", commonArgs)}}}} diff --git a/eng/readme-templates/Support.md b/eng/readme-templates/Support.md index 5315bd4ef1..2ac140b145 100644 --- a/eng/readme-templates/Support.md +++ b/eng/readme-templates/Support.md @@ -5,12 +5,20 @@ set isRuntimeDeps to match(SHORT_REPO, "runtime-deps") ^ set isSamples to match(SHORT_REPO, "samples") ^ set isMonitor to match(SHORT_REPO, "monitor") || match(SHORT_REPO, "base") ^ - set isAspireDashboard to match(SHORT_REPO, "aspire-dashboard") ^ + set isAspireDashboard to SHORT_REPO = "aspire-dashboard" || (split(REPO, "/")[0] = "aspire" && SHORT_REPO = "dashboard") ^ set isReverseProxy to match(SHORT_REPO, "yarp") }}{{ARGS["top-header"]}} Support -{{if isSamples:These sample images are not intended for production use and may be subject to breaking changes or removal at any time. They are provided as a starting point for developers to experiment with and learn about .NET in a containerized environment. +{{if isAspireDashboard:See the [Aspire support policy](https://aspire.dev/support/) for supported versions and lifecycle information. Container images are also covered by the [Supported Container Platforms Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-platforms.md), [Supported Tags Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-tags.md), and [Image Update Policy](https://github.com/dotnet/dotnet-docker/blob/main/README.md#image-update-policy). + +For container security and vulnerability reporting, see the [Security Policy](https://github.com/dotnet/dotnet-docker/blob/main/SECURITY.md) and [Container Vulnerability Workflow](https://github.com/dotnet/dotnet-docker/blob/main/documentation/vulnerability-reporting.md). + +{{ARGS["top-header"]}}# Feedback + +* [Dashboard issues and feature requests](https://github.com/microsoft/aspire/issues). +* [Container image issues](https://github.com/dotnet/dotnet-docker/issues/new/choose). +* [Contact Microsoft Support](https://support.microsoft.com/contactus/).^else:{{if isSamples:These sample images are not intended for production use and may be subject to breaking changes or removal at any time. They are provided as a starting point for developers to experiment with and learn about .NET in a containerized environment. }}{{ARGS["top-header"]}}# Lifecycle @@ -40,12 +48,12 @@ Please refer to the [Security Policy](https://github.com/dotnet/dotnet-docker/bl {{ARGS["top-header"]}}# Feedback * [File an issue](https://github.com/dotnet/dotnet-docker/issues/new/choose) -* [Contact Microsoft Support](https://support.microsoft.com/contactus/) +* [Contact Microsoft Support](https://support.microsoft.com/contactus/)}} {{ARGS["top-header"]}} License * Legal Notice: [Container License Information](https://aka.ms/mcr/osslegalnotice) -* [.NET license](https://github.com/dotnet/dotnet-docker/blob/main/LICENSE) +{{if isAspireDashboard:* [Aspire MIT license](https://github.com/microsoft/aspire/blob/main/LICENSE.TXT)^else:* [.NET license](https://github.com/dotnet/dotnet-docker/blob/main/LICENSE)}} * [Discover licensing for Linux image contents](https://github.com/dotnet/dotnet-docker/blob/main/documentation/image-artifact-details.md){{if !(isRuntimeDeps || isMonitor || isAspireDashboard): * [Windows base image license](https://docs.microsoft.com/virtualization/windowscontainers/images-eula) (only applies to Windows containers) * [Pricing and licensing for Windows Server](https://www.microsoft.com/cloud-platform/windows-server-pricing)}} diff --git a/eng/readme-templates/Use.aspire-dashboard.md b/eng/readme-templates/Use.aspire-dashboard.md index 7eea5331dd..9ef60c0c2f 100644 --- a/eng/readme-templates/Use.aspire-dashboard.md +++ b/eng/readme-templates/Use.aspire-dashboard.md @@ -2,79 +2,38 @@ _ ARGS: top-header: The string to use as the top-level header. readme-host: Moniker of the site that will host the readme -}}The Aspire Dashboard is a browser-based app to view run-time information about your distributed application. +}}Run the dashboard locally: -The dashboard shows: +```console +docker run --rm -d --name aspire-dashboard -p 127.0.0.1:18888:18888 -p 127.0.0.1:4317:18889 -p 127.0.0.1:4318:18890 {{FULL_REPO}}:13 +``` -* Resources that make up your app, such as .NET projects, executables and containers. -* Live console logs of resources. -* Live telemetry, such as structured logs, traces and metrics. +Open . To sign in, use the login URL or token printed in the container logs: -{{ARGS["top-header"]}}# Configuration +```console +docker logs aspire-dashboard +``` -The dashboard must be configured when it is started. The configuration is done via environment variables. The following environment variables are supported: +This example keeps browser-token authentication enabled and binds the published ports to the host's loopback interface. Incoming OTLP telemetry is unauthenticated by default in standalone mode; the browser token does not secure telemetry ingestion. Only accept telemetry from trusted applications; configure HTTPS, authentication, and network controls before exposing the dashboard beyond your machine. See [dashboard security guidance](https://aspire.dev/dashboard/security-considerations/). -* `ASPNETCORE_URLS` specifies one or more HTTP endpoints through which the dashboard frontend is served. The frontend endpoint is used to view the dashboard in a browser. Defaults to `http://localhost:18888`. -* `DOTNET_DASHBOARD_OTLP_ENDPOINT_URL` specifies the [OTLP/gRPC](https://opentelemetry.io/docs/specs/otlp/#otlpgrpc) endpoint. This endpoint hosts an OTLP service and receives telemetry using gRPC. When the dashboard is launched by the Aspire app host this address is secured with HTTPS. Securing the dashboard with HTTPS is recommended. Defaults to `http://localhost:18889`. -* `DOTNET_DASHBOARD_OTLP_HTTP_ENDPOINT_URL` specifies the [OTLP/HTTP](https://opentelemetry.io/docs/specs/otlp/#otlphttp) endpoint. This endpoint hosts an OTLP service and receives telemetry using Protobuf over HTTP. Defaults to `http://localhost:18890`. -* `ASPIRE_DASHBOARD_MCP_ENDPOINT_URL` specifies the Aspire MCP endpoint. When this value isn't specified then the MCP server is hosted with an `ASPNETCORE_URLS` endpoint. The MCP server can be disabled by configuring `Dashboard:Mcp:Disabled` to `true`. Defaults to `http://localhost:18891`. -* `DOTNET_DASHBOARD_UNSECURED_ALLOW_ANONYMOUS` specifies the dashboard doesn't use authentication and accepts anonymous access. This setting is a shortcut to configuring `Dashboard:Frontend:AuthMode`, `Dashboard:Otlp:AuthMode` and `Dashboard:Mcp:AuthMode` to `Unsecured`. -* `DOTNET_DASHBOARD_CONFIG_FILE_PATH` specifies the path for an optional JSON configuration file. +{{ARGS["top-header"]}}# Send telemetry -{{ARGS["top-header"]}}## Frontend authentication +Instrument your application with its language's OpenTelemetry SDK and configure an OTLP exporter with the matching protocol and endpoint. Starting the dashboard does not instrument your application automatically. For applications running on the host, use: -The dashboard's frontend supports OpenID Connect (OIDC). Set `Dashboard__Frontend__AuthMode` to `OpenIdConnect`, then add the following configuration: +* OTLP/gRPC: `http://localhost:4317` (mapped to container port `18889`). +* OTLP/HTTP: `http://localhost:4318` (mapped to container port `18890`). -* `Authentication__Schemes__OpenIdConnect__Authority` — URL to the identity provider (IdP) -* `Authentication__Schemes__OpenIdConnect__ClientId` — Identity of the relying party (RP) -* `Authentication__Schemes__OpenIdConnect__ClientSecret`— A secret that only the real RP would know -* Other properties of [`OpenIdConnectOptions`](https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.builder.openidconnectoptions) specified in configuration container `Authentication__Schemes__OpenIdConnect__*` +For applications in other containers, use the dashboard container's name and port (`18889` or `18890`) on a shared Docker network, not their own `localhost`. -It may also be run unsecured. Set `Dashboard__Frontend__AuthMode` to `Unsecured`. The frontend endpoint will allow anonymous access. This setting is used during local development, but is not recommended if you attempt to host the dashboard in other settings. +{{ARGS["top-header"]}}# Operational notes -{{ARGS["top-header"]}}# OTLP authentication +* Telemetry is stored in memory with configurable limits and is lost when the dashboard restarts. The dashboard is intended for development and short-term diagnostics, not durable telemetry storage. +* Standalone mode displays telemetry without an AppHost. Resource listings and captured console logs require a configured [resource service](https://aspire.dev/dashboard/configuration/#resources). -The OTLP endpoint can be secured with [client certificate](https://learn.microsoft.com/aspnet/core/security/authentication/certauth) or API key authentication. +{{ARGS["top-header"]}}# Documentation and examples -For client certification authentication, set `Dashboard__Otlp__AuthMode` to `Certificate`. - -For API key authentication, set `Dashboard__Otlp__AuthMode` to `ApiKey`, then add the following configuration: - -* `Dashboard__Otlp__PrimaryApiKey` specifies the primary API key. (required, string) -* `Dashboard__Otlp__SecondaryApiKey` specifies the secondary API key. (optional, string) - -It may also be run unsecured. Set `Dashboard__Otlp__AuthMode` to `Unsecured`. The OTLP endpoint will allow anonymous access. This setting is used during local development, but is not recommended if you attempt to host the dashboard in other settings. - -{{ARGS["top-header"]}}# Resources - -* `Dashboard__ResourceServiceClient__Url` specifies the gRPC endpoint to which the dashboard connects for its data. There's no default. If this variable is unspecified, the dashboard shows OTEL data but no resource list or console logs. - -The resource service client supports certificates. Set `Dashboard__ResourceServiceClient__AuthMode` to `Certificate`, then add the following configuration: - -* `Dashboard__ResourceServiceClient__ClientCertificate__Source` (required) one of: - * `File` to load the cert from a file path, configured with: - * `Dashboard__ResourceServiceClient__ClientCertificate__FilePath` (required, string) - * `Dashboard__ResourceServiceClient__ClientCertificate__Password` (optional, string) - * `KeyStore` to load the cert from a key store, configured with: - * `Dashboard__ResourceServiceClient__ClientCertificate__Subject` (required, string) - * `Dashboard__ResourceServiceClient__ClientCertificate__Store` (optional, [`StoreName`](https://learn.microsoft.com/dotnet/api/system.security.cryptography.x509certificates.storename), defaults to `My`) - * `Dashboard__ResourceServiceClient__ClientCertificate__Location` (optional, [`StoreLocation`](https://learn.microsoft.com/dotnet/api/system.security.cryptography.x509certificates.storelocation), defaults to `CurrentUser`) - -To opt-out of authentication, set `Dashboard__ResourceServiceClient__AuthMode` to `Unsecured`. This completely disables all security for the resource service client. This setting is used during local development, but is not recommended if you attempt to host the dashboard in other settings. - -{{ARGS["top-header"]}}## Telemetry Limits - -Telemetry is stored in-memory. To avoid excessive memory usage, the dashboard has limits on the count and size of stored telemetry. When a count limit is reached, new telemetry is added, and the oldest telemetry is removed. When a size limit is reached, data is truncated to the limit. - -* `Dashboard__TelemetryLimits__MaxLogCount` specifies the maximum number of log entries. Defaults to 10,000. -* `Dashboard__TelemetryLimits__MaxTraceCount` specifies the maximum number of traces. Defaults to 10,000. -* `Dashboard__TelemetryLimits__MaxMetricsCount` specifies the maximum number of metric data points. Defaults to 50,000. -* `Dashboard__TelemetryLimits__MaxAttributeCount` specifies the maximum number of attributes on telemetry. Defaults to 128. -* `Dashboard__TelemetryLimits__MaxAttributeLength` specifies the maximum length of attributes. Defaults to unlimited. -* `Dashboard__TelemetryLimits__MaxSpanEventCount` specifies the maximum number of events on span attributes. Defaults to unlimited. - -Limits are per-resource. For example, a `MaxLogCount` value of 10,000 configures the dashboard to store up to 10,000 log entries per-resource. - -{{ARGS["top-header"]}}# Other - -* `Dashboard__ApplicationName` specifies the application name to be displayed in the UI. This applies only when no resource service URL is specified. When a resource service exists, the service specifies the application name. +* [Run the standalone dashboard](https://aspire.dev/dashboard/standalone/). +* [Python telemetry tutorial](https://aspire.dev/dashboard/standalone-for-python/). +* [JavaScript and Node.js telemetry tutorial](https://aspire.dev/dashboard/standalone-for-nodejs/). +* [Standalone dashboard sample (C#)](https://github.com/microsoft/aspire-samples/tree/main/samples/standalone-dashboard). +* [Dashboard configuration reference](https://aspire.dev/dashboard/configuration/). diff --git a/eng/readme-templates/Use.md b/eng/readme-templates/Use.md index ead99901ab..d3e7bccaca 100644 --- a/eng/readme-templates/Use.md +++ b/eng/readme-templates/Use.md @@ -6,8 +6,7 @@ "samples", when(PARENT_REPO = "monitor", cat("monitor-", SHORT_REPO), SHORT_REPO)) }}{{ARGS["top-header"]}} Usage -{{ _ Special case while aspire-dashboard image doesn't have any samples. Remove when https://github.com/dotnet/dotnet-docker/issues/5335 is resolved. ^ -if templateQualifier != "aspire-dashboard": +{{if templateQualifier != "aspire-dashboard": The [.NET Docker samples](https://github.com/dotnet/dotnet-docker/blob/main/samples/README.md) show various ways to use .NET and Docker together. See [Introduction to .NET and Docker](https://learn.microsoft.com/dotnet/core/docker/introduction){{ if templateQualifier = "aspnet" || templateQualifier = "runtime-deps": and [Host ASP.NET Core in Docker containers](https://learn.microsoft.com/aspnet/core/host-and-deploy/docker)}} to learn more. }} From f6c946e9c63449041efcfae29a13233636df4d88 Mon Sep 17 00:00:00 2001 From: IEvangelist Date: Mon, 28 Sep 2026 13:34:44 -0500 Subject: [PATCH 2/4] Fix generated Aspire Dashboard README formatting Preserve the separator before tag listings and render the local dashboard address as code rather than a link for remote link checkers. Regenerate stable outputs without changing approved prose or publication settings. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 793bb50d-ef77-495c-97a8-dc1e4c82c86f --- .portal-docs/docker-hub/README.aspire-dashboard.md | 3 ++- .portal-docs/mar/README.aspire-dashboard.portal.md | 2 +- README.aspire-dashboard.md | 3 ++- eng/readme-templates/DefaultLayout.md | 4 ++-- eng/readme-templates/Use.aspire-dashboard.md | 2 +- 5 files changed, 8 insertions(+), 6 deletions(-) diff --git a/.portal-docs/docker-hub/README.aspire-dashboard.md b/.portal-docs/docker-hub/README.aspire-dashboard.md index 4b43e9297b..fe478da73d 100644 --- a/.portal-docs/docker-hub/README.aspire-dashboard.md +++ b/.portal-docs/docker-hub/README.aspire-dashboard.md @@ -17,7 +17,7 @@ Run the dashboard locally: docker run --rm -d --name aspire-dashboard -p 127.0.0.1:18888:18888 -p 127.0.0.1:4317:18889 -p 127.0.0.1:4318:18890 mcr.microsoft.com/dotnet/aspire-dashboard:13 ``` -Open . To sign in, use the login URL or token printed in the container logs: +Open `http://localhost:18888`. To sign in, use the login URL or token printed in the container logs: ```console docker logs aspire-dashboard @@ -46,6 +46,7 @@ For applications in other containers, use the dashboard container's name and por * [JavaScript and Node.js telemetry tutorial](https://aspire.dev/dashboard/standalone-for-nodejs/). * [Standalone dashboard sample (C#)](https://github.com/microsoft/aspire-samples/tree/main/samples/standalone-dashboard). * [Dashboard configuration reference](https://aspire.dev/dashboard/configuration/). + # Full Tag Listing View the current tags at the [Microsoft Artifact Registry portal](https://mcr.microsoft.com/artifact/mar/dotnet/aspire-dashboard/tags) or on [GitHub](https://github.com/dotnet/dotnet-docker/blob/main/README.aspire-dashboard.md#full-tag-listing). diff --git a/.portal-docs/mar/README.aspire-dashboard.portal.md b/.portal-docs/mar/README.aspire-dashboard.portal.md index b2e569a6f7..afaa640174 100644 --- a/.portal-docs/mar/README.aspire-dashboard.portal.md +++ b/.portal-docs/mar/README.aspire-dashboard.portal.md @@ -17,7 +17,7 @@ Run the dashboard locally: docker run --rm -d --name aspire-dashboard -p 127.0.0.1:18888:18888 -p 127.0.0.1:4317:18889 -p 127.0.0.1:4318:18890 mcr.microsoft.com/dotnet/aspire-dashboard:13 ``` -Open . To sign in, use the login URL or token printed in the container logs: +Open `http://localhost:18888`. To sign in, use the login URL or token printed in the container logs: ```console docker logs aspire-dashboard diff --git a/README.aspire-dashboard.md b/README.aspire-dashboard.md index ff7eaeb1f5..91cebc3786 100644 --- a/README.aspire-dashboard.md +++ b/README.aspire-dashboard.md @@ -19,7 +19,7 @@ Run the dashboard locally: docker run --rm -d --name aspire-dashboard -p 127.0.0.1:18888:18888 -p 127.0.0.1:4317:18889 -p 127.0.0.1:4318:18890 mcr.microsoft.com/dotnet/aspire-dashboard:13 ``` -Open . To sign in, use the login URL or token printed in the container logs: +Open `http://localhost:18888`. To sign in, use the login URL or token printed in the container logs: ```console docker logs aspire-dashboard @@ -48,6 +48,7 @@ For applications in other containers, use the dashboard container's name and por * [JavaScript and Node.js telemetry tutorial](https://aspire.dev/dashboard/standalone-for-nodejs/). * [Standalone dashboard sample (C#)](https://github.com/microsoft/aspire-samples/tree/main/samples/standalone-dashboard). * [Dashboard configuration reference](https://aspire.dev/dashboard/configuration/). + ## Full Tag Listing ### Linux amd64 Tags diff --git a/eng/readme-templates/DefaultLayout.md b/eng/readme-templates/DefaultLayout.md index a70ff6f8f5..b5bbb42692 100644 --- a/eng/readme-templates/DefaultLayout.md +++ b/eng/readme-templates/DefaultLayout.md @@ -23,8 +23,8 @@ if !IS_PRODUCT_FAMILY:{{InsertTemplate("FeaturedTags.md", commonArgs)}} {{InsertTemplate("About.variants.md", commonArgs)}}}}{{if !isAspireDashboard: -{{insertReposListTemplate("RelatedRepos.md")}} -}}{{if !IS_PRODUCT_FAMILY: +{{insertReposListTemplate("RelatedRepos.md")}}}} +{{if !IS_PRODUCT_FAMILY: {{ARGS["top-header"]}} Full Tag Listing {{if ARGS["readme-host"] = "github": *Tags not listed in the table above are not supported. See the [Supported Tags Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-tags.md). See the [full list of tags](https://mcr.microsoft.com/v2/{{REPO}}/tags/list) for all supported and unsupported tags.* diff --git a/eng/readme-templates/Use.aspire-dashboard.md b/eng/readme-templates/Use.aspire-dashboard.md index 9ef60c0c2f..ec686d4d28 100644 --- a/eng/readme-templates/Use.aspire-dashboard.md +++ b/eng/readme-templates/Use.aspire-dashboard.md @@ -8,7 +8,7 @@ docker run --rm -d --name aspire-dashboard -p 127.0.0.1:18888:18888 -p 127.0.0.1:4317:18889 -p 127.0.0.1:4318:18890 {{FULL_REPO}}:13 ``` -Open . To sign in, use the login URL or token printed in the container logs: +Open `http://localhost:18888`. To sign in, use the login URL or token printed in the container logs: ```console docker logs aspire-dashboard From a58bf434a6cbef1206f9e9865677feae851f0611 Mon Sep 17 00:00:00 2001 From: Logan Bussell Date: Thu, 1 Oct 2026 10:00:24 -0700 Subject: [PATCH 3/4] Eject Aspire Dashboard README template Port of 62a315e9e from #7379 (nightly), adapted for main: - Add a Docker Hub host to README.aspire-dashboard.md, since main also publishes .portal-docs/docker-hub/README.aspire-dashboard.md. - Keep the stable-only link to nightly preview builds and main's existing dashboard prose and MAR filename. - Drop the AspireDashboardManifestTests.cs change; that test only exists on nightly. (cherry picked from commit 62a315e9eefea35328f2dc98827e3f96daf67e6e) Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --- .../mar/README.aspire-dashboard.portal.md | 10 +- .../About.aspire-dashboard.md | 3 - eng/readme-templates/About.md | 4 +- eng/readme-templates/About.variants.md | 2 +- eng/readme-templates/DefaultLayout.md | 7 +- eng/readme-templates/FeaturedTags.md | 2 - .../README.aspire-dashboard.dockerhub.md | 1 + .../README.aspire-dashboard.github.md | 1 + .../README.aspire-dashboard.mcr.md | 1 + .../README.aspire-dashboard.md | 91 +++++++++++++++++++ eng/readme-templates/README.mcr.md | 7 +- eng/readme-templates/Support.md | 17 +--- eng/readme-templates/Use.aspire-dashboard.md | 39 -------- eng/readme-templates/Use.md | 4 +- manifest.json | 6 +- 15 files changed, 117 insertions(+), 78 deletions(-) delete mode 100644 eng/readme-templates/About.aspire-dashboard.md create mode 100644 eng/readme-templates/README.aspire-dashboard.dockerhub.md create mode 100644 eng/readme-templates/README.aspire-dashboard.github.md create mode 100644 eng/readme-templates/README.aspire-dashboard.mcr.md create mode 100644 eng/readme-templates/README.aspire-dashboard.md delete mode 100644 eng/readme-templates/Use.aspire-dashboard.md diff --git a/.portal-docs/mar/README.aspire-dashboard.portal.md b/.portal-docs/mar/README.aspire-dashboard.portal.md index afaa640174..41f351ef32 100644 --- a/.portal-docs/mar/README.aspire-dashboard.portal.md +++ b/.portal-docs/mar/README.aspire-dashboard.portal.md @@ -1,14 +1,14 @@ +## Featured Tags + +* `13` + * `docker pull mcr.microsoft.com/dotnet/aspire-dashboard:13` + ## About The [Aspire Dashboard](https://aspire.dev/dashboard/standalone/) is a standalone viewer for logs, traces, and metrics from OpenTelemetry-enabled applications in any language. No Aspire AppHost or .NET application is required. Source code is available in [microsoft/aspire](https://github.com/microsoft/aspire). For preview builds, see the [nightly Aspire Dashboard image](https://mcr.microsoft.com/artifact/mar/aspire/nightly/dashboard/about). -## Featured Tags - -* `13` - * `docker pull mcr.microsoft.com/dotnet/aspire-dashboard:13` - ## Usage Run the dashboard locally: diff --git a/eng/readme-templates/About.aspire-dashboard.md b/eng/readme-templates/About.aspire-dashboard.md deleted file mode 100644 index 960e072b3c..0000000000 --- a/eng/readme-templates/About.aspire-dashboard.md +++ /dev/null @@ -1,3 +0,0 @@ -The [Aspire Dashboard](https://aspire.dev/dashboard/standalone/) is a standalone viewer for logs, traces, and metrics from OpenTelemetry-enabled applications in any language. No Aspire AppHost or .NET application is required. Source code is available in [microsoft/aspire](https://github.com/microsoft/aspire). - -For preview builds, see the [nightly Aspire Dashboard image](https://mcr.microsoft.com/artifact/mar/aspire/nightly/dashboard/about). diff --git a/eng/readme-templates/About.md b/eng/readme-templates/About.md index 4b4d6b7721..d2e20f9007 100644 --- a/eng/readme-templates/About.md +++ b/eng/readme-templates/About.md @@ -12,6 +12,6 @@ "leading-line-break": "true", "readme-host": ARGS["readme-host"] ])}}}} -{{InsertTemplate(join(["About", templateQualifier, "md"], "."), [ "top-header": ARGS["top-header"], "readme-host": ARGS["readme-host"] ])}}{{if templateQualifier != "aspire-dashboard": +{{InsertTemplate(join(["About", templateQualifier, "md"], "."), [ "top-header": ARGS["top-header"], "readme-host": ARGS["readme-host"] ])}} -Watch [discussions](https://github.com/dotnet/dotnet-docker/discussions/categories/announcements) for Docker-related .NET announcements.}} +Watch [discussions](https://github.com/dotnet/dotnet-docker/discussions/categories/announcements) for Docker-related .NET announcements. diff --git a/eng/readme-templates/About.variants.md b/eng/readme-templates/About.variants.md index 100b41fd19..7f230313d6 100644 --- a/eng/readme-templates/About.variants.md +++ b/eng/readme-templates/About.variants.md @@ -8,7 +8,7 @@ }}{{ARGS["top-header"]}} Image Variants .NET container images have several variants that offer different combinations of flexibility and deployment size. -The [Image Variants documentation](https://github.com/dotnet/dotnet-docker/blob/main/documentation/image-variants.md) contains a summary of the image variants and their use-cases.{{if repo != "sdk" && repo != "aspire-dashboard": +The [Image Variants documentation](https://github.com/dotnet/dotnet-docker/blob/main/documentation/image-variants.md) contains a summary of the image variants and their use-cases.{{if repo != "sdk": {{InsertTemplate("About.distroless.md", [ "top-header": ARGS["top-header"] ])}}}}{{if repo = "aspnet": diff --git a/eng/readme-templates/DefaultLayout.md b/eng/readme-templates/DefaultLayout.md index b5bbb42692..fc9aadfa82 100644 --- a/eng/readme-templates/DefaultLayout.md +++ b/eng/readme-templates/DefaultLayout.md @@ -9,7 +9,6 @@ }} ^ set isNightlyRepo to match(split(REPO, "/")[1], "nightly") ^ - set isAspireDashboard to SHORT_REPO = "aspire-dashboard" || (split(REPO, "/")[0] = "aspire" && SHORT_REPO = "dashboard") ^ set readmeRepoName to when(PARENT_REPO = "monitor", cat("monitor-", SHORT_REPO), SHORT_REPO) }}{{insertReposListTemplate("Announcement.md", [ "trailing-line-break": "true" ])}}{{ @@ -19,11 +18,11 @@ if !IS_PRODUCT_FAMILY:{{InsertTemplate("FeaturedTags.md", commonArgs)}} }} {{InsertTemplate("About.md", commonArgs)}} -{{InsertTemplate("Use.md", commonArgs)}}{{if (find(REPO, "monitor") < 0 && find(REPO, "aspire") < 0 && find(REPO, "yarp") < 0): +{{InsertTemplate("Use.md", commonArgs)}}{{if (find(REPO, "monitor") < 0 && find(REPO, "yarp") < 0): -{{InsertTemplate("About.variants.md", commonArgs)}}}}{{if !isAspireDashboard: +{{InsertTemplate("About.variants.md", commonArgs)}}}} -{{insertReposListTemplate("RelatedRepos.md")}}}} +{{insertReposListTemplate("RelatedRepos.md")}} {{if !IS_PRODUCT_FAMILY: {{ARGS["top-header"]}} Full Tag Listing {{if ARGS["readme-host"] = "github": diff --git a/eng/readme-templates/FeaturedTags.md b/eng/readme-templates/FeaturedTags.md index 2f1810e283..b0a5431943 100644 --- a/eng/readme-templates/FeaturedTags.md +++ b/eng/readme-templates/FeaturedTags.md @@ -20,8 +20,6 @@ elif match(REPO, "monitor/base"):* `9` (Standard Support) * `docker pull {{FULL_REPO}}:9` * `8` (Long-Term Support) * `docker pull {{FULL_REPO}}:8`^ -elif match(REPO, "aspire-dashboard"):* `13` - * `docker pull {{FULL_REPO}}:13`^ elif match(REPO, "yarp"):* `2.3-preview` * `docker pull {{FULL_REPO}}:2.3-preview`^ else:{{if VARIABLES["branch"] = "nightly":* `11.0` (Release Candidate) diff --git a/eng/readme-templates/README.aspire-dashboard.dockerhub.md b/eng/readme-templates/README.aspire-dashboard.dockerhub.md new file mode 100644 index 0000000000..d0fbbc6fab --- /dev/null +++ b/eng/readme-templates/README.aspire-dashboard.dockerhub.md @@ -0,0 +1 @@ +{{InsertTemplate("README.aspire-dashboard.md", [ "readme-host": "dockerhub" ])}} diff --git a/eng/readme-templates/README.aspire-dashboard.github.md b/eng/readme-templates/README.aspire-dashboard.github.md new file mode 100644 index 0000000000..d0b6536ed8 --- /dev/null +++ b/eng/readme-templates/README.aspire-dashboard.github.md @@ -0,0 +1 @@ +{{InsertTemplate("README.aspire-dashboard.md", [ "readme-host": "github" ])}} diff --git a/eng/readme-templates/README.aspire-dashboard.mcr.md b/eng/readme-templates/README.aspire-dashboard.mcr.md new file mode 100644 index 0000000000..4a365835b8 --- /dev/null +++ b/eng/readme-templates/README.aspire-dashboard.mcr.md @@ -0,0 +1 @@ +{{InsertTemplate("README.aspire-dashboard.md", [ "readme-host": "mar" ])}} diff --git a/eng/readme-templates/README.aspire-dashboard.md b/eng/readme-templates/README.aspire-dashboard.md new file mode 100644 index 0000000000..c5bcc3b38e --- /dev/null +++ b/eng/readme-templates/README.aspire-dashboard.md @@ -0,0 +1,91 @@ +{{ + _ ARGS: + readme-host: Moniker of the site that will host the readme ^ + + set isGitHub to ARGS["readme-host"] = "github" ^ + set isDockerHub to ARGS["readme-host"] = "dockerhub" ^ + set h to when(isDockerHub, "#", "##") ^ + set isNightlyRepo to match(split(REPO, "/")[1], "nightly") || VARIABLES["branch"] = "nightly" ^ + set stableUrl to when( + isGitHub, + "https://github.com/dotnet/dotnet-docker/blob/main/README.aspire-dashboard.md", + "https://mcr.microsoft.com/artifact/mar/dotnet/aspire-dashboard/about") + +}}{{if isGitHub:# Aspire Dashboard + +}}{{if isNightlyRepo:> **Important**: The {{REPO}} image is a preview build of the Aspire Dashboard and is not signed. See [dotnet/aspire-dashboard]({{stableUrl}}) for stable releases. + +}}{{h}} Featured Tags + +* `13` + * `docker pull {{FULL_REPO}}:13` + +{{h}} About + +The [Aspire Dashboard](https://aspire.dev/dashboard/standalone/) is a standalone viewer for logs, traces, and metrics from OpenTelemetry-enabled applications in any language. No Aspire AppHost or .NET application is required. Source code is available in [microsoft/aspire](https://github.com/microsoft/aspire). +{{if !isNightlyRepo: +For preview builds, see the [nightly Aspire Dashboard image](https://mcr.microsoft.com/artifact/mar/aspire/nightly/dashboard/about). +}} +{{h}} Usage + +Run the dashboard locally: + +```console +docker run --rm -d --name aspire-dashboard -p 127.0.0.1:18888:18888 -p 127.0.0.1:4317:18889 -p 127.0.0.1:4318:18890 {{FULL_REPO}}:13 +``` + +Open `http://localhost:18888`. To sign in, use the login URL or token printed in the container logs: + +```console +docker logs aspire-dashboard +``` + +This example keeps browser-token authentication enabled and binds the published ports to the host's loopback interface. Incoming OTLP telemetry is unauthenticated by default in standalone mode; the browser token does not secure telemetry ingestion. Only accept telemetry from trusted applications; configure HTTPS, authentication, and network controls before exposing the dashboard beyond your machine. See [dashboard security guidance](https://aspire.dev/dashboard/security-considerations/). + +{{h}}# Send telemetry + +Instrument your application with its language's OpenTelemetry SDK and configure an OTLP exporter with the matching protocol and endpoint. Starting the dashboard does not instrument your application automatically. For applications running on the host, use: + +* OTLP/gRPC: `http://localhost:4317` (mapped to container port `18889`). +* OTLP/HTTP: `http://localhost:4318` (mapped to container port `18890`). + +For applications in other containers, use the dashboard container's name and port (`18889` or `18890`) on a shared Docker network, not their own `localhost`. + +{{h}}# Operational notes + +* Telemetry is stored in memory with configurable limits and is lost when the dashboard restarts. The dashboard is intended for development and short-term diagnostics, not durable telemetry storage. +* Standalone mode displays telemetry without an AppHost. Resource listings and captured console logs require a configured [resource service](https://aspire.dev/dashboard/configuration/#resources). + +{{h}}# Documentation and examples + +* [Run the standalone dashboard](https://aspire.dev/dashboard/standalone/). +* [Python telemetry tutorial](https://aspire.dev/dashboard/standalone-for-python/). +* [JavaScript and Node.js telemetry tutorial](https://aspire.dev/dashboard/standalone-for-nodejs/). +* [Standalone dashboard sample (C#)](https://github.com/microsoft/aspire-samples/tree/main/samples/standalone-dashboard). +* [Dashboard configuration reference](https://aspire.dev/dashboard/configuration/). + +{{if isGitHub:## Full Tag Listing + +*Tags not listed in the table above are not supported. See the [Supported Tags Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-tags.md). See the [full list of tags](https://mcr.microsoft.com/v2/{{REPO}}/tags/list) for all supported and unsupported tags.* + +^elif isDockerHub:# Full Tag Listing + +View the current tags at the [Microsoft Artifact Registry portal](https://mcr.microsoft.com/artifact/mar/{{REPO}}/tags) or on [GitHub](https://github.com/dotnet/dotnet-docker/blob/main/README.aspire-dashboard.md#full-tag-listing). + +}}{{h}} Support + +See the [Aspire support policy](https://aspire.dev/support/) for supported versions and lifecycle information. Container images are also covered by the [Supported Container Platforms Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-platforms.md), [Supported Tags Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-tags.md), and [Image Update Policy](https://github.com/dotnet/dotnet-docker/blob/main/README.md#image-update-policy). + +For container security and vulnerability reporting, see the [Security Policy](https://github.com/dotnet/dotnet-docker/blob/main/SECURITY.md) and [Container Vulnerability Workflow](https://github.com/dotnet/dotnet-docker/blob/main/documentation/vulnerability-reporting.md). + +{{h}}# Feedback + +* [Dashboard issues and feature requests](https://github.com/microsoft/aspire/issues). +* [Container image issues](https://github.com/dotnet/dotnet-docker/issues/new/choose). +* [Contact Microsoft Support](https://support.microsoft.com/contactus/). + +{{h}} License + +* Legal Notice: [Container License Information](https://aka.ms/mcr/osslegalnotice) +* [Aspire MIT license](https://github.com/microsoft/aspire/blob/main/LICENSE.TXT) +* [Discover licensing for Linux image contents](https://github.com/dotnet/dotnet-docker/blob/main/documentation/image-artifact-details.md) diff --git a/eng/readme-templates/README.mcr.md b/eng/readme-templates/README.mcr.md index f898147acc..6cd3e88435 100644 --- a/eng/readme-templates/README.mcr.md +++ b/eng/readme-templates/README.mcr.md @@ -1,13 +1,12 @@ {{ - set commonArgs to [ "top-header": "##", "readme-host": "mar" ] ^ - set isAspireDashboard to SHORT_REPO = "aspire-dashboard" || (split(REPO, "/")[0] = "aspire" && SHORT_REPO = "dashboard") + set commonArgs to [ "top-header": "##", "readme-host": "mar" ] }}{{InsertTemplate("About.md", commonArgs)}} {{InsertTemplate("FeaturedTags.md", commonArgs)}} -{{if !isAspireDashboard:{{InsertTemplate("ReposProvider.md", union([ "template": "RelatedRepos.md" ], commonArgs))}} +{{InsertTemplate("ReposProvider.md", union([ "template": "RelatedRepos.md" ], commonArgs))}} -}}{{InsertTemplate("Use.md", commonArgs)}}{{if (find(REPO, "monitor") < 0 && find(REPO, "aspire") < 0 && find(REPO, "yarp") < 0): +{{InsertTemplate("Use.md", commonArgs)}}{{if (find(REPO, "monitor") < 0 && find(REPO, "yarp") < 0): {{InsertTemplate("About.variants.md", commonArgs)}}}} diff --git a/eng/readme-templates/Support.md b/eng/readme-templates/Support.md index 2ac140b145..31d2c6e5da 100644 --- a/eng/readme-templates/Support.md +++ b/eng/readme-templates/Support.md @@ -5,20 +5,11 @@ set isRuntimeDeps to match(SHORT_REPO, "runtime-deps") ^ set isSamples to match(SHORT_REPO, "samples") ^ set isMonitor to match(SHORT_REPO, "monitor") || match(SHORT_REPO, "base") ^ - set isAspireDashboard to SHORT_REPO = "aspire-dashboard" || (split(REPO, "/")[0] = "aspire" && SHORT_REPO = "dashboard") ^ set isReverseProxy to match(SHORT_REPO, "yarp") }}{{ARGS["top-header"]}} Support -{{if isAspireDashboard:See the [Aspire support policy](https://aspire.dev/support/) for supported versions and lifecycle information. Container images are also covered by the [Supported Container Platforms Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-platforms.md), [Supported Tags Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-tags.md), and [Image Update Policy](https://github.com/dotnet/dotnet-docker/blob/main/README.md#image-update-policy). - -For container security and vulnerability reporting, see the [Security Policy](https://github.com/dotnet/dotnet-docker/blob/main/SECURITY.md) and [Container Vulnerability Workflow](https://github.com/dotnet/dotnet-docker/blob/main/documentation/vulnerability-reporting.md). - -{{ARGS["top-header"]}}# Feedback - -* [Dashboard issues and feature requests](https://github.com/microsoft/aspire/issues). -* [Container image issues](https://github.com/dotnet/dotnet-docker/issues/new/choose). -* [Contact Microsoft Support](https://support.microsoft.com/contactus/).^else:{{if isSamples:These sample images are not intended for production use and may be subject to breaking changes or removal at any time. They are provided as a starting point for developers to experiment with and learn about .NET in a containerized environment. +{{if isSamples:These sample images are not intended for production use and may be subject to breaking changes or removal at any time. They are provided as a starting point for developers to experiment with and learn about .NET in a containerized environment. }}{{ARGS["top-header"]}}# Lifecycle @@ -48,12 +39,12 @@ Please refer to the [Security Policy](https://github.com/dotnet/dotnet-docker/bl {{ARGS["top-header"]}}# Feedback * [File an issue](https://github.com/dotnet/dotnet-docker/issues/new/choose) -* [Contact Microsoft Support](https://support.microsoft.com/contactus/)}} +* [Contact Microsoft Support](https://support.microsoft.com/contactus/) {{ARGS["top-header"]}} License * Legal Notice: [Container License Information](https://aka.ms/mcr/osslegalnotice) -{{if isAspireDashboard:* [Aspire MIT license](https://github.com/microsoft/aspire/blob/main/LICENSE.TXT)^else:* [.NET license](https://github.com/dotnet/dotnet-docker/blob/main/LICENSE)}} -* [Discover licensing for Linux image contents](https://github.com/dotnet/dotnet-docker/blob/main/documentation/image-artifact-details.md){{if !(isRuntimeDeps || isMonitor || isAspireDashboard): +* [.NET license](https://github.com/dotnet/dotnet-docker/blob/main/LICENSE) +* [Discover licensing for Linux image contents](https://github.com/dotnet/dotnet-docker/blob/main/documentation/image-artifact-details.md){{if !(isRuntimeDeps || isMonitor): * [Windows base image license](https://docs.microsoft.com/virtualization/windowscontainers/images-eula) (only applies to Windows containers) * [Pricing and licensing for Windows Server](https://www.microsoft.com/cloud-platform/windows-server-pricing)}} diff --git a/eng/readme-templates/Use.aspire-dashboard.md b/eng/readme-templates/Use.aspire-dashboard.md deleted file mode 100644 index ec686d4d28..0000000000 --- a/eng/readme-templates/Use.aspire-dashboard.md +++ /dev/null @@ -1,39 +0,0 @@ -{{ - _ ARGS: - top-header: The string to use as the top-level header. - readme-host: Moniker of the site that will host the readme -}}Run the dashboard locally: - -```console -docker run --rm -d --name aspire-dashboard -p 127.0.0.1:18888:18888 -p 127.0.0.1:4317:18889 -p 127.0.0.1:4318:18890 {{FULL_REPO}}:13 -``` - -Open `http://localhost:18888`. To sign in, use the login URL or token printed in the container logs: - -```console -docker logs aspire-dashboard -``` - -This example keeps browser-token authentication enabled and binds the published ports to the host's loopback interface. Incoming OTLP telemetry is unauthenticated by default in standalone mode; the browser token does not secure telemetry ingestion. Only accept telemetry from trusted applications; configure HTTPS, authentication, and network controls before exposing the dashboard beyond your machine. See [dashboard security guidance](https://aspire.dev/dashboard/security-considerations/). - -{{ARGS["top-header"]}}# Send telemetry - -Instrument your application with its language's OpenTelemetry SDK and configure an OTLP exporter with the matching protocol and endpoint. Starting the dashboard does not instrument your application automatically. For applications running on the host, use: - -* OTLP/gRPC: `http://localhost:4317` (mapped to container port `18889`). -* OTLP/HTTP: `http://localhost:4318` (mapped to container port `18890`). - -For applications in other containers, use the dashboard container's name and port (`18889` or `18890`) on a shared Docker network, not their own `localhost`. - -{{ARGS["top-header"]}}# Operational notes - -* Telemetry is stored in memory with configurable limits and is lost when the dashboard restarts. The dashboard is intended for development and short-term diagnostics, not durable telemetry storage. -* Standalone mode displays telemetry without an AppHost. Resource listings and captured console logs require a configured [resource service](https://aspire.dev/dashboard/configuration/#resources). - -{{ARGS["top-header"]}}# Documentation and examples - -* [Run the standalone dashboard](https://aspire.dev/dashboard/standalone/). -* [Python telemetry tutorial](https://aspire.dev/dashboard/standalone-for-python/). -* [JavaScript and Node.js telemetry tutorial](https://aspire.dev/dashboard/standalone-for-nodejs/). -* [Standalone dashboard sample (C#)](https://github.com/microsoft/aspire-samples/tree/main/samples/standalone-dashboard). -* [Dashboard configuration reference](https://aspire.dev/dashboard/configuration/). diff --git a/eng/readme-templates/Use.md b/eng/readme-templates/Use.md index d3e7bccaca..b12215edc1 100644 --- a/eng/readme-templates/Use.md +++ b/eng/readme-templates/Use.md @@ -6,9 +6,9 @@ "samples", when(PARENT_REPO = "monitor", cat("monitor-", SHORT_REPO), SHORT_REPO)) }}{{ARGS["top-header"]}} Usage -{{if templateQualifier != "aspire-dashboard": + The [.NET Docker samples](https://github.com/dotnet/dotnet-docker/blob/main/samples/README.md) show various ways to use .NET and Docker together. See [Introduction to .NET and Docker](https://learn.microsoft.com/dotnet/core/docker/introduction){{ if templateQualifier = "aspnet" || templateQualifier = "runtime-deps": and [Host ASP.NET Core in Docker containers](https://learn.microsoft.com/aspnet/core/host-and-deploy/docker)}} to learn more. -}} + {{InsertTemplate(join(["Use", templateQualifier, "md"], "."), [ "top-header": ARGS["top-header"], "readme-host": ARGS["readme-host"]])}} diff --git a/manifest.json b/manifest.json index 8aa596c3db..1d6c0d3af1 100644 --- a/manifest.json +++ b/manifest.json @@ -14200,15 +14200,15 @@ "readmes": [ { "path": "README.aspire-dashboard.md", - "templatePath": "eng/readme-templates/README.github.md" + "templatePath": "eng/readme-templates/README.aspire-dashboard.github.md" }, { "path": ".portal-docs/docker-hub/README.aspire-dashboard.md", - "templatePath": "eng/readme-templates/README.dockerhub.md" + "templatePath": "eng/readme-templates/README.aspire-dashboard.dockerhub.md" }, { "path": ".portal-docs/mar/README.aspire-dashboard.portal.md", - "templatePath": "eng/readme-templates/README.mcr.md" + "templatePath": "eng/readme-templates/README.aspire-dashboard.mcr.md" } ], "mcrTagsMetadataTemplate": "eng/mcr-tags-metadata-templates/aspire-dashboard-tags.yml", From 0c3d259ec29735f35eba11b81bf5818fc4d13190 Mon Sep 17 00:00:00 2001 From: David Pine <7679720+IEvangelist@users.noreply.github.com> Date: Thu, 8 Oct 2026 08:10:10 -0500 Subject: [PATCH 4/4] Apply Aspire dashboard README review feedback Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: c8655a27-1c77-4c4b-ad38-7ce0b4f15e77 --- .portal-docs/docker-hub/README.aspire-dashboard.md | 4 ++-- .portal-docs/mar/README.aspire-dashboard.portal.md | 4 ++-- README.aspire-dashboard.md | 4 ++-- eng/readme-templates/README.aspire-dashboard.md | 9 +++++---- 4 files changed, 11 insertions(+), 10 deletions(-) diff --git a/.portal-docs/docker-hub/README.aspire-dashboard.md b/.portal-docs/docker-hub/README.aspire-dashboard.md index fe478da73d..e09a89e4e0 100644 --- a/.portal-docs/docker-hub/README.aspire-dashboard.md +++ b/.portal-docs/docker-hub/README.aspire-dashboard.md @@ -5,7 +5,7 @@ # About -The [Aspire Dashboard](https://aspire.dev/dashboard/standalone/) is a standalone viewer for logs, traces, and metrics from OpenTelemetry-enabled applications in any language. No Aspire AppHost or .NET application is required. Source code is available in [microsoft/aspire](https://github.com/microsoft/aspire). +The [Aspire Dashboard](https://aspire.dev/dashboard/standalone/) is a standalone viewer for logs, traces, and metrics from OpenTelemetry-enabled applications in any language. Source code is available in [microsoft/aspire](https://github.com/microsoft/aspire). For preview builds, see the [nightly Aspire Dashboard image](https://mcr.microsoft.com/artifact/mar/aspire/nightly/dashboard/about). @@ -55,7 +55,7 @@ View the current tags at the [Microsoft Artifact Registry portal](https://mcr.mi See the [Aspire support policy](https://aspire.dev/support/) for supported versions and lifecycle information. Container images are also covered by the [Supported Container Platforms Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-platforms.md), [Supported Tags Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-tags.md), and [Image Update Policy](https://github.com/dotnet/dotnet-docker/blob/main/README.md#image-update-policy). -For container security and vulnerability reporting, see the [Security Policy](https://github.com/dotnet/dotnet-docker/blob/main/SECURITY.md) and [Container Vulnerability Workflow](https://github.com/dotnet/dotnet-docker/blob/main/documentation/vulnerability-reporting.md). +For container security and vulnerability reporting, see the [Security Policy](https://github.com/dotnet/dotnet-docker/blob/main/SECURITY.md) and [Container Vulnerability Workflow](https://github.com/dotnet/dotnet-docker/blob/main/documentation/vulnerability-reporting.md). Additional security information can be found on [aspire.dev/dashboard/security-considerations](https://aspire.dev/dashboard/security-considerations/#standalone-mode). ## Feedback diff --git a/.portal-docs/mar/README.aspire-dashboard.portal.md b/.portal-docs/mar/README.aspire-dashboard.portal.md index 41f351ef32..4d5f3b4a44 100644 --- a/.portal-docs/mar/README.aspire-dashboard.portal.md +++ b/.portal-docs/mar/README.aspire-dashboard.portal.md @@ -5,7 +5,7 @@ ## About -The [Aspire Dashboard](https://aspire.dev/dashboard/standalone/) is a standalone viewer for logs, traces, and metrics from OpenTelemetry-enabled applications in any language. No Aspire AppHost or .NET application is required. Source code is available in [microsoft/aspire](https://github.com/microsoft/aspire). +The [Aspire Dashboard](https://aspire.dev/dashboard/standalone/) is a standalone viewer for logs, traces, and metrics from OpenTelemetry-enabled applications in any language. Source code is available in [microsoft/aspire](https://github.com/microsoft/aspire). For preview builds, see the [nightly Aspire Dashboard image](https://mcr.microsoft.com/artifact/mar/aspire/nightly/dashboard/about). @@ -51,7 +51,7 @@ For applications in other containers, use the dashboard container's name and por See the [Aspire support policy](https://aspire.dev/support/) for supported versions and lifecycle information. Container images are also covered by the [Supported Container Platforms Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-platforms.md), [Supported Tags Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-tags.md), and [Image Update Policy](https://github.com/dotnet/dotnet-docker/blob/main/README.md#image-update-policy). -For container security and vulnerability reporting, see the [Security Policy](https://github.com/dotnet/dotnet-docker/blob/main/SECURITY.md) and [Container Vulnerability Workflow](https://github.com/dotnet/dotnet-docker/blob/main/documentation/vulnerability-reporting.md). +For container security and vulnerability reporting, see the [Security Policy](https://github.com/dotnet/dotnet-docker/blob/main/SECURITY.md) and [Container Vulnerability Workflow](https://github.com/dotnet/dotnet-docker/blob/main/documentation/vulnerability-reporting.md). Additional security information can be found on [aspire.dev/dashboard/security-considerations](https://aspire.dev/dashboard/security-considerations/#standalone-mode). ### Feedback diff --git a/README.aspire-dashboard.md b/README.aspire-dashboard.md index 91cebc3786..c5a2189981 100644 --- a/README.aspire-dashboard.md +++ b/README.aspire-dashboard.md @@ -7,7 +7,7 @@ ## About -The [Aspire Dashboard](https://aspire.dev/dashboard/standalone/) is a standalone viewer for logs, traces, and metrics from OpenTelemetry-enabled applications in any language. No Aspire AppHost or .NET application is required. Source code is available in [microsoft/aspire](https://github.com/microsoft/aspire). +The [Aspire Dashboard](https://aspire.dev/dashboard/standalone/) is a standalone viewer for logs, traces, and metrics from OpenTelemetry-enabled applications in any language. Source code is available in [microsoft/aspire](https://github.com/microsoft/aspire). For preview builds, see the [nightly Aspire Dashboard image](https://mcr.microsoft.com/artifact/mar/aspire/nightly/dashboard/about). @@ -71,7 +71,7 @@ Tags | Dockerfile | OS Version See the [Aspire support policy](https://aspire.dev/support/) for supported versions and lifecycle information. Container images are also covered by the [Supported Container Platforms Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-platforms.md), [Supported Tags Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-tags.md), and [Image Update Policy](https://github.com/dotnet/dotnet-docker/blob/main/README.md#image-update-policy). -For container security and vulnerability reporting, see the [Security Policy](https://github.com/dotnet/dotnet-docker/blob/main/SECURITY.md) and [Container Vulnerability Workflow](https://github.com/dotnet/dotnet-docker/blob/main/documentation/vulnerability-reporting.md). +For container security and vulnerability reporting, see the [Security Policy](https://github.com/dotnet/dotnet-docker/blob/main/SECURITY.md) and [Container Vulnerability Workflow](https://github.com/dotnet/dotnet-docker/blob/main/documentation/vulnerability-reporting.md). Additional security information can be found on [aspire.dev/dashboard/security-considerations](https://aspire.dev/dashboard/security-considerations/#standalone-mode). ### Feedback diff --git a/eng/readme-templates/README.aspire-dashboard.md b/eng/readme-templates/README.aspire-dashboard.md index c5bcc3b38e..61a396e24c 100644 --- a/eng/readme-templates/README.aspire-dashboard.md +++ b/eng/readme-templates/README.aspire-dashboard.md @@ -9,11 +9,12 @@ set stableUrl to when( isGitHub, "https://github.com/dotnet/dotnet-docker/blob/main/README.aspire-dashboard.md", - "https://mcr.microsoft.com/artifact/mar/dotnet/aspire-dashboard/about") + "https://mcr.microsoft.com/artifact/mar/aspire/dashboard/about") ^ + set stableName to when(isGitHub, "dotnet/aspire-dashboard", "aspire/dashboard") }}{{if isGitHub:# Aspire Dashboard -}}{{if isNightlyRepo:> **Important**: The {{REPO}} image is a preview build of the Aspire Dashboard and is not signed. See [dotnet/aspire-dashboard]({{stableUrl}}) for stable releases. +}}{{if isNightlyRepo:> **Important**: The {{REPO}} image is a preview build of the Aspire Dashboard and is not signed. See [{{stableName}}]({{stableUrl}}) for stable releases. }}{{h}} Featured Tags @@ -22,7 +23,7 @@ {{h}} About -The [Aspire Dashboard](https://aspire.dev/dashboard/standalone/) is a standalone viewer for logs, traces, and metrics from OpenTelemetry-enabled applications in any language. No Aspire AppHost or .NET application is required. Source code is available in [microsoft/aspire](https://github.com/microsoft/aspire). +The [Aspire Dashboard](https://aspire.dev/dashboard/standalone/) is a standalone viewer for logs, traces, and metrics from OpenTelemetry-enabled applications in any language. Source code is available in [microsoft/aspire](https://github.com/microsoft/aspire). {{if !isNightlyRepo: For preview builds, see the [nightly Aspire Dashboard image](https://mcr.microsoft.com/artifact/mar/aspire/nightly/dashboard/about). }} @@ -76,7 +77,7 @@ View the current tags at the [Microsoft Artifact Registry portal](https://mcr.mi See the [Aspire support policy](https://aspire.dev/support/) for supported versions and lifecycle information. Container images are also covered by the [Supported Container Platforms Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-platforms.md), [Supported Tags Policy](https://github.com/dotnet/dotnet-docker/blob/main/documentation/supported-tags.md), and [Image Update Policy](https://github.com/dotnet/dotnet-docker/blob/main/README.md#image-update-policy). -For container security and vulnerability reporting, see the [Security Policy](https://github.com/dotnet/dotnet-docker/blob/main/SECURITY.md) and [Container Vulnerability Workflow](https://github.com/dotnet/dotnet-docker/blob/main/documentation/vulnerability-reporting.md). +For container security and vulnerability reporting, see the [Security Policy](https://github.com/dotnet/dotnet-docker/blob/main/SECURITY.md) and [Container Vulnerability Workflow](https://github.com/dotnet/dotnet-docker/blob/main/documentation/vulnerability-reporting.md). Additional security information can be found on [aspire.dev/dashboard/security-considerations](https://aspire.dev/dashboard/security-considerations/#standalone-mode). {{h}}# Feedback