kubernetes

package
v1.9.0 Latest Latest
Warning

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

 Go to latest Published: Aug 25, 2020 License: Apache-2.0, BSD-2-Clause, MIT, + 1 more Imports: 32 Imported by: 192

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BootstrapTokenFrom added in v0.33.0 

func BootstrapTokenFrom(data map[string][]byte) string

BootstrapTokenFrom returns the bootstrap token based on the secret data.

func ComputeBootstrapToken added in v0.33.0 

func ComputeBootstrapToken(ctx context.Context, c client.Client, tokenID, description string, validity time.Duration) (secret *corev1.Secret, err error)

ComputeBootstrapToken computes and creates a new bootstrap token, and returns it.

func CreateTwoWayMergePatch 

func CreateTwoWayMergePatch(obj1 metav1.Object, obj2 metav1.Object) ([]byte, error)

CreateTwoWayMergePatch creates a two way merge patch of the given objects. The two objects have to be pointers implementing the interfaces.

func DNSNamesForService added in v1.8.0 

func DNSNamesForService(name, namespace string) []string

DNSNamesForService returns the possible DNS names for a service with the given name and namespace.

func GetLoadBalancerIngress 

func GetLoadBalancerIngress(ctx context.Context, client client.Client, namespace, name string) (string, error)

GetLoadBalancerIngress takes a context, a client, a namespace and a service name. It queries for a load balancer's technical name (ip address or hostname). It returns the value of the technical name whereby it always prefers the hostname (if given) over the IP address. It also returns the list of all load balancer ingresses.

func HasDeletionTimestamp 

func HasDeletionTimestamp(obj runtime.Object) (bool, error)

HasDeletionTimestamp checks if an object has a deletion timestamp

func HasMetaDataAnnotation 

func HasMetaDataAnnotation(meta metav1.Object, key, value string) bool

HasMetaDataAnnotation checks if the passed meta object has the given key, value set in the annotations section.

func IsEmptyPatch 

func IsEmptyPatch(patch []byte) bool

IsEmptyPatch checks if the given patch is empty. A patch is considered empty if it is the empty string or if it json-decodes to an empty json map.

func Key 

func Key(namespaceOrName string, nameOpt ...string) client.ObjectKey

Key creates a new client.ObjectKey from the given parameters. There are only two ways to call this function:

  • If only namespaceOrName is set, then a client.ObjectKey with name set to namespaceOrName is returned.
  • If namespaceOrName and one nameOpt is given, then a client.ObjectKey with namespace set to namespaceOrName and name set to nameOpt[0] is returned.

For all other cases, this method panics.

func KeyFromObject 

func KeyFromObject(obj metav1.Object) client.ObjectKey

KeyFromObject obtains the client.ObjectKey from the given metav1.Object.

func LookupObject added in v1.7.0 

func LookupObject(ctx context.Context, c client.Client, apiReader client.Reader, key client.ObjectKey, obj runtime.Object) error

LookupObject retrieves an obj for the given object key dealing with potential stale cache that still does not contain the obj. It first tries to retrieve the obj using the given cached client. If the object key is not found, then it does live lookup from the API server using the given apiReader.

func ObjectMeta 

func ObjectMeta(namespaceOrName string, nameOpt ...string) metav1.ObjectMeta

ObjectMeta creates a new metav1.ObjectMeta from the given parameters. There are only two ways to call this function:

  • If only namespaceOrName is set, then a metav1.ObjectMeta with name set to namespaceOrName is returned.
  • If namespaceOrName and one nameOpt is given, then a metav1.ObjectMeta with namespace set to namespaceOrName and name set to nameOpt[0] is returned.

For all other cases, this method panics.

func ObjectMetaFromKey 

func ObjectMetaFromKey(key client.ObjectKey) metav1.ObjectMeta

ObjectMetaFromKey returns an ObjectMeta with the namespace and name set to the values from the key.

func ObjectName added in v1.8.0 

func ObjectName(obj runtime.Object) string

ObjectName returns the name of the given object in the format <namespace>/<name>

func SetMetaDataAnnotation 

func SetMetaDataAnnotation(meta metav1.Object, key, value string)

SetMetaDataAnnotation sets the annotation on the given object. If the given Object did not yet have annotations, they are initialized.

func SetMetaDataLabel 

func SetMetaDataLabel(meta metav1.Object, key, value string)

SetMetaDataLabel sets the key value pair in the labels section of the given Object. If the given Object did not yet have labels, they are initialized.

func SubmitEmptyPatch 

func SubmitEmptyPatch(ctx context.Context, c client.Client, obj runtime.Object) error

SubmitEmptyPatch submits an empty patch to the given `obj` with the given `client` instance.

func TruncateLabelValue 

func TruncateLabelValue(s string) string

TruncateLabelValue truncates a string at 63 characters so it's suitable for a label value.

func TryUpdate 

func TryUpdate(ctx context.Context, backoff wait.Backoff, c client.Client, obj runtime.Object, transform func() error) error

TryUpdate tries to apply the given transformation function onto the given object, and to update it afterwards. It retries the update with an exponential backoff.

func TryUpdateControllerInstallation 

func TryUpdateControllerInstallation(g gardencore.Interface, backoff wait.Backoff, meta metav1.ObjectMeta, transform func(*gardencorev1beta1.ControllerInstallation) (*gardencorev1beta1.ControllerInstallation, error)) (*gardencorev1beta1.ControllerInstallation, error)

TryUpdateControllerInstallation tries to update the status of the controllerInstallation matching the given <meta>. It retries with the given <backoff> characteristics as long as it gets Conflict errors. The transformation function is applied to the current state of the ControllerInstallation object. If the transformation yields a semantically equal ControllerInstallation, no update is done and the operation returns normally.

func TryUpdateControllerInstallationStatus 

func TryUpdateControllerInstallationStatus(g gardencore.Interface, backoff wait.Backoff, meta metav1.ObjectMeta, transform func(*gardencorev1beta1.ControllerInstallation) (*gardencorev1beta1.ControllerInstallation, error)) (*gardencorev1beta1.ControllerInstallation, error)

TryUpdateControllerInstallationStatus tries to update the status of the controllerInstallation matching the given <meta>. It retries with the given <backoff> characteristics as long as it gets Conflict errors. The transformation function is applied to the current state of the ControllerInstallation object. If the transformation yields a semantically equal ControllerInstallation, no update is done and the operation returns normally.

func TryUpdateControllerInstallationStatusWithEqualFunc 

func TryUpdateControllerInstallationStatusWithEqualFunc(g gardencore.Interface, backoff wait.Backoff, meta metav1.ObjectMeta, transform func(*gardencorev1beta1.ControllerInstallation) (*gardencorev1beta1.ControllerInstallation, error), equal func(cur, updated *gardencorev1beta1.ControllerInstallation) bool) (*gardencorev1beta1.ControllerInstallation, error)

TryUpdateControllerInstallationStatusWithEqualFunc tries to update the status of the controllerInstallation matching the given <meta>. It retries with the given <backoff> characteristics as long as it gets Conflict errors. The transformation function is applied to the current state of the ControllerInstallation object. If the equal func concludes a semantically equal ControllerInstallation, no update is done and the operation returns normally.

func TryUpdateControllerInstallationWithEqualFunc 

func TryUpdateControllerInstallationWithEqualFunc(g gardencore.Interface, backoff wait.Backoff, meta metav1.ObjectMeta, transform func(*gardencorev1beta1.ControllerInstallation) (*gardencorev1beta1.ControllerInstallation, error), equal func(cur, updated *gardencorev1beta1.ControllerInstallation) bool) (*gardencorev1beta1.ControllerInstallation, error)

TryUpdateControllerInstallationWithEqualFunc tries to update the status of the controllerInstallation matching the given <meta>. It retries with the given <backoff> characteristics as long as it gets Conflict errors. The transformation function is applied to the current state of the ControllerInstallation object. If the equal func concludes a semantically equal ControllerInstallation, no update is done and the operation returns normally.

func TryUpdateControllerRegistration 

func TryUpdateControllerRegistration(g gardencore.Interface, backoff wait.Backoff, meta metav1.ObjectMeta, transform func(*gardencorev1beta1.ControllerRegistration) (*gardencorev1beta1.ControllerRegistration, error)) (*gardencorev1beta1.ControllerRegistration, error)

TryUpdateControllerRegistration tries to update the status of the controllerRegistration matching the given <meta>. It retries with the given <backoff> characteristics as long as it gets Conflict errors. The transformation function is applied to the current state of the ControllerRegistration object. If the transformation yields a semantically equal ControllerRegistration, no update is done and the operation returns normally.

func TryUpdateControllerRegistrationWithEqualFunc 

func TryUpdateControllerRegistrationWithEqualFunc(g gardencore.Interface, backoff wait.Backoff, meta metav1.ObjectMeta, transform func(*gardencorev1beta1.ControllerRegistration) (*gardencorev1beta1.ControllerRegistration, error), equal func(cur, updated *gardencorev1beta1.ControllerRegistration) bool) (*gardencorev1beta1.ControllerRegistration, error)

TryUpdateControllerRegistrationWithEqualFunc tries to update the status of the controllerRegistration matching the given <meta>. It retries with the given <backoff> characteristics as long as it gets Conflict errors. The transformation function is applied to the current state of the ControllerRegistration object. If the equal func concludes a semantically equal ControllerRegistration, no update is done and the operation returns normally.

func TryUpdateNamespace 

func TryUpdateNamespace(k k8s.Interface, backoff wait.Backoff, meta metav1.ObjectMeta, transform func(*corev1.Namespace) (*corev1.Namespace, error)) (*corev1.Namespace, error)

TryUpdateNamespace tries to update a namespace and retries the operation with the given <backoff>.

func TryUpdateNamespaceLabels 

func TryUpdateNamespaceLabels(k k8s.Interface, backoff wait.Backoff, meta metav1.ObjectMeta, transform func(*corev1.Namespace) (*corev1.Namespace, error)) (*corev1.Namespace, error)

TryUpdateNamespaceLabels tries to update a namespace's labels and retries the operation with the given <backoff>.

func TryUpdateProject 

func TryUpdateProject(g gardencore.Interface, backoff wait.Backoff, meta metav1.ObjectMeta, transform func(*gardencorev1beta1.Project) (*gardencorev1beta1.Project, error)) (*gardencorev1beta1.Project, error)

TryUpdateProject tries to update a project and retries the operation with the given <backoff>.

func TryUpdateProjectStatus 

func TryUpdateProjectStatus(g gardencore.Interface, backoff wait.Backoff, meta metav1.ObjectMeta, transform func(*gardencorev1beta1.Project) (*gardencorev1beta1.Project, error)) (*gardencorev1beta1.Project, error)

TryUpdateProjectStatus tries to update a project's status and retries the operation with the given <backoff>.

func TryUpdateSeed 

func TryUpdateSeed(g gardencore.Interface, backoff wait.Backoff, meta metav1.ObjectMeta, transform func(*gardencorev1beta1.Seed) (*gardencorev1beta1.Seed, error)) (*gardencorev1beta1.Seed, error)

TryUpdateSeed tries to update the status of the seed matching the given <meta>. It retries with the given <backoff> characteristics as long as it gets Conflict errors. The transformation function is applied to the current state of the Seed object. If the transformation yields a semantically equal Seed, no update is done and the operation returns normally.

func TryUpdateSeedConditions added in v0.33.0 

func TryUpdateSeedConditions(g gardencore.Interface, backoff wait.Backoff, meta metav1.ObjectMeta, transform func(*gardencorev1beta1.Seed) (*gardencorev1beta1.Seed, error)) (*gardencorev1beta1.Seed, error)

TryUpdateSeedConditions tries to update the status of the seed matching the given <meta>. It retries with the given <backoff> characteristics as long as it gets Conflict errors. The transformation function is applied to the current state of the Seed object. If the transformation yields a semantically equal Seed (regarding conditions), no update is done and the operation returns normally.

func TryUpdateSeedStatus added in v0.33.0 

func TryUpdateSeedStatus(g gardencore.Interface, backoff wait.Backoff, meta metav1.ObjectMeta, transform func(*gardencorev1beta1.Seed) (*gardencorev1beta1.Seed, error)) (*gardencorev1beta1.Seed, error)

TryUpdateSeedStatus tries to update the status of the seed matching the given <meta>. It retries with the given <backoff> characteristics as long as it gets Conflict errors. The transformation function is applied to the current state of the Seed object. If the transformation yields a semantically equal Seed (regarding Status), no update is done and the operation returns normally.

func TryUpdateSeedWithEqualFunc 

func TryUpdateSeedWithEqualFunc(g gardencore.Interface, backoff wait.Backoff, meta metav1.ObjectMeta, transform func(*gardencorev1beta1.Seed) (*gardencorev1beta1.Seed, error), equal func(cur, updated *gardencorev1beta1.Seed) bool) (*gardencorev1beta1.Seed, error)

TryUpdateSeedWithEqualFunc tries to update the status of the seed matching the given <meta>. It retries with the given <backoff> characteristics as long as it gets Conflict errors. The transformation function is applied to the current state of the Seed object. If the equal func concludes a semantically equal Seed, no update is done and the operation returns normally.

func TryUpdateShoot 

func TryUpdateShoot(g gardencore.Interface, backoff wait.Backoff, meta metav1.ObjectMeta, transform func(*gardencorev1beta1.Shoot) (*gardencorev1beta1.Shoot, error)) (*gardencorev1beta1.Shoot, error)

TryUpdateShoot tries to update the shoot matching the given <meta>. It retries with the given <backoff> characteristics as long as it gets Conflict errors. The transformation function is applied to the current state of the Shoot object. If the transformation yields a semantically equal Shoot, no update is done and the operation returns normally.

func TryUpdateShootAnnotations 

func TryUpdateShootAnnotations(g gardencore.Interface, backoff wait.Backoff, meta metav1.ObjectMeta, transform func(*gardencorev1beta1.Shoot) (*gardencorev1beta1.Shoot, error)) (*gardencorev1beta1.Shoot, error)

TryUpdateShootAnnotations tries to update the annotations of the shoot matching the given <meta>. It retries with the given <backoff> characteristics as long as it gets Conflict errors. The transformation function is applied to the current state of the Shoot object. If the transformation yields a semantically equal Shoot (regarding conditions), no update is done and the operation returns normally.

func TryUpdateShootHibernation 

func TryUpdateShootHibernation(g gardencore.Interface, backoff wait.Backoff, meta metav1.ObjectMeta, transform func(*gardencorev1beta1.Shoot) (*gardencorev1beta1.Shoot, error)) (*gardencorev1beta1.Shoot, error)

TryUpdateShootHibernation tries to update the status of the shoot matching the given <meta>. It retries with the given <backoff> characteristics as long as it gets Conflict errors. The transformation function is applied to the current state of the Shoot object. If the transformation yields a semantically equal Shoot, no update is done and the operation returns normally.

func TryUpdateShootLabels 

func TryUpdateShootLabels(g gardencore.Interface, backoff wait.Backoff, meta metav1.ObjectMeta, transform func(*gardencorev1beta1.Shoot) (*gardencorev1beta1.Shoot, error)) (*gardencorev1beta1.Shoot, error)

TryUpdateShootLabels tries to update the status of the shoot matching the given <meta>. It retries with the given <backoff> characteristics as long as it gets Conflict errors. The transformation function is applied to the current state of the Shoot object. If the transformation yields a semantically equal Shoot (regarding labels), no update is done and the operation returns normally.

func TryUpdateShootStatus 

func TryUpdateShootStatus(g gardencore.Interface, backoff wait.Backoff, meta metav1.ObjectMeta, transform func(*gardencorev1beta1.Shoot) (*gardencorev1beta1.Shoot, error)) (*gardencorev1beta1.Shoot, error)

TryUpdateShootStatus tries to update the status of the shoot matching the given <meta>. It retries with the given <backoff> characteristics as long as it gets Conflict errors. The transformation function is applied to the current state of the Shoot object. If the transformation yields a semantically equal Shoot (regarding Status), no update is done and the operation returns normally.

func TryUpdateStatus 

func TryUpdateStatus(ctx context.Context, backoff wait.Backoff, c client.Client, obj runtime.Object, transform func() error) error

TryUpdateStatus tries to apply the given transformation function onto the given object, and to update its status afterwards. It retries the status update with an exponential backoff.

func ValidDeploymentContainerImageVersion 

func ValidDeploymentContainerImageVersion(deploymentToCheck *appsv1.Deployment, containerName, minimumVersion string) (bool, error)

ValidDeploymentContainerImageVersion validates compliance of a deployment container image to a minimum version

func WaitUntilResourceDeleted 

func WaitUntilResourceDeleted(ctx context.Context, c client.Client, obj runtime.Object, interval time.Duration) error

WaitUntilResourceDeleted deletes the given resource and then waits until it has been deleted. It respects the given interval and timeout.

func WaitUntilResourceDeletedWithDefaults 

func WaitUntilResourceDeletedWithDefaults(ctx context.Context, c client.Client, obj runtime.Object) error

WaitUntilResourceDeletedWithDefaults deletes the given resource and then waits until it has been deleted. It uses a default interval and timeout

func WaitUntilResourcesDeleted added in v1.1.0 

func WaitUntilResourcesDeleted(ctx context.Context, c client.Client, obj runtime.Object, interval time.Duration, opts ...client.ListOption) error

WaitUntilResourcesDeleted waits until the given resources are gone. It respects the given interval and timeout.

Types

type DaemonSetLister 

type DaemonSetLister interface {
	// List lists all DaemonSets that match the given selector.
	List(selector labels.Selector) ([]*appsv1.DaemonSet, error)
	// DaemonSets yields a DaemonSetNamespaceLister for the given namespace.
	DaemonSets(namespace string) DaemonSetNamespaceLister
}

DaemonSetLister is a lister of DaemonSets.

func NewDaemonSetLister 

func NewDaemonSetLister(source DaemonSetSource) DaemonSetLister

NewDaemonSetLister creates a new DaemonSetLister from the given DaemonSetSource.

type DaemonSetNamespaceLister 

type DaemonSetNamespaceLister interface {
	// List lists all DaemonSets that match the given selector in the current namespace.
	List(selector labels.Selector) ([]*appsv1.DaemonSet, error)
	// Get retrieves the DaemonSet with the given name in the current namespace.
	Get(name string) (*appsv1.DaemonSet, error)
}

DaemonSetNamespaceLister is a lister of deployments for a specific namespace.

type DaemonSetSource 

type DaemonSetSource func() ([]*appsv1.DaemonSet, error)

DaemonSetSource is a function that produces a slice of DaemonSets or an error.

type DeploymentLister 

type DeploymentLister interface {
	// List lists all Deployments that match the given selector.
	List(selector labels.Selector) ([]*appsv1.Deployment, error)
	// Deployments yields a DeploymentNamespaceLister for the given namespace.
	Deployments(namespace string) DeploymentNamespaceLister
}

DeploymentLister is a lister of Deployments.

func NewDeploymentLister 

func NewDeploymentLister(source DeploymentSource) DeploymentLister

NewDeploymentLister creates a new DeploymentLister from the given DeploymentSource.

type DeploymentNamespaceLister 

type DeploymentNamespaceLister interface {
	// List lists all Deployments that match the given selector in the current namespace.
	List(selector labels.Selector) ([]*appsv1.Deployment, error)
	// Get retrieves the Deployment with the given name in the current namespace.
	Get(name string) (*appsv1.Deployment, error)
}

DeploymentNamespaceLister is a lister of deployments for a specific namespace.

type DeploymentSource 

type DeploymentSource func() ([]*appsv1.Deployment, error)

DeploymentSource is a function that produces a slice of Deployments or an error.

type EtcdLister added in v1.2.0 

type EtcdLister interface {
	// List lists all Etcds that match the given selector.
	List(selector labels.Selector) ([]*druidv1alpha1.Etcd, error)
	// Etcds yields a EtcdNamespaceLister for the given namespace.
	Etcds(namespace string) EtcdNamespaceLister
}

EtcdLister is a lister of Etcds.

func NewEtcdLister added in v1.2.0 

func NewEtcdLister(source EtcdSource) EtcdLister

NewEtcdLister creates a new EtcdLister from the given EtcdSource.

type EtcdNamespaceLister added in v1.2.0 

type EtcdNamespaceLister interface {
	// List lists all Etcds that match the given selector in the current namespace.
	List(selector labels.Selector) ([]*druidv1alpha1.Etcd, error)
	// Get retrieves the Etcd with the given name in the current namespace.
	Get(name string) (*druidv1alpha1.Etcd, error)
}

EtcdNamespaceLister is a lister of etcds for a specific namespace.

type EtcdSource added in v1.2.0 

type EtcdSource func() ([]*druidv1alpha1.Etcd, error)

EtcdSource is a function that produces a slice of Etcds or an error.

type NodeLister 

type NodeLister interface {
	// List lists all Nodes that match the given selector.
	List(selector labels.Selector) ([]*corev1.Node, error)
}

NodeLister is a lister of Nodes.

func NewNodeLister 

func NewNodeLister(source NodeSource) NodeLister

NewNodeLister creates a new NodeLister from the given NodeSource.

type NodeSource 

type NodeSource func() ([]*corev1.Node, error)

NodeSource is a function that produces a slice of Nodes or an error.

type Object 

type Object interface {
	runtime.Object
	metav1.Object
}

Object is wrapper interface combining runtime.Object and metav1.Object interfaces together.

type StatefulSetLister 

type StatefulSetLister interface {
	// List lists all StatefulSets that match the given selector.
	List(selector labels.Selector) ([]*appsv1.StatefulSet, error)
	// StatefulSets yields a StatefulSetNamespaceLister for the given namespace.
	StatefulSets(namespace string) StatefulSetNamespaceLister
}

StatefulSetLister is a lister of StatefulSets.

func NewStatefulSetLister 

func NewStatefulSetLister(source StatefulSetSource) StatefulSetLister

NewStatefulSetLister creates a new StatefulSetLister form the given StatefulSetSource.

type StatefulSetNamespaceLister 

type StatefulSetNamespaceLister interface {
	// List lists all StatefulSets that match the given selector in the current namespace.
	List(selector labels.Selector) ([]*appsv1.StatefulSet, error)
	// Get retrieves the StatefulSet with the given name in the current namespace.
	Get(name string) (*appsv1.StatefulSet, error)
}

StatefulSetNamespaceLister is a lister of StatefulSets for a specific namespace.

type StatefulSetSource 

type StatefulSetSource func() ([]*appsv1.StatefulSet, error)

StatefulSetSource is a function that produces a slice of StatefulSets or an error.

type WorkerLister added in v0.34.0 

type WorkerLister interface {
	// List lists all Workers that match the given selector in the current namespace.
	List(selector labels.Selector) ([]*extensionsv1alpha1.Worker, error)
	// Workers yields a WorkerNamespaceLister for the given namespace.
	Workers(namespace string) WorkerNamespaceLister
}

WorkerLister is a lister of Workers for a specific namespace.

func NewWorkerLister added in v0.34.0 

func NewWorkerLister(source WorkerSource) WorkerLister

NewWorkerLister creates a new WorkerLister from the given WorkerSource.

type WorkerNamespaceLister added in v0.34.0 

type WorkerNamespaceLister interface {
	// List lists all Workers that match the given selector in the current namespace.
	List(selector labels.Selector) ([]*extensionsv1alpha1.Worker, error)
	// Get retrieves the MachineDeployment with the given name in the current namespace.
	Get(name string) (*extensionsv1alpha1.Worker, error)
}

WorkerNamespaceLister is a lister of Workers for a specific namespace.

type WorkerSource added in v0.34.0 

type WorkerSource func() ([]*extensionsv1alpha1.Worker, error)

WorkerSource is a function that produces a slice of Workers or an error.

Source Files

View all Source files

Directories

Path Synopsis

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.