com.pulumi.kubernetes.helm.v4.kotlin.ChartArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-kubernetes-kotlin Show documentation
Show all versions of pulumi-kubernetes-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
The newest version!
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.kubernetes.helm.v4.kotlin
import com.pulumi.asset.AssetOrArchive
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import com.pulumi.kubernetes.helm.v4.ChartArgs.builder
import com.pulumi.kubernetes.helm.v4.kotlin.inputs.PostRendererArgs
import com.pulumi.kubernetes.helm.v4.kotlin.inputs.PostRendererArgsBuilder
import com.pulumi.kubernetes.helm.v4.kotlin.inputs.RepositoryOptsArgs
import com.pulumi.kubernetes.helm.v4.kotlin.inputs.RepositoryOptsArgsBuilder
import kotlin.Any
import kotlin.Boolean
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
import kotlin.jvm.JvmName
/**
* _See also: [New: Helm Chart v4 resource with new features and languages](/blog/kubernetes-chart-v4/)_
* Chart is a component representing a collection of resources described by a Helm Chart.
* Helm charts are a popular packaging format for Kubernetes applications, and published
* to registries such as [Artifact Hub](https://artifacthub.io/packages/search?kind=0&sort=relevance&page=1).
* Chart does not use Tiller or create a Helm Release; the semantics are equivalent to
* running `helm template --dry-run=server` and then using Pulumi to deploy the resulting YAML manifests.
* This allows you to apply [Pulumi Transformations](https://www.pulumi.com/docs/concepts/options/transformations/) and
* [Pulumi Policies](https://www.pulumi.com/docs/using-pulumi/crossguard/) to the Kubernetes resources.
* You may also want to consider the `Release` resource as an alternative method for managing helm charts. For more
* information about the trade-offs between these options, see: [Choosing the right Helm resource for your use case](https://www.pulumi.com/registry/packages/kubernetes/how-to-guides/choosing-the-right-helm-resource-for-your-use-case).
* ### Chart Resolution
* The Helm Chart can be fetched from any source that is accessible to the `helm` command line.
* The following variations are supported:
* 1. By chart reference with repo prefix: `chart: "example/mariadb"`
* 2. By path to a packaged chart: `chart: "./nginx-1.2.3.tgz"`
* 3. By path to an unpacked chart directory: `chart: "./nginx"`
* 4. By absolute URL: `chart: "https://example.com/charts/nginx-1.2.3.tgz"`
* 5. By chart reference with repo URL: `chart: "nginx", repositoryOpts: { repo: "https://example.com/charts/" }`
* 6. By OCI registry: `chart: "oci://example.com/charts/nginx", version: "1.2.3"`
* A chart reference is a convenient way of referencing a chart in a chart repository.
* When you use a chart reference with a repo prefix (`example/mariadb`), Pulumi will look in Helm's local configuration
* for a chart repository named `example`, and will then look for a chart in that repository whose name is `mariadb`.
* It will install the latest stable version of that chart, unless you specify `devel` to also include
* development versions (alpha, beta, and release candidate releases), or supply a version number with `version`.
* Use the `verify` and optional `keyring` inputs to enable Chart verification.
* By default, Pulumi uses the keyring at `$HOME/.gnupg/pubring.gpg`. See: [Helm Provenance and Integrity](https://helm.sh/docs/topics/provenance/).
* ### Chart Values
* [Values files](https://helm.sh/docs/chart_template_guide/values_files/#helm) (`values.yaml`) may be supplied
* with the `valueYamlFiles` input, accepting [Pulumi Assets](https://www.pulumi.com/docs/concepts/assets-archives/#assets).
* A map of chart values may also be supplied with the `values` input, with highest precedence. You're able to use literals,
* nested maps, [Pulumi outputs](https://www.pulumi.com/docs/concepts/inputs-outputs/), and Pulumi assets as values.
* Assets are automatically opened and converted to a string.
* Note that the use of expressions (e.g. `--set service.type`) is not supported.
* ### Chart Dependency Resolution
* For unpacked chart directories, Pulumi automatically rebuilds the dependencies if dependencies are missing
* and a `Chart.lock` file is present (see: [Helm Dependency Build](https://helm.sh/docs/helm/helm_dependency_build/)).
* Use the `dependencyUpdate` input to have Pulumi update the dependencies (see: [Helm Dependency Update](https://helm.sh/docs/helm/helm_dependency_update/)).
* ### Templating
* The `Chart` resource renders the templates from your chart and then manages the resources directly with the
* Pulumi Kubernetes provider. A default namespace is applied based on the `namespace` input, the provider's
* configured namespace, and the active Kubernetes context. Use the `skipCrds` option to skip installing the
* Custom Resource Definition (CRD) objects located in the chart's `crds/` special directory.
* Use the `postRenderer` input to pipe the rendered manifest through a [post-rendering command](https://helm.sh/docs/topics/advanced/#post-rendering).
* ### Resource Ordering
* Sometimes resources must be applied in a specific order. For example, a namespace resource must be
* created before any namespaced resources, or a Custom Resource Definition (CRD) must be pre-installed.
* Pulumi uses heuristics to determine which order to apply and delete objects within the Chart. Pulumi also
* waits for each object to be fully reconciled, unless `skipAwait` is enabled.
* Pulumi supports the `config.kubernetes.io/depends-on` annotation to declare an explicit dependency on a given resource.
* The annotation accepts a list of resource references, delimited by commas.
* Note that references to resources outside the Chart aren't supported.
* **Resource reference**
* A resource reference is a string that uniquely identifies a resource.
* It consists of the group, kind, name, and optionally the namespace, delimited by forward slashes.
* | Resource Scope | Format |
* | :--------------- | :--------------------------------------------- |
* | namespace-scoped | `/namespaces///` |
* | cluster-scoped | `//` |
* For resources in the “core” group, the empty string is used instead (for example: `/namespaces/test/Pod/pod-a`).
* ## Example Usage
* ### Local Chart Directory
* ```java
* package generated_program;
* import com.pulumi.Pulumi;
* import com.pulumi.kubernetes.helm.v4.Chart;
* import com.pulumi.kubernetes.helm.v4.ChartArgs;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(ctx -> {
* var nginx = new Chart("nginx", ChartArgs.builder()
* .chart("./nginx")
* .build());
* });
* }
* }
* ```
* ### Repository Chart
* ```java
* package generated_program;
* import com.pulumi.Pulumi;
* import com.pulumi.kubernetes.helm.v4.Chart;
* import com.pulumi.kubernetes.helm.v4.ChartArgs;
* import com.pulumi.kubernetes.helm.v4.inputs.RepositoryOptsArgs;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(ctx -> {
* var nginx = new Chart("nginx", ChartArgs.builder()
* .chart("nginx")
* .repositoryOpts(RepositoryOptsArgs.builder()
* .repo("https://charts.bitnami.com/bitnami")
* .build())
* .build());
* });
* }
* }
* ```
* ### OCI Chart
* ```java
* package generated_program;
* import com.pulumi.Pulumi;
* import com.pulumi.kubernetes.helm.v4.Chart;
* import com.pulumi.kubernetes.helm.v4.ChartArgs;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(ctx -> {
* var nginx = new Chart("nginx", ChartArgs.builder()
* .chart("oci://registry-1.docker.io/bitnamicharts/nginx")
* .version("16.0.7")
* .build());
* });
* }
* }
* ```
* ### Chart Values
* ```java
* package generated_program;
* import java.util.Map;
* import com.pulumi.Pulumi;
* import com.pulumi.kubernetes.helm.v4.Chart;
* import com.pulumi.kubernetes.helm.v4.ChartArgs;
* import com.pulumi.kubernetes.helm.v4.inputs.RepositoryOptsArgs;
* import com.pulumi.asset.FileAsset;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(ctx -> {
* var nginx = new Chart("nginx", ChartArgs.builder()
* .chart("nginx")
* .repositoryOpts(RepositoryOptsArgs.builder()
* .repo("https://charts.bitnami.com/bitnami")
* .build())
* .valueYamlFiles(new FileAsset("./values.yaml"))
* .values(Map.of(
* "service", Map.of(
* "type", "ClusterIP"),
* "notes", new FileAsset("./notes.txt")))
* .build());
* });
* }
* }
* ```
* ### Chart Namespace
* ```java
* package generated_program;
* import com.pulumi.Pulumi;
* import com.pulumi.kubernetes.core.v1.Namespace;
* import com.pulumi.kubernetes.core.v1.NamespaceArgs;
* import com.pulumi.kubernetes.helm.v4.Chart;
* import com.pulumi.kubernetes.helm.v4.ChartArgs;
* import com.pulumi.kubernetes.helm.v4.inputs.RepositoryOptsArgs;
* import com.pulumi.kubernetes.meta.v1.inputs.ObjectMetaArgs;
* import com.pulumi.core.Output;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(ctx -> {
* var ns = new Namespace("nginx", NamespaceArgs.builder()
* .metadata(ObjectMetaArgs.builder()
* .name("nginx")
* .build())
* .build());
* var nginx = new Chart("nginx", ChartArgs.builder()
* .namespace(ns.metadata().apply(m -> Output.of(m.name().get())))
* .chart("nginx")
* .repositoryOpts(RepositoryOptsArgs.builder()
* .repo("https://charts.bitnami.com/bitnami")
* .build())
* .build());
* });
* }
* }
* ```
* @property chart Chart name to be installed. A path may be used.
* @property dependencyUpdate Run helm dependency update before installing the chart.
* @property devel Use chart development versions, too. Equivalent to version '>0.0.0-0'. If `version` is set, this is ignored.
* @property keyring Location of public keys used for verification. Used only if `verify` is true
* @property name Release name.
* @property namespace Namespace for the release.
* @property postRenderer Specification defining the post-renderer to use.
* @property repositoryOpts Specification defining the Helm chart repository to use.
* @property resourcePrefix An optional prefix for the auto-generated resource names. Example: A resource created with resourcePrefix="foo" would produce a resource named "foo:resourceName".
* @property skipAwait By default, the provider waits until all resources are in a ready state before marking the release as successful. Setting this to true will skip such await logic.
* @property skipCrds If set, no CRDs will be installed. By default, CRDs are installed if not already present.
* @property valueYamlFiles List of assets (raw yaml files). Content is read and merged with values.
* @property values Custom values set for the release.
* @property verify Verify the chart's integrity.
* @property version Specify the chart version to install. If this is not specified, the latest version is installed.
*/
public data class ChartArgs(
public val chart: Output? = null,
public val dependencyUpdate: Output? = null,
public val devel: Output? = null,
public val keyring: Output? = null,
public val name: Output? = null,
public val namespace: Output? = null,
public val postRenderer: Output? = null,
public val repositoryOpts: Output? = null,
public val resourcePrefix: Output? = null,
public val skipAwait: Output? = null,
public val skipCrds: Output? = null,
public val valueYamlFiles: Output>? = null,
public val values: Output>? = null,
public val verify: Output? = null,
public val version: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.kubernetes.helm.v4.ChartArgs =
com.pulumi.kubernetes.helm.v4.ChartArgs.builder()
.chart(chart?.applyValue({ args0 -> args0 }))
.dependencyUpdate(dependencyUpdate?.applyValue({ args0 -> args0 }))
.devel(devel?.applyValue({ args0 -> args0 }))
.keyring(keyring?.applyValue({ args0 -> args0 }))
.name(name?.applyValue({ args0 -> args0 }))
.namespace(namespace?.applyValue({ args0 -> args0 }))
.postRenderer(postRenderer?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
.repositoryOpts(repositoryOpts?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
.resourcePrefix(resourcePrefix?.applyValue({ args0 -> args0 }))
.skipAwait(skipAwait?.applyValue({ args0 -> args0 }))
.skipCrds(skipCrds?.applyValue({ args0 -> args0 }))
.valueYamlFiles(valueYamlFiles?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.values(values?.applyValue({ args0 -> args0.map({ args0 -> args0.key.to(args0.value) }).toMap() }))
.verify(verify?.applyValue({ args0 -> args0 }))
.version(version?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [ChartArgs].
*/
@PulumiTagMarker
public class ChartArgsBuilder internal constructor() {
private var chart: Output? = null
private var dependencyUpdate: Output? = null
private var devel: Output? = null
private var keyring: Output? = null
private var name: Output? = null
private var namespace: Output? = null
private var postRenderer: Output? = null
private var repositoryOpts: Output? = null
private var resourcePrefix: Output? = null
private var skipAwait: Output? = null
private var skipCrds: Output? = null
private var valueYamlFiles: Output>? = null
private var values: Output>? = null
private var verify: Output? = null
private var version: Output? = null
/**
* @param value Chart name to be installed. A path may be used.
*/
@JvmName("ipgkvflxsmfmxmpr")
public suspend fun chart(`value`: Output) {
this.chart = value
}
/**
* @param value Run helm dependency update before installing the chart.
*/
@JvmName("oxgtgiyatxxxilis")
public suspend fun dependencyUpdate(`value`: Output) {
this.dependencyUpdate = value
}
/**
* @param value Use chart development versions, too. Equivalent to version '>0.0.0-0'. If `version` is set, this is ignored.
*/
@JvmName("otehikmtiepklgbv")
public suspend fun devel(`value`: Output) {
this.devel = value
}
/**
* @param value Location of public keys used for verification. Used only if `verify` is true
*/
@JvmName("foplytnglkwngevq")
public suspend fun keyring(`value`: Output) {
this.keyring = value
}
/**
* @param value Release name.
*/
@JvmName("opatftqrnkuejpgd")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value Namespace for the release.
*/
@JvmName("fciiqueccdtormws")
public suspend fun namespace(`value`: Output) {
this.namespace = value
}
/**
* @param value Specification defining the post-renderer to use.
*/
@JvmName("blvdvrkauaucejud")
public suspend fun postRenderer(`value`: Output) {
this.postRenderer = value
}
/**
* @param value Specification defining the Helm chart repository to use.
*/
@JvmName("irwcnrpdhliosysf")
public suspend fun repositoryOpts(`value`: Output) {
this.repositoryOpts = value
}
/**
* @param value An optional prefix for the auto-generated resource names. Example: A resource created with resourcePrefix="foo" would produce a resource named "foo:resourceName".
*/
@JvmName("jgcfwrwuprmcbdvl")
public suspend fun resourcePrefix(`value`: Output) {
this.resourcePrefix = value
}
/**
* @param value By default, the provider waits until all resources are in a ready state before marking the release as successful. Setting this to true will skip such await logic.
*/
@JvmName("lukdualvdvkeouvd")
public suspend fun skipAwait(`value`: Output) {
this.skipAwait = value
}
/**
* @param value If set, no CRDs will be installed. By default, CRDs are installed if not already present.
*/
@JvmName("cydybkfuxmiubpxs")
public suspend fun skipCrds(`value`: Output) {
this.skipCrds = value
}
/**
* @param value List of assets (raw yaml files). Content is read and merged with values.
*/
@JvmName("jgrylnkrkrddfxke")
public suspend fun valueYamlFiles(`value`: Output>) {
this.valueYamlFiles = value
}
@JvmName("urtwqtedigjyavip")
public suspend fun valueYamlFiles(vararg values: Output) {
this.valueYamlFiles = Output.all(values.asList())
}
/**
* @param values List of assets (raw yaml files). Content is read and merged with values.
*/
@JvmName("esblvcsecwaajgiu")
public suspend fun valueYamlFiles(values: List>) {
this.valueYamlFiles = Output.all(values)
}
/**
* @param value Custom values set for the release.
*/
@JvmName("vgttmtkiajtyvitl")
public suspend fun values(`value`: Output>) {
this.values = value
}
/**
* @param value Verify the chart's integrity.
*/
@JvmName("kxycxtujlggkvvgp")
public suspend fun verify(`value`: Output) {
this.verify = value
}
/**
* @param value Specify the chart version to install. If this is not specified, the latest version is installed.
*/
@JvmName("jhsndffcngbwvgop")
public suspend fun version(`value`: Output) {
this.version = value
}
/**
* @param value Chart name to be installed. A path may be used.
*/
@JvmName("qbjypmtbkvfwlrjy")
public suspend fun chart(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.chart = mapped
}
/**
* @param value Run helm dependency update before installing the chart.
*/
@JvmName("bynkbupnwpuwofrk")
public suspend fun dependencyUpdate(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.dependencyUpdate = mapped
}
/**
* @param value Use chart development versions, too. Equivalent to version '>0.0.0-0'. If `version` is set, this is ignored.
*/
@JvmName("hpripgveatrsceaw")
public suspend fun devel(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.devel = mapped
}
/**
* @param value Location of public keys used for verification. Used only if `verify` is true
*/
@JvmName("xvcblytfcnvekawg")
public suspend fun keyring(`value`: AssetOrArchive?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.keyring = mapped
}
/**
* @param value Release name.
*/
@JvmName("pnrawadunwgfthoc")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
/**
* @param value Namespace for the release.
*/
@JvmName("cirutueybujytstd")
public suspend fun namespace(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.namespace = mapped
}
/**
* @param value Specification defining the post-renderer to use.
*/
@JvmName("kidjuauarjchvmph")
public suspend fun postRenderer(`value`: PostRendererArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.postRenderer = mapped
}
/**
* @param argument Specification defining the post-renderer to use.
*/
@JvmName("ulcxxisnpliaseoc")
public suspend fun postRenderer(argument: suspend PostRendererArgsBuilder.() -> Unit) {
val toBeMapped = PostRendererArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.postRenderer = mapped
}
/**
* @param value Specification defining the Helm chart repository to use.
*/
@JvmName("tupfseojkbfdinnb")
public suspend fun repositoryOpts(`value`: RepositoryOptsArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.repositoryOpts = mapped
}
/**
* @param argument Specification defining the Helm chart repository to use.
*/
@JvmName("cprqkehtoblqevam")
public suspend fun repositoryOpts(argument: suspend RepositoryOptsArgsBuilder.() -> Unit) {
val toBeMapped = RepositoryOptsArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.repositoryOpts = mapped
}
/**
* @param value An optional prefix for the auto-generated resource names. Example: A resource created with resourcePrefix="foo" would produce a resource named "foo:resourceName".
*/
@JvmName("sjbcjxlgsgckneoe")
public suspend fun resourcePrefix(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.resourcePrefix = mapped
}
/**
* @param value By default, the provider waits until all resources are in a ready state before marking the release as successful. Setting this to true will skip such await logic.
*/
@JvmName("oeiqnpboaxlnkkuv")
public suspend fun skipAwait(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.skipAwait = mapped
}
/**
* @param value If set, no CRDs will be installed. By default, CRDs are installed if not already present.
*/
@JvmName("jqaykluslbtlbnin")
public suspend fun skipCrds(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.skipCrds = mapped
}
/**
* @param value List of assets (raw yaml files). Content is read and merged with values.
*/
@JvmName("ixacvmxreiehpqww")
public suspend fun valueYamlFiles(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.valueYamlFiles = mapped
}
/**
* @param values List of assets (raw yaml files). Content is read and merged with values.
*/
@JvmName("yjlbehwjxargxyep")
public suspend fun valueYamlFiles(vararg values: AssetOrArchive) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.valueYamlFiles = mapped
}
/**
* @param value Custom values set for the release.
*/
@JvmName("hpmuqrrxsxcxnaie")
public suspend fun values(`value`: Map?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.values = mapped
}
/**
* @param values Custom values set for the release.
*/
@JvmName("hhoritupujxeiwpt")
public fun values(vararg values: Pair) {
val toBeMapped = values.toMap()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.values = mapped
}
/**
* @param value Verify the chart's integrity.
*/
@JvmName("feppwbdlqmxybvlf")
public suspend fun verify(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.verify = mapped
}
/**
* @param value Specify the chart version to install. If this is not specified, the latest version is installed.
*/
@JvmName("qotxaonueeculkvc")
public suspend fun version(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.version = mapped
}
internal fun build(): ChartArgs = ChartArgs(
chart = chart,
dependencyUpdate = dependencyUpdate,
devel = devel,
keyring = keyring,
name = name,
namespace = namespace,
postRenderer = postRenderer,
repositoryOpts = repositoryOpts,
resourcePrefix = resourcePrefix,
skipAwait = skipAwait,
skipCrds = skipCrds,
valueYamlFiles = valueYamlFiles,
values = values,
verify = verify,
version = version,
)
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy