init

Documentation

Index

• func Install(client *kube.Client, opts Options, crdOnly bool) error
• func ManagerManifests(opts Options) ([]string, error)
• func Prereq(opts Options) []runtime.Object
• func PrereqManifests(opts Options) ([]string, error)
• func WatchKUDOUntilReady(client kubernetes.Interface, opts Options, timeout int64) bool
• type KudoCrds
  • func CRDs() KudoCrds
  • func (c KudoCrds) AsArray() []runtime.Object
  • func (c KudoCrds) AsYaml() ([]string, error)
• type Options
  • func NewOptions(v string, ns string) Options

Functions

func Install

func Install(client *kube.Client, opts Options, crdOnly bool) error

Install uses Kubernetes client to install KUDO.

func ManagerManifests

func ManagerManifests(opts Options) ([]string, error)

ManagerManifests provides a slice of strings for the deployment and service manifest

func Prereq

func Prereq(opts Options) []runtime.Object

Prereq returns the slice of prerequisite objects for KUDO

func PrereqManifests

func PrereqManifests(opts Options) ([]string, error)

PrereqManifests provides a slice of strings for each pre requisite manifest

func WatchKUDOUntilReady

func WatchKUDOUntilReady(client kubernetes.Interface, opts Options, timeout int64) bool

WatchKUDOUntilReady waits for the KUDO pod to become available.

Returns true if it exists. If the timeout was reached and it could not find the pod, it returns false.

Types

type KudoCrds

type KudoCrds struct {
	Operator        runtime.Object
	OperatorVersion runtime.Object
	Instance        runtime.Object
}

KudoCrds represents custom resource definitions needed to run KUDO

func CRDs

func CRDs() KudoCrds

CRDs returns the runtime.Object representation of all the CRDs KUDO requires

func (KudoCrds) AsArray

func (c KudoCrds) AsArray() []runtime.Object

AsArray returns all CRDs as array of runtime objects

func (KudoCrds) AsYaml

func (c KudoCrds) AsYaml() ([]string, error)

AsYaml returns crds as slice of strings

type Options

type Options struct {
	// Version is the version of the manager `0.5.0` for example (must NOT include the `v` in `v0.5.0`)
	Version string
	// namespace to init into (default is kudo-system)
	Namespace string
	// TerminationGracePeriodSeconds defines the termination grace period for a pod
	TerminationGracePeriodSeconds int64
	// Image defines the image to be used
	Image string
}

Options is the configurable options to init

func NewOptions

func NewOptions(v string, ns string) Options

NewOptions provides an option struct with defaults