Documentation
¶
Overview ¶
Package features contains all of the parameters that can configure lovely
Index ¶
- func Features() map[FeatureID]Feature
- func GetDetectionRegex() string
- func GetEnvPropagation() bool
- func GetHelmCRDs() bool
- func GetHelmMerge() string
- func GetHelmName() string
- func GetHelmNamespace() string
- func GetHelmPatch() string
- func GetHelmPath() string
- func GetHelmRepoAddParams() ([]string, error)
- func GetHelmTemplateParams() ([]string, error)
- func GetHelmValues() ([]string, error)
- func GetHelmValuesSet() bool
- func GetHelmfileCRDs() bool
- func GetHelmfileMerge() string
- func GetHelmfilePatch() string
- func GetHelmfilePath() string
- func GetHelmfileTemplateParams() ([]string, error)
- func GetKustomizeMerge() string
- func GetKustomizeParams() ([]string, error)
- func GetKustomizePatch() string
- func GetKustomizePath() string
- func GetPlugins(path string) ([]string, error)
- func GetPreprocessors(path string) ([]string, error)
- type Feature
- type FeatureID
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetDetectionRegex ¶
func GetDetectionRegex() string
GetDetectionRegex returns the regex used to detect applications Set LOVELY_DETECTION_REGEX to the regex to detect applications
func GetEnvPropagation ¶
func GetEnvPropagation() bool
GetEnvPropagation returns extra parameters to pass to processor stage Set LOVELY_ENV_PROPAGATION to activate env propagation
func GetHelmCRDs ¶
func GetHelmCRDs() bool
GetHelmCRDs returns whether to explicitly tell helm to include or skip CRDS Set LOVELY_HELM_CRDS to configure this
func GetHelmMerge ¶
func GetHelmMerge() string
GetHelmMerge returns the yaml to strategic merge into values.yaml Set LOVELY_HELM_MERGE to some yaml you'd like strategic merged into any values.yaml files used by helm
func GetHelmName ¶
func GetHelmName() string
GetHelmName gives us the application name for helm Set LOVELY_HELM_NAME to override the default of ARGOCD_APP_NAME
func GetHelmNamespace ¶
func GetHelmNamespace() string
GetHelmNamespace gives us the namespace for helm
func GetHelmPatch ¶
func GetHelmPatch() string
GetHelmPatch returns the yaml to json6902 patch into values.yaml Set LOVELY_HELM_PATCH to some yaml you'd like json6902 patched into any values.yaml files used by helm
func GetHelmPath ¶
func GetHelmPath() string
GetHelmPath returns the path to helm if overridden, otherwise we search the path Set LOVELY_HELM_PATH to the path to the helm binary
func GetHelmRepoAddParams ¶
GetHelmRepoAddParams returns extra parameters to pass to helm repo add Set LOVELY_HELM_REPO_ADD_PARAMS to extra parameters to pass to helm template
func GetHelmTemplateParams ¶
GetHelmTemplateParams returns extra parameters to pass to helm template Set LOVELY_HELM_TEMPLATE_PARAMS to extra parameters to pass to helm template
func GetHelmValues ¶
GetHelmValues gives us the values file we're going to use for helm Set LOVELY_HELM_VALUES to the path to use for the values file
func GetHelmValuesSet ¶
func GetHelmValuesSet() bool
GetHelmValuesSet returns true if HelmValues() is explicily set
func GetHelmfileCRDs ¶
func GetHelmfileCRDs() bool
GetHelmfileCRDs returns whether to explicitly tell helm to include or skip CRDS Set LOVELY_HELM_CRDS to configure this
func GetHelmfileMerge ¶
func GetHelmfileMerge() string
GetHelmfileMerge returns the yaml to strategic merge into values.yaml Set LOVELY_HELMFILE_MERGE to some yaml you'd like strategic merged into any helmfile.yaml files used by helmfile
func GetHelmfilePatch ¶
func GetHelmfilePatch() string
GetHelmfilePatch returns the yaml to json6902 patch into values.yaml Set LOVELY_HELMFILE_PATCH to some yaml you'd like json6902 patched into any helmfile.yaml files used by helmfile
func GetHelmfilePath ¶
func GetHelmfilePath() string
GetHelmfilePath returns the path to helm if overridden, otherwise we search the path Set LOVELY_HELMFILE_PATH to the path to the helm binary
func GetHelmfileTemplateParams ¶
GetHelmfileTemplateParams returns extra parameters to pass to helmfile template Set LOVELY_HELMFILE_TEMPLATE_PARAMS to extra parameters to pass to helmfile template
func GetKustomizeMerge ¶
func GetKustomizeMerge() string
GetKustomizeMerge returns the yaml to strategic merge into kustomization.yaml Set LOVELY_KUSTOMIZE_MERGE to some yaml you'd like strategic merged on any kustomization.yaml files used by kustomize
func GetKustomizeParams ¶
GetKustomizeParams returns extra parameters to pass to kustomize Set LOVELY_KUSTOMIZE_PARAMS to extra parameters to pass to kustomize
func GetKustomizePatch ¶
func GetKustomizePatch() string
GetKustomizePatch returns the yaml to json6902 patch into kustomization.yaml Set LOVELY_KUSTOMIZE_PATCH to some yaml you'd like json6902 patched on any kustomization.yaml files used by kustomize
func GetKustomizePath ¶
func GetKustomizePath() string
GetKustomizePath returns the path to kustomize if overridden, otherwise we search the path Set LOVELY_KUSTOMIZE_PATH to the path to the kustomize binary
func GetPlugins ¶
GetPlugins returns the list of plugins to run during the generate phase after main processing Set LOVELY_PLUGINS_YAML to a map of a list of plugins to run per directory e.g. foo/bar: - plugin1 - plugin2 helm: - plugin3 Or et LOVELY_PLUGINS to a comma separated list of plugins to run after other processing. for any directories not in the list from the YAML
func GetPreprocessors ¶
GetPreprocessors returns the list of plugins to run before we generate yaml. Set LOVELY_PREPROCESSORS_YAML to a map of a list of plugins to run per directory Set LOVELY_PREPROCESSORS to a comma separated list of plugins to run for any directories not in the list from the YAML
Types ¶
type Feature ¶
type Feature struct {
// Name is the name of the parameter or environment variable, in lower_snake_case
Name string
// Title is plain text user readable name for the parameter
Title string
// DefaultVal is the default value for this parameter under most circumstances
DefaultVal string
// Description is in markdown, but will be rendered as text to plugin.yaml
Description string
}
Feature is an individual configurable element of the plugin
type FeatureID ¶
type FeatureID int
FeatureID is an enum for each feature to output them in a controlled order for docs etc
const ( // The order of these is the order they will appear in the docs Plugins FeatureID = iota PluginsYaml Preprocessors PreprocessorsYaml DetectRx KustomizePath KustomizeParams HelmPath HelmMerge HelmPatch HelmTemplateParams HelmRepoAddParams HelmCRDs KustomizeMerge KustomizePatch AllowGitCheckout HelmName HelmNamespace HelmValues HelmfilePath HelmfileCRDs HelmfileMerge HelmfilePatch HelmfileTemplateParams EnvPropagation FirstFeature = Plugins LastFeature = EnvPropagation )
All the features/parameters this module supports
Source Files