KubernetesEnvironmentExtensions Methods

AddKubernetesEnvironment(IDistributedApplicationBuilder, string)extensionIResourceBuilder<KubernetesEnvironmentResource>

Adds a Kubernetes environment to the application model.

public static class KubernetesEnvironmentExtensions
{
    public static IResourceBuilder<KubernetesEnvironmentResource> AddKubernetesEnvironment(
        this IDistributedApplicationBuilder builder,
        string name)
    {
        // ...
    }
}

KubernetesEnvironmentExtensions.cs#L86-L110

Parameters

builderIDistributedApplicationBuilderThe Hosting.IDistributedApplicationBuilder.

namestringThe name of the Kubernetes environment resource.

Returns

IResourceBuilder<KubernetesEnvironmentResource>A reference to the ApplicationModel.IResourceBuilder`1.

AddNodePool(IResourceBuilder<KubernetesEnvironmentResource>, string)extensionIResourceBuilder<KubernetesNodePoolResource>

Adds a named node pool to the Kubernetes environment.

public static class KubernetesEnvironmentExtensions
{
    public static IResourceBuilder<KubernetesNodePoolResource> AddNodePool(
        this IResourceBuilder<KubernetesEnvironmentResource> builder,
        string name)
    {
        // ...
    }
}

KubernetesEnvironmentExtensions.cs#L246-L257

Parameters

builderIResourceBuilder<KubernetesEnvironmentResource>The Kubernetes environment resource builder.

namestringThe name of the node pool. This value is used as the nodeSelector value.

Returns

IResourceBuilder<KubernetesNodePoolResource>A reference to the ApplicationModel.IResourceBuilder`1 for the new node pool.

Remarks

For vanilla Kubernetes, this creates a named reference to an existing node pool. For managed Kubernetes services (e.g., AKS), the cloud-specific AddNodePool overload provisions the pool with additional configuration such as VM size and autoscaling. Use KubernetesEnvironmentExtensions.WithNodePool to schedule workloads on the returned node pool.

Examples

var k8s = builder.AddKubernetesEnvironment("k8s");
var gpuPool = k8s.AddNodePool("gpu");

builder.AddProject<MyApi>()
    .WithComputeEnvironment(k8s)
    .WithNodePool(gpuPool);

WithDashboard(IResourceBuilder<KubernetesEnvironmentResource>, bool)extensionIResourceBuilder<KubernetesEnvironmentResource>

Enables the Aspire dashboard for telemetry visualization in this Kubernetes environment.

public static class KubernetesEnvironmentExtensions
{
    public static IResourceBuilder<KubernetesEnvironmentResource> WithDashboard(
        this IResourceBuilder<KubernetesEnvironmentResource> builder,
        bool enabled = true)
    {
        // ...
    }
}

KubernetesEnvironmentExtensions.cs#L187-L191

Parameters

builderIResourceBuilder<KubernetesEnvironmentResource>The Kubernetes environment resource builder.

enabledbooloptionalWhether to enable the dashboard. Default is true.

Returns

IResourceBuilder<KubernetesEnvironmentResource>A reference to the ApplicationModel.IResourceBuilder`1.

Remarks

When enabled, an Aspire Dashboard container is deployed alongside the application resources in the Kubernetes cluster. All resources with OTLP telemetry support are automatically configured to send telemetry data to the dashboard.

WithDashboard(IResourceBuilder<KubernetesEnvironmentResource>, Action<IResourceBuilder<KubernetesAspireDashboardResource>>)

extensionIResourceBuilder<KubernetesEnvironmentResource>

Configures the dashboard properties for this Kubernetes environment.

public static class KubernetesEnvironmentExtensions
{
    public static IResourceBuilder<KubernetesEnvironmentResource> WithDashboard(
        this IResourceBuilder<KubernetesEnvironmentResource> builder,
        Action<IResourceBuilder<KubernetesAspireDashboardResource>> configure)
    {
        // ...
    }
}

KubernetesEnvironmentExtensions.cs#L208-L215

Parameters

builderIResourceBuilder<KubernetesEnvironmentResource>The Kubernetes environment resource builder.

configureAction<IResourceBuilder<KubernetesAspireDashboardResource>>A method that can be used for customizing the dashboard resource.

Returns

IResourceBuilder<KubernetesEnvironmentResource>A reference to the ApplicationModel.IResourceBuilder`1.

Remarks

Use this overload to customize the dashboard container, for example to set a specific host port or enable forwarded headers for ingress access.

WithHelm(IResourceBuilder<KubernetesEnvironmentResource>, Action<HelmChartOptions>)extensionIResourceBuilder<KubernetesEnvironmentResource>

Configures the Kubernetes environment to deploy using Helm charts.

public static class KubernetesEnvironmentExtensions
{
    public static IResourceBuilder<KubernetesEnvironmentResource> WithHelm(
        this IResourceBuilder<KubernetesEnvironmentResource> builder,
        Action<HelmChartOptions>? configure = null)
    {
        // ...
    }
}

KubernetesEnvironmentExtensions.cs#L140-L151

Parameters

builderIResourceBuilder<KubernetesEnvironmentResource>The Kubernetes environment resource builder.

configureAction<HelmChartOptions>optionalAn optional callback to configure Helm chart settings such as namespace, release name, and chart version.

Returns

IResourceBuilder<KubernetesEnvironmentResource>A reference to the ApplicationModel.IResourceBuilder`1.

Remarks

Helm is the default deployment engine. Call this method to customize Helm-specific settings.

Examples

Configure Helm deployment with custom settings:

builder.AddKubernetesEnvironment("k8s")
    .WithHelm(helm =>
    {
        helm.WithNamespace("my-namespace");
        helm.WithReleaseName("my-release");
        helm.WithChartVersion("1.0.0");
    });

WithNodePool(IResourceBuilder<T>, IResourceBuilder<KubernetesNodePoolResource>)extensionIResourceBuilder<T>

Schedules a compute resource's workload on the specified Kubernetes node pool. This translates to a Kubernetes nodeSelector in the pod specification targeting the named node pool.

public static class KubernetesEnvironmentExtensions
{
    public static IResourceBuilder<T> WithNodePool<T>(
        this IResourceBuilder<T> builder,
        IResourceBuilder<KubernetesNodePoolResource> nodePool)
    {
        // ...
    }
}

KubernetesEnvironmentExtensions.cs#L286-L290

Parameters

builderIResourceBuilder<T>The resource builder.

nodePoolIResourceBuilder<KubernetesNodePoolResource>The node pool to schedule the workload on.

Returns

IResourceBuilder<T>A reference to the ApplicationModel.IResourceBuilder`1 for chaining.

Examples

var k8s = builder.AddKubernetesEnvironment("k8s");
var gpuPool = k8s.AddNodePool("gpu");

builder.AddProject<MyApi>()
    .WithComputeEnvironment(k8s)
    .WithNodePool(gpuPool);

WithProperties(IResourceBuilder<KubernetesEnvironmentResource>, Action<KubernetesEnvironmentResource>)extensionIResourceBuilder<KubernetesEnvironmentResource>

Allows setting the properties of a Kubernetes environment resource.

public static class KubernetesEnvironmentExtensions
{
    public static IResourceBuilder<KubernetesEnvironmentResource> WithProperties(
        this IResourceBuilder<KubernetesEnvironmentResource> builder,
        Action<KubernetesEnvironmentResource> configure)
    {
        // ...
    }
}

KubernetesEnvironmentExtensions.cs#L164-L169

Parameters

builderIResourceBuilder<KubernetesEnvironmentResource>The Kubernetes environment resource builder.

configureAction<KubernetesEnvironmentResource>A method that can be used for customizing the KubernetesEnvironmentResource.

Returns

IResourceBuilder<KubernetesEnvironmentResource>A reference to the ApplicationModel.IResourceBuilder`1.