k8s

package
v0.32.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 11, 2024 License: Apache-2.0 Imports: 36 Imported by: 0

Documentation

Overview

Package k8s provides a client for interacting with a Kubernetes cluster.

Package k8s provides a client for interacting with a Kubernetes cluster.

Package k8s provides a client for interacting with a Kubernetes cluster.

Package k8s provides a client for interacting with a Kubernetes cluster.

Package k8s provides a client for interacting with a Kubernetes cluster.

Package k8s provides a client for interacting with a Kubernetes cluster.

Package k8s provides a client for interacting with a Kubernetes cluster.

Package k8s provides a client for interacting with a Kubernetes cluster.

Package k8s provides a client for interacting with a Kubernetes cluster.

Package k8s provides a client for interacting with a Kubernetes cluster.

Package k8s provides a client for interacting with a Kubernetes cluster.

Package k8s provides a client for interacting with a Kubernetes cluster.

Package k8s provides a client for interacting with a Kubernetes cluster.

Package k8s provides a client for interacting with a Kubernetes cluster.

Index

Constants

View Source 
const (
	DistroIsUnknown       = "unknown"
	DistroIsK3s           = "k3s"
	DistroIsK3d           = "k3d"
	DistroIsKind          = "kind"
	DistroIsMicroK8s      = "microk8s"
	DistroIsEKS           = "eks"
	DistroIsEKSAnywhere   = "eksanywhere"
	DistroIsDockerDesktop = "dockerdesktop"
	DistroIsGKE           = "gke"
	DistroIsAKS           = "aks"
	DistroIsRKE2          = "rke2"
	DistroIsTKG           = "tkg"
)

List of supported distros via distro detection.

View Source 
const (
	PodResource = "pod"
	SvcResource = "svc"
)

Zarf Tunnel Configuration Constants.

Variables

This section is empty.

Functions

func MakeLabels added in v0.30.0 

func MakeLabels(labels map[string]string) string

MakeLabels is a helper to format a map of label key and value pairs into a single string for use as a selector.

Types

type GeneratedPKI 

type GeneratedPKI struct {
	CA   []byte `json:"ca"`
	Cert []byte `json:"cert"`
	Key  []byte `json:"key"`
}

GeneratedPKI is a struct for storing generated PKI data.

type K8s 

type K8s struct {
	Clientset  kubernetes.Interface
	RestConfig *rest.Config
	Log        Log
	Labels     Labels
}

K8s is a client for interacting with a Kubernetes cluster.

func New 

func New(logger Log, defaultLabels Labels) (*K8s, error)

New creates a new K8s client.

func NewWithWait 

func NewWithWait(logger Log, defaultLabels Labels, timeout time.Duration) (*K8s, error)

NewWithWait is a convenience function that creates a new K8s client and waits for the cluster to be healthy.

func (*K8s) AddLabelsAndAnnotations added in v0.26.1 

func (k *K8s) AddLabelsAndAnnotations(resourceNamespace string, resourceName string, groupKind schema.GroupKind, labels map[string]string, annotations map[string]string) error

AddLabelsAndAnnotations adds the provided labels and annotations to the specified K8s resource

func (*K8s) CreateConfigmap 

func (k *K8s) CreateConfigmap(namespace, name string, data map[string][]byte) (*corev1.ConfigMap, error)

CreateConfigmap applies a configmap to the cluster.

func (*K8s) CreateNamespace 

func (k *K8s) CreateNamespace(namespace *corev1.Namespace) (*corev1.Namespace, error)

CreateNamespace creates the given namespace or returns it if it already exists in the cluster.

func (*K8s) CreateOrUpdateSecret added in v0.23.4 

func (k *K8s) CreateOrUpdateSecret(secret *corev1.Secret) (createdSecret *corev1.Secret, err error)

CreateOrUpdateSecret creates or updates a Kubernetes secret.

func (*K8s) CreateOrUpdateTLSSecret added in v0.23.4 

func (k *K8s) CreateOrUpdateTLSSecret(namespace, name string, conf GeneratedPKI) (*corev1.Secret, error)

CreateOrUpdateTLSSecret creates or updates a Kubernetes secret with a new TLS secret.

func (*K8s) CreatePod 

func (k *K8s) CreatePod(pod *corev1.Pod) (*corev1.Pod, error)

CreatePod inserts the given pod into the cluster.

func (*K8s) CreateService 

func (k *K8s) CreateService(service *corev1.Service) (*corev1.Service, error)

CreateService creates the given service in the cluster.

func (*K8s) DeleteConfigMapsByLabel 

func (k *K8s) DeleteConfigMapsByLabel(namespace string, labels Labels) error

DeleteConfigMapsByLabel deletes a configmap by label(s).

func (*K8s) DeleteConfigmap 

func (k *K8s) DeleteConfigmap(namespace, name string) error

DeleteConfigmap deletes a configmap by name.

func (*K8s) DeleteNamespace 

func (k *K8s) DeleteNamespace(ctx context.Context, name string) error

DeleteNamespace deletes the given namespace from the cluster.

func (*K8s) DeletePod 

func (k *K8s) DeletePod(namespace string, name string) error

DeletePod removes a pod from the cluster by namespace & name.

func (*K8s) DeletePods added in v0.30.1 

func (k *K8s) DeletePods(target PodLookup) error

DeletePods removes a collection of pods from the cluster by pod lookup.

func (*K8s) DeleteSecret 

func (k *K8s) DeleteSecret(secret *corev1.Secret) error

DeleteSecret deletes a Kubernetes secret.

func (*K8s) DeleteService 

func (k *K8s) DeleteService(namespace, name string) error

DeleteService removes a service from the cluster by namespace and name.

func (*K8s) DetectDistro 

func (k *K8s) DetectDistro() (string, error)

DetectDistro returns the matching distro or unknown if not found.

func (*K8s) FindPodContainerPort added in v0.30.0 

func (k *K8s) FindPodContainerPort(svc corev1.Service) int

FindPodContainerPort will find a pod's container port from a service and return it.

Returns 0 if no port is found.

func (*K8s) GeneratePod 

func (k *K8s) GeneratePod(name, namespace string) *corev1.Pod

GeneratePod creates a new pod without adding it to the k8s cluster.

func (*K8s) GenerateSecret 

func (k *K8s) GenerateSecret(namespace, name string, secretType corev1.SecretType) *corev1.Secret

GenerateSecret returns a Kubernetes secret object without applying it to the cluster.

func (*K8s) GenerateService 

func (k *K8s) GenerateService(namespace, name string) *corev1.Service

GenerateService returns a K8s service struct without writing to the cluster.

func (*K8s) GenerateTLSSecret 

func (k *K8s) GenerateTLSSecret(namespace, name string, conf GeneratedPKI) (*corev1.Secret, error)

GenerateTLSSecret returns a Kubernetes secret object without applying it to the cluster.

func (*K8s) GetAllHPAs added in v0.24.0 

func (k *K8s) GetAllHPAs() (*autoscalingV2.HorizontalPodAutoscalerList, error)

GetAllHPAs returns a list of horizontal pod autoscalers for all namespaces.

func (*K8s) GetAllPods 

func (k *K8s) GetAllPods() (*corev1.PodList, error)

GetAllPods returns a list of pods from the cluster for all namespaces.

func (*K8s) GetAllServiceAccounts 

func (k *K8s) GetAllServiceAccounts() (*corev1.ServiceAccountList, error)

GetAllServiceAccounts returns a list of services accounts for all namespaces.

func (*K8s) GetArchitectures added in v0.31.0 

func (k *K8s) GetArchitectures() ([]string, error)

GetArchitectures returns the cluster system architectures if found.

func (*K8s) GetHPA added in v0.24.0 

func (k *K8s) GetHPA(namespace, name string) (*autoscalingV2.HorizontalPodAutoscaler, error)

GetHPA returns a single horizontal pod autoscaler by namespace and name.

func (*K8s) GetHPAs added in v0.24.0 

func (k *K8s) GetHPAs(namespace string) (*autoscalingV2.HorizontalPodAutoscalerList, error)

GetHPAs returns a list of horizontal pod autoscalers in a given namespace.

func (*K8s) GetNamespaces 

func (k *K8s) GetNamespaces() (*corev1.NamespaceList, error)

GetNamespaces returns a list of namespaces in the cluster.

func (*K8s) GetNode added in v0.27.0 

func (k *K8s) GetNode(nodeName string) (*corev1.Node, error)

GetNode returns a node from the k8s cluster.

func (*K8s) GetNodes 

func (k *K8s) GetNodes() (*corev1.NodeList, error)

GetNodes returns a list of nodes from the k8s cluster.

func (*K8s) GetPods 

func (k *K8s) GetPods(namespace string) (*corev1.PodList, error)

GetPods returns a list of pods from the cluster by namespace.

func (*K8s) GetSecret 

func (k *K8s) GetSecret(namespace, name string) (*corev1.Secret, error)

GetSecret returns a Kubernetes secret.

func (*K8s) GetSecretsWithLabel 

func (k *K8s) GetSecretsWithLabel(namespace, labelSelector string) (*corev1.SecretList, error)

GetSecretsWithLabel returns a list of Kubernetes secrets with the given label.

func (*K8s) GetServerVersion added in v0.29.0 

func (k *K8s) GetServerVersion() (version string, err error)

GetServerVersion retrieves and returns the k8s revision.

func (*K8s) GetService 

func (k *K8s) GetService(namespace, serviceName string) (*corev1.Service, error)

GetService returns a Kubernetes service resource in the provided namespace with the given name.

func (*K8s) GetServiceAccount 

func (k *K8s) GetServiceAccount(namespace, name string) (*corev1.ServiceAccount, error)

GetServiceAccount returns a single service account by namespace and name.

func (*K8s) GetServiceAccounts 

func (k *K8s) GetServiceAccounts(namespace string) (*corev1.ServiceAccountList, error)

GetServiceAccounts returns a list of service accounts in a given namespace.

func (*K8s) GetServices added in v0.24.0 

func (k *K8s) GetServices(namespace string) (*corev1.ServiceList, error)

GetServices returns a list of services in the provided namespace. To search all namespaces, pass "" in the namespace arg.

func (*K8s) GetServicesByLabel 

func (k *K8s) GetServicesByLabel(namespace, label, value string) (*corev1.ServiceList, error)

GetServicesByLabel returns a list of matched services given a label and value. To search all namespaces, pass "" in the namespace arg.

func (*K8s) GetServicesByLabelExists 

func (k *K8s) GetServicesByLabelExists(namespace, label string) (*corev1.ServiceList, error)

GetServicesByLabelExists returns a list of matched services given a label. To search all namespaces, pass "" in the namespace arg.

func (*K8s) HandleDeprecations added in v0.28.0 

func (k *K8s) HandleDeprecations(rawData *unstructured.Unstructured, kubernetesVersion semver.Version) (*unstructured.Unstructured, bool, error)

HandleDeprecations takes in an unstructured object and the version of kubernetes in a cluster and returns a converted version of that object and whether it was modified (if applicable)

func (*K8s) IsInitialNamespace added in v0.26.1 

func (k *K8s) IsInitialNamespace(name string) bool

IsInitialNamespace returns true if the given namespace name is an initial k8s namespace: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/#initial-namespaces

func (*K8s) NewTunnel added in v0.30.0 

func (k *K8s) NewTunnel(namespace, resourceType, resourceName, urlSuffix string, local, remote int) (*Tunnel, error)

NewTunnel will create a new Tunnel struct. Note that if you use 0 for the local port, an open port on the host system will be selected automatically, and the Tunnel struct will be updated with the selected port.

func (*K8s) NewZarfManagedNamespace added in v0.26.1 

func (k *K8s) NewZarfManagedNamespace(name string) *corev1.Namespace

NewZarfManagedNamespace returns a corev1.Namespace with Zarf-managed labels

func (*K8s) RemoveLabelsAndAnnotations added in v0.32.0 

func (k *K8s) RemoveLabelsAndAnnotations(resourceNamespace string, resourceName string, groupKind schema.GroupKind, labels map[string]string, annotations map[string]string) error

RemoveLabelsAndAnnotations removes the provided labels and annotations to the specified K8s resource

func (*K8s) ReplaceConfigmap 

func (k *K8s) ReplaceConfigmap(namespace, name string, data map[string][]byte) (*corev1.ConfigMap, error)

ReplaceConfigmap deletes and recreates a configmap.

func (*K8s) ReplaceService 

func (k *K8s) ReplaceService(service *corev1.Service) (*corev1.Service, error)

ReplaceService deletes and re-creates a service.

func (*K8s) ServiceInfoFromNodePortURL added in v0.30.0 

func (k *K8s) ServiceInfoFromNodePortURL(nodePortURL string) (*ServiceInfo, error)

ServiceInfoFromNodePortURL takes a nodePortURL and parses it to find the service info for connecting to the cluster. The string is expected to follow the following format: Example nodePortURL: 127.0.0.1:{PORT}.

func (*K8s) UpdateHPA added in v0.24.0 

func (k *K8s) UpdateHPA(hpa *autoscalingV2.HorizontalPodAutoscaler) (*autoscalingV2.HorizontalPodAutoscaler, error)

UpdateHPA updates the given horizontal pod autoscaler in the cluster.

func (*K8s) UpdateNamespace 

func (k *K8s) UpdateNamespace(namespace *corev1.Namespace) (*corev1.Namespace, error)

UpdateNamespace updates the given namespace in the cluster.

func (*K8s) UpdateServiceAccount added in v0.24.0 

func (k *K8s) UpdateServiceAccount(svcAccount *corev1.ServiceAccount) (*corev1.ServiceAccount, error)

UpdateServiceAccount updates the given service account in the cluster.

func (*K8s) WaitForHealthyCluster 

func (k *K8s) WaitForHealthyCluster(timeout time.Duration) error

WaitForHealthyCluster checks for an available K8s cluster every second until timeout.

func (*K8s) WaitForPodsAndContainers 

func (k *K8s) WaitForPodsAndContainers(target PodLookup, include PodFilter) []corev1.Pod

WaitForPodsAndContainers attempts to find pods matching the given selector and optional inclusion filter It will wait up to 90 seconds for the pods to be found and will return a list of matching pod names If the timeout is reached, an empty list will be returned.

func (*K8s) WaitForServiceAccount added in v0.24.0 

func (k *K8s) WaitForServiceAccount(ns, name string, timeout time.Duration) (*corev1.ServiceAccount, error)

WaitForServiceAccount waits for a service account to be created in the cluster.

type Labels 

type Labels map[string]string

Labels is a map of K8s labels.

type Log 

type Log func(string, ...any)

Log is a function that logs a message.

type PodFilter 

type PodFilter func(pod corev1.Pod) bool

PodFilter is a function that returns true if the pod should be targeted for data injection or lookups.

type PodLookup 

type PodLookup struct {
	Namespace string `json:"namespace" jsonschema:"description=The namespace to target for data injection"`
	Selector  string `json:"selector" jsonschema:"description=The K8s selector to target for data injection"`
	Container string `json:"container" jsonschema:"description=The container to target for data injection"`
}

PodLookup is a struct for specifying a pod to target for data injection or lookups.

type ServiceInfo added in v0.30.0 

type ServiceInfo struct {
	Namespace string
	Name      string
	Port      int
}

ServiceInfo contains information necessary for connecting to a cluster service.

func ServiceInfoFromServiceURL added in v0.30.0 

func ServiceInfoFromServiceURL(serviceURL string) (*ServiceInfo, error)

ServiceInfoFromServiceURL takes a serviceURL and parses it to find the service info for connecting to the cluster. The string is expected to follow the following format: Example serviceURL: http://{SERVICE_NAME}.{NAMESPACE}.svc.cluster.local:{PORT}.

type Tunnel added in v0.30.0 

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

Tunnel is the main struct that configures and manages port forwarding tunnels to Kubernetes resources.

func (*Tunnel) Close added in v0.30.0 

func (tunnel *Tunnel) Close()

Close disconnects a tunnel connection by closing the StopChan, thereby stopping the goroutine.

func (*Tunnel) Connect added in v0.30.0 

func (tunnel *Tunnel) Connect() (string, error)

Connect will establish a tunnel to the specified target.

func (*Tunnel) Endpoint added in v0.30.0 

func (tunnel *Tunnel) Endpoint() string

Endpoint returns the tunnel ip address and port (i.e. for docker registries)

func (*Tunnel) ErrChan added in v0.32.0 

func (tunnel *Tunnel) ErrChan() chan error

ErrChan returns the tunnel's error channel

func (*Tunnel) FullURL added in v0.30.0 

func (tunnel *Tunnel) FullURL() string

FullURL returns the tunnel endpoint as a HTTP URL string with the urlSuffix appended.

func (*Tunnel) HTTPEndpoint added in v0.30.0 

func (tunnel *Tunnel) HTTPEndpoint() string

HTTPEndpoint returns the tunnel endpoint as a HTTP URL string.

func (*Tunnel) Wrap added in v0.32.0 

func (tunnel *Tunnel) Wrap(function func() error) error

Wrap takes a function that returns an error and wraps it to check for tunnel errors as well.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.