published on Friday, Mar 20, 2026 by pulumiverse
published on Friday, Mar 20, 2026 by pulumiverse
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.
Important The
cplnCLI andhelmCLI 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/-fflag. 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
--setflag. - set_string (Map of String) Set STRING values on the command line. Map of key-value pairs. Equivalent to using
--set-stringflag. - set_file (Map of String) Set values from files specified via the command line. Map of key to file path. Equivalent to using
--set-fileflag. - 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
Using getHelmTemplate
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getHelmTemplate(args: GetHelmTemplateArgs, opts?: InvokeOptions): Promise<GetHelmTemplateResult>
function getHelmTemplateOutput(args: GetHelmTemplateOutputArgs, opts?: InvokeOptions): Output<GetHelmTemplateResult>def get_helm_template(chart: Optional[str] = None,
dependency_update: Optional[bool] = None,
description: Optional[str] = None,
gvc: Optional[str] = None,
insecure_skip_tls_verify: Optional[bool] = None,
name: Optional[str] = None,
postrender: Optional[GetHelmTemplatePostrender] = None,
render_subchart_notes: Optional[bool] = None,
repository: Optional[str] = None,
repository_ca_file: Optional[str] = None,
repository_cert_file: Optional[str] = None,
repository_key_file: Optional[str] = None,
repository_password: Optional[str] = None,
repository_username: Optional[str] = None,
set: Optional[Mapping[str, str]] = None,
set_file: Optional[Mapping[str, str]] = None,
set_string: Optional[Mapping[str, str]] = None,
values: Optional[Sequence[str]] = None,
verify: Optional[bool] = None,
version: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetHelmTemplateResult
def get_helm_template_output(chart: Optional[pulumi.Input[str]] = None,
dependency_update: Optional[pulumi.Input[bool]] = None,
description: Optional[pulumi.Input[str]] = None,
gvc: Optional[pulumi.Input[str]] = None,
insecure_skip_tls_verify: Optional[pulumi.Input[bool]] = None,
name: Optional[pulumi.Input[str]] = None,
postrender: Optional[pulumi.Input[GetHelmTemplatePostrenderArgs]] = None,
render_subchart_notes: Optional[pulumi.Input[bool]] = None,
repository: Optional[pulumi.Input[str]] = None,
repository_ca_file: Optional[pulumi.Input[str]] = None,
repository_cert_file: Optional[pulumi.Input[str]] = None,
repository_key_file: Optional[pulumi.Input[str]] = None,
repository_password: Optional[pulumi.Input[str]] = None,
repository_username: Optional[pulumi.Input[str]] = None,
set: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
set_file: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
set_string: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
values: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
verify: Optional[pulumi.Input[bool]] = None,
version: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetHelmTemplateResult]func GetHelmTemplate(ctx *Context, args *GetHelmTemplateArgs, opts ...InvokeOption) (*GetHelmTemplateResult, error)
func GetHelmTemplateOutput(ctx *Context, args *GetHelmTemplateOutputArgs, opts ...InvokeOption) GetHelmTemplateResultOutput> Note: This function is named GetHelmTemplate in the Go SDK.
public static class GetHelmTemplate
{
public static Task<GetHelmTemplateResult> InvokeAsync(GetHelmTemplateArgs args, InvokeOptions? opts = null)
public static Output<GetHelmTemplateResult> Invoke(GetHelmTemplateInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetHelmTemplateResult> getHelmTemplate(GetHelmTemplateArgs args, InvokeOptions options)
public static Output<GetHelmTemplateResult> getHelmTemplate(GetHelmTemplateArgs args, InvokeOptions options)
fn::invoke:
function: cpln:index/getHelmTemplate:getHelmTemplate
arguments:
# arguments dictionaryThe following arguments are supported:
- Chart string
- Name string
- Dependency
Update bool - Description string
- Gvc string
- Insecure
Skip boolTls Verify - Postrender
Pulumiverse.
Cpln. Inputs. Get Helm Template Postrender - Render
Subchart boolNotes - Repository string
- Repository
Ca stringFile - Repository
Cert stringFile - Repository
Key stringFile - Repository
Password string - Repository
Username string - Set Dictionary<string, string>
- Set
File Dictionary<string, string> - Set
String Dictionary<string, string> - Values List<string>
- Verify bool
- Version string
- Chart string
- Name string
- Dependency
Update bool - Description string
- Gvc string
- Insecure
Skip boolTls Verify - Postrender
Get
Helm Template Postrender - Render
Subchart boolNotes - Repository string
- Repository
Ca stringFile - Repository
Cert stringFile - Repository
Key stringFile - Repository
Password string - Repository
Username string - Set map[string]string
- Set
File map[string]string - Set
String map[string]string - Values []string
- Verify bool
- Version string
- chart String
- name String
- dependency
Update Boolean - description String
- gvc String
- insecure
Skip BooleanTls Verify - postrender
Get
Helm Template Postrender - render
Subchart BooleanNotes - repository String
- repository
Ca StringFile - repository
Cert StringFile - repository
Key StringFile - repository
Password String - repository
Username String - set Map<String,String>
- set
File Map<String,String> - set
String Map<String,String> - values List<String>
- verify Boolean
- version String
- chart string
- name string
- dependency
Update boolean - description string
- gvc string
- insecure
Skip booleanTls Verify - postrender
Get
Helm Template Postrender - render
Subchart booleanNotes - repository string
- repository
Ca stringFile - repository
Cert stringFile - repository
Key stringFile - repository
Password string - repository
Username string - set {[key: string]: string}
- set
File {[key: string]: string} - set
String {[key: string]: string} - values string[]
- verify boolean
- version string
- chart str
- name str
- dependency_
update bool - description str
- gvc str
- insecure_
skip_ booltls_ verify - postrender
Get
Helm Template Postrender - render_
subchart_ boolnotes - repository str
- repository_
ca_ strfile - repository_
cert_ strfile - repository_
key_ strfile - repository_
password str - repository_
username str - set Mapping[str, str]
- set_
file Mapping[str, str] - set_
string Mapping[str, str] - values Sequence[str]
- verify bool
- version str
- chart String
- name String
- dependency
Update Boolean - description String
- gvc String
- insecure
Skip BooleanTls Verify - postrender Property Map
- render
Subchart BooleanNotes - repository String
- repository
Ca StringFile - repository
Cert StringFile - repository
Key StringFile - repository
Password String - repository
Username String - set Map<String>
- set
File Map<String> - set
String Map<String> - values List<String>
- verify Boolean
- version String
getHelmTemplate Result
The following output properties are available:
- Chart string
- Id string
- Manifest string
- Name string
- Dependency
Update bool - Description string
- Gvc string
- Insecure
Skip boolTls Verify - Postrender
Pulumiverse.
Cpln. Outputs. Get Helm Template Postrender - Render
Subchart boolNotes - Repository string
- Repository
Ca stringFile - Repository
Cert stringFile - Repository
Key stringFile - Repository
Password string - Repository
Username string - Set Dictionary<string, string>
- Set
File Dictionary<string, string> - Set
String Dictionary<string, string> - Values List<string>
- Verify bool
- Version string
- Chart string
- Id string
- Manifest string
- Name string
- Dependency
Update bool - Description string
- Gvc string
- Insecure
Skip boolTls Verify - Postrender
Get
Helm Template Postrender - Render
Subchart boolNotes - Repository string
- Repository
Ca stringFile - Repository
Cert stringFile - Repository
Key stringFile - Repository
Password string - Repository
Username string - Set map[string]string
- Set
File map[string]string - Set
String map[string]string - Values []string
- Verify bool
- Version string
- chart String
- id String
- manifest String
- name String
- dependency
Update Boolean - description String
- gvc String
- insecure
Skip BooleanTls Verify - postrender
Get
Helm Template Postrender - render
Subchart BooleanNotes - repository String
- repository
Ca StringFile - repository
Cert StringFile - repository
Key StringFile - repository
Password String - repository
Username String - set Map<String,String>
- set
File Map<String,String> - set
String Map<String,String> - values List<String>
- verify Boolean
- version String
- chart string
- id string
- manifest string
- name string
- dependency
Update boolean - description string
- gvc string
- insecure
Skip booleanTls Verify - postrender
Get
Helm Template Postrender - render
Subchart booleanNotes - repository string
- repository
Ca stringFile - repository
Cert stringFile - repository
Key stringFile - repository
Password string - repository
Username string - set {[key: string]: string}
- set
File {[key: string]: string} - set
String {[key: string]: string} - values string[]
- verify boolean
- version string
- chart str
- id str
- manifest str
- name str
- dependency_
update bool - description str
- gvc str
- insecure_
skip_ booltls_ verify - postrender
Get
Helm Template Postrender - render_
subchart_ boolnotes - repository str
- repository_
ca_ strfile - repository_
cert_ strfile - repository_
key_ strfile - repository_
password str - repository_
username str - set Mapping[str, str]
- set_
file Mapping[str, str] - set_
string Mapping[str, str] - values Sequence[str]
- verify bool
- version str
- chart String
- id String
- manifest String
- name String
- dependency
Update Boolean - description String
- gvc String
- insecure
Skip BooleanTls Verify - postrender Property Map
- render
Subchart BooleanNotes - repository String
- repository
Ca StringFile - repository
Cert StringFile - repository
Key StringFile - repository
Password String - repository
Username String - set Map<String>
- set
File Map<String> - set
String Map<String> - values List<String>
- verify Boolean
- version String
Supporting Types
GetHelmTemplatePostrender
- Binary
Path string - The path to an executable to be used for post rendering.
- Args List<string>
- Arguments to the post-renderer.
- Binary
Path string - The path to an executable to be used for post rendering.
- Args []string
- Arguments to the post-renderer.
- binary
Path String - The path to an executable to be used for post rendering.
- args List<String>
- Arguments to the post-renderer.
- binary
Path string - The path to an executable to be used for post rendering.
- args string[]
- Arguments to the post-renderer.
- binary_
path str - The path to an executable to be used for post rendering.
- args Sequence[str]
- Arguments to the post-renderer.
- binary
Path String - The path to an executable to be used for post rendering.
- args List<String>
- Arguments to the post-renderer.
Package Details
- Repository
- cpln pulumiverse/pulumi-cpln
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
cplnTerraform Provider.
published on Friday, Mar 20, 2026 by pulumiverse
