@pulumiverse/cpln/getHelmTemplate.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";
/**
 * Renders Helm chart templates using the `cpln helm template` command without installing. Useful for previewing rendered manifests or feeding them into other resources.
 *
 * For more information about cpln helm, see the [Control Plane Helm Guide](https://docs.controlplane.com/guides/cpln-helm).
 *
 * > **Important** The `cpln` CLI and `helm` CLI must both be installed and available in the PATH for this data source to function.
 *
 * ## Declaration
 *
 * ### Required
 *
 * - **name** (String) The release name to use for rendering the templates.
 * - **chart** (String) Path to the chart. This can be a local path to a chart directory or packaged chart, or a chart name when used with `repository`.
 *
 * ### Optional
 *
 * - **gvc** (String) The GVC (Global Virtual Cloud) context for rendering the helm chart templates. Required only if the chart contains GVC-scoped resources and the GVC is not defined within the chart manifests.
 * - **repository** (String) Chart repository URL where to locate the requested chart. Can be a Helm repository URL or an OCI registry URL.
 * - **version** (String) 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.
 * - **values** (List of String) List of values in raw YAML to pass to the helm chart. Each entry is equivalent to a separate `--values/-f` flag. Values are merged in order, with later entries taking precedence.
 * - **set** (Map of String) Set values on the command line. Map of key-value pairs. Equivalent to using `--set` flag.
 * - **set_string** (Map of String) Set STRING values on the command line. Map of key-value pairs. Equivalent to using `--set-string` flag.
 * - **set_file** (Map of String) Set values from files specified via the command line. Map of key to file path. Equivalent to using `--set-file` flag.
 * - **dependency_update** (Boolean) Update dependencies if they are missing before rendering the chart.
 * - **description** (String) Add a custom description.
 * - **verify** (Boolean) Verify the package before using it.
 * - **repository_username** (String) Chart repository username where to locate the requested chart.
 * - **repository_password** (String, Sensitive) Chart repository password where to locate the requested chart.
 * - **repository_ca_file** (String) Verify certificates of HTTPS-enabled servers using this CA bundle.
 * - **repository_cert_file** (String) Identify HTTPS client using this SSL certificate file.
 * - **repository_key_file** (String) Identify HTTPS client using this SSL key file.
 * - **insecure_skip_tls_verify** (Boolean) Skip TLS certificate checks for the chart download.
 * - **render_subchart_notes** (Boolean) If set, render subchart notes along with the parent.
 * - **postrender** (Block) Post-renderer configuration:
 *   - **binary_path** (String, Required) The path to an executable to be used for post rendering.
 *   - **args** (List of String, Optional) Arguments to the post-renderer.
 *
 * ## Outputs
 *
 * The following attributes are exported:
 *
 * - **id** (String) The unique identifier for this data source (same as name).
 * - **manifest** (String) The rendered manifest output from helm template.
 *
 * ## Example Usage
 */
export declare function getHelmTemplate(args: GetHelmTemplateArgs, opts?: pulumi.InvokeOptions): Promise<GetHelmTemplateResult>;
/**
 * A collection of arguments for invoking getHelmTemplate.
 */
export interface GetHelmTemplateArgs {
    chart: string;
    dependencyUpdate?: boolean;
    description?: string;
    gvc?: string;
    insecureSkipTlsVerify?: boolean;
    name: string;
    postrender?: inputs.GetHelmTemplatePostrender;
    renderSubchartNotes?: boolean;
    repository?: string;
    repositoryCaFile?: string;
    repositoryCertFile?: string;
    repositoryKeyFile?: string;
    repositoryPassword?: string;
    repositoryUsername?: string;
    set?: {
        [key: string]: string;
    };
    setFile?: {
        [key: string]: string;
    };
    setString?: {
        [key: string]: string;
    };
    values?: string[];
    verify?: boolean;
    version?: string;
}
/**
 * A collection of values returned by getHelmTemplate.
 */
export interface GetHelmTemplateResult {
    readonly chart: string;
    readonly dependencyUpdate?: boolean;
    readonly description?: string;
    readonly gvc?: string;
    readonly id: string;
    readonly insecureSkipTlsVerify?: boolean;
    readonly manifest: string;
    readonly name: string;
    readonly postrender?: outputs.GetHelmTemplatePostrender;
    readonly renderSubchartNotes?: boolean;
    readonly repository?: string;
    readonly repositoryCaFile?: string;
    readonly repositoryCertFile?: string;
    readonly repositoryKeyFile?: string;
    readonly repositoryPassword?: string;
    readonly repositoryUsername?: string;
    readonly set?: {
        [key: string]: string;
    };
    readonly setFile?: {
        [key: string]: string;
    };
    readonly setString?: {
        [key: string]: string;
    };
    readonly values?: string[];
    readonly verify?: boolean;
    readonly version?: string;
}
/**
 * Renders Helm chart templates using the `cpln helm template` command without installing. Useful for previewing rendered manifests or feeding them into other resources.
 *
 * For more information about cpln helm, see the [Control Plane Helm Guide](https://docs.controlplane.com/guides/cpln-helm).
 *
 * > **Important** The `cpln` CLI and `helm` CLI must both be installed and available in the PATH for this data source to function.
 *
 * ## Declaration
 *
 * ### Required
 *
 * - **name** (String) The release name to use for rendering the templates.
 * - **chart** (String) Path to the chart. This can be a local path to a chart directory or packaged chart, or a chart name when used with `repository`.
 *
 * ### Optional
 *
 * - **gvc** (String) The GVC (Global Virtual Cloud) context for rendering the helm chart templates. Required only if the chart contains GVC-scoped resources and the GVC is not defined within the chart manifests.
 * - **repository** (String) Chart repository URL where to locate the requested chart. Can be a Helm repository URL or an OCI registry URL.
 * - **version** (String) 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.
 * - **values** (List of String) List of values in raw YAML to pass to the helm chart. Each entry is equivalent to a separate `--values/-f` flag. Values are merged in order, with later entries taking precedence.
 * - **set** (Map of String) Set values on the command line. Map of key-value pairs. Equivalent to using `--set` flag.
 * - **set_string** (Map of String) Set STRING values on the command line. Map of key-value pairs. Equivalent to using `--set-string` flag.
 * - **set_file** (Map of String) Set values from files specified via the command line. Map of key to file path. Equivalent to using `--set-file` flag.
 * - **dependency_update** (Boolean) Update dependencies if they are missing before rendering the chart.
 * - **description** (String) Add a custom description.
 * - **verify** (Boolean) Verify the package before using it.
 * - **repository_username** (String) Chart repository username where to locate the requested chart.
 * - **repository_password** (String, Sensitive) Chart repository password where to locate the requested chart.
 * - **repository_ca_file** (String) Verify certificates of HTTPS-enabled servers using this CA bundle.
 * - **repository_cert_file** (String) Identify HTTPS client using this SSL certificate file.
 * - **repository_key_file** (String) Identify HTTPS client using this SSL key file.
 * - **insecure_skip_tls_verify** (Boolean) Skip TLS certificate checks for the chart download.
 * - **render_subchart_notes** (Boolean) If set, render subchart notes along with the parent.
 * - **postrender** (Block) Post-renderer configuration:
 *   - **binary_path** (String, Required) The path to an executable to be used for post rendering.
 *   - **args** (List of String, Optional) Arguments to the post-renderer.
 *
 * ## Outputs
 *
 * The following attributes are exported:
 *
 * - **id** (String) The unique identifier for this data source (same as name).
 * - **manifest** (String) The rendered manifest output from helm template.
 *
 * ## Example Usage
 */
export declare function getHelmTemplateOutput(args: GetHelmTemplateOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetHelmTemplateResult>;
/**
 * A collection of arguments for invoking getHelmTemplate.
 */
export interface GetHelmTemplateOutputArgs {
    chart: pulumi.Input<string>;
    dependencyUpdate?: pulumi.Input<boolean>;
    description?: pulumi.Input<string>;
    gvc?: pulumi.Input<string>;
    insecureSkipTlsVerify?: pulumi.Input<boolean>;
    name: pulumi.Input<string>;
    postrender?: pulumi.Input<inputs.GetHelmTemplatePostrenderArgs>;
    renderSubchartNotes?: pulumi.Input<boolean>;
    repository?: pulumi.Input<string>;
    repositoryCaFile?: pulumi.Input<string>;
    repositoryCertFile?: pulumi.Input<string>;
    repositoryKeyFile?: pulumi.Input<string>;
    repositoryPassword?: pulumi.Input<string>;
    repositoryUsername?: pulumi.Input<string>;
    set?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    setFile?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    setString?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    values?: pulumi.Input<pulumi.Input<string>[]>;
    verify?: pulumi.Input<boolean>;
    version?: pulumi.Input<string>;
}