github/kubernetes
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update doc comments and change name of feature gate

Browse Source
This commit is contained in:
Peter Schuurman
2022-11-01 17:20:31 -07:00
parent 8a9c126eca
commit 366997951b
18 changed files with 182 additions and 95 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
staging/src/k8s.io/api/apps/v1/generated.proto
View File

@@ -625,10 +625,14 @@ message StatefulSetList {
// StatefulSetOrdinals describes the policy used for replica ordinal assignment
// in this StatefulSet.
message StatefulSetOrdinals {
// Start is the number representing the first index that is used to represent
// replica ordinals. Defaults to 0.
// If set, replica ordinals will be numbered
// [.spec.ordinals.start, .spec.ordinals.start - .spec.replicas).
// start is the number representing the first replica's index. It may be used
// to number replicas from an alternate index (eg: 1-indexed) over the default
// 0-indexed names, or to orchestrate progressive movement of replicas from
// one StatefulSet to another.
// If set, replica indices will be in the range:
// [.spec.ordinals.start, .spec.ordinals.start + .spec.replicas).
// If unset, defaults to 0. Replica indices will be in the range:
// [0, .spec.replicas).
// +optional
optional int32 start = 1;
}
@@ -725,11 +729,13 @@ message StatefulSetSpec {
// which is alpha. +optional
optional StatefulSetPersistentVolumeClaimRetentionPolicy persistentVolumeClaimRetentionPolicy = 10;
// Ordinals controls how the stateful set creates pod and persistent volume
// claim names.
// The default behavior assigns a number starting with zero and incremented by
// one for each additional replica requested. This requires the
// StatefulSetSlice feature gate to be enabled, which is alpha.
// ordinals controls the numbering of replica indices in a StatefulSet. A
// StatefulSet will create pods with the format <statefulsetname>-<podindex>.
// For example, a pod in a StatefulSet named "web" with index number "3" would
// be named "web-3". The default ordinals behavior assigns a "0" index to the
// first replica and increments the index by one for each additional replica
// requested. Using the ordinals field requires the StatefulSetStartOrdinal
// feature gate to be enabled, which is alpha.
// +optional
optional StatefulSetOrdinals ordinals = 11;
}

24
staging/src/k8s.io/api/apps/v1/types.go
View File

@@ -166,10 +166,14 @@ type StatefulSetPersistentVolumeClaimRetentionPolicy struct {
// StatefulSetOrdinals describes the policy used for replica ordinal assignment
// in this StatefulSet.
type StatefulSetOrdinals struct {
// Start is the number representing the first index that is used to represent
// replica ordinals. Defaults to 0.
// If set, replica ordinals will be numbered in the range:
// [.spec.ordinals.start, .spec.ordinals.start + .spec.replicas).
// start is the number representing the first replica's index. It may be used
// to number replicas from an alternate index (eg: 1-indexed) over the default
// 0-indexed names, or to orchestrate progressive movement of replicas from
// one StatefulSet to another.
// If set, replica indices will be in the range:
// [.spec.ordinals.start, .spec.ordinals.start + .spec.replicas).
// If unset, defaults to 0. Replica indices will be in the range:
// [0, .spec.replicas).
// +optional
Start int32 `json:"start" protobuf:"varint,1,opt,name=start"`
}
@@ -249,11 +253,13 @@ type StatefulSetSpec struct {
// which is alpha. +optional
PersistentVolumeClaimRetentionPolicy *StatefulSetPersistentVolumeClaimRetentionPolicy `json:"persistentVolumeClaimRetentionPolicy,omitempty" protobuf:"bytes,10,opt,name=persistentVolumeClaimRetentionPolicy"`
// Ordinals controls how the stateful set creates pod and persistent volume
// claim names.
// The default behavior assigns a number starting with zero and incremented by
// one for each additional replica requested. This requires the
// StatefulSetSlice feature gate to be enabled, which is alpha.
// ordinals controls the numbering of replica indices in a StatefulSet. A
// StatefulSet will create pods with the format <statefulsetname>-<podindex>.
// For example, a pod in a StatefulSet named "web" with index number "3" would
// be named "web-3". The default ordinals behavior assigns a "0" index to the
// first replica and increments the index by one for each additional replica
// requested. Using the ordinals field requires the StatefulSetStartOrdinal
// feature gate to be enabled, which is alpha.
// +optional
Ordinals *StatefulSetOrdinals `json:"ordinals,omitempty" protobuf:"bytes,11,opt,name=ordinals"`
}

4
staging/src/k8s.io/api/apps/v1/types_swagger_doc_generated.go generated
View File

@@ -326,7 +326,7 @@ func (StatefulSetList) SwaggerDoc() map[string]string {
var map_StatefulSetOrdinals = map[string]string{
"": "StatefulSetOrdinals describes the policy used for replica ordinal assignment in this StatefulSet.",
"start": "Start is the number representing the first index that is used to represent replica ordinals. Defaults to 0. If set, replica ordinals will be numbered [.spec.ordinals.start, .spec.ordinals.start - .spec.replicas).",
"start": "start is the number representing the first replica's index. It may be used to number replicas from an alternate index (eg: 1-indexed) over the default 0-indexed names, or to orchestrate progressive movement of replicas from one StatefulSet to another. If set, replica indices will be in the range:\n [.spec.ordinals.start, .spec.ordinals.start + .spec.replicas).\nIf unset, defaults to 0. Replica indices will be in the range:\n [0, .spec.replicas).",
}
func (StatefulSetOrdinals) SwaggerDoc() map[string]string {
@@ -355,7 +355,7 @@ var map_StatefulSetSpec = map[string]string{
"revisionHistoryLimit": "revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.",
"minReadySeconds": "Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)",
"persistentVolumeClaimRetentionPolicy": "persistentVolumeClaimRetentionPolicy describes the lifecycle of persistent volume claims created from volumeClaimTemplates. By default, all persistent volume claims are created as needed and retained until manually deleted. This policy allows the lifecycle to be altered, for example by deleting persistent volume claims when their stateful set is deleted, or when their pod is scaled down. This requires the StatefulSetAutoDeletePVC feature gate to be enabled, which is alpha. +optional",
"ordinals": "Ordinals controls how the stateful set creates pod and persistent volume claim names. The default behavior assigns a number starting with zero and incremented by one for each additional replica requested. This requires the StatefulSetSlice feature gate to be enabled, which is alpha.",
"ordinals": "ordinals controls the numbering of replica indices in a StatefulSet. A StatefulSet will create pods with the format <statefulsetname>-<podindex>. For example, a pod in a StatefulSet named \"web\" with index number \"3\" would be named \"web-3\". The default ordinals behavior assigns a \"0\" index to the first replica and increments the index by one for each additional replica requested. Using the ordinals field requires the StatefulSetStartOrdinal feature gate to be enabled, which is alpha.",
}
func (StatefulSetSpec) SwaggerDoc() map[string]string {

24
staging/src/k8s.io/api/apps/v1beta1/generated.proto
View File

@@ -383,10 +383,14 @@ message StatefulSetList {
// StatefulSetOrdinals describes the policy used for replica ordinal assignment
// in this StatefulSet.
message StatefulSetOrdinals {
// Start is the number representing the first index that is used to represent
// replica ordinals. Defaults to 0.
// If set, replica ordinals will be numbered
// [.spec.ordinals.start, .spec.ordinals.start - .spec.replicas).
// start is the number representing the first replica's index. It may be used
// to number replicas from an alternate index (eg: 1-indexed) over the default
// 0-indexed names, or to orchestrate progressive movement of replicas from
// one StatefulSet to another.
// If set, replica indices will be in the range:
// [.spec.ordinals.start, .spec.ordinals.start + .spec.replicas).
// If unset, defaults to 0. Replica indices will be in the range:
// [0, .spec.replicas).
// +optional
optional int32 start = 1;
}
@@ -481,11 +485,13 @@ message StatefulSetSpec {
// +optional
optional StatefulSetPersistentVolumeClaimRetentionPolicy persistentVolumeClaimRetentionPolicy = 10;
// Ordinals controls how the stateful set creates pod and persistent volume
// claim names.
// The default behavior assigns a number starting with zero and incremented by
// one for each additional replica requested. This requires the
// StatefulSetSlice feature gate to be enabled, which is alpha.
// ordinals controls the numbering of replica indices in a StatefulSet. A
// StatefulSet will create pods with the format <statefulsetname>-<podindex>.
// For example, a pod in a StatefulSet named "web" with index number "3" would
// be named "web-3". The default ordinals behavior assigns a "0" index to the
// first replica and increments the index by one for each additional replica
// requested. Using the ordinals field requires the StatefulSetStartOrdinal
// feature gate to be enabled, which is alpha.
// +optional
optional StatefulSetOrdinals ordinals = 11;
}

24
staging/src/k8s.io/api/apps/v1beta1/types.go
View File

@@ -207,10 +207,14 @@ type StatefulSetPersistentVolumeClaimRetentionPolicy struct {
// StatefulSetOrdinals describes the policy used for replica ordinal assignment
// in this StatefulSet.
type StatefulSetOrdinals struct {
// Start is the number representing the first index that is used to represent
// replica ordinals. Defaults to 0.
// If set, replica ordinals will be numbered in the range:
// [.spec.ordinals.start, .spec.ordinals.start + .spec.replicas).
// start is the number representing the first replica's index. It may be used
// to number replicas from an alternate index (eg: 1-indexed) over the default
// 0-indexed names, or to orchestrate progressive movement of replicas from
// one StatefulSet to another.
// If set, replica indices will be in the range:
// [.spec.ordinals.start, .spec.ordinals.start + .spec.replicas).
// If unset, defaults to 0. Replica indices will be in the range:
// [0, .spec.replicas).
// +optional
Start int32 `json:"start" protobuf:"varint,1,opt,name=start"`
}
@@ -288,11 +292,13 @@ type StatefulSetSpec struct {
// +optional
PersistentVolumeClaimRetentionPolicy *StatefulSetPersistentVolumeClaimRetentionPolicy `json:"persistentVolumeClaimRetentionPolicy,omitempty" protobuf:"bytes,10,opt,name=persistentVolumeClaimRetentionPolicy"`
// Ordinals controls how the stateful set creates pod and persistent volume
// claim names.
// The default behavior assigns a number starting with zero and incremented by
// one for each additional replica requested. This requires the
// StatefulSetSlice feature gate to be enabled, which is alpha.
// ordinals controls the numbering of replica indices in a StatefulSet. A
// StatefulSet will create pods with the format <statefulsetname>-<podindex>.
// For example, a pod in a StatefulSet named "web" with index number "3" would
// be named "web-3". The default ordinals behavior assigns a "0" index to the
// first replica and increments the index by one for each additional replica
// requested. Using the ordinals field requires the StatefulSetStartOrdinal
// feature gate to be enabled, which is alpha.
// +optional
Ordinals *StatefulSetOrdinals `json:"ordinals,omitempty" protobuf:"bytes,11,opt,name=ordinals"`
}

4
staging/src/k8s.io/api/apps/v1beta1/types_swagger_doc_generated.go generated
View File

@@ -230,7 +230,7 @@ func (StatefulSetList) SwaggerDoc() map[string]string {
var map_StatefulSetOrdinals = map[string]string{
"": "StatefulSetOrdinals describes the policy used for replica ordinal assignment in this StatefulSet.",
"start": "Start is the number representing the first index that is used to represent replica ordinals. Defaults to 0. If set, replica ordinals will be numbered [.spec.ordinals.start, .spec.ordinals.start - .spec.replicas).",
"start": "start is the number representing the first replica's index. It may be used to number replicas from an alternate index (eg: 1-indexed) over the default 0-indexed names, or to orchestrate progressive movement of replicas from one StatefulSet to another. If set, replica indices will be in the range:\n [.spec.ordinals.start, .spec.ordinals.start + .spec.replicas).\nIf unset, defaults to 0. Replica indices will be in the range:\n [0, .spec.replicas).",
}
func (StatefulSetOrdinals) SwaggerDoc() map[string]string {
@@ -259,7 +259,7 @@ var map_StatefulSetSpec = map[string]string{
"revisionHistoryLimit": "revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.",
"minReadySeconds": "Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)",
"persistentVolumeClaimRetentionPolicy": "PersistentVolumeClaimRetentionPolicy describes the policy used for PVCs created from the StatefulSet VolumeClaimTemplates. This requires the StatefulSetAutoDeletePVC feature gate to be enabled, which is alpha.",
"ordinals": "Ordinals controls how the stateful set creates pod and persistent volume claim names. The default behavior assigns a number starting with zero and incremented by one for each additional replica requested. This requires the StatefulSetSlice feature gate to be enabled, which is alpha.",
"ordinals": "ordinals controls the numbering of replica indices in a StatefulSet. A StatefulSet will create pods with the format <statefulsetname>-<podindex>. For example, a pod in a StatefulSet named \"web\" with index number \"3\" would be named \"web-3\". The default ordinals behavior assigns a \"0\" index to the first replica and increments the index by one for each additional replica requested. Using the ordinals field requires the StatefulSetStartOrdinal feature gate to be enabled, which is alpha.",
}
func (StatefulSetSpec) SwaggerDoc() map[string]string {

24
staging/src/k8s.io/api/apps/v1beta2/generated.proto
View File

@@ -670,10 +670,14 @@ message StatefulSetList {
// StatefulSetOrdinals describes the policy used for replica ordinal assignment
// in this StatefulSet.
message StatefulSetOrdinals {
// Start is the number representing the first index that is used to represent
// replica ordinals. Defaults to 0.
// If set, replica ordinals will be numbered
// [.spec.ordinals.start, .spec.ordinals.start - .spec.replicas).
// start is the number representing the first replica's index. It may be used
// to number replicas from an alternate index (eg: 1-indexed) over the default
// 0-indexed names, or to orchestrate progressive movement of replicas from
// one StatefulSet to another.
// If set, replica indices will be in the range:
// [.spec.ordinals.start, .spec.ordinals.start + .spec.replicas).
// If unset, defaults to 0. Replica indices will be in the range:
// [0, .spec.replicas).
// +optional
optional int32 start = 1;
}
@@ -767,11 +771,13 @@ message StatefulSetSpec {
// +optional
optional StatefulSetPersistentVolumeClaimRetentionPolicy persistentVolumeClaimRetentionPolicy = 10;
// Ordinals controls how the stateful set creates pod and persistent volume
// claim names.
// The default behavior assigns a number starting with zero and incremented by
// one for each additional replica requested. This requires the
// StatefulSetSlice feature gate to be enabled, which is alpha.
// ordinals controls the numbering of replica indices in a StatefulSet. A
// StatefulSet will create pods with the format <statefulsetname>-<podindex>.
// For example, a pod in a StatefulSet named "web" with index number "3" would
// be named "web-3". The default ordinals behavior assigns a "0" index to the
// first replica and increments the index by one for each additional replica
// requested. Using the ordinals field requires the StatefulSetStartOrdinal
// feature gate to be enabled, which is alpha.
// +optional
optional StatefulSetOrdinals ordinals = 11;
}

24
staging/src/k8s.io/api/apps/v1beta2/types.go
View File

@@ -217,10 +217,14 @@ type StatefulSetPersistentVolumeClaimRetentionPolicy struct {
// StatefulSetOrdinals describes the policy used for replica ordinal assignment
// in this StatefulSet.
type StatefulSetOrdinals struct {
// Start is the number representing the first index that is used to represent
// replica ordinals. Defaults to 0.
// If set, replica ordinals will be numbered in the range:
// [.spec.ordinals.start, .spec.ordinals.start + .spec.replicas).
// start is the number representing the first replica's index. It may be used
// to number replicas from an alternate index (eg: 1-indexed) over the default
// 0-indexed names, or to orchestrate progressive movement of replicas from
// one StatefulSet to another.
// If set, replica indices will be in the range:
// [.spec.ordinals.start, .spec.ordinals.start + .spec.replicas).
// If unset, defaults to 0. Replica indices will be in the range:
// [0, .spec.replicas).
// +optional
Start int32 `json:"start" protobuf:"varint,1,opt,name=start"`
}
@@ -297,11 +301,13 @@ type StatefulSetSpec struct {
// +optional
PersistentVolumeClaimRetentionPolicy *StatefulSetPersistentVolumeClaimRetentionPolicy `json:"persistentVolumeClaimRetentionPolicy,omitempty" protobuf:"bytes,10,opt,name=persistentVolumeClaimRetentionPolicy"`
// Ordinals controls how the stateful set creates pod and persistent volume
// claim names.
// The default behavior assigns a number starting with zero and incremented by
// one for each additional replica requested. This requires the
// StatefulSetSlice feature gate to be enabled, which is alpha.
// ordinals controls the numbering of replica indices in a StatefulSet. A
// StatefulSet will create pods with the format <statefulsetname>-<podindex>.
// For example, a pod in a StatefulSet named "web" with index number "3" would
// be named "web-3". The default ordinals behavior assigns a "0" index to the
// first replica and increments the index by one for each additional replica
// requested. Using the ordinals field requires the StatefulSetStartOrdinal
// feature gate to be enabled, which is alpha.
// +optional
Ordinals *StatefulSetOrdinals `json:"ordinals,omitempty" protobuf:"bytes,11,opt,name=ordinals"`
}

4
staging/src/k8s.io/api/apps/v1beta2/types_swagger_doc_generated.go generated
View File

@@ -354,7 +354,7 @@ func (StatefulSetList) SwaggerDoc() map[string]string {
var map_StatefulSetOrdinals = map[string]string{
"": "StatefulSetOrdinals describes the policy used for replica ordinal assignment in this StatefulSet.",
"start": "Start is the number representing the first index that is used to represent replica ordinals. Defaults to 0. If set, replica ordinals will be numbered [.spec.ordinals.start, .spec.ordinals.start - .spec.replicas).",
"start": "start is the number representing the first replica's index. It may be used to number replicas from an alternate index (eg: 1-indexed) over the default 0-indexed names, or to orchestrate progressive movement of replicas from one StatefulSet to another. If set, replica indices will be in the range:\n [.spec.ordinals.start, .spec.ordinals.start + .spec.replicas).\nIf unset, defaults to 0. Replica indices will be in the range:\n [0, .spec.replicas).",
}
func (StatefulSetOrdinals) SwaggerDoc() map[string]string {
@@ -383,7 +383,7 @@ var map_StatefulSetSpec = map[string]string{
"revisionHistoryLimit": "revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.",
"minReadySeconds": "Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)",
"persistentVolumeClaimRetentionPolicy": "PersistentVolumeClaimRetentionPolicy describes the policy used for PVCs created from the StatefulSet VolumeClaimTemplates. This requires the StatefulSetAutoDeletePVC feature gate to be enabled, which is alpha.",
"ordinals": "Ordinals controls how the stateful set creates pod and persistent volume claim names. The default behavior assigns a number starting with zero and incremented by one for each additional replica requested. This requires the StatefulSetSlice feature gate to be enabled, which is alpha.",
"ordinals": "ordinals controls the numbering of replica indices in a StatefulSet. A StatefulSet will create pods with the format <statefulsetname>-<podindex>. For example, a pod in a StatefulSet named \"web\" with index number \"3\" would be named \"web-3\". The default ordinals behavior assigns a \"0\" index to the first replica and increments the index by one for each additional replica requested. Using the ordinals field requires the StatefulSetStartOrdinal feature gate to be enabled, which is alpha.",
}
func (StatefulSetSpec) SwaggerDoc() map[string]string {