kubectl

Documentation

Overview

Package kubectl implements helper functions for managing kubernetes resources in e2e tests

This package borrows some code from https://github.com/grafana/xk6-kubernetes

Index

• type Client
  • func NewForConfig(_ context.Context, config *rest.Config) (*Client, error)
  • func NewFromKubeconfig(ctx context.Context, kubeconfig string) (*Client, error)
  • func (c *Client) Apply(ctx context.Context, yaml string) error
  • func (c *Client) ForwardPodPort(ctx context.Context, namespace string, pod string, port uint, ...) (uint, error)
• type PortForwardOption
  • func WithLocalPort(port uint) PortForwardOption
  • func WithOutputStreams(stdout io.Writer, stderr io.Writer) PortForwardOption

Types

type Client

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

Client holds the state to access kubernetes

func NewForConfig

func NewForConfig(_ context.Context, config *rest.Config) (*Client, error)

NewForConfig returns a new Client using a rest.Config

func NewFromKubeconfig

func NewFromKubeconfig(ctx context.Context, kubeconfig string) (*Client, error)

NewFromKubeconfig returns a new Client using the kubeconfig pointed by the path provided

func (*Client) Apply

func (c *Client) Apply(ctx context.Context, yaml string) error

Apply creates resources in a kubernetes cluster from a YAML manifest

func (*Client) ForwardPodPort

func (c *Client) ForwardPodPort(
	ctx context.Context,
	namespace string,
	pod string,
	port uint,
	opts ...PortForwardOption,
) (uint, error)

ForwardPodPort opens a local port for forwards requests to a pod's port. Returns the local port used for listening

type PortForwardOption

type PortForwardOption func(portForwardConfig) portForwardConfig

PortForwardOption defines a configuration option for port forwarding

func WithLocalPort

func WithLocalPort(port uint) PortForwardOption

WithLocalPort sets the local port to listen for request. Defaults to 0 (random local port)

func WithOutputStreams

func WithOutputStreams(stdout io.Writer, stderr io.Writer) PortForwardOption

WithOutputStreams sets the output streams for the port forwarder. Default to nil