kube

Documentation

Index

• Constants
• func BuildDefaultPortMap(remotePort int32) []string
• func WithConfigPath(path string) func(c *Client)
• func WithNamespace(namespace string) func(c *Client)
• type ApplyOptions
• type Client
  • func NewClient(opts ...Opt) (*Client, error)
  • func (c *Client) Apply(schema schema.GroupVersionResource, resource *unstructured.Unstructured, ...) error
  • func (c *Client) ConfigMap(namespace, name string, opts metav1.GetOptions) (*corev1.ConfigMap, error)
  • func (c *Client) ConfigMaps(namespace string, opts metav1.ListOptions) ([]corev1.ConfigMap, error)
  • func (c *Client) CreateDeployment(namespace string, deployment *appsv1.Deployment, opts metav1.CreateOptions) error
  • func (c *Client) CreateIngress(namespace string, ingress *networkingv1.Ingress, opts metav1.CreateOptions) error
  • func (c *Client) CreatePod(namespace string, pod *corev1.Pod, opts metav1.CreateOptions) error
  • func (c *Client) CreateSecret(namespace string, secret *corev1.Secret, opts metav1.CreateOptions) error
  • func (c *Client) CreateService(namespace string, service *corev1.Service, opts metav1.CreateOptions) error
  • func (c *Client) Exec(command string, pod corev1.Pod) (string, string, error)
  • func (c *Client) Ingresses(namespace string, opts metav1.ListOptions) ([]networkingv1.Ingress, error)
  • func (c *Client) Namespaces(opts metav1.ListOptions) ([]corev1.Namespace, error)
  • func (c *Client) Pods(namespace string, opts metav1.ListOptions) ([]corev1.Pod, error)
  • func (c *Client) PortForward(ctx context.Context, pod corev1.Pod) error
  • func (c *Client) Secrets(namespace string, opts metav1.ListOptions) ([]corev1.Secret, error)
  • func (c *Client) Service(namespace, name string, opts metav1.GetOptions) (*corev1.Service, error)
  • func (c *Client) Services(namespace string, opts metav1.ListOptions) ([]corev1.Service, error)
• type DefaultPortForwarder
  • func (*DefaultPortForwarder) ForwardPorts(method string, restConfig *rest.Config, url *url.URL, ports []string, ...) error
• type DefaultRemoteExecutor
  • func (*DefaultRemoteExecutor) Execute(url *url.URL, restConfig *rest.Config, stdout, stderr io.Writer) error
• type Opt
• type PortForwarder
• type RemoteExecutor

Constants

const (
	DefaultNamespace = "default"
	DefaultLocalPort = "7150"
)

Functions

func BuildDefaultPortMap

func BuildDefaultPortMap(remotePort int32) []string

only require remoteport as input

func WithConfigPath

func WithConfigPath(path string) func(c *Client)

WithConfigPath configures the KubeClient with a predetermined path for the 'kubeconfig' file This avoids the usual searches done within findKubeConfig

func WithNamespace

func WithNamespace(namespace string) func(c *Client)

WithNamespace configures the KubeClient with a custom default namespace

Types

type ApplyOptions

type ApplyOptions struct {
	Name          string
	GetOptions    *metav1.GetOptions
	CreateOptions *metav1.CreateOptions
	UpdateOptions *metav1.UpdateOptions
}

type Client

type Client struct {
	// ConfigPath is the configuration file path for which the current client(-set) was created
	ConfigPath string

	// Executor is the connection between local and remote IO streams
	Executor RemoteExecutor

	// PortForwarder is the implementation for the port-forward functionality
	PortForwarder PortForwarder

	// Config is the rest.Config for which the client was built
	Config *rest.Config

	// Client is the embedded Kubernetes ClientSet
	Client *kubernetes.Clientset

	// flags are the Kubernetes-specific flags which will be injected into the CLI
	Flags *genericclioptions.ConfigFlags
	// contains filtered or unexported fields
}

func NewClient

func NewClient(opts ...Opt) (*Client, error)

NewClient instantiates a new KubeClient with a configured and embedded Clientset

func (*Client) Apply

func (c *Client) Apply(schema schema.GroupVersionResource, resource *unstructured.Unstructured, opts *ApplyOptions) error

func (*Client) ConfigMap

func (c *Client) ConfigMap(namespace, name string, opts metav1.GetOptions) (*corev1.ConfigMap, error)

func (*Client) ConfigMaps

func (c *Client) ConfigMaps(namespace string, opts metav1.ListOptions) ([]corev1.ConfigMap, error)

func (*Client) CreateDeployment

func (c *Client) CreateDeployment(namespace string, deployment *appsv1.Deployment, opts metav1.CreateOptions) error

func (*Client) CreateIngress

func (c *Client) CreateIngress(namespace string, ingress *networkingv1.Ingress, opts metav1.CreateOptions) error

func (*Client) CreatePod

func (c *Client) CreatePod(namespace string, pod *corev1.Pod, opts metav1.CreateOptions) error

func (*Client) CreateSecret

func (c *Client) CreateSecret(namespace string, secret *corev1.Secret, opts metav1.CreateOptions) error

func (*Client) CreateService

func (c *Client) CreateService(namespace string, service *corev1.Service, opts metav1.CreateOptions) error

func (*Client) Exec

func (c *Client) Exec(command string, pod corev1.Pod) (string, string, error)

Exec executes a command within the container of a specific Pod in the current namespace configured for the client. If another namespace is required the ExecInNamespace helper provides an escape hatch

func (*Client) Ingresses

func (c *Client) Ingresses(namespace string, opts metav1.ListOptions) ([]networkingv1.Ingress, error)

func (*Client) Namespaces

func (c *Client) Namespaces(opts metav1.ListOptions) ([]corev1.Namespace, error)

func (*Client) Pods

func (c *Client) Pods(namespace string, opts metav1.ListOptions) ([]corev1.Pod, error)

func (*Client) PortForward

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

PortForward port-forwards a remote port of a Kubernetes container to the local machine

func (*Client) Secrets

func (c *Client) Secrets(namespace string, opts metav1.ListOptions) ([]corev1.Secret, error)

func (*Client) Service

func (c *Client) Service(namespace, name string, opts metav1.GetOptions) (*corev1.Service, error)

func (*Client) Services

func (c *Client) Services(namespace string, opts metav1.ListOptions) ([]corev1.Service, error)

type DefaultPortForwarder

type DefaultPortForwarder struct{}

func (*DefaultPortForwarder) ForwardPorts

func (*DefaultPortForwarder) ForwardPorts(method string, restConfig *rest.Config, url *url.URL, ports []string, stopChan,
	readyChan chan struct{}) error

type DefaultRemoteExecutor

type DefaultRemoteExecutor struct{}

DefaultRemoteExecutor is the standard implementation of remote command execution

func (*DefaultRemoteExecutor) Execute

func (*DefaultRemoteExecutor) Execute(url *url.URL, restConfig *rest.Config, stdout, stderr io.Writer) error

Execute implements the RemoteExecutor interface for the DefaultRemoteExecutor

type Opt

type Opt func(c *Client)

Opt represents a configuration option for the KubeClient

type PortForwarder

type PortForwarder interface {
	ForwardPorts(method string, restConfig *rest.Config, url *url.URL, ports []string, stopChan,
		readyChan chan struct{}) error
}

type RemoteExecutor

type RemoteExecutor interface {
	Execute(url *url.URL, restConfig *rest.Config, stdout, stderr io.Writer) error
}

RemoteExecutor defines the interface accepted by the Exec command - provided for test stubbing