pubcontrol

Documentation

Index

• Constants
• Variables
• func IsReferenceEqual(ref1, ref2 *policyv1alpha1.TargetReference) bool
• func PodUnavailableBudgetValidatePod(client client.Client, control PubControl, pod *corev1.Pod, ...) (allowed bool, reason string, err error)
• type PubControl
  • func NewPubControl(client client.Client) PubControl

Constants

const (
	// Marked pods will not be pub-protected, solving the scenario of force pod deletion
	PodPubNoProtectionAnnotation = "pub.kruise.io/no-protect"
	// related-pub annotation in pod
	PodRelatedPubAnnotation = "kruise.io/related-pub"
)

const (
	// MaxUnavailablePodSize is the max size of PUB.DisruptedPods + PUB.UnavailablePods.
	MaxUnavailablePodSize = 2000
)

Variables

var ConflictRetry = wait.Backoff{
	Steps:    4,
	Duration: 500 * time.Millisecond,
	Factor:   1.0,
	Jitter:   0.1,
}

Functions

func IsReferenceEqual

func IsReferenceEqual(ref1, ref2 *policyv1alpha1.TargetReference) bool

check APIVersion, Kind, Name

func PodUnavailableBudgetValidatePod

func PodUnavailableBudgetValidatePod(client client.Client, control PubControl, pod *corev1.Pod, operation policyv1alpha1.PubOperation, dryRun bool) (allowed bool, reason string, err error)

parameters: 1. allowed(bool) indicates whether to allow this update operation 2. err(error)

Types

type PubControl

type PubControl interface {
	// IsPodReady indicates whether pod is fully ready
	// 1. pod.Status.Phase == v1.PodRunning
	// 2. pod.condition PodReady == true
	IsPodReady(pod *corev1.Pod) bool
	// IsPodStateConsistent indicates whether pod.spec and pod.status are consistent after updating containers
	IsPodStateConsistent(pod *corev1.Pod) bool
	// GetPodsForPub returns Pods protected by the pub object.
	// return two parameters
	// 1. podList
	// 2. expectedCount, the default is workload.Replicas
	GetPodsForPub(pub *policyv1alpha1.PodUnavailableBudget) ([]*corev1.Pod, int32, error)

	// webhook
	// determine if this change to pod might cause unavailability
	IsPodUnavailableChanged(oldPod, newPod *corev1.Pod) bool
	// get pub for pod
	GetPubForPod(pod *corev1.Pod) (*policyv1alpha1.PodUnavailableBudget, error)
}

func NewPubControl

func NewPubControl(client client.Client) PubControl