plugin

Documentation

Index

• func Run(f util.Factory, args []string) error
• type RenderableObject
  • func (r RenderableObject) Annotations() (annotations map[string]interface{})
  • func (r RenderableObject) Include(templateName string, data interface{}) (string, error)
  • func (r RenderableObject) IncludeRenderableObject(obj RenderableObject) (output string)
  • func (r RenderableObject) KStatus() *kstatus.Result
  • func (r RenderableObject) Kind() (kind string)
  • func (r RenderableObject) KubeGet(namespace string, args ...string) (out []RenderableObject)
  • func (r RenderableObject) KubeGetByLabelsMap(namespace, resourceType string, labels map[string]interface{}) (out []RenderableObject)
  • func (r RenderableObject) KubeGetEvents() RenderableObject
  • func (r RenderableObject) KubeGetFirst(namespace string, args ...string) RenderableObject
  • func (r RenderableObject) KubeGetIngressesMatchingService(namespace, svcName string) (out []RenderableObject)
  • func (r RenderableObject) KubeGetNodeStatsSummary(nodeName string) map[string]interface{}
  • func (r RenderableObject) KubeGetNonTerminatedPodsOnNode(nodeName string) (podList []RenderableObject)
  • func (r RenderableObject) KubeGetOwners() (out []RenderableObject)
  • func (r RenderableObject) KubeGetResourcesOwnedOf(resourceOrKind string) (out []RenderableObject)
  • func (r RenderableObject) KubeGetServicesMatchingLabels(namespace string, labels map[string]interface{}) (out []RenderableObject)
  • func (r RenderableObject) KubeGetServicesMatchingPod(namespace, podName string) (out []RenderableObject)
  • func (r RenderableObject) KubeGetUnifiedDiffString(resourceOrKind, namespace, nameA, nameB string) string
  • func (r RenderableObject) Labels() (labels map[string]interface{})
  • func (r RenderableObject) Metadata() (metadata map[string]interface{})
  • func (r RenderableObject) Name() string
  • func (r RenderableObject) Namespace() string
  • func (r RenderableObject) RolloutStatus(obj RenderableObject) map[string]interface{}
  • func (r RenderableObject) Spec() (spec map[string]interface{})
  • func (r RenderableObject) Status() (status map[string]interface{})
  • func (r RenderableObject) StatusConditions() (conditions []interface{})
  • func (r RenderableObject) String() string

Functions

func Run

func Run(f util.Factory, args []string) error

Types

type RenderableObject

type RenderableObject struct {
	unstructured.Unstructured

	Config *viper.Viper
	// contains filtered or unexported fields
}

RenderableObject is the object passed to the templates, also provides methods to run queries against Kubernetes API. It is an unstructured.Unstructured (so it has the Object field that keeps the Object) but there a numerous helper methods that already helps with the templates.

func (RenderableObject) Annotations

func (r RenderableObject) Annotations() (annotations map[string]interface{})

func (RenderableObject) Include

func (r RenderableObject) Include(templateName string, data interface{}) (string, error)

func (RenderableObject) IncludeRenderableObject

func (r RenderableObject) IncludeRenderableObject(obj RenderableObject) (output string)

func (RenderableObject) KStatus

func (r RenderableObject) KStatus() *kstatus.Result

KStatus return a Result object of kstatus for the object.

func (RenderableObject) Kind

func (r RenderableObject) Kind() (kind string)

func (RenderableObject) KubeGet

func (r RenderableObject) KubeGet(namespace string, args ...string) (out []RenderableObject)

func (RenderableObject) KubeGetByLabelsMap

func (r RenderableObject) KubeGetByLabelsMap(namespace, resourceType string, labels map[string]interface{}) (out []RenderableObject)

KubeGetByLabelsMap returns results similar to this:

> kubectl get -n {namespace} {resourceType} -l {label_key=label_val,...}

func (RenderableObject) KubeGetEvents

func (r RenderableObject) KubeGetEvents() RenderableObject

func (RenderableObject) KubeGetFirst

func (r RenderableObject) KubeGetFirst(namespace string, args ...string) RenderableObject

KubeGetFirst returns a new RenderableObject with a nil Object when no object found.

func (RenderableObject) KubeGetIngressesMatchingService

func (r RenderableObject) KubeGetIngressesMatchingService(namespace, svcName string) (out []RenderableObject)

func (RenderableObject) KubeGetNodeStatsSummary

func (r RenderableObject) KubeGetNodeStatsSummary(nodeName string) map[string]interface{}

func (RenderableObject) KubeGetNonTerminatedPodsOnNode

func (r RenderableObject) KubeGetNonTerminatedPodsOnNode(nodeName string) (podList []RenderableObject)

KubeGetNonTerminatedPodsOnNode returns details of all pods which are not in terminal status

func (RenderableObject) KubeGetOwners

func (r RenderableObject) KubeGetOwners() (out []RenderableObject)

KubeGetOwners returns the list of objects which are listed in the Owner references of an object.

func (RenderableObject) KubeGetResourcesOwnedOf

func (r RenderableObject) KubeGetResourcesOwnedOf(resourceOrKind string) (out []RenderableObject)

KubeGetResourcesOwnedOf is meant to be called from templates. It returns a RenderableObject list for all resources which have provided kind or resource type with the current object listed in the ownerReferences.

func (RenderableObject) KubeGetServicesMatchingLabels

func (r RenderableObject) KubeGetServicesMatchingLabels(namespace string, labels map[string]interface{}) (out []RenderableObject)

func (RenderableObject) KubeGetServicesMatchingPod

func (r RenderableObject) KubeGetServicesMatchingPod(namespace, podName string) (out []RenderableObject)

func (RenderableObject) KubeGetUnifiedDiffString

func (r RenderableObject) KubeGetUnifiedDiffString(resourceOrKind, namespace, nameA, nameB string) string

KubeGetUnifiedDiffString generates a unified diff between given 2 resources and ignores several keys which are known to be creating noise in diff, see the removeFieldsThatCreateDiffNoise function to see which fields are being dropped.

func (RenderableObject) Labels

func (r RenderableObject) Labels() (labels map[string]interface{})

func (RenderableObject) Metadata

func (r RenderableObject) Metadata() (metadata map[string]interface{})

func (RenderableObject) Name

func (r RenderableObject) Name() string

func (RenderableObject) Namespace

func (r RenderableObject) Namespace() string

func (RenderableObject) RolloutStatus

func (r RenderableObject) RolloutStatus(obj RenderableObject) map[string]interface{}

RolloutStatus returns a map[string]interface{} with 3 keys: done: bool, message, error: string

func (RenderableObject) Spec

func (r RenderableObject) Spec() (spec map[string]interface{})

func (RenderableObject) Status

func (r RenderableObject) Status() (status map[string]interface{})

func (RenderableObject) StatusConditions

func (r RenderableObject) StatusConditions() (conditions []interface{})

func (RenderableObject) String

func (r RenderableObject) String() string