CommunityToolkit.Aspire.Hosting.Kind
📦 CommunityToolkit.Aspire.Hosting.Kindv13.5.1-beta.895Import path
apphost/modules/aspire26Functions
11Types
11 types, 26 functions and 12 members
Handles
handle
CommunityToolkit_Aspire_Hosting_KindCrdWaitBehaviorhandle
IKindResource5 membershandle
K8sManifestResource19 membershandle
KindClusterResource3 membershandle
KindDeployedResource1 membershandle
KindEnvironmentResourcehandle
KindHelmChartResource5 membershandle
KubernetesAspireDashboardResourcehandle
KubernetesEnvironmentResource1 membersEnums
Functions
ContainerResource
method
WithKindContainerReferencebuilderConfigures 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) ContainerResourcemethod
WithKindNetworkbuilderConnects a container resource to the Kind container network, enabling it to communicate with the Kind cluster's API server and nodes.
WithKindNetwork() ContainerResourceDistributedApplicationBuilder
IKindResource
method
WithClusterLifetimebuilderSets 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) IKindResourcemethod
WithKubernetesVersionbuilderSets the Kubernetes version for the Kind cluster.
WithKubernetesVersion(version string) IKindResourcemethod
WithNodeImagebuilderSets the Kind node image for every node in the cluster.
WithNodeImage(image string) IKindResourcemethod
WithNodeMountbuilderAdds an extra host mount to every Kind node container.
WithNodeMount(hostPath string, containerPath string, options ...*WithNodeMountOptions) IKindResourcemethod
WithWorkerNodesbuilderSets the number of worker nodes for the Kind cluster.
WithWorkerNodes(count float64) IKindResourceK8sManifestResource
method
WithApplyTimeoutbuilderSets the maximum time to wait for
kubectl apply to complete.WithApplyTimeout(timeout float64) K8sManifestResourcemethod
WithClusterReadyTimeoutbuilderSets the maximum time to wait for the Kubernetes API to become reachable before running
kubectl apply.WithClusterReadyTimeout(timeout float64) K8sManifestResourcemethod
WithCrdWaitBehaviorbuilderSets whether CRD wait failures fail the manifest resource or are logged as best-effort warnings.
WithCrdWaitBehavior(behavior CrdWaitBehavior) K8sManifestResourcemethod
WithCrdWaitTimeoutbuilderSets the maximum time to wait for applied CRDs to reach the
Established condition.WithCrdWaitTimeout(timeout float64) K8sManifestResourcemethod
WithFieldManagerbuilderSets the field manager name passed to
kubectl apply --field-manager .WithFieldManager(fieldManager string) K8sManifestResourcemethod
WithRecursivebuilderRecursively applies manifests from subdirectories (maps to
kubectl apply --recursive ). Only meaningful when the manifest path is a directory.WithRecursive() K8sManifestResourcemethod
WithServerSideApplybuilderApplies the manifest server-side (maps to
kubectl apply --server-side ). Required for large CRDs that exceed the client-side annotation size limit.WithServerSideApply(options ...*WithServerSideApplyOptions) K8sManifestResourceKindClusterResource
method
AddHelmChartbuilderAdds a Helm chart to be deployed to the Kind cluster.
AddHelmChart(name string, chartRef string) KindHelmChartResourcemethod
AddManifestbuilderAdds a Kubernetes manifest to be applied to the Kind cluster via
kubectl apply.AddManifest(name string, manifestPath string) K8sManifestResourcemethod
AddManifestFromContentbuilderAdds Kubernetes manifest content to be applied to the Kind cluster via
kubectl apply -f - .AddManifestFromContent(name string, content string) K8sManifestResourceKindDeployedResource
KindHelmChartResource
method
WithChartVersionbuilderSets the chart version (maps to
helm install --version ).WithChartVersion(version string) KindHelmChartResourcemethod
WithCrdWaitRetrybuilderRetries Helm installs that race newly-created CRDs which have not reached the
Established condition yet.WithCrdWaitRetry(options ...*WithCrdWaitRetryOptions) KindHelmChartResourcemethod
WithHelmStringValuebuilderSets a Helm value while preserving it as a string (maps to
helm install --set-string key=value ).WithHelmStringValue(key string, value string) KindHelmChartResourcemethod
WithHelmValuebuilderSets a Helm value (maps to
helm install --set key=value ).WithHelmValue(key string, value string) KindHelmChartResourcemethod
WithHelmValuesFilebuilderAdds a values file (maps to
helm install -f path ).WithHelmValuesFile(path string) KindHelmChartResource