CommunityToolkit.Aspire.Hosting.Kind

📦 CommunityToolkit.Aspire.Hosting.Kindv13.5.1-beta.736

26Functions

8Types

8 types and 23 members

Types

handleCrdWaitBehavior

handleK8sManifestResource30 members

handleKindClusterResource3 members

handleKindDeployedResource1 members

handleKindEnvironmentResource

handleKindHelmChartResource5 members

Functions

methodaddHelmChartbuilder

Adds a Helm chart to be deployed to the Kind cluster.

addHelmChart(name: string, chartRef: string): KindHelmChartResource

methodaddKindClusterbuilder

Adds a Kind cluster resource to the application model.

addKindCluster(name: string): KindClusterResource

methodaddManifestbuilder

Adds a Kubernetes manifest to be applied to the Kind cluster via `kubectl apply`.

addManifest(name: string, manifestPath: string): K8sManifestResource

methodaddManifestFromContentbuilder

Adds Kubernetes manifest content to be applied to the Kind cluster via `kubectl apply -f -`.

addManifestFromContent(name: string, content: string): K8sManifestResource

methodwithApplyTimeoutbuilder

Sets the maximum time to wait for `kubectl apply` to complete.

withApplyTimeout(timeout: timespan): K8sManifestResource

methodwithChartVersionbuilder

Sets the chart version (maps to `helm install --version`).

withChartVersion(version: string): KindHelmChartResource

methodwithClusterLifetimebuilder

Sets the cluster lifetime. When `Session` (the default), the cluster is deleted on graceful shutdown or other process-exit signals on a best-effort basis. When `Persistent`, the cluster survives AppHost restarts and is reused on next startup.

withClusterLifetime(lifetime: ClusterLifetime): IKindResource

methodwithClusterReadyTimeoutbuilder

Sets the maximum time to wait for the Kubernetes API to become reachable before running `kubectl apply`.

withClusterReadyTimeout(timeout: timespan): K8sManifestResource

methodwithCrdWaitBehaviorbuilder

Sets whether CRD wait failures fail the manifest resource or are logged as best-effort warnings.

withCrdWaitBehavior(behavior: CrdWaitBehavior): K8sManifestResource

methodwithCrdWaitRetrybuilder

Retries Helm installs that race newly-created CRDs which have not reached the `Established` condition yet.

withCrdWaitRetry(maxAttempts?: number, backoff?: timespan, crdWaitTimeout?: timespan): KindHelmChartResource

methodwithCrdWaitTimeoutbuilder

Sets the maximum time to wait for applied CRDs to reach the `Established` condition.

withCrdWaitTimeout(timeout: timespan): K8sManifestResource

methodwithFieldManagerbuilder

Sets the field manager name passed to `kubectl apply --field-manager`.

withFieldManager(fieldManager: string): K8sManifestResource

methodwithHelmStringValuebuilder

Sets a Helm value while preserving it as a string (maps to `helm install --set-string key=value`).

withHelmStringValue(key: string, value: string): KindHelmChartResource

methodwithHelmValuebuilder

Sets a Helm value (maps to `helm install --set key=value`).

withHelmValue(key: string, value: string): KindHelmChartResource

methodwithHelmValuesFilebuilder

Adds a values file (maps to `helm install -f path`).

withHelmValuesFile(path: string): KindHelmChartResource

methodwithKindbuilder

Configures the Kubernetes environment to create and deploy to a local Kind cluster. Enables `aspire deploy` to provision the cluster, load container images, and install the generated Helm chart.

withKind(): KindEnvironmentResource

methodwithKindClusterReferencebuilder

Configures a non-container resource to reference the Kind cluster by injecting kubeconfig environment variables.

withKindClusterReference(kind: KindClusterResource): IResourceWithEnvironment

methodwithKindContainerReferencebuilder

Configures a container resource to reference the Kind cluster by bind-mounting the container-compatible kubeconfig, injecting environment variables, and connecting to the Kind container network.

withKindContainerReference(kind: KindClusterResource): ContainerResource

methodwithKindNetworkbuilder

Connects a container resource to the Kind container network, enabling it to communicate with the Kind cluster's API server and nodes.

withKindNetwork(): ContainerResource

methodwithKubernetesVersionbuilder

Sets the Kubernetes version for the Kind cluster.

withKubernetesVersion(version: string): IKindResource

methodwithNamespacebuilder

Sets the Kubernetes namespace for the deployment.

withNamespace(namespace: string): KindDeployedResource

methodwithNodeImagebuilder

Sets the Kind node image for every node in the cluster.

withNodeImage(image: string): IKindResource

methodwithNodeMountbuilder

Adds an extra host mount to every Kind node container.

withNodeMount(hostPath: string, containerPath: string, readOnly?: boolean): IKindResource

methodwithRecursivebuilder

Recursively applies manifests from subdirectories (maps to `kubectl apply --recursive`). Only meaningful when the manifest path is a directory.

withRecursive(): K8sManifestResource

methodwithServerSideApplybuilder

Applies the manifest server-side (maps to `kubectl apply --server-side`). Required for large CRDs that exceed the client-side annotation size limit.

withServerSideApply(forceConflicts?: boolean): K8sManifestResource

methodwithWorkerNodesbuilder

Sets the number of worker nodes for the Kind cluster.

withWorkerNodes(count: number): IKindResource

Enums

enumClusterLifetime2 values

enumCrdWaitBehavior2 values