AddRookVersionLabelToDaemonSet adds or updates a label reporting the Rook version which last modified a DaemonSet.

AddRookVersionLabelToDeployment adds or updates a label reporting the Rook version which last modified a deployment.

AddRookVersionLabelToJob adds or updates a label reporting the Rook version which last modified a Job.

Replaces the pod default toleration of 300s used when the node controller detect a not ready node (node.kubernetes.io/unreachable).

ApplyMultus apply multus selector to Pods Multus supports short and json syntax, use only one kind at a time.

BaseKubernetesDeleteOptions returns the base set of Kubernetes delete options which most delete operations should use.

ClusterDaemonEnvVars Environment variables used by storage cluster daemon.

ConfigDirEnvVar config dir env var.

ConfigOverrideEnvVar config override env var.

ConfigOverrideMount is an override mount.

ConfigOverrideVolume is an override volume.

CreateDaemonSet creates.

CreateDeployment creates a deployment with a last applied hash annotation added.

CreateOrUpdateEndpoint creates a service or updates the service declaratively if it already exists.

CreateOrUpdatePrometheusRule creates a prometheusRule object or an error.

CreateOrUpdateSecret creates a secret or updates the secret declaratively if it already exists.

CreateOrUpdateService creates a service or updates the service declaratively if it already exists.

CreateOrUpdateServiceMonitor creates serviceMonitor object or an error.

DeleteBatchJob deletes a Kubernetes job.

DeleteConfigMap deletes a ConfigMap.

DeleteDaemonset makes a best effort at deleting a daemonset and its pods, then waits for them to be deleted.

DeleteDeployment makes a best effort at deleting a deployment and its pods, then waits for them to be deleted.

DeleteReplicaSet makes a best effort at deleting a deployment and its pods, then waits for them to be deleted.

DeleteResource implements the DeleteOptions logic around deletion of a Kubernetes resource.

DeleteService deletes a Service and returns the error if any.

DeploymentNames returns a list of the names of deployments in the deployment list.

ExpandPVCIfRequired will expand the PVC if requested size is greater than the actual size of existing PVC.

GenerateNodeAffinity will return v1.NodeAffinity or error.

GetContainerImage returns the container image matching the given name for a pod.

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/.

GetDeploymentImage returns the version of the image running in the pod spec for the desired container.

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/.

GetDeploymentSpecImage returns the image name from the spec.

GetK8SVersion gets the version of the running K8S cluster.

GetKubernetesNodesMatchingRookNodes lists all the nodes in Kubernetes and returns all the Kubernetes nodes that have a corresponding match in the list of Rook nodes.

GetMatchingContainer takes a list of containers and a name, and returns the first container in the list matching the name.

GetNetworkAttachmentConfig returns the NetworkAttachmentDefinitions configuration.

GetNodeHostName returns the hostname label given the node name.

GetNodeHostNames returns the name of the node resource mapped to their hostname label.

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.

GetNodeSchedulable returns a boolean if the node is tainted as Schedulable or not true -> Node is schedulable false -> Node is unschedulable.

GetNotReadyKubernetesNodes lists all the nodes that are in NotReady state.

GetOperatorSetting gets the operator setting from ConfigMap or Env Var returns defaultValue if setting is not found.

GetJobLog gets the logs for the pod.

GetPodPhaseMap takes a list of pods and returns a map of pod phases to the names of pods that are in that phase.

GetPrometheusRule returns provided prometheus rules or an error.

GetRunningPod reads the name and namespace of a pod from the environment, and returns the pod (if it exists).

GetServiceMonitor returns servicemonitor or an error.

GetSpecContainerImage returns the container image for a podspec, given a container name.

GetValidNodes returns all nodes that (1) are not cordoned, (2) meet Rook's placement terms, and (3) are ready.

Hash stableName computes a stable pseudorandom string suitable for inclusion in a Kubernetes object name from the given seed string.

IndexToName converts an index to a daemon name based on as few letters of the alphabet as possible.

NameEnvVar pod name env var.

NamespaceEnvVar namespace env var.

NameToIndex converts a daemon name to an index, which is the inverse of IndexToName For example: a -> 0 b -> 1.

NewEventReporter returns EventReporter object.

NewOwnerInfo create a new ownerInfo to set ownerReference by controllerutil.

NewOwnerInfoWithOwnerRef create a new ownerInfo to set ownerReference by rook itself.

NodeConfigURI returns the node config URI path for this node.

NodeEnvVar node env var.

NodeIsReady returns true if the node is ready.

NodeIsTolerable returns true if the node's taints are all tolerated by the given tolerations.

NodeMeetsAffinityTerms returns true if the node meets the terms of the node affinity.

NodeMeetsPlacementTerms returns true if the Rook placement allows the node to have resources scheduled on it.

ParseServiceType parses a string and returns a*v1.ServiceType.

ParseStringToLabels parse a label selector string into a map[string]string.

PathToVolumeName converts a path to a valid volume name.

PodIPEnvVar returns an env var such that the pod's ip will be mapped to the given property (env var) name within the container.

PodsRunningWithLabel returns the number of running pods with the given label.

PodsWithLabelAreAllRunning returns whether all pods with the label are in running state.

RookNodesMatchingKubernetesNodes returns only the given Rook nodes which have a corresponding match in the list of Kubernetes nodes.

RookVersionLabelMatchesCurrent returns true if the Rook version on the resource label matches the current Rook version running.

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.

SetNodeAntiAffinityForPod assign pod anti-affinity when pod should not be co-located.

StartOperatorSettingsWatch starts the watch for Operator Settings ConfigMap.

TaintIsWellKnown returns true if the taint's key is in the WellKnownTaints list.

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.

UpdateDeploymentAndWait updates a deployment and waits until it is running to return.

UpdateMultipleDeployments updates multiple deployments and returns DeploymentsUpdated map of deployment names which were updated successfully and the observed generation of the deployments before they were updated.

UpdateService updates a service declaratively.

ValidNode returns true if the node (1) is schedulable, (2) meets Rook's placement terms, and (3) is ready.

ValidNodeNoSched returns true if the node (1) meets Rook's placement terms, and (2) is ready.

WaitForDeploymentImage waits for all deployments with the given labels are running.

WaitForDeploymentsToUpdate waits for all deployments to update.

WaitForJobCompletion waits for a job to reach the completed state.

WatchCR begins watching the custom resource (CRD).

YamlToContainerResource takes raw YAML string and converts it to array of ContainerResource.

This function takes raw YAML string and converts it to Kubernetes Tolerations array.

AppAttr app label.

ClusterAttr cluster label.

ConfigOverrideName config override name.

ConfigOverrideVal config override value.

DataDir folder.

DataDirVolume data dir volume.

DefaultNamespace for the cluster.

DefaultRepoPrefix repo prefix.

EmptyStatus indicates the object just got created.

FailedStatus reflects that some task failed for ceph related CRs.

Namespace for rook.

NodeNameEnvVar is the env variable for getting the node via downward api.

PodNameEnvVar is the env variable for getting the pod name via downward api.

PodNamespaceEnvVar is the env variable for getting the pod namespace via downward api.

PrivateIPEnvVar pod IP env var.

ProcessingStatus reflects that the tasks are in progress for ceph related CRs.

PublicIPEnvVar public IP env var.

ReadyStatus reflects the completeness of tasks for ceph related CRs.

ReconcileFailedStatus indicates a reconciliation failed.

ReconcilingStatus indicates the CR is reconciling.

RookType for the CRD.

RookVersionLabelKey is the key used for reporting the Rook version which last created or modified a resource.

WellKnownTaints is a list of well-known taint keys in the Kubernetes code base.

CustomResource is for creating a Kubernetes TPR/CRD.

DeleteOptions are a common set of options controlling the behavior of k8sutil delete operations.

EventReporter is custom events reporter type which allows user to limit the events.

NetworkAttachmentConfig represents the configuration of the NetworkAttachmentDefinitions object.

OwnerInfo is to set owner references.

Patcher is a utility for patching of objects and their status.

WaitOptions are a common set of options controlling the behavior of k8sutil operations.

DeploymentsUpdated is a mapping from deployment name to the observed generation of the old deployment which was updated.