REFERENCE.md

Reference

Table of Contents

Classes

Private Classes

• kubecm::deploy: Puppet entrypoint for the kubecm::deploy plan

Functions

Private Functions

• kubecm::print_report: Print apply results like a Puppet report

Plans

• kubecm::deploy: Install or upgrade a release

Plans

kubecm::deploy

Install or upgrade a release

Parameters

The following parameters are available in the kubecm::deploy plan:

• release
• chart
• chart_source
• deploy
• hooks
• namespace
• remove_resources
• remove_patches
• render_to
• repo_url
• version
• wait
• sleep
• subcharts
• parent
• build_dir

release

Data type: String

Installation name (what is this deployment called)

chart

Data type: String

Chart name, or your name for this deployment and set chart_source

Default value: $release

chart_source

Data type: Optional[String]

Typically repo_name/chart_name or an oci:// URI, but could be a local path, a valid Puppet file source, or undef for no chart (just Hiera resources).

Default value: undef

deploy

Data type: Boolean

Run or skip the deployment

Default value: true

hooks

Data type: Boolean

Enable or disable install hooks

Default value: true

namespace

Data type: Optional[String]

Kubernetes namespace to manage

Default value: undef

remove_resources

Data type: Array[String]

A list of keys to remove from the resources hash (i.e. don't deploy these!)

Default value: []

remove_patches

Data type: Array[String]

A list of keys to remove from the patches hash (i.e. don't apply these!)

Default value: []

render_to

Data type: Optional[String]

Just save the fully-rendered chart to this yaml file

Default value: undef

repo_url

Data type: Optional[String]

Optional URL of the Helm repo to add

Default value: undef

version

Data type: Optional[String]

Optional Helm chart version

Default value: undef

wait

Data type: Boolean

Wait for resources to become available

Default value: false

sleep

Data type: Optional[Numeric]

Wait additional time, in seconds (for example, for a VIP to propagate)

Default value: undef

subcharts

Data type: Array[Hash]

Additional charts to deploy as part of this one

Default value: []

parent

Data type: Optional[String]

Private. The parent release this one is being rendered for.

Default value: undef

build_dir

Data type: String

Scratch directory for compiling manifests

Default value: lookup('kubecm::deploy::build_dir')