install

Documentation

Index

• func ExistingVersion(version string) (bool, error)
• func Generate(options Options, manifestsBase string) (*manifestgen.Manifest, error)
• func GetGenWarning(options Options) string
• func GetLatestVersion() (string, error)
• type Options
  • func MakeDefaultOptions() Options

Functions

func ExistingVersion

func ExistingVersion(version string) (bool, error)

ExistingVersion calls the GitHub API to confirm the given version does exist.

func Generate

func Generate(options Options, manifestsBase string) (*manifestgen.Manifest, error)

Generate returns the install manifests as a multi-doc YAML. The manifests are built from a GitHub release or from a Kustomize overlay if the supplied Options.BaseURL is a local path. The manifestsBase should be set to an empty string when Generate is called by consumers that don't embed the manifests.

func GetGenWarning

func GetGenWarning(options Options) string

GetGenWarning generates a consistent generation warning in the install and bootstrap case in the following format: # This manifest was generated by flux. DO NOT EDIT. # Flux version: v0.21.1 # Components: source-controller,kustomize-controller,helm-controller,notification-controller,image-reflector-controller,image-automation-controller

func GetLatestVersion

func GetLatestVersion() (string, error)

GetLatestVersion calls the GitHub API and returns the latest released version.

Types

type Options

type Options struct {
	BaseURL                string
	Version                string
	Namespace              string
	Components             []string
	ComponentsExtra        []string
	EventsAddr             string
	Registry               string
	ImagePullSecret        string
	WatchAllNamespaces     bool
	NetworkPolicy          bool
	LogLevel               string
	NotificationController string
	ManifestFile           string
	Timeout                time.Duration
	TargetPath             string
	ClusterDomain          string
	TolerationKeys         []string
}

func MakeDefaultOptions

func MakeDefaultOptions() Options