Skip to main content

Interface: ChartOptions#

@kosko/helm.ChartOptions

Hierarchy#

  • LoadOptions

    ChartOptions

Properties#

apiVersions#

Optional apiVersions: string[]

Kubernetes API versions used for Capabilities.APIVersions.

Defined in: packages/helm/src/load.ts:47


caFile#

Optional caFile: string

Verify certificates of HTTPS-enabled servers using this CA bundle.

Defined in: packages/helm/src/load.ts:52


certFile#

Optional certFile: string

Identify HTTPS client using this SSL certificate file.

Defined in: packages/helm/src/load.ts:57


chart#

chart: string

The path of a local chart or the name of a remote chart.

Defined in: packages/helm/src/load.ts:37


dependencyUpdate#

Optional dependencyUpdate: boolean

Run helm dependency update before installing the chart.

Defined in: packages/helm/src/load.ts:62


description#

Optional description: string

Add a custom description.

Defined in: packages/helm/src/load.ts:67


devel#

Optional devel: boolean

Use development versions, too. Equivalent to version '>0.0.0-0'. If version is set, this is ignored.

Defined in: packages/helm/src/load.ts:72


generateName#

Optional generateName: boolean

Generate the name (and omit the name parameter).

Defined in: packages/helm/src/load.ts:77


keyFile#

Optional keyFile: string

Identify HTTPS client using this SSL key file.

Defined in: packages/helm/src/load.ts:82


keyring#

Optional keyring: string

Location of public keys used for verification (default ~/.gnupg/pubring.gpg).

Defined in: packages/helm/src/load.ts:87


name#

Optional name: string

Name of the release.

Defined in: packages/helm/src/load.ts:42


nameTemplate#

Optional nameTemplate: string

Specify template used to name the release.

Defined in: packages/helm/src/load.ts:92


namespace#

Optional namespace: string

Namespace scope for this request.

Defined in: packages/helm/src/load.ts:97


noHooks#

Optional noHooks: boolean

Prevent hooks from running during install.

Defined in: packages/helm/src/load.ts:102


password#

Optional password: string

Chart repository password where to locate the requested chart.

Defined in: packages/helm/src/load.ts:107


repo#

Optional repo: string

Chart repository url where to locate the requested chart.

Defined in: packages/helm/src/load.ts:112


skipCrds#

Optional skipCrds: boolean

If set, no CRDs will be installed. By default, CRDs are installed if not already present.

Defined in: packages/helm/src/load.ts:117


skipTests#

Optional skipTests: boolean

Skip tests from templated output.

Defined in: packages/helm/src/load.ts:122


timeout#

Optional timeout: string

Time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)

Defined in: packages/helm/src/load.ts:127


username#

Optional username: string

Chart repository username where to locate the requested chart.

Defined in: packages/helm/src/load.ts:132


values#

Optional values: any

Specify values.

Defined in: packages/helm/src/load.ts:137


verify#

Optional verify: boolean

Verify the package before using it.

Defined in: packages/helm/src/load.ts:142


version#

Optional version: string

Specify the exact chart version to use. If this is not specified, the latest version is used.

Defined in: packages/helm/src/load.ts:147

Methods#

transform#

Optionaltransform(manifest: Manifest): undefined | null | Manifest

Parameters:#

NameType
manifestManifest

Returns: undefined | null | Manifest

Defined in: packages/yaml/dist/load.d.ts:7