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/pkg/apis/policy/v1beta1/generated.proto
It has these top-level messages:
Eviction
PodDisruptionBudget
PodDisruptionBudgetList
PodDisruptionBudgetSpec
PodDisruptionBudgetStatus
Index ¶
- Constants
- Variables
- func Convert_policy_Eviction_To_v1beta1_Eviction(in *policy.Eviction, out *Eviction, s conversion.Scope) error
- func Convert_policy_PodDisruptionBudgetList_To_v1beta1_PodDisruptionBudgetList(in *policy.PodDisruptionBudgetList, out *PodDisruptionBudgetList, ...) error
- func Convert_policy_PodDisruptionBudgetSpec_To_v1beta1_PodDisruptionBudgetSpec(in *policy.PodDisruptionBudgetSpec, out *PodDisruptionBudgetSpec, ...) error
- func Convert_policy_PodDisruptionBudgetStatus_To_v1beta1_PodDisruptionBudgetStatus(in *policy.PodDisruptionBudgetStatus, out *PodDisruptionBudgetStatus, ...) error
- func Convert_policy_PodDisruptionBudget_To_v1beta1_PodDisruptionBudget(in *policy.PodDisruptionBudget, out *PodDisruptionBudget, s conversion.Scope) error
- func Convert_v1beta1_Eviction_To_policy_Eviction(in *Eviction, out *policy.Eviction, s conversion.Scope) error
- func Convert_v1beta1_PodDisruptionBudgetList_To_policy_PodDisruptionBudgetList(in *PodDisruptionBudgetList, out *policy.PodDisruptionBudgetList, ...) error
- func Convert_v1beta1_PodDisruptionBudgetSpec_To_policy_PodDisruptionBudgetSpec(in *PodDisruptionBudgetSpec, out *policy.PodDisruptionBudgetSpec, ...) error
- func Convert_v1beta1_PodDisruptionBudgetStatus_To_policy_PodDisruptionBudgetStatus(in *PodDisruptionBudgetStatus, out *policy.PodDisruptionBudgetStatus, ...) error
- func Convert_v1beta1_PodDisruptionBudget_To_policy_PodDisruptionBudget(in *PodDisruptionBudget, out *policy.PodDisruptionBudget, s conversion.Scope) error
- func DeepCopy_v1beta1_Eviction(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_v1beta1_PodDisruptionBudget(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_v1beta1_PodDisruptionBudgetList(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_v1beta1_PodDisruptionBudgetSpec(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_v1beta1_PodDisruptionBudgetStatus(in interface{}, out interface{}, c *conversion.Cloner) error
- func RegisterConversions(scheme *runtime.Scheme) error
- func RegisterDeepCopies(scheme *runtime.Scheme) error
- func Resource(resource string) schema.GroupResource
- type Eviction
- func (x *Eviction) CodecDecodeSelf(d *codec1978.Decoder)
- func (x *Eviction) CodecEncodeSelf(e *codec1978.Encoder)
- 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 (x *PodDisruptionBudget) CodecDecodeSelf(d *codec1978.Decoder)
- func (x *PodDisruptionBudget) CodecEncodeSelf(e *codec1978.Encoder)
- 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 (x *PodDisruptionBudgetList) CodecDecodeSelf(d *codec1978.Decoder)
- func (x *PodDisruptionBudgetList) CodecEncodeSelf(e *codec1978.Encoder)
- 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 (x *PodDisruptionBudgetSpec) CodecDecodeSelf(d *codec1978.Decoder)
- func (x *PodDisruptionBudgetSpec) CodecEncodeSelf(e *codec1978.Encoder)
- 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 (x *PodDisruptionBudgetStatus) CodecDecodeSelf(d *codec1978.Decoder)
- func (x *PodDisruptionBudgetStatus) CodecEncodeSelf(e *codec1978.Encoder)
- 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 (
SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
AddToScheme = SchemeBuilder.AddToScheme
)
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1beta1"}
SchemeGroupVersion is group version used to register these objects
Functions ¶
func Convert_policy_Eviction_To_v1beta1_Eviction ¶
func Convert_policy_Eviction_To_v1beta1_Eviction(in *policy.Eviction, out *Eviction, s conversion.Scope) error
func Convert_policy_PodDisruptionBudgetList_To_v1beta1_PodDisruptionBudgetList ¶
func Convert_policy_PodDisruptionBudgetList_To_v1beta1_PodDisruptionBudgetList(in *policy.PodDisruptionBudgetList, out *PodDisruptionBudgetList, s conversion.Scope) error
func Convert_policy_PodDisruptionBudgetSpec_To_v1beta1_PodDisruptionBudgetSpec ¶
func Convert_policy_PodDisruptionBudgetSpec_To_v1beta1_PodDisruptionBudgetSpec(in *policy.PodDisruptionBudgetSpec, out *PodDisruptionBudgetSpec, s conversion.Scope) error
func Convert_policy_PodDisruptionBudgetStatus_To_v1beta1_PodDisruptionBudgetStatus ¶
func Convert_policy_PodDisruptionBudgetStatus_To_v1beta1_PodDisruptionBudgetStatus(in *policy.PodDisruptionBudgetStatus, out *PodDisruptionBudgetStatus, s conversion.Scope) error
func Convert_policy_PodDisruptionBudget_To_v1beta1_PodDisruptionBudget ¶
func Convert_policy_PodDisruptionBudget_To_v1beta1_PodDisruptionBudget(in *policy.PodDisruptionBudget, out *PodDisruptionBudget, s conversion.Scope) error
func Convert_v1beta1_Eviction_To_policy_Eviction ¶
func Convert_v1beta1_Eviction_To_policy_Eviction(in *Eviction, out *policy.Eviction, s conversion.Scope) error
func Convert_v1beta1_PodDisruptionBudgetList_To_policy_PodDisruptionBudgetList ¶
func Convert_v1beta1_PodDisruptionBudgetList_To_policy_PodDisruptionBudgetList(in *PodDisruptionBudgetList, out *policy.PodDisruptionBudgetList, s conversion.Scope) error
func Convert_v1beta1_PodDisruptionBudgetSpec_To_policy_PodDisruptionBudgetSpec ¶
func Convert_v1beta1_PodDisruptionBudgetSpec_To_policy_PodDisruptionBudgetSpec(in *PodDisruptionBudgetSpec, out *policy.PodDisruptionBudgetSpec, s conversion.Scope) error
func Convert_v1beta1_PodDisruptionBudgetStatus_To_policy_PodDisruptionBudgetStatus ¶
func Convert_v1beta1_PodDisruptionBudgetStatus_To_policy_PodDisruptionBudgetStatus(in *PodDisruptionBudgetStatus, out *policy.PodDisruptionBudgetStatus, s conversion.Scope) error
func Convert_v1beta1_PodDisruptionBudget_To_policy_PodDisruptionBudget ¶
func Convert_v1beta1_PodDisruptionBudget_To_policy_PodDisruptionBudget(in *PodDisruptionBudget, out *policy.PodDisruptionBudget, s conversion.Scope) error
func DeepCopy_v1beta1_Eviction ¶
func DeepCopy_v1beta1_Eviction(in interface{}, out interface{}, c *conversion.Cloner) error
func DeepCopy_v1beta1_PodDisruptionBudget ¶
func DeepCopy_v1beta1_PodDisruptionBudget(in interface{}, out interface{}, c *conversion.Cloner) error
func DeepCopy_v1beta1_PodDisruptionBudgetList ¶
func DeepCopy_v1beta1_PodDisruptionBudgetList(in interface{}, out interface{}, c *conversion.Cloner) error
func DeepCopy_v1beta1_PodDisruptionBudgetSpec ¶
func DeepCopy_v1beta1_PodDisruptionBudgetSpec(in interface{}, out interface{}, c *conversion.Cloner) error
func DeepCopy_v1beta1_PodDisruptionBudgetStatus ¶
func DeepCopy_v1beta1_PodDisruptionBudgetStatus(in interface{}, out interface{}, c *conversion.Cloner) error
func RegisterConversions ¶
func RegisterConversions(scheme *runtime.Scheme) error
RegisterConversions adds conversion functions to the given scheme. Public to allow building arbitrary schemes.
func RegisterDeepCopies ¶
func RegisterDeepCopies(scheme *runtime.Scheme) error
RegisterDeepCopies adds deep-copy functions to the given scheme. Public to allow building arbitrary schemes.
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) CodecDecodeSelf ¶
func (x *Eviction) CodecDecodeSelf(d *codec1978.Decoder)
func (*Eviction) CodecEncodeSelf ¶
func (x *Eviction) CodecEncodeSelf(e *codec1978.Encoder)
func (*Eviction) Descriptor ¶
func (*Eviction) Descriptor() ([]byte, []int)
func (*Eviction) ProtoMessage ¶
func (*Eviction) ProtoMessage()
func (Eviction) SwaggerDoc ¶
func (Eviction) SwaggerDoc() map[string]string
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) CodecDecodeSelf ¶
func (x *PodDisruptionBudget) CodecDecodeSelf(d *codec1978.Decoder)
func (*PodDisruptionBudget) CodecEncodeSelf ¶
func (x *PodDisruptionBudget) CodecEncodeSelf(e *codec1978.Encoder)
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) SwaggerDoc ¶
func (PodDisruptionBudget) SwaggerDoc() map[string]string
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) CodecDecodeSelf ¶
func (x *PodDisruptionBudgetList) CodecDecodeSelf(d *codec1978.Decoder)
func (*PodDisruptionBudgetList) CodecEncodeSelf ¶
func (x *PodDisruptionBudgetList) CodecEncodeSelf(e *codec1978.Encoder)
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) SwaggerDoc ¶
func (PodDisruptionBudgetList) SwaggerDoc() map[string]string
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"`
}
PodDisruptionBudgetSpec is a description of a PodDisruptionBudget.
func (*PodDisruptionBudgetSpec) CodecDecodeSelf ¶
func (x *PodDisruptionBudgetSpec) CodecDecodeSelf(d *codec1978.Decoder)
func (*PodDisruptionBudgetSpec) CodecEncodeSelf ¶
func (x *PodDisruptionBudgetSpec) CodecEncodeSelf(e *codec1978.Encoder)
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) SwaggerDoc ¶
func (PodDisruptionBudgetSpec) SwaggerDoc() map[string]string
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) CodecDecodeSelf ¶
func (x *PodDisruptionBudgetStatus) CodecDecodeSelf(d *codec1978.Decoder)
func (*PodDisruptionBudgetStatus) CodecEncodeSelf ¶
func (x *PodDisruptionBudgetStatus) CodecEncodeSelf(e *codec1978.Encoder)
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) SwaggerDoc ¶
func (PodDisruptionBudgetStatus) SwaggerDoc() map[string]string