helm

Documentation

Overview

Package manifests contains the HelmGenerator implementation of the Generator interface.

Index

• func NewHelmGeneratorWithObjectTransformer(fsys fs.FS, chartPath string, clnt client.Client, ...) (manifests.TransformableGenerator, error)
• func NewHelmGeneratorWithParameterTransformer(fsys fs.FS, chartPath string, clnt client.Client, ...) (manifests.TransformableGenerator, error)
• func NewTransformableHelmGenerator(fsys fs.FS, chartPath string, clnt client.Client) (manifests.TransformableGenerator, error)
• type HelmGenerator
  • func NewHelmGenerator(fsys fs.FS, chartPath string, clnt client.Client) (*HelmGenerator, error)
  • func (g *HelmGenerator) Generate(ctx context.Context, namespace string, name string, ...) ([]client.Object, error)

Functions

func NewHelmGeneratorWithObjectTransformer

func NewHelmGeneratorWithObjectTransformer(fsys fs.FS, chartPath string, clnt client.Client, transformer manifests.ObjectTransformer) (manifests.TransformableGenerator, error)

Create a new HelmGenerator with an ObjectTransformer attached (further transformers can be attached to the returned generator object).

func NewHelmGeneratorWithParameterTransformer

func NewHelmGeneratorWithParameterTransformer(fsys fs.FS, chartPath string, clnt client.Client, transformer manifests.ParameterTransformer) (manifests.TransformableGenerator, error)

Create a new HelmGenerator with a ParameterTransformer attached (further transformers can be attached to the returned generator object).

func NewTransformableHelmGenerator

func NewTransformableHelmGenerator(fsys fs.FS, chartPath string, clnt client.Client) (manifests.TransformableGenerator, error)

Create a new HelmGenerator as TransformableGenerator.

Types

type HelmGenerator

type HelmGenerator struct {
	// contains filtered or unexported fields
}

HelmGenerator is a Generator implementation that basically renders a given Helm chart. A few restrictions apply to the provided Helm chart: it must not contain any subcharts, some template functions are not supported, some bultin variables are not supported, and hooks are processed in a slightly different fashion. Note: HelmGenerator's Generate() method expects client and reconciler name to be set in the passed context; see: Context.WithClient() and Context.WithReconcilerName() in package pkg/component.

func NewHelmGenerator

func NewHelmGenerator(fsys fs.FS, chartPath string, clnt client.Client) (*HelmGenerator, error)

Create a new HelmGenerator. The parameter client should be a client for the local cluster (i.e. the cluster where the component object resides); it is used by the localLookup and mustLocalLookup template functions. If fsys is nil, the local operating system filesystem will be used, and chartPath can be an absolute or relative path (in the latter case it will be considered relative to the current working directory). If fsys is non-nil, then chartPath should be a relative path; if an absolute path is supplied, it will be turned An empty chartPath will be treated like ".".

func (*HelmGenerator) Generate

func (g *HelmGenerator) Generate(ctx context.Context, namespace string, name string, parameters types.Unstructurable) ([]client.Object, error)

Generate resource descriptors.