kubernetes

Documentation

Index

• Variables
• func GetClientset() (kubernetes.Interface, error)
• func GetDynamicClient() (dynamic.Interface, error)
• func IsRetryableAPIError(err error) bool
• func StartPods(c kubernetes.Interface, namespace string, pod v1.Pod, waitForRunning bool) error
• func WaitForDeploymentToStabilize(c kubernetes.Interface, ns, name string, timeout time.Duration) error
• func WaitForPodComplete(pods corev1.PodInterface, podName string, timeout time.Duration) error
• func WaitForPodReady(pods corev1.PodInterface, podName string) error
• func WaitForPodsWithLabelRunning(c kubernetes.Interface, ns string, label labels.Selector) error
• func WaitForRCToStabilize(c kubernetes.Interface, ns, name string, timeout time.Duration) error
• func WaitForService(c kubernetes.Interface, namespace, name string, exist bool, ...) error
• func WaitForServiceEndpointsNum(c kubernetes.Interface, namespace, serviceName string, expectNum int, ...) error
• type ColorPicker
  • func NewColorPicker(artifacts []*v1alpha2.Artifact) ColorPicker
• type ImageList
  • func NewImageList() *ImageList
  • func (l *ImageList) Add(image string)
  • func (l *ImageList) Remove(image string)
  • func (l *ImageList) Select(pod *v1.Pod) bool
• type LogAggregator
  • func NewLogAggregator(out io.Writer, podSelector PodSelector, colorPicker ColorPicker) *LogAggregator
  • func (a *LogAggregator) IsMuted() bool
  • func (a *LogAggregator) Mute()
  • func (a *LogAggregator) Start(ctx context.Context) error
  • func (a *LogAggregator) Unmute()
• type PodSelector
• type PodStore
  • func NewPodStore(c kubernetes.Interface, namespace string, label fmt.Stringer, ...) *PodStore
  • func (s *PodStore) List() []*v1.Pod
  • func (s *PodStore) Stop()

Variables

var Client = GetClientset

Client is for tests

var DynamicClient = GetDynamicClient

Functions

func GetClientset

func GetClientset() (kubernetes.Interface, error)

func GetDynamicClient

func GetDynamicClient() (dynamic.Interface, error)

func IsRetryableAPIError

func IsRetryableAPIError(err error) bool

func StartPods

func StartPods(c kubernetes.Interface, namespace string, pod v1.Pod, waitForRunning bool) error

func WaitForDeploymentToStabilize

func WaitForDeploymentToStabilize(c kubernetes.Interface, ns, name string, timeout time.Duration) error

WaitForDeploymentToStabilize waits till the Deployment has a matching generation/replica count between spec and status.

func WaitForPodComplete

func WaitForPodComplete(pods corev1.PodInterface, podName string, timeout time.Duration) error

func WaitForPodReady

func WaitForPodReady(pods corev1.PodInterface, podName string) error

func WaitForPodsWithLabelRunning

func WaitForPodsWithLabelRunning(c kubernetes.Interface, ns string, label labels.Selector) error

WaitForPodsWithLabelRunning waits up to 10 minutes for all matching pods to become Running and at least one matching pod exists.

func WaitForRCToStabilize

func WaitForRCToStabilize(c kubernetes.Interface, ns, name string, timeout time.Duration) error

WaitForRCToStabilize waits till the RC has a matching generation/replica count between spec and status.

func WaitForService

func WaitForService(c kubernetes.Interface, namespace, name string, exist bool, interval, timeout time.Duration) error

WaitForService waits until the service appears (exist == true), or disappears (exist == false)

func WaitForServiceEndpointsNum

func WaitForServiceEndpointsNum(c kubernetes.Interface, namespace, serviceName string, expectNum int, interval, timeout time.Duration) error

WaitForServiceEndpointsNum waits until the amount of endpoints that implement service to expectNum.

Types

type ColorPicker

type ColorPicker interface {
	Pick(pod *v1.Pod) color.Color
}

ColorPicker is used to associate colors for with pods so that the container logs can be output to the terminal with a consistent color being used to identify logs from each pod.

func NewColorPicker

func NewColorPicker(artifacts []*v1alpha2.Artifact) ColorPicker

NewColorPicker creates a new ColorPicker. For each artfact, a color will be selected sequentially from `colorCodes`. If all colors are used, the first color will be used again. The formatter for the associated color will then be returned by `Pick` each time it is called for the artifact and can be used to write to out in that color.

type ImageList

type ImageList struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

ImageList implements PodSelector based on a list of images names.

func NewImageList

func NewImageList() *ImageList

NewImageList creates a new ImageList.

func (*ImageList) Add

func (l *ImageList) Add(image string)

Add adds an image to the list.

func (*ImageList) Remove

func (l *ImageList) Remove(image string)

Remove removes an image from the list.

func (*ImageList) Select

func (l *ImageList) Select(pod *v1.Pod) bool

Select returns true if one of the pod's images is in the list.

type LogAggregator

type LogAggregator struct {
	// contains filtered or unexported fields
}

LogAggregator aggregates the logs for all the deployed pods.

func NewLogAggregator

func NewLogAggregator(out io.Writer, podSelector PodSelector, colorPicker ColorPicker) *LogAggregator

NewLogAggregator creates a new LogAggregator for a given output.

func (*LogAggregator) IsMuted

func (a *LogAggregator) IsMuted() bool

IsMuted says if the logs are to be muted.

func (*LogAggregator) Mute

func (a *LogAggregator) Mute()

Mute mutes the logs.

func (*LogAggregator) Start

func (a *LogAggregator) Start(ctx context.Context) error

func (*LogAggregator) Unmute

func (a *LogAggregator) Unmute()

Unmute unmutes the logs.

type PodSelector

type PodSelector interface {
	Select(pod *v1.Pod) bool
}

PodSelector is used to choose which pods to log.

type PodStore

type PodStore struct {
	cache.Store

	Reflector *cache.Reflector
	// contains filtered or unexported fields
}

func NewPodStore

func NewPodStore(c kubernetes.Interface, namespace string, label fmt.Stringer, field fmt.Stringer) *PodStore

func (*PodStore) List

func (s *PodStore) List() []*v1.Pod

func (*PodStore) Stop

func (s *PodStore) Stop()