api

package

v0.2.1 Latest Latest Go to latest Published: Jun 7, 2020 License: Apache-2.0 Imports: 12 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func ConfigPathFromDirectory(d string) string

ConfigPathFromDirectory determines the kube config location from the HOME environment variable. If HOME is not defined, return empty.

func FailedPodConditions(pod corev1.Pod) []types.PodCondition

FailedPodConditions returns an array of PodConditions that have failed

func NotReadyPodContainerStatus(pod corev1.Pod) []types.ContainerStatus

NotReadyPodContainerStatus returns an array of ContainerStatus for Pod containers that are not ready

func PodIsReady(pod corev1.Pod) bool

PodIsReady returns true if all Pod Conditions are marked as True and if all Containers are Ready

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

Client is a wrapper around a Kubernetes Interface

func NewClient(config types.ClientConfig) (*Client, error)

NewClient takes in a ClientConfig and generates a new Client to interface with the Kubernetes Cluster as outlined in the ClientConfig

func (c *Client) Events(selectors types.EventSelectors) ([]corev1.Event, error)

Events takes a EventSelectors and returns an array of Kubernetes Events based on those selectors

func (c *Client) PodLogs(pod corev1.Pod, container string) (string, error)

PodLogs grabs the logs for a specific Pod Container. If container is empty string, the default Pod Container will be used.

func (c *Client) Pods(selectors types.PodSelectors) ([]corev1.Pod, error)

Pods takes a PodSelectors and returns an array of Kubernetes Pods based on those selectors