@pulumiverse/cpln/helmRelease.d.ts

A Pulumi package for creating and managing Control Plane (cpln) resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
export declare class HelmRelease extends pulumi.CustomResource {
    /**
     * Get an existing HelmRelease resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: HelmReleaseState, opts?: pulumi.CustomResourceOptions): HelmRelease;
    /**
     * Returns true if the given object is an instance of HelmRelease.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is HelmRelease;
    /**
     * Path to the chart. This can be a local path to a chart directory or packaged chart, or a URL/path when used with --repo.
     */
    readonly chart: pulumi.Output<string>;
    /**
     * Update dependencies if they are missing before installing the chart.
     */
    readonly dependencyUpdate: pulumi.Output<boolean>;
    /**
     * Add a custom description for the release.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * The GVC (Global Virtual Cloud) to use for the helm deployment. Required only if the chart deploys GVC-scoped resources and the GVC is not defined within the chart manifests.
     */
    readonly gvc: pulumi.Output<string | undefined>;
    /**
     * Skip TLS certificate checks for the chart download.
     */
    readonly insecureSkipTlsVerify: pulumi.Output<boolean>;
    /**
     * The rendered manifest of the helm release.
     */
    readonly manifest: pulumi.Output<string>;
    /**
     * Maximum number of revisions saved per release. Use 0 for no limit. Default is 10. Only used on upgrade.
     */
    readonly maxHistory: pulumi.Output<number>;
    /**
     * The release name for this helm deployment.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Post-renderer configuration. Specifies a binary to run after helm renders the manifests.
     */
    readonly postrender: pulumi.Output<outputs.HelmReleasePostrender | undefined>;
    /**
     * If set, render subchart notes along with the parent on install/upgrade.
     */
    readonly renderSubchartNotes: pulumi.Output<boolean>;
    /**
     * Chart repository URL where to locate the requested chart. Can be a Helm repository URL or an OCI registry URL.
     */
    readonly repository: pulumi.Output<string | undefined>;
    /**
     * Verify certificates of HTTPS-enabled servers using this CA bundle.
     */
    readonly repositoryCaFile: pulumi.Output<string | undefined>;
    /**
     * Identify HTTPS client using this SSL certificate file.
     */
    readonly repositoryCertFile: pulumi.Output<string | undefined>;
    /**
     * Identify HTTPS client using this SSL key file.
     */
    readonly repositoryKeyFile: pulumi.Output<string | undefined>;
    /**
     * Chart repository password where to locate the requested chart.
     */
    readonly repositoryPassword: pulumi.Output<string | undefined>;
    /**
     * Chart repository username where to locate the requested chart.
     */
    readonly repositoryUsername: pulumi.Output<string | undefined>;
    /**
     * Rendered manifests keyed by kind/gvc/name (e.g., workload/my-gvc/my-workload). GVC may be empty for GVC-level resources.
     */
    readonly resources: pulumi.Output<{
        [key: string]: string;
    }>;
    /**
     * The current revision number of the helm release.
     */
    readonly revision: pulumi.Output<number>;
    /**
     * Set values on the command line. Map of key-value pairs. Equivalent to using --set flag.
     */
    readonly set: pulumi.Output<{
        [key: string]: string;
    } | undefined>;
    /**
     * Set values from files specified via the command line. Map of key to file path. Equivalent to using --set-file flag.
     */
    readonly setFile: pulumi.Output<{
        [key: string]: string;
    } | undefined>;
    /**
     * Set STRING values on the command line. Map of key-value pairs. Equivalent to using --set-string flag.
     */
    readonly setString: pulumi.Output<{
        [key: string]: string;
    } | undefined>;
    /**
     * The current status of the helm release.
     */
    readonly status: pulumi.Output<string>;
    /**
     * The amount of seconds to wait for workloads to be ready before timing out. Only used when wait is true. Default is 300 seconds.
     */
    readonly timeout: pulumi.Output<number>;
    /**
     * List of values in raw YAML to pass to helm.
     */
    readonly values: pulumi.Output<string[] | undefined>;
    /**
     * Verify the package before using it.
     */
    readonly verify: pulumi.Output<boolean>;
    /**
     * Specify a version constraint for the chart version to use. This can be a specific tag (e.g., 1.1.1) or a valid range (e.g., ^2.0.0). If not specified, the latest version is used.
     */
    readonly version: pulumi.Output<string | undefined>;
    /**
     * If set to true, will wait until all Workloads are in a ready state before marking the release as successful.
     */
    readonly wait: pulumi.Output<boolean>;
    /**
     * Create a HelmRelease resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: HelmReleaseArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering HelmRelease resources.
 */
export interface HelmReleaseState {
    /**
     * Path to the chart. This can be a local path to a chart directory or packaged chart, or a URL/path when used with --repo.
     */
    chart?: pulumi.Input<string>;
    /**
     * Update dependencies if they are missing before installing the chart.
     */
    dependencyUpdate?: pulumi.Input<boolean>;
    /**
     * Add a custom description for the release.
     */
    description?: pulumi.Input<string>;
    /**
     * The GVC (Global Virtual Cloud) to use for the helm deployment. Required only if the chart deploys GVC-scoped resources and the GVC is not defined within the chart manifests.
     */
    gvc?: pulumi.Input<string>;
    /**
     * Skip TLS certificate checks for the chart download.
     */
    insecureSkipTlsVerify?: pulumi.Input<boolean>;
    /**
     * The rendered manifest of the helm release.
     */
    manifest?: pulumi.Input<string>;
    /**
     * Maximum number of revisions saved per release. Use 0 for no limit. Default is 10. Only used on upgrade.
     */
    maxHistory?: pulumi.Input<number>;
    /**
     * The release name for this helm deployment.
     */
    name?: pulumi.Input<string>;
    /**
     * Post-renderer configuration. Specifies a binary to run after helm renders the manifests.
     */
    postrender?: pulumi.Input<inputs.HelmReleasePostrender>;
    /**
     * If set, render subchart notes along with the parent on install/upgrade.
     */
    renderSubchartNotes?: pulumi.Input<boolean>;
    /**
     * Chart repository URL where to locate the requested chart. Can be a Helm repository URL or an OCI registry URL.
     */
    repository?: pulumi.Input<string>;
    /**
     * Verify certificates of HTTPS-enabled servers using this CA bundle.
     */
    repositoryCaFile?: pulumi.Input<string>;
    /**
     * Identify HTTPS client using this SSL certificate file.
     */
    repositoryCertFile?: pulumi.Input<string>;
    /**
     * Identify HTTPS client using this SSL key file.
     */
    repositoryKeyFile?: pulumi.Input<string>;
    /**
     * Chart repository password where to locate the requested chart.
     */
    repositoryPassword?: pulumi.Input<string>;
    /**
     * Chart repository username where to locate the requested chart.
     */
    repositoryUsername?: pulumi.Input<string>;
    /**
     * Rendered manifests keyed by kind/gvc/name (e.g., workload/my-gvc/my-workload). GVC may be empty for GVC-level resources.
     */
    resources?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * The current revision number of the helm release.
     */
    revision?: pulumi.Input<number>;
    /**
     * Set values on the command line. Map of key-value pairs. Equivalent to using --set flag.
     */
    set?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * Set values from files specified via the command line. Map of key to file path. Equivalent to using --set-file flag.
     */
    setFile?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * Set STRING values on the command line. Map of key-value pairs. Equivalent to using --set-string flag.
     */
    setString?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * The current status of the helm release.
     */
    status?: pulumi.Input<string>;
    /**
     * The amount of seconds to wait for workloads to be ready before timing out. Only used when wait is true. Default is 300 seconds.
     */
    timeout?: pulumi.Input<number>;
    /**
     * List of values in raw YAML to pass to helm.
     */
    values?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Verify the package before using it.
     */
    verify?: pulumi.Input<boolean>;
    /**
     * Specify a version constraint for the chart version to use. This can be a specific tag (e.g., 1.1.1) or a valid range (e.g., ^2.0.0). If not specified, the latest version is used.
     */
    version?: pulumi.Input<string>;
    /**
     * If set to true, will wait until all Workloads are in a ready state before marking the release as successful.
     */
    wait?: pulumi.Input<boolean>;
}
/**
 * The set of arguments for constructing a HelmRelease resource.
 */
export interface HelmReleaseArgs {
    /**
     * Path to the chart. This can be a local path to a chart directory or packaged chart, or a URL/path when used with --repo.
     */
    chart: pulumi.Input<string>;
    /**
     * Update dependencies if they are missing before installing the chart.
     */
    dependencyUpdate?: pulumi.Input<boolean>;
    /**
     * Add a custom description for the release.
     */
    description?: pulumi.Input<string>;
    /**
     * The GVC (Global Virtual Cloud) to use for the helm deployment. Required only if the chart deploys GVC-scoped resources and the GVC is not defined within the chart manifests.
     */
    gvc?: pulumi.Input<string>;
    /**
     * Skip TLS certificate checks for the chart download.
     */
    insecureSkipTlsVerify?: pulumi.Input<boolean>;
    /**
     * Maximum number of revisions saved per release. Use 0 for no limit. Default is 10. Only used on upgrade.
     */
    maxHistory?: pulumi.Input<number>;
    /**
     * The release name for this helm deployment.
     */
    name?: pulumi.Input<string>;
    /**
     * Post-renderer configuration. Specifies a binary to run after helm renders the manifests.
     */
    postrender?: pulumi.Input<inputs.HelmReleasePostrender>;
    /**
     * If set, render subchart notes along with the parent on install/upgrade.
     */
    renderSubchartNotes?: pulumi.Input<boolean>;
    /**
     * Chart repository URL where to locate the requested chart. Can be a Helm repository URL or an OCI registry URL.
     */
    repository?: pulumi.Input<string>;
    /**
     * Verify certificates of HTTPS-enabled servers using this CA bundle.
     */
    repositoryCaFile?: pulumi.Input<string>;
    /**
     * Identify HTTPS client using this SSL certificate file.
     */
    repositoryCertFile?: pulumi.Input<string>;
    /**
     * Identify HTTPS client using this SSL key file.
     */
    repositoryKeyFile?: pulumi.Input<string>;
    /**
     * Chart repository password where to locate the requested chart.
     */
    repositoryPassword?: pulumi.Input<string>;
    /**
     * Chart repository username where to locate the requested chart.
     */
    repositoryUsername?: pulumi.Input<string>;
    /**
     * Set values on the command line. Map of key-value pairs. Equivalent to using --set flag.
     */
    set?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * Set values from files specified via the command line. Map of key to file path. Equivalent to using --set-file flag.
     */
    setFile?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * Set STRING values on the command line. Map of key-value pairs. Equivalent to using --set-string flag.
     */
    setString?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * The amount of seconds to wait for workloads to be ready before timing out. Only used when wait is true. Default is 300 seconds.
     */
    timeout?: pulumi.Input<number>;
    /**
     * List of values in raw YAML to pass to helm.
     */
    values?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Verify the package before using it.
     */
    verify?: pulumi.Input<boolean>;
    /**
     * Specify a version constraint for the chart version to use. This can be a specific tag (e.g., 1.1.1) or a valid range (e.g., ^2.0.0). If not specified, the latest version is used.
     */
    version?: pulumi.Input<string>;
    /**
     * If set to true, will wait until all Workloads are in a ready state before marking the release as successful.
     */
    wait?: pulumi.Input<boolean>;
}