podutil

Documentation

Overview

podutil contains utilities for reading, writing and filtering streams and lists of api.Pod objects.

Index

• func Annotate(meta *api.ObjectMeta, kv map[string]string)
• func Gunzip(gzipped []byte) <-chan *api.Pod
• func Gzip(pods <-chan *api.Pod) ([]byte, error)
• func List(pods <-chan *api.Pod) *api.PodList
• func ReadFromDir(dirpath string) (<-chan *api.Pod, <-chan error)
• func Stream(list *api.PodList, err error) <-chan *api.Pod
• func WriteToDir(pods <-chan *api.Pod, destDir string) error
• type FilterFunc
  • func Annotator(m map[string]string) FilterFunc
  • func Environment(env []api.EnvVar) FilterFunc
  • func (filter FilterFunc) Do(in <-chan *api.Pod) <-chan *api.Pod
• type Filters
  • func (filters Filters) Do(in <-chan *api.Pod) (out <-chan *api.Pod)

Functions

func Annotate

func Annotate(meta *api.ObjectMeta, kv map[string]string)

Annotate safely copies annotation metadata from kv to meta.Annotations.

func Gunzip

func Gunzip(gzipped []byte) <-chan *api.Pod

func Gzip

func Gzip(pods <-chan *api.Pod) ([]byte, error)

func List

func List(pods <-chan *api.Pod) *api.PodList

List reads every pod from the pods chan and returns them all in an api.PodList

func ReadFromDir

func ReadFromDir(dirpath string) (<-chan *api.Pod, <-chan error)

func Stream

func Stream(list *api.PodList, err error) <-chan *api.Pod

Stream returns a chan of pods that yields each pod from the given list. No pods are yielded if err is non-nil.

func WriteToDir

func WriteToDir(pods <-chan *api.Pod, destDir string) error

Types

type FilterFunc

type FilterFunc func(pod *api.Pod) (bool, error)

return true if the pod passes the filter

func Annotator

func Annotator(m map[string]string) FilterFunc

Annotator returns a filter that copies annotations from map m into a pod

func Environment

func Environment(env []api.EnvVar) FilterFunc

Environment returns a filter that writes environment variables into pod containers

func (FilterFunc) Do

func (filter FilterFunc) Do(in <-chan *api.Pod) <-chan *api.Pod

type Filters

type Filters []FilterFunc

func (Filters) Do

func (filters Filters) Do(in <-chan *api.Pod) (out <-chan *api.Pod)