Skip to content
DocsTry Aspire
DocsTry

HelmChartOptions Methods

ClassMethods10 members
Provides options for configuring Helm chart deployment settings on a KubernetesEnvironmentResource.
Sets the Helm chart description written to the generated Chart.yaml.
public sealed class HelmChartOptions
{
public HelmChartOptions WithChartDescription(
string description)
{
// ...
}
}
descriptionstringThe chart description.
Sets the Helm chart description written to the generated Chart.yaml using a parameter that will be prompted at deploy time.
public sealed class HelmChartOptions
{
public HelmChartOptions WithChartDescription(
IResourceBuilder<ParameterResource> description)
{
// ...
}
}
descriptionIResourceBuilder<ParameterResource>A parameter resource builder for the chart description value.
Sets the Helm chart name written to the generated Chart.yaml.
public sealed class HelmChartOptions
{
public HelmChartOptions WithChartName(
string name)
{
// ...
}
}
namestringThe chart name. Must match Helm's chart-name format (alphanumeric, -, _, or .).
Sets the Helm chart name written to the generated Chart.yaml using a parameter that will be prompted at deploy time.
public sealed class HelmChartOptions
{
public HelmChartOptions WithChartName(
IResourceBuilder<ParameterResource> name)
{
// ...
}
}
nameIResourceBuilder<ParameterResource>A parameter resource builder for the chart name value.
Sets the Helm chart version for deployment.
public sealed class HelmChartOptions
{
public HelmChartOptions WithChartVersion(
string version)
{
// ...
}
}
versionstring The chart version. Helm accepts strict SemVer 2.0 strings (e.g. "1.2.3", "1.2.3-beta.1+ef365") as well as partial versions ( "1", "1.2") and versions with a leading v ( "v1.2.3"), which are coerced to a full semantic version. Leading zeros are not allowed.
Sets the Helm chart version for deployment using a parameter that will be prompted at deploy time.
public sealed class HelmChartOptions
{
public HelmChartOptions WithChartVersion(
IResourceBuilder<ParameterResource> version)
{
// ...
}
}
versionIResourceBuilder<ParameterResource>A parameter resource builder for the chart version value.
Sets the target Kubernetes namespace for deployment.
public sealed class HelmChartOptions
{
public HelmChartOptions WithNamespace(
string @namespace)
{
// ...
}
}
namespacestringThe namespace name.
Sets the target Kubernetes namespace for deployment using a parameter that will be prompted at deploy time.
public sealed class HelmChartOptions
{
public HelmChartOptions WithNamespace(
IResourceBuilder<ParameterResource> @namespace)
{
// ...
}
}
namespaceIResourceBuilder<ParameterResource>A parameter resource builder for the namespace value.
Sets the Helm release name for deployment.
public sealed class HelmChartOptions
{
public HelmChartOptions WithReleaseName(
string releaseName)
{
// ...
}
}
releaseNamestringThe release name.
Sets the Helm release name for deployment using a parameter that will be prompted at deploy time.
public sealed class HelmChartOptions
{
public HelmChartOptions WithReleaseName(
IResourceBuilder<ParameterResource> releaseName)
{
// ...
}
}
releaseNameIResourceBuilder<ParameterResource>A parameter resource builder for the release name value.