kube

Documentation

Index

• Constants
• func CronJobWithNamespacedName(namespace, name string) *batchv1beta1.CronJob
• func DeploymentWithNamespacedName(namespace, name string) *appsv1.Deployment
• func IsCronJobActive(cronJob *batchv1beta1.CronJob) bool
• func IsDeploymentReady(deployment *appsv1.Deployment) bool
• func IsDeploymentScheduled(deployment *appsv1.Deployment) bool
• func IsDeploymentUpdated(deployment *appsv1.Deployment) bool
• func IsJobActive(job *batchv1.Job) bool
• func IsPodReady(pod *corev1.Pod) bool
• func IsReplicaSetAvailable(rs *appsv1.ReplicaSet) bool
• func IsReplicaSetReady(rs *appsv1.ReplicaSet) bool
• func JobWithNamespacedName(namespace, name string) *batchv1.Job
• func NamespacedName(obj runtime.Object) types.NamespacedName
• func PodWithNamespacedName(namespace, name string) *corev1.Pod
• func ReplicaSetWithNamespacedName(namespace, name string) *appsv1.ReplicaSet
• type Client
  • func NewClient(restConfig *rest.Config, opts ...ClientOption) (*Client, error)
  • func (c *Client) Events(ctx context.Context, obj runtime.Object) ([]corev1.Event, error)
  • func (c *Client) ListForOwner(ctx context.Context, list runtime.Object, owner runtime.Object) error
  • func (c *Client) Logs(ctx context.Context, pod *corev1.Pod) (io.ReadCloser, error)
  • func (c *Client) LogsString(ctx context.Context, pod *corev1.Pod) (string, error)
  • func (c *Client) PortForward(pod *corev1.Pod, localPort, podPort int) (*PortForward, error)
  • func (c *Client) WaitUntil(ctx context.Context, conditions ...Condition) error
• type ClientOption
  • func ClientWithScheme(scheme *runtime.Scheme) ClientOption
• type Condition
  • func CronJobIsActive(cronJob *batchv1beta1.CronJob) Condition
  • func DeploymentIsReady(deployment *appsv1.Deployment) Condition
  • func DeploymentIsScheduled(deployment *appsv1.Deployment) Condition
  • func DeploymentIsUpdated(deployment *appsv1.Deployment) Condition
  • func JobIsActive(job *batchv1.Job) Condition
  • func PodIsReady(pod *corev1.Pod) Condition
  • func ReplicaSetIsAvailable(rs *appsv1.ReplicaSet) Condition
  • func ReplicaSetIsReady(rs *appsv1.ReplicaSet) Condition
• type PortForward
  • func (pf *PortForward) Close() error

Constants

const PortAny = 0

Functions

func CronJobWithNamespacedName

func CronJobWithNamespacedName(namespace, name string) *batchv1beta1.CronJob

func DeploymentWithNamespacedName

func DeploymentWithNamespacedName(namespace, name string) *appsv1.Deployment

func IsCronJobActive

func IsCronJobActive(cronJob *batchv1beta1.CronJob) bool

func IsDeploymentReady

func IsDeploymentReady(deployment *appsv1.Deployment) bool

func IsDeploymentScheduled

func IsDeploymentScheduled(deployment *appsv1.Deployment) bool

func IsDeploymentUpdated

func IsDeploymentUpdated(deployment *appsv1.Deployment) bool

func IsJobActive

func IsJobActive(job *batchv1.Job) bool

func IsPodReady

func IsPodReady(pod *corev1.Pod) bool

func IsReplicaSetAvailable

func IsReplicaSetAvailable(rs *appsv1.ReplicaSet) bool

func IsReplicaSetReady

func IsReplicaSetReady(rs *appsv1.ReplicaSet) bool

func JobWithNamespacedName

func JobWithNamespacedName(namespace, name string) *batchv1.Job

func NamespacedName

func NamespacedName(obj runtime.Object) types.NamespacedName

NamespaceName conveniently creates a NamespacedName from any valid kubernetes resource. If no valid object is provided, the function will panic.

func PodWithNamespacedName

func PodWithNamespacedName(namespace, name string) *corev1.Pod

func ReplicaSetWithNamespacedName

func ReplicaSetWithNamespacedName(namespace, name string) *appsv1.ReplicaSet

Types

type Client

type Client struct {
	client.Client
	Clientset *kubernetes.Clientset
	// contains filtered or unexported fields
}

Client is an extension to the controller-runtime Client and client-go's default Clientset, which provides additional capabilities including port-forward and more.

func NewClient

func NewClient(restConfig *rest.Config, opts ...ClientOption) (*Client, error)

func (*Client) Events

func (c *Client) Events(ctx context.Context, obj runtime.Object) ([]corev1.Event, error)

func (*Client) ListForOwner

func (c *Client) ListForOwner(ctx context.Context, list runtime.Object, owner runtime.Object) error

func (*Client) Logs

func (c *Client) Logs(ctx context.Context, pod *corev1.Pod) (io.ReadCloser, error)

func (*Client) LogsString

func (c *Client) LogsString(ctx context.Context, pod *corev1.Pod) (string, error)

func (*Client) PortForward

func (c *Client) PortForward(pod *corev1.Pod, localPort, podPort int) (*PortForward, error)

func (*Client) WaitUntil

func (c *Client) WaitUntil(ctx context.Context, conditions ...Condition) error

type ClientOption

type ClientOption interface {
	// contains filtered or unexported methods
}

ClientOption interface is implemented by all possible options to instantiate a new kubernetes client.

func ClientWithScheme

func ClientWithScheme(scheme *runtime.Scheme) ClientOption

ClientWithScheme override the default scheme and provide your own.

type Condition

type Condition interface {
	// contains filtered or unexported methods
}

func CronJobIsActive

func CronJobIsActive(cronJob *batchv1beta1.CronJob) Condition

func DeploymentIsReady

func DeploymentIsReady(deployment *appsv1.Deployment) Condition

func DeploymentIsScheduled

func DeploymentIsScheduled(deployment *appsv1.Deployment) Condition

func DeploymentIsUpdated

func DeploymentIsUpdated(deployment *appsv1.Deployment) Condition

func JobIsActive

func JobIsActive(job *batchv1.Job) Condition

func PodIsReady

func PodIsReady(pod *corev1.Pod) Condition

func ReplicaSetIsAvailable

func ReplicaSetIsAvailable(rs *appsv1.ReplicaSet) Condition

func ReplicaSetIsReady

func ReplicaSetIsReady(rs *appsv1.ReplicaSet) Condition

type PortForward

type PortForward struct {
	LocalPort int
	// contains filtered or unexported fields
}

func (*PortForward) Close

func (pf *PortForward) Close() error