K3sClusterResource

Classsealednet10.0

📦 CommunityToolkit.Aspire.Hosting.K3s v13.5.0

Represents a k3s Kubernetes cluster running as a privileged container resource. Injects the cluster's kubeconfig into a dependent resource.

Host processes receive KUBECONFIG=<host-path>/local/kubeconfig.yaml.
Containers receive KUBECONFIG=/tmp/k3s-kubeconfig.yaml and a file-level bind-mount of the container-network kubeconfig variant. Both are applied by the BeforeStartEvent subscriber registered in AddK3sCluster.

namespace Aspire.Hosting.ApplicationModel;

public sealed class K3sClusterResource
    : Aspire.Hosting.ApplicationModel.ContainerResource,
      Aspire.Hosting.ApplicationModel.IExpressionValue,
      Aspire.Hosting.ApplicationModel.IManifestExpressionProvider,
      Aspire.Hosting.ApplicationModel.IResource,
      Aspire.Hosting.ApplicationModel.IResourceWithConnectionString,
      Aspire.Hosting.ApplicationModel.IValueProvider,
      Aspire.Hosting.ApplicationModel.IValueWithReferences
{
    // ...
}

ContainerResourceIExpressionValueIManifestExpressionProviderIResourceIResourceWithConnectionStringIValueProviderIValueWithReferences

7 members

Constructors1

K3sClusterResource(string)

Represents a k3s Kubernetes cluster running as a privileged container resource. Injects the cluster's kubeconfig into a dependent resource.

Host processes receive KUBECONFIG=<host-path>/local/kubeconfig.yaml.
Containers receive KUBECONFIG=/tmp/k3s-kubeconfig.yaml and a file-level bind-mount of the container-network kubeconfig variant. Both are applied by the BeforeStartEvent subscriber registered in AddK3sCluster.

View all constructors

Properties5

ApiEndpointget

EndpointReference

Gets the endpoint reference for the k3s API server (port 6443).

ConnectionStringEnvironmentVariableget

string?

Overrides the default ConnectionStrings__ prefix so Aspire injects KUBECONFIG.

ConnectionStringExpressionget

ReferenceExpression

Manifest expression for the local kubeconfig path.

HelmReleasesgetats ignored

IReadOnlyDictionary<string, string>

A dictionary of registered Helm releases keyed by resource name.

Manifestsgetats ignored

IReadOnlyList<string>

Names of registered K8sManifestResource children.

View all properties

Methods1

GetConnectionStringAsync(CancellationToken)

ValueTask<string?>

Returns the host-accessible kubeconfig path for this cluster.

View all methods