adjust comment prefixes in k8s.io/api/apps/v1beta1/types.go

This commit is contained in:
Mateusz Puczyński
2023-03-04 21:20:24 +01:00
parent f74724a3f4
commit d1877f514a
4 changed files with 104 additions and 104 deletions

View File

@@ -5186,14 +5186,14 @@ func schema_k8sio_api_apps_v1beta1_ControllerRevision(ref common.ReferenceCallba
},
"data": {
SchemaProps: spec.SchemaProps{
Description: "Data is the serialized representation of the state.",
Description: "data is the serialized representation of the state.",
Default: map[string]interface{}{},
Ref: ref("k8s.io/apimachinery/pkg/runtime.RawExtension"),
},
},
"revision": {
SchemaProps: spec.SchemaProps{
Description: "Revision indicates the revision of the state represented by Data.",
Description: "revision indicates the revision of the state represented by Data.",
Default: 0,
Type: []string{"integer"},
Format: "int64",
@@ -5490,14 +5490,14 @@ func schema_k8sio_api_apps_v1beta1_DeploymentSpec(ref common.ReferenceCallback)
Properties: map[string]spec.Schema{
"replicas": {
SchemaProps: spec.SchemaProps{
Description: "Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.",
Description: "replicas is the number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.",
Type: []string{"integer"},
Format: "int32",
},
},
"selector": {
SchemaProps: spec.SchemaProps{
Description: "Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment.",
Description: "selector is the label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment.",
Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.LabelSelector"),
},
},
@@ -5522,34 +5522,34 @@ func schema_k8sio_api_apps_v1beta1_DeploymentSpec(ref common.ReferenceCallback)
},
"minReadySeconds": {
SchemaProps: spec.SchemaProps{
Description: "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)",
Description: "minReadySeconds is the 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)",
Type: []string{"integer"},
Format: "int32",
},
},
"revisionHistoryLimit": {
SchemaProps: spec.SchemaProps{
Description: "The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 2.",
Description: "revisionHistoryLimit is the number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 2.",
Type: []string{"integer"},
Format: "int32",
},
},
"paused": {
SchemaProps: spec.SchemaProps{
Description: "Indicates that the deployment is paused.",
Description: "paused indicates that the deployment is paused.",
Type: []string{"boolean"},
Format: "",
},
},
"rollbackTo": {
SchemaProps: spec.SchemaProps{
Description: "DEPRECATED. The config this deployment is rolling back to. Will be cleared after rollback is done.",
Description: "DEPRECATED. rollbackTo is the config this deployment is rolling back to. Will be cleared after rollback is done.",
Ref: ref("k8s.io/api/apps/v1beta1.RollbackConfig"),
},
},
"progressDeadlineSeconds": {
SchemaProps: spec.SchemaProps{
Description: "The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.",
Description: "progressDeadlineSeconds is the maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.",
Type: []string{"integer"},
Format: "int32",
},
@@ -5572,21 +5572,21 @@ func schema_k8sio_api_apps_v1beta1_DeploymentStatus(ref common.ReferenceCallback
Properties: map[string]spec.Schema{
"observedGeneration": {
SchemaProps: spec.SchemaProps{
Description: "The generation observed by the deployment controller.",
Description: "observedGeneration is the generation observed by the deployment controller.",
Type: []string{"integer"},
Format: "int64",
},
},
"replicas": {
SchemaProps: spec.SchemaProps{
Description: "Total number of non-terminated pods targeted by this deployment (their labels match the selector).",
Description: "replicas is the total number of non-terminated pods targeted by this deployment (their labels match the selector).",
Type: []string{"integer"},
Format: "int32",
},
},
"updatedReplicas": {
SchemaProps: spec.SchemaProps{
Description: "Total number of non-terminated pods targeted by this deployment that have the desired template spec.",
Description: "updatedReplicas is the total number of non-terminated pods targeted by this deployment that have the desired template spec.",
Type: []string{"integer"},
Format: "int32",
},
@@ -5607,7 +5607,7 @@ func schema_k8sio_api_apps_v1beta1_DeploymentStatus(ref common.ReferenceCallback
},
"unavailableReplicas": {
SchemaProps: spec.SchemaProps{
Description: "Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.",
Description: "unavailableReplicas is the total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.",
Type: []string{"integer"},
Format: "int32",
},
@@ -5620,7 +5620,7 @@ func schema_k8sio_api_apps_v1beta1_DeploymentStatus(ref common.ReferenceCallback
},
},
SchemaProps: spec.SchemaProps{
Description: "Represents the latest available observations of a deployment's current state.",
Description: "Conditions represent the latest available observations of a deployment's current state.",
Type: []string{"array"},
Items: &spec.SchemaOrArray{
Schema: &spec.Schema{
@@ -5634,7 +5634,7 @@ func schema_k8sio_api_apps_v1beta1_DeploymentStatus(ref common.ReferenceCallback
},
"collisionCount": {
SchemaProps: spec.SchemaProps{
Description: "Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.",
Description: "collisionCount is the count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.",
Type: []string{"integer"},
Format: "int32",
},
@@ -5738,7 +5738,7 @@ func schema_k8sio_api_apps_v1beta1_RollingUpdateStatefulSetStrategy(ref common.R
},
"maxUnavailable": {
SchemaProps: spec.SchemaProps{
Description: "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 up. This can not be 0. Defaults to 1. This field is alpha-level and is only honored by servers that enable the MaxUnavailableStatefulSet feature. The field applies to all pods in the range 0 to Replicas-1. That means if there is any unavailable pod in the range 0 to Replicas-1, it will be counted towards MaxUnavailable.",
Description: "maxUnavailable is 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 up. This can not be 0. Defaults to 1. This field is alpha-level and is only honored by servers that enable the MaxUnavailableStatefulSet feature. The field applies to all pods in the range 0 to Replicas-1. That means if there is any unavailable pod in the range 0 to Replicas-1, it will be counted towards MaxUnavailable.",
Ref: ref("k8s.io/apimachinery/pkg/util/intstr.IntOrString"),
},
},
@@ -5780,14 +5780,14 @@ func schema_k8sio_api_apps_v1beta1_Scale(ref common.ReferenceCallback) common.Op
},
"spec": {
SchemaProps: spec.SchemaProps{
Description: "defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.",
Description: "spec defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.",
Default: map[string]interface{}{},
Ref: ref("k8s.io/api/apps/v1beta1.ScaleSpec"),
},
},
"status": {
SchemaProps: spec.SchemaProps{
Description: "current status of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. Read-only.",
Description: "status defines current status of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. Read-only.",
Default: map[string]interface{}{},
Ref: ref("k8s.io/api/apps/v1beta1.ScaleStatus"),
},
@@ -5809,7 +5809,7 @@ func schema_k8sio_api_apps_v1beta1_ScaleSpec(ref common.ReferenceCallback) commo
Properties: map[string]spec.Schema{
"replicas": {
SchemaProps: spec.SchemaProps{
Description: "desired number of instances for the scaled object.",
Description: "replicas is the number of observed instances of the scaled object.",
Type: []string{"integer"},
Format: "int32",
},
@@ -5829,7 +5829,7 @@ func schema_k8sio_api_apps_v1beta1_ScaleStatus(ref common.ReferenceCallback) com
Properties: map[string]spec.Schema{
"replicas": {
SchemaProps: spec.SchemaProps{
Description: "actual number of observed instances of the scaled object.",
Description: "replias is the actual number of observed instances of the scaled object.",
Default: 0,
Type: []string{"integer"},
Format: "int32",
@@ -5853,7 +5853,7 @@ func schema_k8sio_api_apps_v1beta1_ScaleStatus(ref common.ReferenceCallback) com
},
"targetSelector": {
SchemaProps: spec.SchemaProps{
Description: "label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors",
Description: "targetSelector is the label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors",
Type: []string{"string"},
Format: "",
},
@@ -6046,14 +6046,14 @@ func schema_k8sio_api_apps_v1beta1_StatefulSetPersistentVolumeClaimRetentionPoli
Properties: map[string]spec.Schema{
"whenDeleted": {
SchemaProps: spec.SchemaProps{
Description: "WhenDeleted specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is deleted. The default policy of `Retain` causes PVCs to not be affected by StatefulSet deletion. The `Delete` policy causes those PVCs to be deleted.",
Description: "whenDeleted specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is deleted. The default policy of `Retain` causes PVCs to not be affected by StatefulSet deletion. The `Delete` policy causes those PVCs to be deleted.",
Type: []string{"string"},
Format: "",
},
},
"whenScaled": {
SchemaProps: spec.SchemaProps{
Description: "WhenScaled specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is scaled down. The default policy of `Retain` causes PVCs to not be affected by a scaledown. The `Delete` policy causes the associated PVCs for any excess pods above the replica count to be deleted.",
Description: "whenScaled specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is scaled down. The default policy of `Retain` causes PVCs to not be affected by a scaledown. The `Delete` policy causes the associated PVCs for any excess pods above the replica count to be deleted.",
Type: []string{"string"},
Format: "",
},
@@ -6136,7 +6136,7 @@ func schema_k8sio_api_apps_v1beta1_StatefulSetSpec(ref common.ReferenceCallback)
},
"minReadySeconds": {
SchemaProps: spec.SchemaProps{
Description: "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)",
Description: "minReadySeconds is the 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)",
Type: []string{"integer"},
Format: "int32",
},
@@ -6234,7 +6234,7 @@ func schema_k8sio_api_apps_v1beta1_StatefulSetStatus(ref common.ReferenceCallbac
},
},
SchemaProps: spec.SchemaProps{
Description: "Represents the latest available observations of a statefulset's current state.",
Description: "conditions represent the latest available observations of a statefulset's current state.",
Type: []string{"array"},
Items: &spec.SchemaOrArray{
Schema: &spec.Schema{
@@ -6248,7 +6248,7 @@ func schema_k8sio_api_apps_v1beta1_StatefulSetStatus(ref common.ReferenceCallbac
},
"availableReplicas": {
SchemaProps: spec.SchemaProps{
Description: "Total number of available pods (ready for at least minReadySeconds) targeted by this StatefulSet.",
Description: "availableReplicas is the total number of available pods (ready for at least minReadySeconds) targeted by this StatefulSet.",
Default: 0,
Type: []string{"integer"},
Format: "int32",