helmfile

Documentation

Index

• Constants
• type Args
• type Cmd
• type ConfigRepo
  • func NewConfigRepo(options Options) *ConfigRepo
  • func (r *ConfigRepo) CleanOutputDirectoryIfEnabled() error
  • func (r *ConfigRepo) HelmUpdate() error
  • func (r *ConfigRepo) RenderForRelease(release gitops.Release, args *Args) error
  • func (r *ConfigRepo) RenderForTarget(target gitops.Target, args *Args) error
• type Options

Constants

const AppVersionEnvVar = "THF_APP_VERSION"

const ArgocdProjectEnvVar = "THF_ARGOCD_PROJECT"

const ChartPathEnvVar = "THF_CHART_PATH"

const ClusterAddressEnvVar = "THF_CLUSTER_ADDRESS"

const ClusterNameEnvVar = "THF_CLUSTER_NAME"

const NamespaceEnvVar = "THF_NAMESPACE"

const ProgName = "helmfile"

ProgName is the name of the `helmfile` binary

const ReleaseNameEnvVar = "THF_RELEASE_NAME"

const ReleaseTypeEnvVar = "THF_RELEASE_TYPE"

const TargetBaseEnvVar = "THF_TARGET_BASE"

const TargetNameEnvVar = "THF_TARGET_NAME"

const TargetTypeEnvVar = "THF_TARGET_TYPE"

Environment variables -- prefixed with THF for "terra-helmfile", used to pass in information to helmfile

Types

type Args

type Args struct {
	ChartVersion *string  // ChartVersion optionally override chart version
	AppVersion   *string  // AppVersion optionally override application version (container image)
	ValuesFiles  []string // ValuesFiles optional list of files for overriding chart values
	ArgocdMode   bool     // ArgocdMode if true, render ArgoCD manifests instead of application manifests
}

Args arguments for a helmfile render

type Cmd

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

Cmd encapsulates low-level parameters for a `helmfile` command

type ConfigRepo

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

ConfigRepo can be used to `helmfile` render commands on a clone of the `terra-helmfile` repo

func NewConfigRepo

func NewConfigRepo(options Options) *ConfigRepo

NewConfigRepo constructs a new ConfigRepo object

func (*ConfigRepo) CleanOutputDirectoryIfEnabled

func (r *ConfigRepo) CleanOutputDirectoryIfEnabled() error

CleanOutputDirectory cleans the output directory before rendering

func (*ConfigRepo) HelmUpdate

func (r *ConfigRepo) HelmUpdate() error

HelmUpdate updates Helm repo indexes.

func (*ConfigRepo) RenderForRelease

func (r *ConfigRepo) RenderForRelease(release gitops.Release, args *Args) error

func (*ConfigRepo) RenderForTarget

func (r *ConfigRepo) RenderForTarget(target gitops.Target, args *Args) error

type Options

type Options struct {
	ThelmaHome       string        // ThelmaHome to terra-helmfile repo clone
	ChartSourceDir   string        // ChartSourceDir path on filesystem containing chart sources
	ChartCacheDir    string        // ChartCacheDir path to shared chart cache directory that can be re-used across renders
	ResolverMode     resolver.Mode // Resolver mode
	HelmfileLogLevel string        // HelmfileLogLevel is the --log-level argument to pass to `helmfile` command
	Stdout           bool          // Stdout if true, render to stdout instead of output directory
	OutputDir        string        // Output directory where manifests should be rendered
	ScratchDir       string        // Scratch directory where temporary files should be written
	ShellRunner      shell.Runner  // ShellRunner shell Runner to use for executing helmfile commands
}

Options constructor arguments for a ConfigRepo