manifestgen

Documentation

Overview

Package manifestgen generates Kubernetes manifests for flux install and the Git source and Kustomization manifests for flux bootstrap.

Index

• Constants
• func MkdirTempAbs(dir, pattern string) (string, error)
• type Manifest
  • func (m *Manifest) WriteFile(rootDir string) (string, error)

Constants

const (
	PartOfLabelKey   = "app.kubernetes.io/part-of"
	PartOfLabelValue = "flux"
	InstanceLabelKey = "app.kubernetes.io/instance"
	VersionLabelKey  = "app.kubernetes.io/version"
)

These labels can be used to track down the namespace, custom resource definitions, deployments, services, network policies, service accounts, cluster roles and cluster role bindings belonging to Flux.

const GenWarning = "# This manifest was generated by flux. DO NOT EDIT."

Functions

func MkdirTempAbs

func MkdirTempAbs(dir, pattern string) (string, error)

MkdirTempAbs creates a tmp dir and returns the absolute path to the dir. This is required since certain OSes like MacOS create temporary files in e.g. `/private/var`, to which `/var` is a symlink.

Types

type Manifest

type Manifest struct {
	// Relative path to the YAML file
	Path string
	// Content in YAML format
	Content string
}

Manifest holds the data of a multi-doc YAML

func (*Manifest) WriteFile

func (m *Manifest) WriteFile(rootDir string) (string, error)

WriteFile writes the YAML content to a file inside the root path. If the file does not exist, WriteFile creates it with permissions perm, otherwise WriteFile overwrites the file, without changing permissions.