Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

KubernetesAspireDashboardResource

Handle
📦 Aspire.Hosting.Kubernetes v13.6.5-preview.1.26559.7

Represents a resource for the Aspire Dashboard deployed into a Kubernetes environment. This resource is used to visualize telemetry data from resources running in the cluster.

type KubernetesAspireDashboardResource interface {
IComputeResource
Resource
ResourceWithArgs
ResourceWithEndpoints
ResourceWithEnvironment
ResourceWithWaitSupport
}

Properties

propertyOtlpGrpcEndpointEndpointReferenceget
Gets the OTLP gRPC endpoint for receiving telemetry data.
OtlpGrpcEndpoint() EndpointReference
propertyPrimaryEndpointEndpointReferenceget
Gets the primary HTTP endpoint of the Aspire Dashboard UI.
PrimaryEndpoint() EndpointReference

Methods

Configures whether forwarded headers processing is enabled for the Aspire dashboard container.
WithForwardedHeaders(options ...*WithForwardedHeadersOptions) KubernetesAspireDashboardResource
options...*WithForwardedHeadersOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithForwardedHeadersOptions argument.

Enabled*boolTrue to enable forwarded headers, false to disable.
KubernetesAspireDashboardResource

The resource builder.

Returns a handle; failures surface later via Err().

methodWithOtlpServicePortbuilder
Sets the Kubernetes Service ports for the Aspire Dashboard OTLP endpoints.
WithOtlpServicePort(options ...*WithOtlpServicePortOptions) KubernetesAspireDashboardResource
options...*WithOtlpServicePortOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithOtlpServicePortOptions argument.

GrpcPort*float64The Service port for the OTLP gRPC endpoint. If null, the Service port defaults to the container port (18889).
HttpPort*float64The Service port for the OTLP HTTP endpoint. If null, the Service port defaults to the container port (18890).
KubernetesAspireDashboardResource

The resource builder.

Returns a handle; failures surface later via Err().

methodWithServicePortbuilder
Sets the Kubernetes Service port for the Aspire Dashboard HTTP endpoint.
WithServicePort(options ...*WithServicePortOptions) KubernetesAspireDashboardResource
options...*WithServicePortOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithServicePortOptions argument.

Port*float64The Service port number. Cluster-internal clients will connect to this port, which routes to the dashboard's container port (18888). If null, the Service port defaults to the container port.
KubernetesAspireDashboardResource

The resource builder.

Returns a handle; failures surface later via Err().