Documentation ¶
Overview ¶
Package policy is for any kind of policy object. Suitable examples, even if they aren't all here, are PodDisruptionBudget, PodSecurityPolicy, NetworkPolicy, etc. +k8s:openapi-gen=true
Package v1beta1 is a generated protocol buffer package. It is generated from these files: k8s.io/kubernetes/vendor/k8s.io/api/policy/v1beta1/generated.proto It has these top-level messages: Eviction PodDisruptionBudget PodDisruptionBudgetList PodDisruptionBudgetSpec PodDisruptionBudgetStatus
Index ¶
- Constants
- Variables
- func RegisterDeepCopies(scheme *runtime.Scheme) errordeprecated
- func Resource(resource string) schema.GroupResource
- type Eviction
- func (in *Eviction) DeepCopy() *Eviction
- func (in *Eviction) DeepCopyInto(out *Eviction)
- func (in *Eviction) DeepCopyObject() runtime.Object
- func (*Eviction) Descriptor() ([]byte, []int)
- func (m *Eviction) Marshal() (dAtA []byte, err error)
- func (m *Eviction) MarshalTo(dAtA []byte) (int, error)
- func (*Eviction) ProtoMessage()
- func (m *Eviction) Reset()
- func (m *Eviction) Size() (n int)
- func (this *Eviction) String() string
- func (Eviction) SwaggerDoc() map[string]string
- func (m *Eviction) Unmarshal(dAtA []byte) error
- type PodDisruptionBudget
- func (in *PodDisruptionBudget) DeepCopy() *PodDisruptionBudget
- func (in *PodDisruptionBudget) DeepCopyInto(out *PodDisruptionBudget)
- func (in *PodDisruptionBudget) DeepCopyObject() runtime.Object
- func (*PodDisruptionBudget) Descriptor() ([]byte, []int)
- func (m *PodDisruptionBudget) Marshal() (dAtA []byte, err error)
- func (m *PodDisruptionBudget) MarshalTo(dAtA []byte) (int, error)
- func (*PodDisruptionBudget) ProtoMessage()
- func (m *PodDisruptionBudget) Reset()
- func (m *PodDisruptionBudget) Size() (n int)
- func (this *PodDisruptionBudget) String() string
- func (PodDisruptionBudget) SwaggerDoc() map[string]string
- func (m *PodDisruptionBudget) Unmarshal(dAtA []byte) error
- type PodDisruptionBudgetList
- func (in *PodDisruptionBudgetList) DeepCopy() *PodDisruptionBudgetList
- func (in *PodDisruptionBudgetList) DeepCopyInto(out *PodDisruptionBudgetList)
- func (in *PodDisruptionBudgetList) DeepCopyObject() runtime.Object
- func (*PodDisruptionBudgetList) Descriptor() ([]byte, []int)
- func (m *PodDisruptionBudgetList) Marshal() (dAtA []byte, err error)
- func (m *PodDisruptionBudgetList) MarshalTo(dAtA []byte) (int, error)
- func (*PodDisruptionBudgetList) ProtoMessage()
- func (m *PodDisruptionBudgetList) Reset()
- func (m *PodDisruptionBudgetList) Size() (n int)
- func (this *PodDisruptionBudgetList) String() string
- func (PodDisruptionBudgetList) SwaggerDoc() map[string]string
- func (m *PodDisruptionBudgetList) Unmarshal(dAtA []byte) error
- type PodDisruptionBudgetSpec
- func (in *PodDisruptionBudgetSpec) DeepCopy() *PodDisruptionBudgetSpec
- func (in *PodDisruptionBudgetSpec) DeepCopyInto(out *PodDisruptionBudgetSpec)
- func (*PodDisruptionBudgetSpec) Descriptor() ([]byte, []int)
- func (m *PodDisruptionBudgetSpec) Marshal() (dAtA []byte, err error)
- func (m *PodDisruptionBudgetSpec) MarshalTo(dAtA []byte) (int, error)
- func (*PodDisruptionBudgetSpec) ProtoMessage()
- func (m *PodDisruptionBudgetSpec) Reset()
- func (m *PodDisruptionBudgetSpec) Size() (n int)
- func (this *PodDisruptionBudgetSpec) String() string
- func (PodDisruptionBudgetSpec) SwaggerDoc() map[string]string
- func (m *PodDisruptionBudgetSpec) Unmarshal(dAtA []byte) error
- type PodDisruptionBudgetStatus
- func (in *PodDisruptionBudgetStatus) DeepCopy() *PodDisruptionBudgetStatus
- func (in *PodDisruptionBudgetStatus) DeepCopyInto(out *PodDisruptionBudgetStatus)
- func (*PodDisruptionBudgetStatus) Descriptor() ([]byte, []int)
- func (m *PodDisruptionBudgetStatus) Marshal() (dAtA []byte, err error)
- func (m *PodDisruptionBudgetStatus) MarshalTo(dAtA []byte) (int, error)
- func (*PodDisruptionBudgetStatus) ProtoMessage()
- func (m *PodDisruptionBudgetStatus) Reset()
- func (m *PodDisruptionBudgetStatus) Size() (n int)
- func (this *PodDisruptionBudgetStatus) String() string
- func (PodDisruptionBudgetStatus) SwaggerDoc() map[string]string
- func (m *PodDisruptionBudgetStatus) Unmarshal(dAtA []byte) error
Constants ¶
const GroupName = "policy"
GroupName is the group name use in this package
Variables ¶
var ( ErrInvalidLengthGenerated = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowGenerated = fmt.Errorf("proto: integer overflow") )
var ( // TODO: move SchemeBuilder with zz_generated.deepcopy.go to k8s.io/api. // localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes. SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) AddToScheme = localSchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1beta1"}
SchemeGroupVersion is group version used to register these objects
Functions ¶
func RegisterDeepCopies
deprecated
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 { metav1.TypeMeta `json:",inline"` // ObjectMeta describes the pod that is being evicted. metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` // DeleteOptions may be provided DeleteOptions *metav1.DeleteOptions `json:"deleteOptions,omitempty" protobuf:"bytes,2,opt,name=deleteOptions"` }
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.
func (*Eviction) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Eviction.
func (*Eviction) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Eviction) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Eviction) Descriptor ¶
func (*Eviction) ProtoMessage ¶
func (*Eviction) ProtoMessage()
func (Eviction) SwaggerDoc ¶
type PodDisruptionBudget ¶
type PodDisruptionBudget struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` // Specification of the desired behavior of the PodDisruptionBudget. Spec PodDisruptionBudgetSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"` // Most recently observed status of the PodDisruptionBudget. Status PodDisruptionBudgetStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"` }
PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods
func (*PodDisruptionBudget) DeepCopy ¶
func (in *PodDisruptionBudget) DeepCopy() *PodDisruptionBudget
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PodDisruptionBudget.
func (*PodDisruptionBudget) DeepCopyInto ¶
func (in *PodDisruptionBudget) DeepCopyInto(out *PodDisruptionBudget)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PodDisruptionBudget) DeepCopyObject ¶
func (in *PodDisruptionBudget) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*PodDisruptionBudget) Descriptor ¶
func (*PodDisruptionBudget) Descriptor() ([]byte, []int)
func (*PodDisruptionBudget) Marshal ¶
func (m *PodDisruptionBudget) Marshal() (dAtA []byte, err error)
func (*PodDisruptionBudget) MarshalTo ¶
func (m *PodDisruptionBudget) MarshalTo(dAtA []byte) (int, error)
func (*PodDisruptionBudget) ProtoMessage ¶
func (*PodDisruptionBudget) ProtoMessage()
func (*PodDisruptionBudget) Reset ¶
func (m *PodDisruptionBudget) Reset()
func (*PodDisruptionBudget) Size ¶
func (m *PodDisruptionBudget) Size() (n int)
func (*PodDisruptionBudget) String ¶
func (this *PodDisruptionBudget) String() string
func (PodDisruptionBudget) SwaggerDoc ¶
func (PodDisruptionBudget) SwaggerDoc() map[string]string
func (*PodDisruptionBudget) Unmarshal ¶
func (m *PodDisruptionBudget) Unmarshal(dAtA []byte) error
type PodDisruptionBudgetList ¶
type PodDisruptionBudgetList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` Items []PodDisruptionBudget `json:"items" protobuf:"bytes,2,rep,name=items"` }
PodDisruptionBudgetList is a collection of PodDisruptionBudgets.
func (*PodDisruptionBudgetList) DeepCopy ¶
func (in *PodDisruptionBudgetList) DeepCopy() *PodDisruptionBudgetList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PodDisruptionBudgetList.
func (*PodDisruptionBudgetList) DeepCopyInto ¶
func (in *PodDisruptionBudgetList) DeepCopyInto(out *PodDisruptionBudgetList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PodDisruptionBudgetList) DeepCopyObject ¶
func (in *PodDisruptionBudgetList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*PodDisruptionBudgetList) Descriptor ¶
func (*PodDisruptionBudgetList) Descriptor() ([]byte, []int)
func (*PodDisruptionBudgetList) Marshal ¶
func (m *PodDisruptionBudgetList) Marshal() (dAtA []byte, err error)
func (*PodDisruptionBudgetList) MarshalTo ¶
func (m *PodDisruptionBudgetList) MarshalTo(dAtA []byte) (int, error)
func (*PodDisruptionBudgetList) ProtoMessage ¶
func (*PodDisruptionBudgetList) ProtoMessage()
func (*PodDisruptionBudgetList) Reset ¶
func (m *PodDisruptionBudgetList) Reset()
func (*PodDisruptionBudgetList) Size ¶
func (m *PodDisruptionBudgetList) Size() (n int)
func (*PodDisruptionBudgetList) String ¶
func (this *PodDisruptionBudgetList) String() string
func (PodDisruptionBudgetList) SwaggerDoc ¶
func (PodDisruptionBudgetList) SwaggerDoc() map[string]string
func (*PodDisruptionBudgetList) Unmarshal ¶
func (m *PodDisruptionBudgetList) Unmarshal(dAtA []byte) error
type PodDisruptionBudgetSpec ¶
type PodDisruptionBudgetSpec struct { // 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 *intstr.IntOrString `json:"minAvailable,omitempty" protobuf:"bytes,1,opt,name=minAvailable"` // Label query over pods whose evictions are managed by the disruption // budget. Selector *metav1.LabelSelector `json:"selector,omitempty" protobuf:"bytes,2,opt,name=selector"` // "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 *intstr.IntOrString `json:"maxUnavailable,omitempty" protobuf:"bytes,3,opt,name=maxUnavailable"` }
PodDisruptionBudgetSpec is a description of a PodDisruptionBudget.
func (*PodDisruptionBudgetSpec) DeepCopy ¶
func (in *PodDisruptionBudgetSpec) DeepCopy() *PodDisruptionBudgetSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PodDisruptionBudgetSpec.
func (*PodDisruptionBudgetSpec) DeepCopyInto ¶
func (in *PodDisruptionBudgetSpec) DeepCopyInto(out *PodDisruptionBudgetSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PodDisruptionBudgetSpec) Descriptor ¶
func (*PodDisruptionBudgetSpec) Descriptor() ([]byte, []int)
func (*PodDisruptionBudgetSpec) Marshal ¶
func (m *PodDisruptionBudgetSpec) Marshal() (dAtA []byte, err error)
func (*PodDisruptionBudgetSpec) MarshalTo ¶
func (m *PodDisruptionBudgetSpec) MarshalTo(dAtA []byte) (int, error)
func (*PodDisruptionBudgetSpec) ProtoMessage ¶
func (*PodDisruptionBudgetSpec) ProtoMessage()
func (*PodDisruptionBudgetSpec) Reset ¶
func (m *PodDisruptionBudgetSpec) Reset()
func (*PodDisruptionBudgetSpec) Size ¶
func (m *PodDisruptionBudgetSpec) Size() (n int)
func (*PodDisruptionBudgetSpec) String ¶
func (this *PodDisruptionBudgetSpec) String() string
func (PodDisruptionBudgetSpec) SwaggerDoc ¶
func (PodDisruptionBudgetSpec) SwaggerDoc() map[string]string
func (*PodDisruptionBudgetSpec) Unmarshal ¶
func (m *PodDisruptionBudgetSpec) Unmarshal(dAtA []byte) error
type PodDisruptionBudgetStatus ¶
type PodDisruptionBudgetStatus struct { // Most recent generation observed when updating this PDB status. PodDisruptionsAllowed and other // status informatio is valid only if observedGeneration equals to PDB's object generation. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty" protobuf:"varint,1,opt,name=observedGeneration"` // 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]metav1.Time `json:"disruptedPods" protobuf:"bytes,2,rep,name=disruptedPods"` // Number of pod disruptions that are currently allowed. PodDisruptionsAllowed int32 `json:"disruptionsAllowed" protobuf:"varint,3,opt,name=disruptionsAllowed"` // current number of healthy pods CurrentHealthy int32 `json:"currentHealthy" protobuf:"varint,4,opt,name=currentHealthy"` // minimum desired number of healthy pods DesiredHealthy int32 `json:"desiredHealthy" protobuf:"varint,5,opt,name=desiredHealthy"` // total number of pods counted by this disruption budget ExpectedPods int32 `json:"expectedPods" protobuf:"varint,6,opt,name=expectedPods"` }
PodDisruptionBudgetStatus represents information about the status of a PodDisruptionBudget. Status may trail the actual state of a system.
func (*PodDisruptionBudgetStatus) DeepCopy ¶
func (in *PodDisruptionBudgetStatus) DeepCopy() *PodDisruptionBudgetStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PodDisruptionBudgetStatus.
func (*PodDisruptionBudgetStatus) DeepCopyInto ¶
func (in *PodDisruptionBudgetStatus) DeepCopyInto(out *PodDisruptionBudgetStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PodDisruptionBudgetStatus) Descriptor ¶
func (*PodDisruptionBudgetStatus) Descriptor() ([]byte, []int)
func (*PodDisruptionBudgetStatus) Marshal ¶
func (m *PodDisruptionBudgetStatus) Marshal() (dAtA []byte, err error)
func (*PodDisruptionBudgetStatus) MarshalTo ¶
func (m *PodDisruptionBudgetStatus) MarshalTo(dAtA []byte) (int, error)
func (*PodDisruptionBudgetStatus) ProtoMessage ¶
func (*PodDisruptionBudgetStatus) ProtoMessage()
func (*PodDisruptionBudgetStatus) Reset ¶
func (m *PodDisruptionBudgetStatus) Reset()
func (*PodDisruptionBudgetStatus) Size ¶
func (m *PodDisruptionBudgetStatus) Size() (n int)
func (*PodDisruptionBudgetStatus) String ¶
func (this *PodDisruptionBudgetStatus) String() string
func (PodDisruptionBudgetStatus) SwaggerDoc ¶
func (PodDisruptionBudgetStatus) SwaggerDoc() map[string]string
func (*PodDisruptionBudgetStatus) Unmarshal ¶
func (m *PodDisruptionBudgetStatus) Unmarshal(dAtA []byte) error