Documentation ¶
Overview ¶
Package kit for Kubernetes operators
Package k8sutil for Kubernetes helpers.
Package k8sutil for Kubernetes helpers.
Package k8sutil for Kubernetes helpers.
Package k8sutil for Kubernetes helpers.
Package k8sutil for Kubernetes helpers.
Package k8sutil for Kubernetes helpers.
Package k8sutil for Kubernetes helpers.
Package k8sutil for Kubernetes helpers.
Index ¶
- Constants
- Variables
- func AddLabelToDeployement(key, value string, d *v1.Deployment)
- func AddLabelToJob(key, value string, b *batchv1.Job)
- func AddLabelToPod(key, value string, p *corev1.PodTemplateSpec)
- func AddRookVersionLabelToDaemonSet(d *v1.DaemonSet)
- func AddRookVersionLabelToDeployment(d *v1.Deployment)
- func AddRookVersionLabelToJob(j *batch.Job)
- func AddRookVersionLabelToObjectMeta(meta *metav1.ObjectMeta)
- func AddRookVersionLabelToStatefulSet(ss *apps.StatefulSet)
- func AddUnreachableNodeToleration(podSpec *v1.PodSpec)
- func ApplyMultus(net rookv1.NetworkSpec, objectMeta *metav1.ObjectMeta) error
- func BaseKubernetesDeleteOptions() *metav1.DeleteOptions
- func BinariesMountInfo() (v1.EnvVar, v1.Volume, v1.VolumeMount)
- func ClusterDaemonEnvVars(image string) []v1.EnvVar
- func ConfigDirEnvVar(dataDir string) v1.EnvVar
- func ConfigOverrideEnvVar() v1.EnvVar
- func ConfigOverrideMount() v1.VolumeMount
- func ConfigOverrideVolume() v1.Volume
- func CreateDaemonSet(name, namespace string, clientset kubernetes.Interface, ds *apps.DaemonSet) error
- func CreateDeployment(name, namespace string, clientset kubernetes.Interface, dep *apps.Deployment) error
- func CreateOrUpdatePrometheusRule(prometheusRule *monitoringv1.PrometheusRule) (*monitoringv1.PrometheusRule, error)
- func CreateOrUpdateService(clientset kubernetes.Interface, namespace string, ...) (*v1.Service, error)
- func CreateOrUpdateServiceMonitor(serviceMonitorDefinition *monitoringv1.ServiceMonitor) (*monitoringv1.ServiceMonitor, error)
- func CreateStatefulSet(name, namespace string, clientset kubernetes.Interface, ss *apps.StatefulSet) error
- func DeleteBatchJob(clientset kubernetes.Interface, namespace, name string, wait bool) error
- func DeleteConfigMap(clientset kubernetes.Interface, cmName, namespace string, opts *DeleteOptions) error
- func DeleteDaemonset(clientset kubernetes.Interface, namespace, name string) error
- func DeleteDeployment(clientset kubernetes.Interface, namespace, name string) error
- func DeleteReplicaSet(clientset kubernetes.Interface, namespace, name string) error
- func DeleteResource(delete func() error, verify func() error, resource string, opts *DeleteOptions, ...) error
- func GenerateNodeAffinity(nodeAffinity string) (*v1.NodeAffinity, error)
- func GetContainerImage(pod *v1.Pod, name string) (string, error)
- func GetDaemonsets(clientset kubernetes.Interface, namespace, labelSelector string) (*apps.DaemonSetList, error)
- func GetDeploymentImage(clientset kubernetes.Interface, namespace, name, container string) (string, error)
- func GetDeploymentSpecImage(clientset kubernetes.Interface, d apps.Deployment, container string, ...) (string, error)
- func GetDeployments(clientset kubernetes.Interface, namespace, labelSelector string) (*apps.DeploymentList, error)
- func GetK8SVersion(clientset kubernetes.Interface) (*version.Version, error)
- func GetKubernetesNodesMatchingRookNodes(rookNodes []rookv1.Node, clientset kubernetes.Interface) ([]v1.Node, error)
- func GetMatchingContainer(containers []v1.Container, name string) (v1.Container, error)
- func GetMultusIfName(selector string) (string, error)
- func GetNodeHostName(clientset kubernetes.Interface, nodeName string) (string, error)
- func GetNodeHostNameLabel(node *v1.Node) (string, error)
- func GetNodeHostNames(clientset kubernetes.Interface) (map[string]string, error)
- func GetNodeNameFromHostname(clientset kubernetes.Interface, hostName string) (string, error)
- func GetNodeSchedulable(node v1.Node) bool
- func GetOperatorSetting(clientset kubernetes.Interface, settingName, defaultValue string) (string, error)
- func GetPodLog(clientset kubernetes.Interface, namespace string, labelSelector string) (string, error)
- func GetPodPhaseMap(pods *v1.PodList) map[v1.PodPhase][]string
- func GetPrometheusRule(ruleFilePath string) (*monitoringv1.PrometheusRule, error)
- func GetRunningPod(clientset kubernetes.Interface) (*v1.Pod, error)
- func GetServiceMonitor(filePath string) (*monitoringv1.ServiceMonitor, error)
- func GetSpecContainerImage(spec v1.PodSpec, name string, initContainer bool) (string, error)
- func GetValidNodes(rookStorage rookv1.StorageScopeSpec, clientset kubernetes.Interface, ...) []rookv1.Node
- func Hash(s string) string
- func IndexToName(index int) string
- func MakeRookImage(version string) string
- func MergeResourceRequirements(first, second v1.ResourceRequirements) v1.ResourceRequirements
- func NameEnvVar() v1.EnvVar
- func NameToIndex(name string) (int, error)
- func NamespaceEnvVar() v1.EnvVar
- func NodeConfigURI() (string, error)
- func NodeEnvVar() v1.EnvVar
- func NodeIsInRookNodeList(targetNodeName string, rookNodes []rookv1.Node) bool
- func NodeIsReady(node v1.Node) bool
- func NodeIsTolerable(node v1.Node, tolerations []v1.Toleration, ignoreWellKnownTaints bool) bool
- func NodeMeetsAffinityTerms(node v1.Node, affinity *v1.NodeAffinity) (bool, error)
- func NodeMeetsPlacementTerms(node v1.Node, placement rookv1.Placement, ignoreWellKnownTaints bool) (bool, error)
- func ParseServiceType(serviceString string) v1.ServiceType
- func PathToVolumeName(path string) string
- func PodIPEnvVar(property string) v1.EnvVar
- func PodsRunningWithLabel(clientset kubernetes.Interface, namespace, label string) (int, error)
- func RookNodesMatchingKubernetesNodes(rookStorage rookv1.StorageScopeSpec, kubernetesNodes []v1.Node) []rookv1.Node
- func RunReplaceableJob(clientset kubernetes.Interface, job *batch.Job, deleteIfFound bool) error
- func SetNodeAntiAffinityForPod(pod *v1.PodSpec, p rookv1.Placement, ...)
- func SetOwnerRef(object *metav1.ObjectMeta, ownerRef *metav1.OwnerReference)
- func SetOwnerRefs(object *metav1.ObjectMeta, ownerRefs []metav1.OwnerReference)
- func SetOwnerRefsWithoutBlockOwner(object *metav1.ObjectMeta, ownerRefs []metav1.OwnerReference)
- func TaintIsWellKnown(t v1.Taint) bool
- func TruncateNodeName(format, nodeName string) string
- func UpdateDeploymentAndWait(context *clusterd.Context, modifiedDeployment *apps.Deployment, ...) (*v1.Deployment, error)
- func UpdateService(clientset kubernetes.Interface, namespace string, ...) (*v1.Service, error)
- func ValidNode(node v1.Node, placement rookv1.Placement) (bool, error)
- func ValidNodeNoSched(node v1.Node, placement rookv1.Placement) (bool, error)
- func WaitForDeploymentImage(clientset kubernetes.Interface, namespace, label, container string, ...) error
- func WaitForJobCompletion(clientset kubernetes.Interface, job *batch.Job, timeout time.Duration) error
- func WatchCR(resource CustomResource, namespace string, ...) error
- func YamlToTolerations(raw string) ([]v1.Toleration, error)
- type ConfigMapKVStore
- func (kv *ConfigMapKVStore) ClearStore(storeName string) error
- func (kv *ConfigMapKVStore) GetStore(storeName string) (map[string]string, error)
- func (kv *ConfigMapKVStore) GetValue(storeName, key string) (string, error)
- func (kv *ConfigMapKVStore) SetValue(storeName, key, value string) error
- func (kv *ConfigMapKVStore) SetValueWithLabels(storeName, key, value string, labels map[string]string) error
- type CustomResource
- type DeleteOptions
- type WaitOptions
Constants ¶
const ( // Namespace for rook Namespace = "rook" // DefaultNamespace for the cluster DefaultNamespace = "default" // DataDirVolume data dir volume DataDirVolume = "rook-data" // DataDir folder DataDir = "/var/lib/rook" // RookType for the CRD RookType = "kubernetes.io/rook" // PodNameEnvVar is the env variable for getting the pod name via downward api PodNameEnvVar = "POD_NAME" // PodNamespaceEnvVar is the env variable for getting the pod namespace via downward api PodNamespaceEnvVar = "POD_NAMESPACE" // NodeNameEnvVar is the env variable for getting the node via downward api NodeNameEnvVar = "NODE_NAME" // RookVersionLabelKey is the key used for reporting the Rook version which last created or // modified a resource. RookVersionLabelKey = "rook-version" )
const ( // AppAttr app label AppAttr = "app" // ClusterAttr cluster label ClusterAttr = "rook_cluster" // PublicIPEnvVar public IP env var PublicIPEnvVar = "ROOK_PUBLIC_IP" // PrivateIPEnvVar pod IP env var PrivateIPEnvVar = "ROOK_PRIVATE_IP" // DefaultRepoPrefix repo prefix DefaultRepoPrefix = "rook" // ConfigOverrideName config override name ConfigOverrideName = "rook-config-override" // ConfigOverrideVal config override value ConfigOverrideVal = "config" )
const ( // ReadyStatus reflects the completeness of tasks for ceph related CRs ReadyStatus = "Ready" // ProcessingStatus reflects that the tasks are in progress for ceph related CRs ProcessingStatus = "Processing" // FailedStatus reflects that some task failed for ceph related CRs FailedStatus = "Failed" )
const (
BinariesMountPath = "/rook"
)
const (
TopologyLabelPrefix = "topology.rook.io/"
)
Variables ¶
var WellKnownTaints = []string{ scheduler.TaintNodeNotReady, scheduler.TaintNodeUnreachable, scheduler.TaintNodeUnschedulable, scheduler.TaintNodeMemoryPressure, scheduler.TaintNodeDiskPressure, scheduler.TaintNodeNetworkUnavailable, scheduler.TaintNodePIDPressure, scheduler.TaintExternalCloudProvider, scheduler.TaintNodeShutdown, }
WellKnownTaints is a list of well-known taint keys in the Kubernetes code base. Kubernetes may automatically apply these taints to nodes during runtime. Most will be added with the `NoSchedule` affect, but some are created with `NoExecute`. Rook may wish to ignore these taints when decided whether to modify resources it creates based on whether taints are likely to have been added by Kubernetes or by the user. see: https://github.com/kubernetes/kubernetes/blob/master/pkg/scheduler/api/well_known_labels.go and: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/#taint-based-evictions
Functions ¶
func AddLabelToDeployement ¶
func AddLabelToDeployement(key, value string, d *v1.Deployment)
func AddLabelToJob ¶
func AddLabelToPod ¶
func AddLabelToPod(key, value string, p *corev1.PodTemplateSpec)
func AddRookVersionLabelToDaemonSet ¶
AddRookVersionLabelToDaemonSet adds or updates a label reporting the Rook version which last modified a DaemonSet.
func AddRookVersionLabelToDeployment ¶
func AddRookVersionLabelToDeployment(d *v1.Deployment)
AddRookVersionLabelToDeployment adds or updates a label reporting the Rook version which last modified a deployment.
func AddRookVersionLabelToJob ¶
AddRookVersionLabelToJob adds or updates a label reporting the Rook version which last modified a Job.
func AddRookVersionLabelToObjectMeta ¶
func AddRookVersionLabelToObjectMeta(meta *metav1.ObjectMeta)
func AddRookVersionLabelToStatefulSet ¶
func AddRookVersionLabelToStatefulSet(ss *apps.StatefulSet)
AddRookVersionLabelToStatefulSet adds or updates a label reporting the Rook version which last modified a apps.statefulset.
func AddUnreachableNodeToleration ¶
Replaces the pod default toleration of 300s used when the node controller detect a not ready node (node.kubernetes.io/unreachable)
func ApplyMultus ¶
func ApplyMultus(net rookv1.NetworkSpec, objectMeta *metav1.ObjectMeta) error
ApplyMultus apply multus selector to Pods Multus supports short and json syntax, use only one kind at a time.
func BaseKubernetesDeleteOptions ¶
func BaseKubernetesDeleteOptions() *metav1.DeleteOptions
BaseKubernetesDeleteOptions returns the base set of Kubernetes delete options which most delete operations should use.
func BinariesMountInfo ¶
func ClusterDaemonEnvVars ¶
ClusterDaemonEnvVars Environment variables used by storage cluster daemon
func ConfigDirEnvVar ¶
ConfigDirEnvVar config dir env var
func ConfigOverrideEnvVar ¶
ConfigOverrideEnvVar config override env var
func ConfigOverrideMount ¶
func ConfigOverrideMount() v1.VolumeMount
ConfigOverrideMount is an override mount
func ConfigOverrideVolume ¶
ConfigOverrideVolume is an override volume
func CreateDaemonSet ¶
func CreateDaemonSet(name, namespace string, clientset kubernetes.Interface, ds *apps.DaemonSet) error
CreateDaemonSet creates
func CreateDeployment ¶
func CreateDeployment(name, namespace string, clientset kubernetes.Interface, dep *apps.Deployment) error
func CreateOrUpdatePrometheusRule ¶
func CreateOrUpdatePrometheusRule(prometheusRule *monitoringv1.PrometheusRule) (*monitoringv1.PrometheusRule, error)
CreateOrUpdatePrometheusRule creates a prometheusRule object or an error
func CreateOrUpdateService ¶
func CreateOrUpdateService( clientset kubernetes.Interface, namespace string, serviceDefinition *v1.Service, ) (*v1.Service, error)
CreateOrUpdateService creates a service or updates the service declaratively if it already exists.
func CreateOrUpdateServiceMonitor ¶
func CreateOrUpdateServiceMonitor(serviceMonitorDefinition *monitoringv1.ServiceMonitor) (*monitoringv1.ServiceMonitor, error)
CreateOrUpdateServiceMonitor creates serviceMonitor object or an error
func CreateStatefulSet ¶
func CreateStatefulSet(name, namespace string, clientset kubernetes.Interface, ss *apps.StatefulSet) error
create a apps.statefulset
func DeleteBatchJob ¶
func DeleteBatchJob(clientset kubernetes.Interface, namespace, name string, wait bool) error
DeleteBatchJob deletes a Kubernetes job.
func DeleteConfigMap ¶
func DeleteConfigMap(clientset kubernetes.Interface, cmName, namespace string, opts *DeleteOptions) error
DeleteConfigMap deletes a ConfigMap.
func DeleteDaemonset ¶
func DeleteDaemonset(clientset kubernetes.Interface, namespace, name string) error
DeleteDaemonset makes a best effort at deleting a daemonset and its pods, then waits for them to be deleted
func DeleteDeployment ¶
func DeleteDeployment(clientset kubernetes.Interface, namespace, name string) error
DeleteDeployment makes a best effort at deleting a deployment and its pods, then waits for them to be deleted
func DeleteReplicaSet ¶
func DeleteReplicaSet(clientset kubernetes.Interface, namespace, name string) error
DeleteReplicaSet makes a best effort at deleting a deployment and its pods, then waits for them to be deleted
func DeleteResource ¶
func DeleteResource( delete func() error, verify func() error, resource string, opts *DeleteOptions, defaultWaitOptions *WaitOptions, ) error
DeleteResource implements the DeleteOptions logic around deletion of a Kubernetes resource.
The delete and verify functions used as parameters should implement and return the error from the Kubernetes `Delete` and `Get` commands respectively.
The resource string will be used to report the resource in log and error messages. A good pattern would be to set this string to the resource type (e.g., Deployment) and the name of the resource (e.g., my-deployment).
The default wait options should specify sane defaults for retry count and retry interval for deletion of the specific resource type. Only retry count and interval will be used from this parameter.
func GenerateNodeAffinity ¶
func GenerateNodeAffinity(nodeAffinity string) (*v1.NodeAffinity, error)
GenerateNodeAffinity will return v1.NodeAffinity or error
func GetContainerImage ¶
GetContainerImage returns the container image matching the given name for a pod. If the pod only has a single container, the name argument is ignored.
func GetDaemonsets ¶
func GetDaemonsets(clientset kubernetes.Interface, namespace, labelSelector string) (*apps.DaemonSetList, error)
GetDaemonsets returns a list of daemonsets names labels matching a given selector example of a label selector might be "app=rook-ceph-mon, mon!=b" more: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
func GetDeploymentImage ¶
func GetDeploymentImage(clientset kubernetes.Interface, namespace, name, container string) (string, error)
GetDeploymentImage returns the version of the image running in the pod spec for the desired container
func GetDeploymentSpecImage ¶
func GetDeploymentSpecImage(clientset kubernetes.Interface, d apps.Deployment, container string, initContainer bool) (string, error)
GetDeploymentSpecImage returns the image name from the spec
func GetDeployments ¶
func GetDeployments(clientset kubernetes.Interface, namespace, labelSelector string) (*apps.DeploymentList, error)
GetDeployments returns a list of deployment names labels matching a given selector example of a label selector might be "app=rook-ceph-mon, mon!=b" more: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
func GetK8SVersion ¶
func GetK8SVersion(clientset kubernetes.Interface) (*version.Version, error)
GetK8SVersion gets the version of the running K8S cluster
func GetKubernetesNodesMatchingRookNodes ¶
func GetKubernetesNodesMatchingRookNodes(rookNodes []rookv1.Node, clientset kubernetes.Interface) ([]v1.Node, error)
GetKubernetesNodesMatchingRookNodes lists all the nodes in Kubernetes and returns all the Kubernetes nodes that have a corresponding match in the list of Rook nodes.
func GetMatchingContainer ¶
GetMatchingContainer takes a list of containers and a name, and returns the first container in the list matching the name. If the list contains a single container it is always returned, even if the name does not match.
func GetMultusIfName ¶
GetMultusIfName return a network interface name that multus will assign when connected to the multus network.
func GetNodeHostName ¶
func GetNodeHostName(clientset kubernetes.Interface, nodeName string) (string, error)
GetNodeHostName returns the hostname label given the node name.
func GetNodeHostNames ¶
func GetNodeHostNames(clientset kubernetes.Interface) (map[string]string, error)
GetNodeHostNames returns the name of the node resource mapped to their hostname label. Typically these will be the same name, but sometimes they are not such as when nodes have a longer dns name, but the hostname is short.
func GetNodeNameFromHostname ¶
func GetNodeNameFromHostname(clientset kubernetes.Interface, hostName string) (string, error)
GetNodeNameFromHostname returns the name of the node resource looked up by the hostname label Typically these will be the same name, but sometimes they are not such as when nodes have a longer dns name, but the hostname is short.
func GetNodeSchedulable ¶
GetNodeSchedulable returns a boolean if the node is tainted as Schedulable or not true -> Node is schedulable false -> Node is unschedulable
func GetOperatorSetting ¶
func GetOperatorSetting(clientset kubernetes.Interface, settingName, defaultValue string) (string, error)
GetOperatorSetting gets the operator setting from ConfigMap or Env Var returns defaultValue if setting is not found
func GetPodLog ¶
func GetPodLog(clientset kubernetes.Interface, namespace string, labelSelector string) (string, error)
GetJobLog gets the logs for the pod. If there is more than one pod with the label selector, the logs from the first pod will be returned.
func GetPodPhaseMap ¶
GetPodPhaseMap takes a list of pods and returns a map of pod phases to the names of pods that are in that phase
func GetPrometheusRule ¶
func GetPrometheusRule(ruleFilePath string) (*monitoringv1.PrometheusRule, error)
GetPrometheusRule returns provided prometheus rules or an error
func GetRunningPod ¶
func GetRunningPod(clientset kubernetes.Interface) (*v1.Pod, error)
GetRunningPod reads the name and namespace of a pod from the environment, and returns the pod (if it exists).
func GetServiceMonitor ¶
func GetServiceMonitor(filePath string) (*monitoringv1.ServiceMonitor, error)
GetServiceMonitor returns servicemonitor or an error
func GetSpecContainerImage ¶
GetSpecContainerImage returns the container image for a podspec, given a container name. The name is ignored if the podspec has a single container, in which case the image for that container is returned.
func GetValidNodes ¶
func GetValidNodes(rookStorage rookv1.StorageScopeSpec, clientset kubernetes.Interface, placement rookv1.Placement) []rookv1.Node
GetValidNodes returns all nodes that (1) are not cordoned, (2) meet Rook's placement terms, and (3) are ready.
func Hash ¶
Hash stableName computes a stable pseudorandom string suitable for inclusion in a Kubernetes object name from the given seed string.
func IndexToName ¶
IndexToName converts an index to a daemon name based on as few letters of the alphabet as possible. For example:
0 -> a 1 -> b 25 -> z 26 -> aa
func MakeRookImage ¶
MakeRookImage formats the container name
func MergeResourceRequirements ¶
func MergeResourceRequirements(first, second v1.ResourceRequirements) v1.ResourceRequirements
func NameToIndex ¶
NameToIndex converts a daemon name to an index, which is the inverse of IndexToName For example:
a -> 0 b -> 1
func NodeConfigURI ¶
NodeConfigURI returns the node config URI path for this node
func NodeIsInRookNodeList ¶
NodeIsInRookNodeList will return true if the target node is found in a given list of Rook nodes.
func NodeIsReady ¶
NodeIsReady returns true if the node is ready. It returns false if the node is not ready.
func NodeIsTolerable ¶
NodeIsTolerable returns true if the node's taints are all tolerated by the given tolerations. There is the option to ignore well known taints defined in WellKnownTaints. See WellKnownTaints for more information.
func NodeMeetsAffinityTerms ¶
NodeMeetsAffinityTerms returns true if the node meets the terms of the node affinity. `PreferredDuringSchedulingIgnoredDuringExecution` terms are ignored and not used to judge a node's usability.
func NodeMeetsPlacementTerms ¶
func NodeMeetsPlacementTerms(node v1.Node, placement rookv1.Placement, ignoreWellKnownTaints bool) (bool, error)
NodeMeetsPlacementTerms returns true if the Rook placement allows the node to have resources scheduled on it. A node is placeable if it (1) meets any affinity terms that may be set in the placement, and (2) its taints are tolerated by the placements tolerations. There is the option to ignore well known taints defined in WellKnownTaints. See WellKnownTaints for more information.
func ParseServiceType ¶
func ParseServiceType(serviceString string) v1.ServiceType
ParseServiceType parses a string and returns a*v1.ServiceType. If the ServiceType is invalid, this should be considered an error.
func PathToVolumeName ¶
PathToVolumeName converts a path to a valid volume name
func PodIPEnvVar ¶
PodIPEnvVar returns an env var such that the pod's ip will be mapped to the given property (env var) name within the container.
func PodsRunningWithLabel ¶
func PodsRunningWithLabel(clientset kubernetes.Interface, namespace, label string) (int, error)
PodsRunningWithLabel returns the number of running pods with the given label
func RookNodesMatchingKubernetesNodes ¶
func RookNodesMatchingKubernetesNodes(rookStorage rookv1.StorageScopeSpec, kubernetesNodes []v1.Node) []rookv1.Node
RookNodesMatchingKubernetesNodes returns only the given Rook nodes which have a corresponding match in the list of Kubernetes nodes.
func RunReplaceableJob ¶
RunReplaceableJob runs a Kubernetes job with the intention that the job can be replaced by another call to this function with the same job name. For example, if a storage operator is restarted/updated before the job can complete, the operator's next run of the job should replace the previous job if deleteIfFound is set to true.
func SetNodeAntiAffinityForPod ¶
func SetNodeAntiAffinityForPod(pod *v1.PodSpec, p rookv1.Placement, requiredDuringScheduling, preferredDuringScheduling bool, labels, nodeSelector map[string]string)
SetNodeAntiAffinityForPod assign pod anti-affinity when pod should not be co-located
func SetOwnerRef ¶
func SetOwnerRef(object *metav1.ObjectMeta, ownerRef *metav1.OwnerReference)
func SetOwnerRefs ¶
func SetOwnerRefs(object *metav1.ObjectMeta, ownerRefs []metav1.OwnerReference)
func SetOwnerRefsWithoutBlockOwner ¶
func SetOwnerRefsWithoutBlockOwner(object *metav1.ObjectMeta, ownerRefs []metav1.OwnerReference)
func TaintIsWellKnown ¶
TaintIsWellKnown returns true if the taint's key is in the WellKnownTaints list. False otherwise. See WellKnownTaints for more information.
func TruncateNodeName ¶
TruncateNodeName hashes the nodeName in case it would case the name to be longer than 63 characters WARNING If your format and nodeName as a hash, are longer than 63 chars it won't be truncated! Your format alone should only be 31 chars at max because of MD5 hash being 32 chars. For more information, see the following resources: https://stackoverflow.com/a/50451893 https://stackoverflow.com/a/32294443
func UpdateDeploymentAndWait ¶
func UpdateDeploymentAndWait(context *clusterd.Context, modifiedDeployment *apps.Deployment, namespace string, verifyCallback func(action string) error) (*v1.Deployment, error)
UpdateDeploymentAndWait updates a deployment and waits until it is running to return. It will error if the deployment does not exist to be updated or if it takes too long. This method has a generic callback function that each backend can rely on It serves two purposes:
- verify that a resource can be stopped
- verify that we can continue the update procedure
Basically, we go one resource by one and check if we can stop and then if the resource has been successfully updated we check if we can go ahead and move to the next one.
func UpdateService ¶
func UpdateService( clientset kubernetes.Interface, namespace string, serviceDefinition *v1.Service, ) (*v1.Service, error)
UpdateService updates a service declaratively. If the service does not exist this is considered an error condition.
func ValidNode ¶
ValidNode returns true if the node (1) is schedulable, (2) meets Rook's placement terms, and (3) is ready. False otherwise.
func ValidNodeNoSched ¶
ValidNodeNoSched returns true if the node (1) meets Rook's placement terms, and (2) is ready. Unlike ValidNode, this method will ignore the Node.Spec.Unschedulable flag. False otherwise.
func WaitForDeploymentImage ¶
func WaitForDeploymentImage(clientset kubernetes.Interface, namespace, label, container string, initContainer bool, desiredImage string) error
WaitForDeploymentImage waits for all deployments with the given labels are running. WARNING:This is currently only useful for testing!
func WaitForJobCompletion ¶
func WaitForJobCompletion(clientset kubernetes.Interface, job *batch.Job, timeout time.Duration) error
WaitForJobCompletion waits for a job to reach the completed state. Assumes that only one pod needs to complete.
func WatchCR ¶
func WatchCR(resource CustomResource, namespace string, handlers cache.ResourceEventHandlerFuncs, client rest.Interface, objType runtime.Object, done <-chan struct{}) error
WatchCR begins watching the custom resource (CRD). The call will block until a Done signal is raised during in the context. When the watch has detected a create, update, or delete event, it will handled by the functions in the resourceEventHandlers. After the callback returns, the watch loop will continue for the next event. If the callback returns an error, the error will be logged.
func YamlToTolerations ¶
func YamlToTolerations(raw string) ([]v1.Toleration, error)
This function takes raw YAML string and converts it to Kubernetes Tolerations array
Types ¶
type ConfigMapKVStore ¶
type ConfigMapKVStore struct {
// contains filtered or unexported fields
}
func NewConfigMapKVStore ¶
func NewConfigMapKVStore(namespace string, clientset kubernetes.Interface, ownerRef metav1.OwnerReference) *ConfigMapKVStore
func (*ConfigMapKVStore) ClearStore ¶
func (kv *ConfigMapKVStore) ClearStore(storeName string) error
func (*ConfigMapKVStore) GetStore ¶
func (kv *ConfigMapKVStore) GetStore(storeName string) (map[string]string, error)
func (*ConfigMapKVStore) GetValue ¶
func (kv *ConfigMapKVStore) GetValue(storeName, key string) (string, error)
func (*ConfigMapKVStore) SetValue ¶
func (kv *ConfigMapKVStore) SetValue(storeName, key, value string) error
func (*ConfigMapKVStore) SetValueWithLabels ¶
func (kv *ConfigMapKVStore) SetValueWithLabels(storeName, key, value string, labels map[string]string) error
type CustomResource ¶
type CustomResource struct { // Name of the custom resource Name string // Plural of the custom resource in plural Plural string // Group the custom resource belongs to Group string // Version which should be defined in a const above Version string // Kind is the serialized interface of the resource. Kind string }
CustomResource is for creating a Kubernetes TPR/CRD
type DeleteOptions ¶
type DeleteOptions struct { // MustDelete controls the idempotency of the delete operation. If MustDelete is true and the // resource being deleted does not exist, the delete operation is considered a failure. If // MustDelete is false and the resource being deleted does not exist, the delete operation is // considered a success. MustDelete bool // DeleteOptions is a superset of WaitOptions. WaitOptions }
DeleteOptions are a common set of options controlling the behavior of k8sutil delete operations. DeleteOptions is a superset of WaitOptions.
type WaitOptions ¶
type WaitOptions struct { // Wait defines whether the operation should wait in a loop and verify that the operation was // successful before returning. Wait bool // RetryCount defines how many times the operation should retry verification in the wait loop // before giving up. If RetryCount is zero, the operation should default to a sane value based // on the operation. RetryCount uint // RetryInterval defines the time the operation will wait before retrying verification. If // RetryInterval is zero, the operation should default to a sane value based on the operation. RetryInterval time.Duration // ErrorOnTimeout defines whether the operation should time out with an error. If ErrorOnTimeout // is true and the operation times out, the operation is considered a failure. If ErrorOnTimeout // is false and the operation times out, the operation should log a warning but not not report // failure. ErrorOnTimeout bool }
WaitOptions are a common set of options controlling the behavior of k8sutil operations. If WaitOptions are specified, the operation should wait in a loop and verify that the operation being performed was successful.