kube

Documentation

Overview

Package kube provides primitives for working with Kubernetes objects.

Index

• func AggregateImagePullSecretsData(images ContainerImages, credentials map[string]docker.Auth) map[string][]byte
• func ComputeHash(obj interface{}) string
• func DeepHashObject(hasher hash.Hash, objectToWrite interface{})
• func GVRForResource(mapper meta.RESTMapper, resource string) (gvr schema.GroupVersionResource, gvk schema.GroupVersionKind, err error)
• func GetActiveDeadlineSeconds(d time.Duration) *int64
• func GetPodSpec(obj client.Object) (corev1.PodSpec, error)
• func GetTerminatedContainersStatusesByPod(pod *corev1.Pod) map[string]*corev1.ContainerStateTerminated
• func IsBuiltInWorkload(controller *metav1.OwnerReference) bool
• func KindForObject(object metav1.Object, scheme *runtime.Scheme) (string, error)
• func MapContainerNamesToDockerAuths(images ContainerImages, secrets []corev1.Secret) (map[string]docker.Auth, error)
• func MapDockerRegistryServersToAuths(imagePullSecrets []corev1.Secret) (map[string]docker.Auth, error)
• func NewImagePullSecret(meta metav1.ObjectMeta, server, username, password string) (*corev1.Secret, error)
• func NewRunnableJob(scheme *runtime.Scheme, clientset kubernetes.Interface, job *batchv1.Job, ...) runner.Runnable
• type CRManager
  • func NewCRManager(clientset kubernetes.Interface, clientsetext extapi.ApiextensionsV1Interface, ...) *CRManager
  • func (m *CRManager) Cleanup(ctx context.Context) (err error)
  • func (m *CRManager) Init(ctx context.Context) error
• type ContainerImages
  • func GetContainerImagesFromJob(job *batchv1.Job) (ContainerImages, error)
  • func GetContainerImagesFromPodSpec(spec corev1.PodSpec) ContainerImages
  • func (ci ContainerImages) AsJSON() (string, error)
  • func (ci ContainerImages) FromJSON(value string) error
• type Kind
• type LogsReader
  • func NewLogsReader(clientset kubernetes.Interface) LogsReader
• type Object
  • func GetPartialObjectFromKindAndNamespacedName(kind Kind, name types.NamespacedName) Object
  • func ObjectFromLabelsSet(set labels.Set) (Object, error)
• type ObjectResolver
  • func (o *ObjectResolver) GetObjectFromPartialObject(ctx context.Context, workload Object) (client.Object, error)
  • func (o *ObjectResolver) GetRelatedReplicasetName(ctx context.Context, object Object) (string, error)
• type ScannerOpts
• type SecretsReader
  • func NewSecretsReader(client client.Client) SecretsReader

Functions

func AggregateImagePullSecretsData

func AggregateImagePullSecretsData(images ContainerImages, credentials map[string]docker.Auth) map[string][]byte

func ComputeHash

func ComputeHash(obj interface{}) string

ComputeHash returns a hash value calculated from a given object. The hash will be safe encoded to avoid bad words.

func DeepHashObject

func DeepHashObject(hasher hash.Hash, objectToWrite interface{})

DeepHashObject writes specified object to hash using the spew library which follows pointers and prints actual values of the nested objects ensuring the hash does not change when a pointer changes.

func GVRForResource

func GVRForResource(mapper meta.RESTMapper, resource string) (gvr schema.GroupVersionResource, gvk schema.GroupVersionKind, err error)

func GetActiveDeadlineSeconds

func GetActiveDeadlineSeconds(d time.Duration) *int64

func GetPodSpec

func GetPodSpec(obj client.Object) (corev1.PodSpec, error)

GetPodSpec returns v1.PodSpec from the specified Kubernetes client.Object. Returns error if the given client.Object is not a Kubernetes workload.

func GetTerminatedContainersStatusesByPod

func GetTerminatedContainersStatusesByPod(pod *corev1.Pod) map[string]*corev1.ContainerStateTerminated

func IsBuiltInWorkload

func IsBuiltInWorkload(controller *metav1.OwnerReference) bool

IsBuiltInWorkload returns true if the specified v1.OwnerReference is a built-in Kubernetes workload, false otherwise.

func KindForObject

func KindForObject(object metav1.Object, scheme *runtime.Scheme) (string, error)

func MapContainerNamesToDockerAuths

func MapContainerNamesToDockerAuths(images ContainerImages, secrets []corev1.Secret) (map[string]docker.Auth, error)

MapContainerNamesToDockerAuths creates the mapping from a container name to the Docker authentication credentials for the specified kube.ContainerImages and image pull Secrets.

func MapDockerRegistryServersToAuths

func MapDockerRegistryServersToAuths(imagePullSecrets []corev1.Secret) (map[string]docker.Auth, error)

MapDockerRegistryServersToAuths creates the mapping from a Docker registry server to the Docker authentication credentials for the specified slice of image pull Secrets.

func NewImagePullSecret

func NewImagePullSecret(meta metav1.ObjectMeta, server, username, password string) (*corev1.Secret, error)

NewImagePullSecret constructs a new image pull Secret with the specified registry server and basic authentication credentials.

func NewRunnableJob

func NewRunnableJob(
	scheme *runtime.Scheme,
	clientset kubernetes.Interface,
	job *batchv1.Job,
	secrets ...*corev1.Secret,
) runner.Runnable

NewRunnableJob constructs a new Runnable task defined as Kubernetes job configuration and secrets that it references.

Types

type CRManager

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

func NewCRManager

func NewCRManager(
	clientset kubernetes.Interface,
	clientsetext extapi.ApiextensionsV1Interface,
	configManager starboard.ConfigManager,
) *CRManager

NewCRManager constructs a CRManager with the given starboard.ConfigManager and kubernetes.Interface.

func (*CRManager) Cleanup

func (m *CRManager) Cleanup(ctx context.Context) (err error)

func (*CRManager) Init

func (m *CRManager) Init(ctx context.Context) error

type ContainerImages

type ContainerImages map[string]string

ContainerImages is a simple structure to hold the mapping between container names and container image references.

func GetContainerImagesFromJob

func GetContainerImagesFromJob(job *batchv1.Job) (ContainerImages, error)

GetContainerImagesFromJob returns a map of container names to container images from the specified v1.Job. The mapping is encoded as JSON value of the AnnotationContainerImages annotation.

func GetContainerImagesFromPodSpec

func GetContainerImagesFromPodSpec(spec corev1.PodSpec) ContainerImages

GetContainerImagesFromPodSpec returns a map of container names to container images from the specified v1.PodSpec.

func (ContainerImages) AsJSON

func (ci ContainerImages) AsJSON() (string, error)

func (ContainerImages) FromJSON

func (ci ContainerImages) FromJSON(value string) error

type Kind

type Kind string

Kind represents the type of a Kubernetes Object.

const (
	KindUnknown Kind = "Unknown"

	KindNode      Kind = "Node"
	KindNamespace Kind = "Namespace"

	KindPod                   Kind = "Pod"
	KindReplicaSet            Kind = "ReplicaSet"
	KindReplicationController Kind = "ReplicationController"
	KindDeployment            Kind = "Deployment"
	KindStatefulSet           Kind = "StatefulSet"
	KindDaemonSet             Kind = "DaemonSet"
	KindCronJob               Kind = "CronJob"
	KindJob                   Kind = "Job"
)

type LogsReader

type LogsReader interface {
	GetLogsByJobAndContainerName(ctx context.Context, job *batchv1.Job, containerName string) (io.ReadCloser, error)
	GetTerminatedContainersStatusesByJob(ctx context.Context, job *batchv1.Job) (map[string]*corev1.ContainerStateTerminated, error)
}

func NewLogsReader

func NewLogsReader(clientset kubernetes.Interface) LogsReader

type Object

type Object struct {
	Kind      Kind
	Name      string
	Namespace string
}

TODO Rename from Object to PartialObject (consider embedding types.NamespacedName struct) Object is a simplified representation of a Kubernetes object. Each object has kind, which designates the type of the entity it represents. Objects have names and many of them live in namespaces.

func GetPartialObjectFromKindAndNamespacedName

func GetPartialObjectFromKindAndNamespacedName(kind Kind, name types.NamespacedName) Object

func ObjectFromLabelsSet

func ObjectFromLabelsSet(set labels.Set) (Object, error)

type ObjectResolver

type ObjectResolver struct {
	client.Client
}

func (*ObjectResolver) GetObjectFromPartialObject

func (o *ObjectResolver) GetObjectFromPartialObject(ctx context.Context, workload Object) (client.Object, error)

func (*ObjectResolver) GetRelatedReplicasetName

func (o *ObjectResolver) GetRelatedReplicasetName(ctx context.Context, object Object) (string, error)

GetRelatedReplicasetName attempts to find the replicaset that is associated with the given owner. If the owner is a Deployment, it will look for a ReplicaSet that is controlled by the Deployment. If the owner is a Pod, it will look for the ReplicaSet that owns the Pod.

type ScannerOpts

type ScannerOpts struct {
	ScanJobTimeout time.Duration
	DeleteScanJob  bool
}

ScannerOpts holds configuration of the vulnerability Scanner.

type SecretsReader

type SecretsReader interface {
	ListByLocalObjectReferences(ctx context.Context, refs []corev1.LocalObjectReference, ns string) ([]corev1.Secret, error)
	ListByServiceAccount(ctx context.Context, name string, ns string) ([]corev1.Secret, error)
	ListImagePullSecretsByPodSpec(ctx context.Context, spec corev1.PodSpec, ns string) ([]corev1.Secret, error)
}

SecretsReader defines methods for reading Secrets.

func NewSecretsReader

func NewSecretsReader(client client.Client) SecretsReader

NewSecretsReader constructs a new SecretsReader which is using the client package provided by the controller-runtime libraries for interacting with the Kubernetes API server.