install

Documentation

Index

• 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 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 case in the following format: # This manifest was generated by kjournal. DO NOT EDIT. # kjournal version: v0.0.1

func GetLatestVersion

func GetLatestVersion() (string, error)

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

Types

type Options

type Options struct {
	AsKustomization bool
	Base            string
	Version         string
	Namespace       string
	Registry        string
	ImagePullSecret string
	NetworkPolicy   bool
	CertManager     bool
	ServiceMonitor  bool
	ConfigTemplate  string
	LogLevel        string
	ManifestFile    string
	Timeout         time.Duration
	TargetPath      string
	ClusterDomain   string
}

func MakeDefaultOptions

func MakeDefaultOptions() Options