Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

HelmReleaseResource

Handle
📦 CommunityToolkit.Aspire.Hosting.K3s v13.6.1

Represents a Helm chart release installed into a k3s cluster.

type HelmReleaseResource interface {
IComputeResource
Resource
ResourceWithArgs
ResourceWithEndpoints
ResourceWithEnvironment
ResourceWithParent
ResourceWithWaitSupport
}

Properties

propertyNamespacestringget
Gets the Kubernetes namespace the chart is installed into.
Namespace() (string, error)
propertyParentK3sClusterResourceget
Gets the Parent property
Parent() K3sClusterResource
propertyReleaseNamestringget
Gets the Helm release name passed to helm upgrade --install.
ReleaseName() (string, error)

Methods

methodWithHelmValuebuilder
Adds a Helm --set key=value override to the release.
WithHelmValue(
key string,
value string,
) HelmReleaseResource
keystringThe Helm value path using dot notation, e.g. server.service.type. If the same key is set more than once, the last call wins.
valuestringThe value to assign.
HelmReleaseResource

The same builder, for chaining.

Returns a handle; failures surface later via Err().

methodWithHelmValuesFilebuilder
Supplies a YAML values file to the Helm release (--values).
WithHelmValuesFile(path string) HelmReleaseResource
pathstringPath to the YAML values file on the host. Relative paths are resolved against the AppHost project directory. Call this method multiple times to supply additional files; they are applied in declaration order and later files win for duplicate keys.
HelmReleaseResource

The same builder, for chaining.

Returns a handle; failures surface later via Err().