mirror of https://github.com/k3s-io/k3s
api: Correct a typo in the API docs for rolling update strategy
parent
a9fd9cef76
commit
a5ba311260
|
@ -1505,7 +1505,7 @@
|
||||||
"properties": {
|
"properties": {
|
||||||
"maxSurge": {
|
"maxSurge": {
|
||||||
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString",
|
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString",
|
||||||
"description": "The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of desired pods."
|
"description": "The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods."
|
||||||
},
|
},
|
||||||
"maxUnavailable": {
|
"maxUnavailable": {
|
||||||
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString",
|
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString",
|
||||||
|
@ -2484,7 +2484,7 @@
|
||||||
"properties": {
|
"properties": {
|
||||||
"maxSurge": {
|
"maxSurge": {
|
||||||
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString",
|
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString",
|
||||||
"description": "The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of desired pods."
|
"description": "The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods."
|
||||||
},
|
},
|
||||||
"maxUnavailable": {
|
"maxUnavailable": {
|
||||||
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString",
|
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString",
|
||||||
|
@ -12596,7 +12596,7 @@
|
||||||
"properties": {
|
"properties": {
|
||||||
"maxSurge": {
|
"maxSurge": {
|
||||||
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString",
|
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString",
|
||||||
"description": "The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. By default, a value of 1 is used. Example: when this is set to 30%, the new RC can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of desired pods."
|
"description": "The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. By default, a value of 1 is used. Example: when this is set to 30%, the new RC can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods."
|
||||||
},
|
},
|
||||||
"maxUnavailable": {
|
"maxUnavailable": {
|
||||||
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString",
|
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString",
|
||||||
|
|
|
@ -407,7 +407,7 @@ type RollingUpdateDeployment struct {
|
||||||
// Example: when this is set to 30%, the new RC can be scaled up by 30%
|
// Example: when this is set to 30%, the new RC can be scaled up by 30%
|
||||||
// immediately when the rolling update starts. Once old pods have been killed,
|
// immediately when the rolling update starts. Once old pods have been killed,
|
||||||
// new RC can be scaled up further, ensuring that total number of pods running
|
// new RC can be scaled up further, ensuring that total number of pods running
|
||||||
// at any time during the update is atmost 130% of original pods.
|
// at any time during the update is at most 130% of original pods.
|
||||||
// +optional
|
// +optional
|
||||||
MaxSurge intstr.IntOrString
|
MaxSurge intstr.IntOrString
|
||||||
}
|
}
|
||||||
|
|
|
@ -101,7 +101,7 @@ type RollingUpdaterConfig struct {
|
||||||
// when the rolling update starts, such that the total number of old and new pods do not exceed
|
// when the rolling update starts, such that the total number of old and new pods do not exceed
|
||||||
// 130% of desired pods. Once old pods have been killed, new RC can be scaled up
|
// 130% of desired pods. Once old pods have been killed, new RC can be scaled up
|
||||||
// further, ensuring that total number of pods running at any time during
|
// further, ensuring that total number of pods running at any time during
|
||||||
// the update is atmost 130% of desired pods.
|
// the update is at most 130% of desired pods.
|
||||||
MaxSurge intstr.IntOrString
|
MaxSurge intstr.IntOrString
|
||||||
// OnProgress is invoked if set during each scale cycle, to allow the caller to perform additional logic or
|
// OnProgress is invoked if set during each scale cycle, to allow the caller to perform additional logic or
|
||||||
// abort the scale. If an error is returned the cleanup method will not be invoked. The percentage value
|
// abort the scale. If an error is returned the cleanup method will not be invoked. The percentage value
|
||||||
|
|
|
@ -263,7 +263,7 @@ message RollingUpdateDeployment {
|
||||||
// the rolling update starts, such that the total number of old and new pods do not exceed
|
// the rolling update starts, such that the total number of old and new pods do not exceed
|
||||||
// 130% of desired pods. Once old pods have been killed,
|
// 130% of desired pods. Once old pods have been killed,
|
||||||
// new ReplicaSet can be scaled up further, ensuring that total number of pods running
|
// new ReplicaSet can be scaled up further, ensuring that total number of pods running
|
||||||
// at any time during the update is atmost 130% of desired pods.
|
// at any time during the update is at most 130% of desired pods.
|
||||||
// +optional
|
// +optional
|
||||||
optional k8s.io.apimachinery.pkg.util.intstr.IntOrString maxSurge = 2;
|
optional k8s.io.apimachinery.pkg.util.intstr.IntOrString maxSurge = 2;
|
||||||
}
|
}
|
||||||
|
|
|
@ -17,7 +17,7 @@ limitations under the License.
|
||||||
package v1beta1
|
package v1beta1
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"k8s.io/api/core/v1"
|
v1 "k8s.io/api/core/v1"
|
||||||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||||
"k8s.io/apimachinery/pkg/runtime"
|
"k8s.io/apimachinery/pkg/runtime"
|
||||||
"k8s.io/apimachinery/pkg/util/intstr"
|
"k8s.io/apimachinery/pkg/util/intstr"
|
||||||
|
@ -433,7 +433,7 @@ type RollingUpdateDeployment struct {
|
||||||
// the rolling update starts, such that the total number of old and new pods do not exceed
|
// the rolling update starts, such that the total number of old and new pods do not exceed
|
||||||
// 130% of desired pods. Once old pods have been killed,
|
// 130% of desired pods. Once old pods have been killed,
|
||||||
// new ReplicaSet can be scaled up further, ensuring that total number of pods running
|
// new ReplicaSet can be scaled up further, ensuring that total number of pods running
|
||||||
// at any time during the update is atmost 130% of desired pods.
|
// at any time during the update is at most 130% of desired pods.
|
||||||
// +optional
|
// +optional
|
||||||
MaxSurge *intstr.IntOrString `json:"maxSurge,omitempty" protobuf:"bytes,2,opt,name=maxSurge"`
|
MaxSurge *intstr.IntOrString `json:"maxSurge,omitempty" protobuf:"bytes,2,opt,name=maxSurge"`
|
||||||
}
|
}
|
||||||
|
|
|
@ -149,7 +149,7 @@ func (RollbackConfig) SwaggerDoc() map[string]string {
|
||||||
var map_RollingUpdateDeployment = map[string]string{
|
var map_RollingUpdateDeployment = map[string]string{
|
||||||
"": "Spec to control the desired behavior of rolling update.",
|
"": "Spec to control the desired behavior of rolling update.",
|
||||||
"maxUnavailable": "The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.",
|
"maxUnavailable": "The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.",
|
||||||
"maxSurge": "The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of desired pods.",
|
"maxSurge": "The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods.",
|
||||||
}
|
}
|
||||||
|
|
||||||
func (RollingUpdateDeployment) SwaggerDoc() map[string]string {
|
func (RollingUpdateDeployment) SwaggerDoc() map[string]string {
|
||||||
|
|
|
@ -527,7 +527,7 @@ message RollingUpdateDeployment {
|
||||||
// the rolling update starts, such that the total number of old and new pods do not exceed
|
// the rolling update starts, such that the total number of old and new pods do not exceed
|
||||||
// 130% of desired pods. Once old pods have been killed,
|
// 130% of desired pods. Once old pods have been killed,
|
||||||
// new ReplicaSet can be scaled up further, ensuring that total number of pods running
|
// new ReplicaSet can be scaled up further, ensuring that total number of pods running
|
||||||
// at any time during the update is atmost 130% of desired pods.
|
// at any time during the update is at most 130% of desired pods.
|
||||||
// +optional
|
// +optional
|
||||||
optional k8s.io.apimachinery.pkg.util.intstr.IntOrString maxSurge = 2;
|
optional k8s.io.apimachinery.pkg.util.intstr.IntOrString maxSurge = 2;
|
||||||
}
|
}
|
||||||
|
|
|
@ -17,7 +17,7 @@ limitations under the License.
|
||||||
package v1beta2
|
package v1beta2
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"k8s.io/api/core/v1"
|
v1 "k8s.io/api/core/v1"
|
||||||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||||
runtime "k8s.io/apimachinery/pkg/runtime"
|
runtime "k8s.io/apimachinery/pkg/runtime"
|
||||||
"k8s.io/apimachinery/pkg/util/intstr"
|
"k8s.io/apimachinery/pkg/util/intstr"
|
||||||
|
@ -413,7 +413,7 @@ type RollingUpdateDeployment struct {
|
||||||
// the rolling update starts, such that the total number of old and new pods do not exceed
|
// the rolling update starts, such that the total number of old and new pods do not exceed
|
||||||
// 130% of desired pods. Once old pods have been killed,
|
// 130% of desired pods. Once old pods have been killed,
|
||||||
// new ReplicaSet can be scaled up further, ensuring that total number of pods running
|
// new ReplicaSet can be scaled up further, ensuring that total number of pods running
|
||||||
// at any time during the update is atmost 130% of desired pods.
|
// at any time during the update is at most 130% of desired pods.
|
||||||
// +optional
|
// +optional
|
||||||
MaxSurge *intstr.IntOrString `json:"maxSurge,omitempty" protobuf:"bytes,2,opt,name=maxSurge"`
|
MaxSurge *intstr.IntOrString `json:"maxSurge,omitempty" protobuf:"bytes,2,opt,name=maxSurge"`
|
||||||
}
|
}
|
||||||
|
|
|
@ -272,7 +272,7 @@ func (RollingUpdateDaemonSet) SwaggerDoc() map[string]string {
|
||||||
var map_RollingUpdateDeployment = map[string]string{
|
var map_RollingUpdateDeployment = map[string]string{
|
||||||
"": "Spec to control the desired behavior of rolling update.",
|
"": "Spec to control the desired behavior of rolling update.",
|
||||||
"maxUnavailable": "The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.",
|
"maxUnavailable": "The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.",
|
||||||
"maxSurge": "The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of desired pods.",
|
"maxSurge": "The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods.",
|
||||||
}
|
}
|
||||||
|
|
||||||
func (RollingUpdateDeployment) SwaggerDoc() map[string]string {
|
func (RollingUpdateDeployment) SwaggerDoc() map[string]string {
|
||||||
|
|
|
@ -1063,7 +1063,7 @@ message RollingUpdateDeployment {
|
||||||
// the rolling update starts, such that the total number of old and new pods do not exceed
|
// the rolling update starts, such that the total number of old and new pods do not exceed
|
||||||
// 130% of desired pods. Once old pods have been killed,
|
// 130% of desired pods. Once old pods have been killed,
|
||||||
// new RC can be scaled up further, ensuring that total number of pods running
|
// new RC can be scaled up further, ensuring that total number of pods running
|
||||||
// at any time during the update is atmost 130% of desired pods.
|
// at any time during the update is at most 130% of desired pods.
|
||||||
// +optional
|
// +optional
|
||||||
optional k8s.io.apimachinery.pkg.util.intstr.IntOrString maxSurge = 2;
|
optional k8s.io.apimachinery.pkg.util.intstr.IntOrString maxSurge = 2;
|
||||||
}
|
}
|
||||||
|
|
|
@ -18,7 +18,7 @@ package v1beta1
|
||||||
|
|
||||||
import (
|
import (
|
||||||
appsv1beta1 "k8s.io/api/apps/v1beta1"
|
appsv1beta1 "k8s.io/api/apps/v1beta1"
|
||||||
"k8s.io/api/core/v1"
|
v1 "k8s.io/api/core/v1"
|
||||||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||||
"k8s.io/apimachinery/pkg/util/intstr"
|
"k8s.io/apimachinery/pkg/util/intstr"
|
||||||
)
|
)
|
||||||
|
@ -229,7 +229,7 @@ type RollingUpdateDeployment struct {
|
||||||
// the rolling update starts, such that the total number of old and new pods do not exceed
|
// the rolling update starts, such that the total number of old and new pods do not exceed
|
||||||
// 130% of desired pods. Once old pods have been killed,
|
// 130% of desired pods. Once old pods have been killed,
|
||||||
// new RC can be scaled up further, ensuring that total number of pods running
|
// new RC can be scaled up further, ensuring that total number of pods running
|
||||||
// at any time during the update is atmost 130% of desired pods.
|
// at any time during the update is at most 130% of desired pods.
|
||||||
// +optional
|
// +optional
|
||||||
MaxSurge *intstr.IntOrString `json:"maxSurge,omitempty" protobuf:"bytes,2,opt,name=maxSurge"`
|
MaxSurge *intstr.IntOrString `json:"maxSurge,omitempty" protobuf:"bytes,2,opt,name=maxSurge"`
|
||||||
}
|
}
|
||||||
|
|
|
@ -559,7 +559,7 @@ func (RollingUpdateDaemonSet) SwaggerDoc() map[string]string {
|
||||||
var map_RollingUpdateDeployment = map[string]string{
|
var map_RollingUpdateDeployment = map[string]string{
|
||||||
"": "Spec to control the desired behavior of rolling update.",
|
"": "Spec to control the desired behavior of rolling update.",
|
||||||
"maxUnavailable": "The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. By default, a fixed value of 1 is used. Example: when this is set to 30%, the old RC can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old RC can be scaled down further, followed by scaling up the new RC, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.",
|
"maxUnavailable": "The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. By default, a fixed value of 1 is used. Example: when this is set to 30%, the old RC can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old RC can be scaled down further, followed by scaling up the new RC, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.",
|
||||||
"maxSurge": "The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. By default, a value of 1 is used. Example: when this is set to 30%, the new RC can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of desired pods.",
|
"maxSurge": "The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. By default, a value of 1 is used. Example: when this is set to 30%, the new RC can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods.",
|
||||||
}
|
}
|
||||||
|
|
||||||
func (RollingUpdateDeployment) SwaggerDoc() map[string]string {
|
func (RollingUpdateDeployment) SwaggerDoc() map[string]string {
|
||||||
|
|
Loading…
Reference in New Issue