meta

package
v0.0.0-...-a212bfd Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 30, 2019 License: BSD-3-Clause Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GenerateObjectMeta

func GenerateObjectMeta(c Conf) (om *metav1.ObjectMeta, err error)

GenerateObjectMeta function generates ObjectMeta struct as per the Conf struct passed.

Types

type Conf

type Conf struct {
	// Instance is the Owner Object which manages the Object.
	Instance interfaces.Object
	// Name defines the name for the Object. This is used to populate
	// the field of same name in ObjectMeta
	Name string
	// Namespace defines the namespace in which Object is/will be
	// present. This is used to populate the field of same name in
	// ObjectMeta
	Namespace string
	// GenLabelsFunc is used to generate labels for Object. The
	// generated string map populates the Labels in ObjectMeta.
	GenLabelsFunc
	// GenAnnotationsFunc is used to generate annotations for the
	// Object. The generated string map populates the Annotations in
	// ObjectMeta
	GenAnnotationsFunc
	// GenFinalizersFunc is used to generate finalizers for the
	// Object. The generated string slice populates the Finalizers in
	// ObjectMeta
	GenFinalizersFunc
	// AppendLabels is used to determine if labels from Owner Object
	// are to be inherited.
	AppendLabels bool
}

Conf object is used to pass parameters to functions in Meta package and generate ObjectMeta struct.

type GenAnnotationsFunc

type GenAnnotationsFunc func(interfaces.Object) (map[string]string, error)

GenAnnotationsFunc defines a function which takes the Owner Object and generates map of string to string. This can be used to generate Annotations for the Object.

type GenFinalizersFunc

type GenFinalizersFunc func(interfaces.Object) ([]string, error)

GenFinalizersFunc defines a function which takes the Owner Object and generates string slice This can be used to generate Finalizers for the Object.

type GenLabelsFunc

type GenLabelsFunc func(interfaces.Object) (map[string]string, error)

GenLabelsFunc defines a function which takes the Owner Object and generates map of string to string. This can be used to generate labels for the Object.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL