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

Add generated docs for discovery v1beta1 and storage v1 types

Browse Source
This commit is contained in:
Ravi Nalluri
2022-11-16 16:55:33 -06:00
parent 1a80cfdc5c
commit fdcf7b3b92
8 changed files with 197 additions and 195 deletions
Download Patch File Download Diff File Expand all files Collapse all files

78
pkg/generated/openapi/zz_generated.openapi.go generated
View File

@@ -28182,21 +28182,21 @@ func schema_k8sio_api_discovery_v1beta1_EndpointPort(ref common.ReferenceCallbac
},
"protocol": {
SchemaProps: spec.SchemaProps{
Description: "The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.",
Description: "protocol represents the IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.",
Type: []string{"string"},
Format: "",
},
},
"port": {
SchemaProps: spec.SchemaProps{
Description: "The port number of the endpoint. If this is not specified, ports are not restricted and must be interpreted in the context of the specific consumer.",
Description: "port represents the port number of the endpoint. If this is not specified, ports are not restricted and must be interpreted in the context of the specific consumer.",
Type: []string{"integer"},
Format: "int32",
},
},
"appProtocol": {
SchemaProps: spec.SchemaProps{
Description: "The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.",
Description: "appProtocol represents the application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.",
Type: []string{"string"},
Format: "",
},
@@ -28320,7 +28320,7 @@ func schema_k8sio_api_discovery_v1beta1_EndpointSliceList(ref common.ReferenceCa
},
"items": {
SchemaProps: spec.SchemaProps{
Description: "List of endpoint slices",
Description: "items is the list of endpoint slices",
Type: []string{"array"},
Items: &spec.SchemaOrArray{
Schema: &spec.Schema{
@@ -42610,7 +42610,7 @@ func schema_k8sio_api_storage_v1_CSIDriver(ref common.ReferenceCallback) common.
},
"spec": {
SchemaProps: spec.SchemaProps{
Description: "Specification of the CSI Driver.",
Description: "spec represents the specification of the CSI Driver.",
Default: map[string]interface{}{},
Ref: ref("k8s.io/api/storage/v1.CSIDriverSpec"),
},
@@ -42725,7 +42725,7 @@ func schema_k8sio_api_storage_v1_CSIDriverSpec(ref common.ReferenceCallback) com
},
"fsGroupPolicy": {
SchemaProps: spec.SchemaProps{
Description: "Defines if the underlying volume supports changing ownership and permission of the volume before being mounted. Refer to the specific FSGroupPolicy values for additional details.\n\nThis field is immutable.\n\nDefaults to ReadWriteOnceWithFSType, which will examine each volume to determine if Kubernetes should modify ownership and permissions of the volume. With the default policy the defined fsGroup will only be applied if a fstype is defined and the volume's access mode contains ReadWriteOnce.",
Description: "fsGroupPolicy defines if the underlying volume supports changing ownership and permission of the volume before being mounted. Refer to the specific FSGroupPolicy values for additional details.\n\nThis field is immutable.\n\nDefaults to ReadWriteOnceWithFSType, which will examine each volume to determine if Kubernetes should modify ownership and permissions of the volume. With the default policy the defined fsGroup will only be applied if a fstype is defined and the volume's access mode contains ReadWriteOnce.",
Type: []string{"string"},
Format: "",
},
@@ -42737,7 +42737,7 @@ func schema_k8sio_api_storage_v1_CSIDriverSpec(ref common.ReferenceCallback) com
},
},
SchemaProps: spec.SchemaProps{
Description: "TokenRequests indicates the CSI driver needs pods' service account tokens it is mounting volume for to do necessary authentication. Kubelet will pass the tokens in VolumeContext in the CSI NodePublishVolume calls. The CSI driver should parse and validate the following VolumeContext: \"csi.storage.k8s.io/serviceAccount.tokens\": {\n \"<audience>\": {\n \"token\": <token>,\n \"expirationTimestamp\": <expiration timestamp in RFC3339>,\n },\n ...\n}\n\nNote: Audience in each TokenRequest should be different and at most one token is empty string. To receive a new token after expiry, RequiresRepublish can be used to trigger NodePublishVolume periodically.",
Description: "tokenRequests indicates the CSI driver needs pods' service account tokens it is mounting volume for to do necessary authentication. Kubelet will pass the tokens in VolumeContext in the CSI NodePublishVolume calls. The CSI driver should parse and validate the following VolumeContext: \"csi.storage.k8s.io/serviceAccount.tokens\": {\n \"<audience>\": {\n \"token\": <token>,\n \"expirationTimestamp\": <expiration timestamp in RFC3339>,\n },\n ...\n}\n\nNote: Audience in each TokenRequest should be different and at most one token is empty string. To receive a new token after expiry, RequiresRepublish can be used to trigger NodePublishVolume periodically.",
Type: []string{"array"},
Items: &spec.SchemaOrArray{
Schema: &spec.Schema{
@@ -42751,14 +42751,14 @@ func schema_k8sio_api_storage_v1_CSIDriverSpec(ref common.ReferenceCallback) com
},
"requiresRepublish": {
SchemaProps: spec.SchemaProps{
Description: "RequiresRepublish indicates the CSI driver wants `NodePublishVolume` being periodically called to reflect any possible change in the mounted volume. This field defaults to false.\n\nNote: After a successful initial NodePublishVolume call, subsequent calls to NodePublishVolume should only update the contents of the volume. New mount points will not be seen by a running container.",
Description: "requiresRepublish indicates the CSI driver wants `NodePublishVolume` being periodically called to reflect any possible change in the mounted volume. This field defaults to false.\n\nNote: After a successful initial NodePublishVolume call, subsequent calls to NodePublishVolume should only update the contents of the volume. New mount points will not be seen by a running container.",
Type: []string{"boolean"},
Format: "",
},
},
"seLinuxMount": {
SchemaProps: spec.SchemaProps{
Description: "SELinuxMount specifies if the CSI driver supports \"-o context\" mount option.\n\nWhen \"true\", the CSI driver must ensure that all volumes provided by this CSI driver can be mounted separately with different `-o context` options. This is typical for storage backends that provide volumes as filesystems on block devices or as independent shared volumes. Kubernetes will call NodeStage / NodePublish with \"-o context=xyz\" mount option when mounting a ReadWriteOncePod volume used in Pod that has explicitly set SELinux context. In the future, it may be expanded to other volume AccessModes. In any case, Kubernetes will ensure that the volume is mounted only with a single SELinux context.\n\nWhen \"false\", Kubernetes won't pass any special SELinux mount options to the driver. This is typical for volumes that represent subdirectories of a bigger shared filesystem.\n\nDefault is \"false\".",
Description: "seLinuxMount specifies if the CSI driver supports \"-o context\" mount option.\n\nWhen \"true\", the CSI driver must ensure that all volumes provided by this CSI driver can be mounted separately with different `-o context` options. This is typical for storage backends that provide volumes as filesystems on block devices or as independent shared volumes. Kubernetes will call NodeStage / NodePublish with \"-o context=xyz\" mount option when mounting a ReadWriteOncePod volume used in Pod that has explicitly set SELinux context. In the future, it may be expanded to other volume AccessModes. In any case, Kubernetes will ensure that the volume is mounted only with a single SELinux context.\n\nWhen \"false\", Kubernetes won't pass any special SELinux mount options to the driver. This is typical for volumes that represent subdirectories of a bigger shared filesystem.\n\nDefault is \"false\".",
Type: []string{"boolean"},
Format: "",
},
@@ -42794,7 +42794,7 @@ func schema_k8sio_api_storage_v1_CSINode(ref common.ReferenceCallback) common.Op
},
"metadata": {
SchemaProps: spec.SchemaProps{
Description: "metadata.name must be the Kubernetes node name.",
Description: "Standard object's metadata. metadata.name must be the Kubernetes node name.",
Default: map[string]interface{}{},
Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta"),
},
@@ -42824,7 +42824,7 @@ func schema_k8sio_api_storage_v1_CSINodeDriver(ref common.ReferenceCallback) com
Properties: map[string]spec.Schema{
"name": {
SchemaProps: spec.SchemaProps{
Description: "This is the name of the CSI driver that this object refers to. This MUST be the same name returned by the CSI GetPluginName() call for that driver.",
Description: "name represents the name of the CSI driver that this object refers to. This MUST be the same name returned by the CSI GetPluginName() call for that driver.",
Default: "",
Type: []string{"string"},
Format: "",
@@ -42978,20 +42978,20 @@ func schema_k8sio_api_storage_v1_CSIStorageCapacity(ref common.ReferenceCallback
},
"metadata": {
SchemaProps: spec.SchemaProps{
Description: "Standard object's metadata. The name has no particular meaning. It must be be a DNS subdomain (dots allowed, 253 characters). To ensure that there are no conflicts with other CSI drivers on the cluster, the recommendation is to use csisc-<uuid>, a generated name, or a reverse-domain name which ends with the unique CSI driver name.\n\nObjects are namespaced.\n\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
Description: "Standard object's metadata. The name has no particular meaning. It must be a DNS subdomain (dots allowed, 253 characters). To ensure that there are no conflicts with other CSI drivers on the cluster, the recommendation is to use csisc-<uuid>, a generated name, or a reverse-domain name which ends with the unique CSI driver name.\n\nObjects are namespaced.\n\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
Default: map[string]interface{}{},
Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta"),
},
},
"nodeTopology": {
SchemaProps: spec.SchemaProps{
Description: "NodeTopology defines which nodes have access to the storage for which capacity was reported. If not set, the storage is not accessible from any node in the cluster. If empty, the storage is accessible from all nodes. This field is immutable.",
Description: "nodeTopology defines which nodes have access to the storage for which capacity was reported. If not set, the storage is not accessible from any node in the cluster. If empty, the storage is accessible from all nodes. This field is immutable.",
Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.LabelSelector"),
},
},
"storageClassName": {
SchemaProps: spec.SchemaProps{
Description: "The name of the StorageClass that the reported capacity applies to. It must meet the same requirements as the name of a StorageClass object (non-empty, DNS subdomain). If that object no longer exists, the CSIStorageCapacity object is obsolete and should be removed by its creator. This field is immutable.",
Description: "storageClassName represents the name of the StorageClass that the reported capacity applies to. It must meet the same requirements as the name of a StorageClass object (non-empty, DNS subdomain). If that object no longer exists, the CSIStorageCapacity object is obsolete and should be removed by its creator. This field is immutable.",
Default: "",
Type: []string{"string"},
Format: "",
@@ -42999,13 +42999,13 @@ func schema_k8sio_api_storage_v1_CSIStorageCapacity(ref common.ReferenceCallback
},
"capacity": {
SchemaProps: spec.SchemaProps{
Description: "Capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields.\n\nThe semantic is currently (CSI spec 1.2) defined as: The available capacity, in bytes, of the storage that can be used to provision volumes. If not set, that information is currently unavailable.",
Description: "capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields.\n\nThe semantic is currently (CSI spec 1.2) defined as: The available capacity, in bytes, of the storage that can be used to provision volumes. If not set, that information is currently unavailable.",
Ref: ref("k8s.io/apimachinery/pkg/api/resource.Quantity"),
},
},
"maximumVolumeSize": {
SchemaProps: spec.SchemaProps{
Description: "MaximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields.\n\nThis is defined since CSI spec 1.4.0 as the largest size that may be used in a CreateVolumeRequest.capacity_range.required_bytes field to create a volume with the same parameters as those in GetCapacityRequest. The corresponding value in the Kubernetes API is ResourceRequirements.Requests in a volume claim.",
Description: "maximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields.\n\nThis is defined since CSI spec 1.4.0 as the largest size that may be used in a CreateVolumeRequest.capacity_range.required_bytes field to create a volume with the same parameters as those in GetCapacityRequest. The corresponding value in the Kubernetes API is ResourceRequirements.Requests in a volume claim.",
Ref: ref("k8s.io/apimachinery/pkg/api/resource.Quantity"),
},
},
@@ -43056,7 +43056,7 @@ func schema_k8sio_api_storage_v1_CSIStorageCapacityList(ref common.ReferenceCall
},
},
SchemaProps: spec.SchemaProps{
Description: "Items is the list of CSIStorageCapacity objects.",
Description: "items is the list of CSIStorageCapacity objects.",
Type: []string{"array"},
Items: &spec.SchemaOrArray{
Schema: &spec.Schema{
@@ -43107,7 +43107,7 @@ func schema_k8sio_api_storage_v1_StorageClass(ref common.ReferenceCallback) comm
},
"provisioner": {
SchemaProps: spec.SchemaProps{
Description: "Provisioner indicates the type of the provisioner.",
Description: "provisioner indicates the type of the provisioner.",
Default: "",
Type: []string{"string"},
Format: "",
@@ -43115,7 +43115,7 @@ func schema_k8sio_api_storage_v1_StorageClass(ref common.ReferenceCallback) comm
},
"parameters": {
SchemaProps: spec.SchemaProps{
Description: "Parameters holds the parameters for the provisioner that should create volumes of this storage class.",
Description: "parameters holds the parameters for the provisioner that should create volumes of this storage class.",
Type: []string{"object"},
AdditionalProperties: &spec.SchemaOrBool{
Allows: true,
@@ -43153,14 +43153,14 @@ func schema_k8sio_api_storage_v1_StorageClass(ref common.ReferenceCallback) comm
},
"allowVolumeExpansion": {
SchemaProps: spec.SchemaProps{
Description: "AllowVolumeExpansion shows whether the storage class allow volume expand",
Description: "allowVolumeExpansion shows whether the storage class allow volume expand.",
Type: []string{"boolean"},
Format: "",
},
},
"volumeBindingMode": {
SchemaProps: spec.SchemaProps{
Description: "VolumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature.",
Description: "volumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature.",
Type: []string{"string"},
Format: "",
},
@@ -43172,7 +43172,7 @@ func schema_k8sio_api_storage_v1_StorageClass(ref common.ReferenceCallback) comm
},
},
SchemaProps: spec.SchemaProps{
Description: "Restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature.",
Description: "allowedTopologies restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature.",
Type: []string{"array"},
Items: &spec.SchemaOrArray{
Schema: &spec.Schema{
@@ -43223,7 +43223,7 @@ func schema_k8sio_api_storage_v1_StorageClassList(ref common.ReferenceCallback)
},
"items": {
SchemaProps: spec.SchemaProps{
Description: "Items is the list of StorageClasses",
Description: "items is the list of StorageClasses",
Type: []string{"array"},
Items: &spec.SchemaOrArray{
Schema: &spec.Schema{
@@ -43253,7 +43253,7 @@ func schema_k8sio_api_storage_v1_TokenRequest(ref common.ReferenceCallback) comm
Properties: map[string]spec.Schema{
"audience": {
SchemaProps: spec.SchemaProps{
Description: "Audience is the intended audience of the token in \"TokenRequestSpec\". It will default to the audiences of kube apiserver.",
Description: "audience is the intended audience of the token in \"TokenRequestSpec\". It will default to the audiences of kube apiserver.",
Default: "",
Type: []string{"string"},
Format: "",
@@ -43261,7 +43261,7 @@ func schema_k8sio_api_storage_v1_TokenRequest(ref common.ReferenceCallback) comm
},
"expirationSeconds": {
SchemaProps: spec.SchemaProps{
Description: "ExpirationSeconds is the duration of validity of the token in \"TokenRequestSpec\". It has the same default value of \"ExpirationSeconds\" in \"TokenRequestSpec\".",
Description: "expirationSeconds is the duration of validity of the token in \"TokenRequestSpec\". It has the same default value of \"ExpirationSeconds\" in \"TokenRequestSpec\".",
Type: []string{"integer"},
Format: "int64",
},
@@ -43303,14 +43303,14 @@ func schema_k8sio_api_storage_v1_VolumeAttachment(ref common.ReferenceCallback)
},
"spec": {
SchemaProps: spec.SchemaProps{
Description: "Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system.",
Description: "spec represents specification of the desired attach/detach volume behavior. Populated by the Kubernetes system.",
Default: map[string]interface{}{},
Ref: ref("k8s.io/api/storage/v1.VolumeAttachmentSpec"),
},
},
"status": {
SchemaProps: spec.SchemaProps{
Description: "Status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher.",
Description: "status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher.",
Default: map[string]interface{}{},
Ref: ref("k8s.io/api/storage/v1.VolumeAttachmentStatus"),
},
@@ -43354,7 +43354,7 @@ func schema_k8sio_api_storage_v1_VolumeAttachmentList(ref common.ReferenceCallba
},
"items": {
SchemaProps: spec.SchemaProps{
Description: "Items is the list of VolumeAttachments",
Description: "items is the list of VolumeAttachments",
Type: []string{"array"},
Items: &spec.SchemaOrArray{
Schema: &spec.Schema{
@@ -43384,7 +43384,7 @@ func schema_k8sio_api_storage_v1_VolumeAttachmentSource(ref common.ReferenceCall
Properties: map[string]spec.Schema{
"persistentVolumeName": {
SchemaProps: spec.SchemaProps{
Description: "Name of the persistent volume to attach.",
Description: "persistentVolumeName represents the name of the persistent volume to attach.",
Type: []string{"string"},
Format: "",
},
@@ -43412,7 +43412,7 @@ func schema_k8sio_api_storage_v1_VolumeAttachmentSpec(ref common.ReferenceCallba
Properties: map[string]spec.Schema{
"attacher": {
SchemaProps: spec.SchemaProps{
Description: "Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName().",
Description: "attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName().",
Default: "",
Type: []string{"string"},
Format: "",
@@ -43420,14 +43420,14 @@ func schema_k8sio_api_storage_v1_VolumeAttachmentSpec(ref common.ReferenceCallba
},
"source": {
SchemaProps: spec.SchemaProps{
Description: "Source represents the volume that should be attached.",
Description: "source represents the volume that should be attached.",
Default: map[string]interface{}{},
Ref: ref("k8s.io/api/storage/v1.VolumeAttachmentSource"),
},
},
"nodeName": {
SchemaProps: spec.SchemaProps{
Description: "The node that the volume should be attached to.",
Description: "nodeName represents the node that the volume should be attached to.",
Default: "",
Type: []string{"string"},
Format: "",
@@ -43451,7 +43451,7 @@ func schema_k8sio_api_storage_v1_VolumeAttachmentStatus(ref common.ReferenceCall
Properties: map[string]spec.Schema{
"attached": {
SchemaProps: spec.SchemaProps{
Description: "Indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.",
Description: "attached indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.",
Default: false,
Type: []string{"boolean"},
Format: "",
@@ -43459,7 +43459,7 @@ func schema_k8sio_api_storage_v1_VolumeAttachmentStatus(ref common.ReferenceCall
},
"attachmentMetadata": {
SchemaProps: spec.SchemaProps{
Description: "Upon successful attach, this field is populated with any information returned by the attach operation that must be passed into subsequent WaitForAttach or Mount calls. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.",
Description: "attachmentMetadata is populated with any information returned by the attach operation, upon successful attach, that must be passed into subsequent WaitForAttach or Mount calls. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.",
Type: []string{"object"},
AdditionalProperties: &spec.SchemaOrBool{
Allows: true,
@@ -43475,13 +43475,13 @@ func schema_k8sio_api_storage_v1_VolumeAttachmentStatus(ref common.ReferenceCall
},
"attachError": {
SchemaProps: spec.SchemaProps{
Description: "The last error encountered during attach operation, if any. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.",
Description: "attachError represents the last error encountered during attach operation, if any. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.",
Ref: ref("k8s.io/api/storage/v1.VolumeError"),
},
},
"detachError": {
SchemaProps: spec.SchemaProps{
Description: "The last error encountered during detach operation, if any. This field must only be set by the entity completing the detach operation, i.e. the external-attacher.",
Description: "detachError represents the last error encountered during detach operation, if any. This field must only be set by the entity completing the detach operation, i.e. the external-attacher.",
Ref: ref("k8s.io/api/storage/v1.VolumeError"),
},
},
@@ -43503,14 +43503,14 @@ func schema_k8sio_api_storage_v1_VolumeError(ref common.ReferenceCallback) commo
Properties: map[string]spec.Schema{
"time": {
SchemaProps: spec.SchemaProps{
Description: "Time the error was encountered.",
Description: "time the error was encountered.",
Default: map[string]interface{}{},
Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.Time"),
},
},
"message": {
SchemaProps: spec.SchemaProps{
Description: "String detailing the error encountered during Attach or Detach operation. This string may be logged, so it should not contain sensitive information.",
Description: "message represents the error encountered during Attach or Detach operation. This string may be logged, so it should not contain sensitive information.",
Type: []string{"string"},
Format: "",
},
@@ -43532,7 +43532,7 @@ func schema_k8sio_api_storage_v1_VolumeNodeResources(ref common.ReferenceCallbac
Properties: map[string]spec.Schema{
"count": {
SchemaProps: spec.SchemaProps{
Description: "Maximum number of unique volumes managed by the CSI driver that can be used on a node. A volume that is both attached and mounted on a node is considered to be used once, not twice. The same rule applies for a unique volume that is shared among multiple pods on the same node. If this field is not specified, then the supported number of volumes on this node is unbounded.",
Description: "count indicates the maximum number of unique volumes managed by the CSI driver that can be used on a node. A volume that is both attached and mounted on a node is considered to be used once, not twice. The same rule applies for a unique volume that is shared among multiple pods on the same node. If this field is not specified, then the supported number of volumes on this node is unbounded.",
Type: []string{"integer"},
Format: "int32",
},