v1

Documentation

Index

• Constants
• Variables
• func Resource(resource string) schema.GroupResource
• type Eviction
  • func (v *Eviction) GroupVersionKind() schema.GroupVersionKind
• type PodDisruptionBudget
  • func (v *PodDisruptionBudget) GroupVersionKind() schema.GroupVersionKind
• type PodDisruptionBudgetList
  • func (v *PodDisruptionBudgetList) GroupVersionKind() schema.GroupVersionKind
• type PodDisruptionBudgetSpec
• type PodDisruptionBudgetStatus

Constants

const GroupName = "policy"

GroupName is the group name use in this package

Variables

var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type Eviction

type Eviction struct {

	// APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
	APIVersion string `json:"apiVersion,omitempty"`

	// DeleteOptions may be provided
	DeleteOptions *apimachinery_pkg_apis_meta_v1.DeleteOptions `json:"deleteOptions,omitempty"`

	// Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
	Kind string `json:"kind,omitempty"`

	// ObjectMeta describes the pod that is being evicted.
	Metadata *apimachinery_pkg_apis_meta_v1.ObjectMeta `json:"metadata,omitempty"`
}

Eviction Eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to .../pods/<pod name>/evictions.

swagger:model Eviction

func (*Eviction) GroupVersionKind

func (v *Eviction) GroupVersionKind() schema.GroupVersionKind

type PodDisruptionBudget

type PodDisruptionBudget struct {

	// APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
	APIVersion string `json:"apiVersion,omitempty"`

	// Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
	Kind string `json:"kind,omitempty"`

	// Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	Metadata *apimachinery_pkg_apis_meta_v1.ObjectMeta `json:"metadata,omitempty"`

	// Specification of the desired behavior of the PodDisruptionBudget.
	Spec *PodDisruptionBudgetSpec `json:"spec,omitempty"`

	// Most recently observed status of the PodDisruptionBudget.
	Status *PodDisruptionBudgetStatus `json:"status,omitempty"`
}

PodDisruptionBudget PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods

swagger:model PodDisruptionBudget

func (*PodDisruptionBudget) GroupVersionKind

func (v *PodDisruptionBudget) GroupVersionKind() schema.GroupVersionKind

type PodDisruptionBudgetList

type PodDisruptionBudgetList struct {

	// APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
	APIVersion string `json:"apiVersion,omitempty"`

	// Items is a list of PodDisruptionBudgets
	// Required: true
	Items []*PodDisruptionBudget `json:"items"`

	// Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
	Kind string `json:"kind,omitempty"`

	// Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	Metadata *apimachinery_pkg_apis_meta_v1.ListMeta `json:"metadata,omitempty"`
}

PodDisruptionBudgetList PodDisruptionBudgetList is a collection of PodDisruptionBudgets.

swagger:model PodDisruptionBudgetList

func (*PodDisruptionBudgetList) GroupVersionKind

func (v *PodDisruptionBudgetList) GroupVersionKind() schema.GroupVersionKind

type PodDisruptionBudgetSpec

type PodDisruptionBudgetSpec struct {

	// An eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable".
	MaxUnavailable *apimachinery_pkg_util_intstr.IntOrString `json:"maxUnavailable,omitempty"`

	// An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod.  So for example you can prevent all voluntary evictions by specifying "100%".
	MinAvailable *apimachinery_pkg_util_intstr.IntOrString `json:"minAvailable,omitempty"`

	// Label query over pods whose evictions are managed by the disruption budget. A null selector will match no pods, while an empty ({}) selector will select all pods within the namespace.
	Selector *apimachinery_pkg_apis_meta_v1.LabelSelector `json:"selector,omitempty"`

	// UnhealthyPodEvictionPolicy defines the criteria for when unhealthy pods should be considered for eviction. Current implementation considers healthy pods, as pods that have status.conditions item with type="Ready",status="True".
	//
	// Valid policies are IfHealthyBudget and AlwaysAllow. If no policy is specified, the default behavior will be used, which corresponds to the IfHealthyBudget policy.
	//
	// IfHealthyBudget policy means that running pods (status.phase="Running"), but not yet healthy can be evicted only if the guarded application is not disrupted (status.currentHealthy is at least equal to status.desiredHealthy). Healthy pods will be subject to the PDB for eviction.
	//
	// AlwaysAllow policy means that all running pods (status.phase="Running"), but not yet healthy are considered disrupted and can be evicted regardless of whether the criteria in a PDB is met. This means perspective running pods of a disrupted application might not get a chance to become healthy. Healthy pods will be subject to the PDB for eviction.
	//
	// Additional policies may be added in the future. Clients making eviction decisions should disallow eviction of unhealthy pods if they encounter an unrecognized policy in this field.
	//
	// This field is beta-level. The eviction API uses this field when the feature gate PDBUnhealthyPodEvictionPolicy is enabled (enabled by default).
	UnhealthyPodEvictionPolicy string `json:"unhealthyPodEvictionPolicy,omitempty"`
}

PodDisruptionBudgetSpec PodDisruptionBudgetSpec is a description of a PodDisruptionBudget.

swagger:model PodDisruptionBudgetSpec

type PodDisruptionBudgetStatus

type PodDisruptionBudgetStatus struct {

	// Conditions contain conditions for PDB. The disruption controller sets the DisruptionAllowed condition. The following are known values for the reason field (additional reasons could be added in the future): - SyncFailed: The controller encountered an error and wasn't able to compute
	//               the number of allowed disruptions. Therefore no disruptions are
	//               allowed and the status of the condition will be False.
	// - InsufficientPods: The number of pods are either at or below the number
	//                     required by the PodDisruptionBudget. No disruptions are
	//                     allowed and the status of the condition will be False.
	// - SufficientPods: There are more pods than required by the PodDisruptionBudget.
	//                   The condition will be True, and the number of allowed
	//                   disruptions are provided by the disruptionsAllowed property.
	Conditions []*apimachinery_pkg_apis_meta_v1.Condition `json:"conditions,omitempty"`

	// current number of healthy pods
	// Required: true
	CurrentHealthy *int32 `json:"currentHealthy"`

	// minimum desired number of healthy pods
	// Required: true
	DesiredHealthy *int32 `json:"desiredHealthy"`

	// DisruptedPods contains information about pods whose eviction was processed by the API server eviction subresource handler but has not yet been observed by the PodDisruptionBudget controller. A pod will be in this map from the time when the API server processed the eviction request to the time when the pod is seen by PDB controller as having been marked for deletion (or after a timeout). The key in the map is the name of the pod and the value is the time when the API server processed the eviction request. If the deletion didn't occur and a pod is still there it will be removed from the list automatically by PodDisruptionBudget controller after some time. If everything goes smooth this map should be empty for the most of the time. Large number of entries in the map may indicate problems with pod deletions.
	DisruptedPods map[string]*apimachinery_pkg_apis_meta_v1.Time `json:"disruptedPods,omitempty"`

	// Number of pod disruptions that are currently allowed.
	// Required: true
	DisruptionsAllowed *int32 `json:"disruptionsAllowed"`

	// total number of pods counted by this disruption budget
	// Required: true
	ExpectedPods *int32 `json:"expectedPods"`

	// Most recent generation observed when updating this PDB status. DisruptionsAllowed and other status information is valid only if observedGeneration equals to PDB's object generation.
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
}

PodDisruptionBudgetStatus PodDisruptionBudgetStatus represents information about the status of a PodDisruptionBudget. Status may trail the actual state of a system.

swagger:model PodDisruptionBudgetStatus