helm

Documentation

Index

• func Render(ctx context.Context, releaseName string, namespace string, chartPath string, ...) ([]byte, error)
• type Config
  • func (c Config) Expand(values []string) Config

Functions

func Render

func Render(
	ctx context.Context,
	releaseName string,
	namespace string,
	chartPath string,
	valuesPaths []string,
) ([]byte, error)

Render delegates, in-process to the Argo CD repo server to render plain YAML manifests from a Helm chart.

Types

type Config

type Config struct {
	// ReleaseName specifies the release name that will be used when executing the
	// `helm template` command.
	ReleaseName string `json:"releaseName,omitempty"`
	// ChartPath is a path to a directory, relative to the root of the repository,
	// where a Helm chart can be located. This is used as an argument in the
	// `helm template` command. By convention, if left unspecified, the value
	// `base/` is assumed.
	ChartPath string `json:"chartPath,omitempty"`
	// Values are paths to Helm values files (e.g. values.yaml), relative to the
	// root of the repository. Each of these will be used as a value for the
	// `--values` flag in the `helm template` command. By convention, if left
	// unspecified, one path will be assumed: <branch name>/values.yaml.
	ValuesPaths []string `json:"valuesPaths,omitempty"`
	// Namespace is the Kubernetes namespace in which the Helm chart will be
	// rendered. This is used as an argument in the `helm template` command. By
	// convention, if left unspecified, the value `default` is assumed.
	Namespace string `json:"namespace,omitempty"`
}

Config encapsulates optional Helm configuration options.

func (Config) Expand

func (c Config) Expand(values []string) Config

Expand expands all file/directory paths referenced by this configuration object, replacing placeholders of the form ${n} where n is a non-negative integer, with corresponding values from the provided string array. The modified object is returned.