k8s

Documentation

Overview

Package k8s provides utility functions for working with Kubernetes clusters.

Index

• func Clientset() *kubernetes.Clientset
• func CreateDaemonSet(namespace, name string, labels map[string]string, ...) (*appv1.DaemonSet, error)
• func CreateNetworkPolicy(namespace string, name string, selectorMap map[string]string, ...) error
• func DaemonSetExists(namespace, name string) (bool, error)
• func DeleteDaemonSet(namespace, name string) error
• func DeleteNetworkPolicy(namespace string, name string) error
• func DeletePersistentVolumeClaim(namespace, name string)
• func DeletePod(namespace, name string) error
• func DeletePodWithGracePeriod(namespace, name string, gracePeriodSeconds *int64) error
• func DeleteService(namespace, name string) error
• func DeployPersistentVolumeClaim(namespace, name string, labels map[string]string, size resource.Quantity)
• func DeployPod(podConfig PodConfig, init bool) (*v1.Pod, error)
• func DeployService(namespace, name string, labels, selectorMap map[string]string, portsTCP []int, ...) (*v1.Service, error)
• func GetDaemonSet(namespace, name string) (*appv1.DaemonSet, error)
• func GetService(namespace, name string) (*v1.Service, error)
• func GetServiceIP(namespace, name string) (string, error)
• func Initialize() error
• func IsInitialized() bool
• func IsPodRunning(namespace, name string) (bool, error)
• func Namespace() string
• func PatchService(namespace, name string, labels, selectorMap map[string]string, ...) error
• func PortForwardPod(namespace string, podName string, localPort int, remotePort int) error
• func ReplacePod(podConfig PodConfig) (*v1.Pod, error)
• func ReplacePodWithGracePeriod(podConfig PodConfig, gracePeriod *int64) (*v1.Pod, error)
• func RunCommandInPod(namespace, podName, containerName string, cmd []string) (string, error)
• func UpdateDaemonSet(namespace, name string, labels map[string]string, ...) (*appv1.DaemonSet, error)
• type PodConfig
• type Volume
  • func NewVolume(path, size string, owner int64) *Volume

Functions

func Clientset

func Clientset() *kubernetes.Clientset

Clientset returns the Kubernetes clientset.

func CreateDaemonSet

func CreateDaemonSet(namespace, name string, labels map[string]string, initContainers []v1.Container, containers []v1.Container) (*appv1.DaemonSet, error)

CreateDaemonSet creates a new daemonset.

func CreateNetworkPolicy

func CreateNetworkPolicy(namespace string, name string, selectorMap map[string]string, ingressSelectorMap map[string]string, egressSelectorMap map[string]string) error

CreateNetworkPolicy creates a new NetworkPolicy resource.

func DaemonSetExists

func DaemonSetExists(namespace, name string) (bool, error)

DaemonSetExists checks if a daemonset exists.

func DeleteDaemonSet

func DeleteDaemonSet(namespace, name string) error

DeleteDaemonSet deletes an existing daemonset.

func DeleteNetworkPolicy

func DeleteNetworkPolicy(namespace string, name string) error

DeleteNetworkPolicy removes a NetworkPolicy resource.

func DeletePersistentVolumeClaim

func DeletePersistentVolumeClaim(namespace, name string)

DeletePersistentVolumeClaim deletes the PersistentVolumeClaim with the specified name in the specified namespace.

func DeletePod

func DeletePod(namespace, name string) error

DeletePod deletes a pod with the given name in the specified namespace.

func DeletePodWithGracePeriod

func DeletePodWithGracePeriod(namespace, name string, gracePeriodSeconds *int64) error

DeletePodWithGracePeriod deletes a pod with the given name in the specified namespace.

func DeleteService

func DeleteService(namespace, name string) error

DeleteService deletes a service if it exists.

func DeployPersistentVolumeClaim

func DeployPersistentVolumeClaim(namespace, name string, labels map[string]string, size resource.Quantity)

DeployPersistentVolumeClaim creates a new PersistentVolumeClaim in the specified namespace.

func DeployPod

func DeployPod(podConfig PodConfig, init bool) (*v1.Pod, error)

DeployPod creates a new pod in the given namespace if it doesn't already exist.

func DeployService

func DeployService(namespace, name string, labels, selectorMap map[string]string, portsTCP []int, portsUDP []int) (*v1.Service, error)

DeployService deploys a service if it does not exist.

func GetDaemonSet

func GetDaemonSet(namespace, name string) (*appv1.DaemonSet, error)

GetDaemonSet retrieves a daemonset.

func GetService

func GetService(namespace, name string) (*v1.Service, error)

GetService retrieves a service.

func GetServiceIP

func GetServiceIP(namespace, name string) (string, error)

GetServiceIP retrieves the IP address of a service.

func Initialize

func Initialize() error

Initialize sets up the Kubernetes client with the appropriate configuration.

func IsInitialized

func IsInitialized() bool

IsInitialized checks if the Kubernetes clientset has been initialized.

func IsPodRunning

func IsPodRunning(namespace, name string) (bool, error)

IsPodRunning returns true if all containers in the pod are running.

func Namespace

func Namespace() string

Namespace returns the current namespace in use.

func PatchService

func PatchService(namespace, name string, labels, selectorMap map[string]string, portsTCP, portsUDP []int) error

PatchService patches an existing service.

func PortForwardPod

func PortForwardPod(namespace string, podName string, localPort int, remotePort int) error

PortForwardPod forwards a local port to a port on a pod.

func ReplacePod

func ReplacePod(podConfig PodConfig) (*v1.Pod, error)

ReplacePod replaces a pod in the given namespace and returns the new Pod object.

func ReplacePodWithGracePeriod

func ReplacePodWithGracePeriod(podConfig PodConfig, gracePeriod *int64) (*v1.Pod, error)

ReplacePodWithGracePeriod replaces a pod in the given namespace and returns the new Pod object with a grace period.

func RunCommandInPod

func RunCommandInPod(namespace, podName, containerName string, cmd []string) (string, error)

RunCommandInPod runs a command in a container within a pod.

func UpdateDaemonSet

func UpdateDaemonSet(namespace, name string, labels map[string]string, initContainers []v1.Container, containers []v1.Container) (*appv1.DaemonSet, error)

UpdateDaemonSet updates an existing daemonset.

Types

type PodConfig

type PodConfig struct {
	Namespace     string            // Kubernetes namespace of the Pod
	Name          string            // Name to assign to the Pod
	Labels        map[string]string // Labels to apply to the Pod
	Image         string            // Name of the Docker image to use for the container
	Command       []string          // Command to run in the container
	Args          []string          // Arguments to pass to the command in the container
	Env           map[string]string // Environment variables to set in the container
	Volumes       []*Volume         // Volumes to mount in the Pod
	MemoryRequest string            // Memory request for the container
	MemoryLimit   string            // Memory limit for the container
	CPURequest    string            // CPU request for the container
}

PodConfig contains the specifications for creating a new Pod object

type Volume

type Volume struct {
	Path  string
	Size  string
	Owner int64
}

Volume represents a volume.

func NewVolume

func NewVolume(path, size string, owner int64) *Volume

NewVolume creates a new volume with the given path, size and owner.