K3sClusterOptions

Docs/Reference/Search C# APIs/CommunityToolkit.Aspire.Hosting.K3s/K3sClusterOptions

K3sClusterOptions

Docs Reference Search C# APIs CommunityToolkit.Aspire.Hosting.K3s K3sClusterOptions

Classsealednet10.0

📦 CommunityToolkit.Aspire.Hosting.K3s v13.4.1-beta.706

Advanced options for K3sBuilderExtensions.AddK3sCluster.

namespace CommunityToolkit.Aspire.Hosting;

public sealed class K3sClusterOptions
{
    // ...
}

Source

Search members of K3sClusterOptions...

constructorproperty

13 membersClear filters

Remarks

Most settings are exposed directly as fluent builder methods — prefer those for discoverability and TypeScript polyglot compatibility:

• K3sBuilderExtensions.WithAgentCount — number of worker nodes
• K3sBuilderExtensions.WithK3sVersion — k3s image tag
• K3sBuilderExtensions.WithPodSubnet — pod CIDR ( --cluster-cidr)
• K3sBuilderExtensions.WithServiceSubnet — service CIDR ( --service-cidr)
• K3sBuilderExtensions.WithDisabledComponent — disable built-in components
• K3sBuilderExtensions.WithExtraArg — raw k3s server arguments
• K3sBuilderExtensions.WithHelmImage — Helm installer image
• K3sBuilderExtensions.WithKubectlImage — kubectl image
• K3sBuilderExtensions.WithDataVolume — persistent data volume
• K3sBuilderExtensions.WithLifetime — container lifetime

Constructors1

K3sClusterOptions

View all constructors

Properties12

AgentCountget; set

int

Gets or sets the number of agent (worker) nodes. Defaults to 0 (single-node cluster).

ClusterCidrget; set

string?

Gets or sets the pod IP address range in CIDR notation ( --cluster-cidr). Defaults to k3s built-in value of 10.42.0.0/16 when null.

DisabledComponentsget

IList<string>

Gets the list of built-in k3s components to disable (each passed as --disable=<component>).

ExtraArgsget

IList<string>

Gets the list of raw arguments appended verbatim to the k3s server command.

HelmImageget; set

string

Gets or sets the Helm installer image name. Defaults to alpine/helm.

HelmRegistryget; set

string

Gets or sets the container registry for the Helm installer image. Defaults to docker.io.

HelmTagget; set

string

Gets or sets the Helm installer image tag. Defaults to 3.17.3.

ImageTagget; set

string?

Gets or sets the k3s container image tag, e.g. v1.32.3-k3s1. When null the version bundled with this package is used.

KubectlImageget; set

string

Gets or sets the kubectl image name. Defaults to alpine/kubectl.

KubectlRegistryget; set

string

Gets or sets the container registry for the kubectl image. Defaults to docker.io.

KubectlTagget; set

string

Gets or sets the kubectl image tag. Defaults to 1.36.0.

ServiceCidrget; set

string?

Gets or sets the Service cluster IP address range in CIDR notation ( --service-cidr). Defaults to k3s built-in value of 10.43.0.0/16 when null.

View all properties