Copyright 2022 The Kruise Authors.

ComputeHash returns a hash value calculated from pod template and a collisionCount to avoid hash collision.

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.

DeploymentMaxUnavailable returns the maximum unavailable pods a rolling deployment can take.

hash hashes `data` with sha256 and returns the hex string.

EqualIgnoreHash compare template without pod-template-hash label.

FilterActiveDeployment will filter out terminating deployment.

FilterActivePods will filter out terminating pods.

FindCanaryAndStableReplicaSet find the canary and stable replicaset for the deployment - canary replicaset: the template equals to deployment's; - stable replicaset: an active replicaset(replicas>0) with the smallest revision.

GetDeploymentExtraStatus decode the extra-status object for advanced deployment from the annotation rollouts.kruise.io/deployment-extra-status.

GetDeploymentStrategy decode the strategy object for advanced deployment from the annotation rollouts.kruise.io/deployment-strategy.

GetEmptyObjectWithKey return an empty object with the same namespaced name.

GetEmptyWorkloadObject return specific object based on the given gvk.

GetMetadata can parse the whole metadata field from client workload object.

GetOwnerWorkload return the top-level workload that is controlled by rollout, if the object has no owner, just return nil.

GetPodCondition extracts the provided condition from the given status and returns that.

GetPodConditionFromList extracts the provided condition from the given list of condition and returns the index of the condition and the condition.

GetPodReadyCondition extracts the pod ready condition from the given status and returns that.

GetReplicas return replicas from client workload object.

GetRolloutCondition returns the condition with the provided type.

GetStatefulSetPartition get partition of object.

GetTemplate return pod template spec for client workload object.

GetTypeMeta can parse the whole TypeMeta field from client workload object.

IsCompletedPod return true if pod is at Failed or Succeeded phase.

IsConsistentWithRevision return true iff pod is match the revision.

IsEqualRevision return true if a and b have equal revision label.

IsOwnedBy will return true if the child is owned by parent directly or indirectly.

IsPodReady returns true if a pod is ready; false otherwise.

IsPodReadyConditionTrue returns true if a pod is ready; false otherwise.

IsStatefulSetRollingUpdate return true if updateStrategy of object is rollingUpdate type.

IsStatefulSetUnorderedUpdate return true if the updateStrategy of object is unordered update.

IsSupportedWorkload return true if the kind of workload can be processed by Rollout.

IsWorkloadType return true is object matches the workload type.

ListOwnedPods will list all pods belong to workload, including terminating pods.

NewRolloutCondition creates a new rollout condition.

ParseWorkload parse workload as WorkloadInfo.

ParseWorkloadStatus parse status of object as WorkloadStatus.

SafeEncodeString encodes s using the same characters as rand.String.

SetRolloutCondition updates the rollout to include the provided condition.

SetStatefulSetPartition set partition to object.

UpdateFinalizer add/remove a finalizer from a object.

WrappedPodCount return the number of pods which satisfy the filter.

For Others.

BatchReleaseControlAnnotation is controller info about batchRelease when rollout.

CanaryDeploymentFinalizer is a finalizer to resources patched by batchRelease controller.

CanaryDeploymentLabel is to label canary deployment that is created by batchRelease controller.

CloneSetType DeploymentType and StatefulSetType are values to WorkloadTypeLabel.

For Others.

DeploymentRevisionAnnotation is the revision annotation of a deployment's replica sets which records its rollout sequence.

For Others.

InRolloutProgressingAnnotation marks workload as entering the rollout progressing processand does not allow paused=false during this process.

KruiseRolloutFinalizer is a finalizer for deployment/service/ingress/gateway/etc.

NoNeedUpdatePodLabel will be patched to pod when rollback in batches if the pods no need to rollback.

For Others.

RolloutHashAnnotation record observed rollout spec hash.

For Others.

WorkloadTypeLabel is a label to identify workload type.

RolloutState is annotation[rollouts.kruise.io/in-progressing] value.

Workload is used to return (controller, scale, selector) fields from the controller finder functions.

ControllerFinderFunc is a function type that maps a pod to a list of controllers and their scale.