diff --git a/api/openapi-spec/root_swagger.json b/api/openapi-spec/root_swagger.json index b0c1a2ce775..6fb81d20e59 100644 --- a/api/openapi-spec/root_swagger.json +++ b/api/openapi-spec/root_swagger.json @@ -29065,7 +29065,7 @@ "description": "PodDisruptionBudgetSpec is a description of a PodDisruptionBudget.", "properties": { "minAvailable": { - "description": "The minimum number of pods that must be available simultaneously. This can be either an integer or a string specifying a percentage, e.g. \"28%\".", + "description": "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%\".", "$ref": "#/definitions/intstr.IntOrString" }, "selector": { diff --git a/api/openapi-spec/v1alpha1.policy.json b/api/openapi-spec/v1alpha1.policy.json index 78ab4f57b4b..c7584b11c9d 100644 --- a/api/openapi-spec/v1alpha1.policy.json +++ b/api/openapi-spec/v1alpha1.policy.json @@ -1166,7 +1166,7 @@ "description": "PodDisruptionBudgetSpec is a description of a PodDisruptionBudget.", "properties": { "minAvailable": { - "description": "The minimum number of pods that must be available simultaneously. This can be either an integer or a string specifying a percentage, e.g. \"28%\".", + "description": "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%\".", "$ref": "#/definitions/intstr.IntOrString" }, "selector": { diff --git a/api/swagger-spec/policy_v1alpha1.json b/api/swagger-spec/policy_v1alpha1.json index 8ac961a5132..db221511a37 100644 --- a/api/swagger-spec/policy_v1alpha1.json +++ b/api/swagger-spec/policy_v1alpha1.json @@ -1159,7 +1159,7 @@ "properties": { "minAvailable": { "type": "string", - "description": "The minimum number of pods that must be available simultaneously. This can be either an integer or a string specifying a percentage, e.g. \"28%\"." + "description": "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%\"." }, "selector": { "$ref": "unversioned.LabelSelector", diff --git a/docs/api-reference/policy/v1alpha1/definitions.html b/docs/api-reference/policy/v1alpha1/definitions.html index 0a9e2deaaa8..b0d89704b90 100755 --- a/docs/api-reference/policy/v1alpha1/definitions.html +++ b/docs/api-reference/policy/v1alpha1/definitions.html @@ -1243,7 +1243,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

minAvailable

-

The minimum number of pods that must be available simultaneously. This can be either an integer or a string specifying a percentage, e.g. "28%".

+

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%".

false

string

@@ -1388,7 +1388,7 @@ Examples:
diff --git a/pkg/apis/policy/v1alpha1/generated.proto b/pkg/apis/policy/v1alpha1/generated.proto index 8fb5c2be63f..2b8048013ee 100644 --- a/pkg/apis/policy/v1alpha1/generated.proto +++ b/pkg/apis/policy/v1alpha1/generated.proto @@ -61,8 +61,10 @@ message PodDisruptionBudgetList { // PodDisruptionBudgetSpec is a description of a PodDisruptionBudget. message PodDisruptionBudgetSpec { - // The minimum number of pods that must be available simultaneously. This - // can be either an integer or a string specifying a percentage, e.g. "28%". + // 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%". optional k8s.io.kubernetes.pkg.util.intstr.IntOrString minAvailable = 1; // Label query over pods whose evictions are managed by the disruption diff --git a/pkg/apis/policy/v1alpha1/types_swagger_doc_generated.go b/pkg/apis/policy/v1alpha1/types_swagger_doc_generated.go index 7750b1007fe..f11858ff242 100644 --- a/pkg/apis/policy/v1alpha1/types_swagger_doc_generated.go +++ b/pkg/apis/policy/v1alpha1/types_swagger_doc_generated.go @@ -57,7 +57,7 @@ func (PodDisruptionBudgetList) SwaggerDoc() map[string]string { var map_PodDisruptionBudgetSpec = map[string]string{ "": "PodDisruptionBudgetSpec is a description of a PodDisruptionBudget.", - "minAvailable": "The minimum number of pods that must be available simultaneously. This can be either an integer or a string specifying a percentage, e.g. \"28%\".", + "minAvailable": "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%\".", "selector": "Label query over pods whose evictions are managed by the disruption budget.", } diff --git a/pkg/generated/openapi/zz_generated.openapi.go b/pkg/generated/openapi/zz_generated.openapi.go index dfa85bdbd81..0c556c2490b 100644 --- a/pkg/generated/openapi/zz_generated.openapi.go +++ b/pkg/generated/openapi/zz_generated.openapi.go @@ -4871,7 +4871,7 @@ var OpenAPIDefinitions *common.OpenAPIDefinitions = &common.OpenAPIDefinitions{ Properties: map[string]spec.Schema{ "minAvailable": { SchemaProps: spec.SchemaProps{ - Description: "The minimum number of pods that must be available simultaneously. This can be either an integer or a string specifying a percentage, e.g. \"28%\".", + Description: "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%\".", Ref: spec.MustCreateRef("#/definitions/intstr.IntOrString"), }, }, @@ -14579,7 +14579,7 @@ var OpenAPIDefinitions *common.OpenAPIDefinitions = &common.OpenAPIDefinitions{ Properties: map[string]spec.Schema{ "minAvailable": { SchemaProps: spec.SchemaProps{ - Description: "The minimum number of pods that must be available simultaneously. This can be either an integer or a string specifying a percentage, e.g. \"28%\".", + Description: "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%\".", Ref: spec.MustCreateRef("#/definitions/intstr.IntOrString"), }, },