kubernetes

Documentation

Index

• Variables
• func AggregatePodWatcher(namespaces []string, aggregate chan<- watch.Event) (func(), error)
• func TopLevelOwnerKey(obj metav1.Object, kind string) string
• func WaitForDeploymentToStabilize(ctx context.Context, c kubernetes.Interface, ns, name string, ...) error
• func WaitForPodInitialized(ctx context.Context, pods corev1.PodInterface, podName string) error
• func WaitForPodSucceeded(ctx context.Context, pods corev1.PodInterface, podName string, ...) error
• type ColorPicker
  • func NewColorPicker(baseImageNames []string) ColorPicker
• type ImageList
  • func NewImageList() *ImageList
  • func (l *ImageList) Add(image string)
  • func (l *ImageList) Select(pod *v1.Pod) bool
• type LogAggregator
  • func NewLogAggregator(out io.Writer, cli *kubectl.CLI, baseImageNames []string, ...) *LogAggregator
  • func (a *LogAggregator) IsMuted() bool
  • func (a *LogAggregator) Mute()
  • func (a *LogAggregator) SetSince(t time.Time)
  • func (a *LogAggregator) Start(ctx context.Context) error
  • func (a *LogAggregator) Stop()
  • func (a *LogAggregator) Unmute()
• type PodErr
  • func (e *PodErr) Error() string
• type PodSelector
• type PodStatus
  • func GetPodDetails(client kubernetes.Interface, ns string, podName string) PodStatus

Variables

var (
	Client        = getClientset
	DynamicClient = getDynamicClient
)

for tests

Functions

func AggregatePodWatcher

func AggregatePodWatcher(namespaces []string, aggregate chan<- watch.Event) (func(), error)

AggregatePodWatcher returns a watcher for multiple namespaces.

func TopLevelOwnerKey

func TopLevelOwnerKey(obj metav1.Object, kind string) string

TopLevelOwnerKey returns a key associated with the top level owner of a Kubernetes resource in the form Kind-Name

func WaitForDeploymentToStabilize

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

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

func WaitForPodInitialized

func WaitForPodInitialized(ctx context.Context, pods corev1.PodInterface, podName string) error

WaitForPodInitialized waits until init containers have started running

func WaitForPodSucceeded

func WaitForPodSucceeded(ctx context.Context, pods corev1.PodInterface, podName string, timeout time.Duration) error

WaitForPodSucceeded waits until the Pod status is Succeeded.

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(baseImageNames []string) ColorPicker

NewColorPicker creates a new ColorPicker. For each artifact, 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) 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, cli *kubectl.CLI, baseImageNames []string, podSelector PodSelector, namespaces []string) *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) SetSince

func (a *LogAggregator) SetSince(t time.Time)

func (*LogAggregator) Start

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

Start starts a logger that listens to pods and tail their logs if they are matched by the `podSelector`.

func (*LogAggregator) Stop

func (a *LogAggregator) Stop()

Stop stops the logger.

func (*LogAggregator) Unmute

func (a *LogAggregator) Unmute()

Unmute unmutes the logs.

type PodErr

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

func (*PodErr) Error

func (e *PodErr) Error() string

type PodSelector

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

PodSelector is used to choose which pods to log.

type PodStatus

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

func GetPodDetails

func GetPodDetails(client kubernetes.Interface, ns string, podName string) PodStatus