-
Notifications
You must be signed in to change notification settings - Fork 242
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add snapshot.storage.k8s.io CRDs (#94)
- Loading branch information
Showing
6 changed files
with
554 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| { | ||
| "description": "VolumeSnapshot is a user's request for either creating a point-in-time snapshot of a persistent volume, or binding to a pre-existing snapshot.", | ||
| "properties": { | ||
| "apiVersion": { | ||
| "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", | ||
| "type": "string" | ||
| }, | ||
| "kind": { | ||
| "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", | ||
| "type": "string" | ||
| }, | ||
| "spec": { | ||
| "description": "spec defines the desired characteristics of a snapshot requested by a user. More info: https://kubernetes.io/docs/concepts/storage/volume-snapshots#volumesnapshots Required.", | ||
| "properties": { | ||
| "source": { | ||
| "description": "source specifies where a snapshot will be created from. This field is immutable after creation. Required.", | ||
| "oneOf": [ | ||
| { | ||
| "required": [ | ||
| "persistentVolumeClaimName" | ||
| ] | ||
| }, | ||
| { | ||
| "required": [ | ||
| "volumeSnapshotContentName" | ||
| ] | ||
| } | ||
| ], | ||
| "properties": { | ||
| "persistentVolumeClaimName": { | ||
| "description": "persistentVolumeClaimName specifies the name of the PersistentVolumeClaim object representing the volume from which a snapshot should be created. This PVC is assumed to be in the same namespace as the VolumeSnapshot object. This field should be set if the snapshot does not exists, and needs to be created. This field is immutable.", | ||
| "type": "string" | ||
| }, | ||
| "volumeSnapshotContentName": { | ||
| "description": "volumeSnapshotContentName specifies the name of a pre-existing VolumeSnapshotContent object representing an existing volume snapshot. This field should be set if the snapshot already exists and only needs a representation in Kubernetes. This field is immutable.", | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "type": "object", | ||
| "additionalProperties": false | ||
| }, | ||
| "volumeSnapshotClassName": { | ||
| "description": "VolumeSnapshotClassName is the name of the VolumeSnapshotClass requested by the VolumeSnapshot. VolumeSnapshotClassName may be left nil to indicate that the default SnapshotClass should be used. A given cluster may have multiple default Volume SnapshotClasses: one default per CSI Driver. If a VolumeSnapshot does not specify a SnapshotClass, VolumeSnapshotSource will be checked to figure out what the associated CSI Driver is, and the default VolumeSnapshotClass associated with that CSI Driver will be used. If more than one VolumeSnapshotClass exist for a given CSI Driver and more than one have been marked as default, CreateSnapshot will fail and generate an event. Empty string is not allowed for this field.", | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "source" | ||
| ], | ||
| "type": "object", | ||
| "additionalProperties": false | ||
| }, | ||
| "status": { | ||
| "description": "status represents the current information of a snapshot. Consumers must verify binding between VolumeSnapshot and VolumeSnapshotContent objects is successful (by validating that both VolumeSnapshot and VolumeSnapshotContent point at each other) before using this object.", | ||
| "properties": { | ||
| "boundVolumeSnapshotContentName": { | ||
| "description": "boundVolumeSnapshotContentName is the name of the VolumeSnapshotContent object to which this VolumeSnapshot object intends to bind to. If not specified, it indicates that the VolumeSnapshot object has not been successfully bound to a VolumeSnapshotContent object yet. NOTE: To avoid possible security issues, consumers must verify binding between VolumeSnapshot and VolumeSnapshotContent objects is successful (by validating that both VolumeSnapshot and VolumeSnapshotContent point at each other) before using this object.", | ||
| "type": "string" | ||
| }, | ||
| "creationTime": { | ||
| "description": "creationTime is the timestamp when the point-in-time snapshot is taken by the underlying storage system. In dynamic snapshot creation case, this field will be filled in by the snapshot controller with the \"creation_time\" value returned from CSI \"CreateSnapshot\" gRPC call. For a pre-existing snapshot, this field will be filled with the \"creation_time\" value returned from the CSI \"ListSnapshots\" gRPC call if the driver supports it. If not specified, it may indicate that the creation time of the snapshot is unknown.", | ||
| "format": "date-time", | ||
| "type": "string" | ||
| }, | ||
| "error": { | ||
| "description": "error is the last observed error during snapshot creation, if any. This field could be helpful to upper level controllers(i.e., application controller) to decide whether they should continue on waiting for the snapshot to be created based on the type of error reported. The snapshot controller will keep retrying when an error occurs during the snapshot creation. Upon success, this error field will be cleared.", | ||
| "properties": { | ||
| "message": { | ||
| "description": "message is a string detailing the encountered error during snapshot creation if specified. NOTE: message may be logged, and it should not contain sensitive information.", | ||
| "type": "string" | ||
| }, | ||
| "time": { | ||
| "description": "time is the timestamp when the error was encountered.", | ||
| "format": "date-time", | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "type": "object", | ||
| "additionalProperties": false | ||
| }, | ||
| "readyToUse": { | ||
| "description": "readyToUse indicates if the snapshot is ready to be used to restore a volume. In dynamic snapshot creation case, this field will be filled in by the snapshot controller with the \"ready_to_use\" value returned from CSI \"CreateSnapshot\" gRPC call. For a pre-existing snapshot, this field will be filled with the \"ready_to_use\" value returned from the CSI \"ListSnapshots\" gRPC call if the driver supports it, otherwise, this field will be set to \"True\". If not specified, it means the readiness of a snapshot is unknown.", | ||
| "type": "boolean" | ||
| }, | ||
| "restoreSize": { | ||
| "description": "restoreSize represents the minimum size of volume required to create a volume from this snapshot. In dynamic snapshot creation case, this field will be filled in by the snapshot controller with the \"size_bytes\" value returned from CSI \"CreateSnapshot\" gRPC call. For a pre-existing snapshot, this field will be filled with the \"size_bytes\" value returned from the CSI \"ListSnapshots\" gRPC call if the driver supports it. When restoring a volume from this snapshot, the size of the volume MUST NOT be smaller than the restoreSize if it is specified, otherwise the restoration will fail. If not specified, it indicates that the size is unknown.", | ||
| "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", | ||
| "type": "string", | ||
| "x-kubernetes-int-or-string": true | ||
| } | ||
| }, | ||
| "type": "object", | ||
| "additionalProperties": false | ||
| } | ||
| }, | ||
| "required": [ | ||
| "spec" | ||
| ], | ||
| "type": "object" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| { | ||
| "description": "VolumeSnapshot is a user's request for either creating a point-in-time snapshot of a persistent volume, or binding to a pre-existing snapshot.", | ||
| "properties": { | ||
| "apiVersion": { | ||
| "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", | ||
| "type": "string" | ||
| }, | ||
| "kind": { | ||
| "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", | ||
| "type": "string" | ||
| }, | ||
| "spec": { | ||
| "description": "spec defines the desired characteristics of a snapshot requested by a user. More info: https://kubernetes.io/docs/concepts/storage/volume-snapshots#volumesnapshots Required.", | ||
| "properties": { | ||
| "source": { | ||
| "description": "source specifies where a snapshot will be created from. This field is immutable after creation. Required.", | ||
| "properties": { | ||
| "persistentVolumeClaimName": { | ||
| "description": "persistentVolumeClaimName specifies the name of the PersistentVolumeClaim object representing the volume from which a snapshot should be created. This PVC is assumed to be in the same namespace as the VolumeSnapshot object. This field should be set if the snapshot does not exists, and needs to be created. This field is immutable.", | ||
| "type": "string" | ||
| }, | ||
| "volumeSnapshotContentName": { | ||
| "description": "volumeSnapshotContentName specifies the name of a pre-existing VolumeSnapshotContent object representing an existing volume snapshot. This field should be set if the snapshot already exists and only needs a representation in Kubernetes. This field is immutable.", | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "type": "object", | ||
| "additionalProperties": false | ||
| }, | ||
| "volumeSnapshotClassName": { | ||
| "description": "VolumeSnapshotClassName is the name of the VolumeSnapshotClass requested by the VolumeSnapshot. VolumeSnapshotClassName may be left nil to indicate that the default SnapshotClass should be used. A given cluster may have multiple default Volume SnapshotClasses: one default per CSI Driver. If a VolumeSnapshot does not specify a SnapshotClass, VolumeSnapshotSource will be checked to figure out what the associated CSI Driver is, and the default VolumeSnapshotClass associated with that CSI Driver will be used. If more than one VolumeSnapshotClass exist for a given CSI Driver and more than one have been marked as default, CreateSnapshot will fail and generate an event. Empty string is not allowed for this field.", | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "source" | ||
| ], | ||
| "type": "object", | ||
| "additionalProperties": false | ||
| }, | ||
| "status": { | ||
| "description": "status represents the current information of a snapshot. Consumers must verify binding between VolumeSnapshot and VolumeSnapshotContent objects is successful (by validating that both VolumeSnapshot and VolumeSnapshotContent point at each other) before using this object.", | ||
| "properties": { | ||
| "boundVolumeSnapshotContentName": { | ||
| "description": "boundVolumeSnapshotContentName is the name of the VolumeSnapshotContent object to which this VolumeSnapshot object intends to bind to. If not specified, it indicates that the VolumeSnapshot object has not been successfully bound to a VolumeSnapshotContent object yet. NOTE: To avoid possible security issues, consumers must verify binding between VolumeSnapshot and VolumeSnapshotContent objects is successful (by validating that both VolumeSnapshot and VolumeSnapshotContent point at each other) before using this object.", | ||
| "type": "string" | ||
| }, | ||
| "creationTime": { | ||
| "description": "creationTime is the timestamp when the point-in-time snapshot is taken by the underlying storage system. In dynamic snapshot creation case, this field will be filled in by the snapshot controller with the \"creation_time\" value returned from CSI \"CreateSnapshot\" gRPC call. For a pre-existing snapshot, this field will be filled with the \"creation_time\" value returned from the CSI \"ListSnapshots\" gRPC call if the driver supports it. If not specified, it may indicate that the creation time of the snapshot is unknown.", | ||
| "format": "date-time", | ||
| "type": "string" | ||
| }, | ||
| "error": { | ||
| "description": "error is the last observed error during snapshot creation, if any. This field could be helpful to upper level controllers(i.e., application controller) to decide whether they should continue on waiting for the snapshot to be created based on the type of error reported. The snapshot controller will keep retrying when an error occurs during the snapshot creation. Upon success, this error field will be cleared.", | ||
| "properties": { | ||
| "message": { | ||
| "description": "message is a string detailing the encountered error during snapshot creation if specified. NOTE: message may be logged, and it should not contain sensitive information.", | ||
| "type": "string" | ||
| }, | ||
| "time": { | ||
| "description": "time is the timestamp when the error was encountered.", | ||
| "format": "date-time", | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "type": "object", | ||
| "additionalProperties": false | ||
| }, | ||
| "readyToUse": { | ||
| "description": "readyToUse indicates if the snapshot is ready to be used to restore a volume. In dynamic snapshot creation case, this field will be filled in by the snapshot controller with the \"ready_to_use\" value returned from CSI \"CreateSnapshot\" gRPC call. For a pre-existing snapshot, this field will be filled with the \"ready_to_use\" value returned from the CSI \"ListSnapshots\" gRPC call if the driver supports it, otherwise, this field will be set to \"True\". If not specified, it means the readiness of a snapshot is unknown.", | ||
| "type": "boolean" | ||
| }, | ||
| "restoreSize": { | ||
| "description": "restoreSize represents the minimum size of volume required to create a volume from this snapshot. In dynamic snapshot creation case, this field will be filled in by the snapshot controller with the \"size_bytes\" value returned from CSI \"CreateSnapshot\" gRPC call. For a pre-existing snapshot, this field will be filled with the \"size_bytes\" value returned from the CSI \"ListSnapshots\" gRPC call if the driver supports it. When restoring a volume from this snapshot, the size of the volume MUST NOT be smaller than the restoreSize if it is specified, otherwise the restoration will fail. If not specified, it indicates that the size is unknown.", | ||
| "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", | ||
| "type": "string", | ||
| "x-kubernetes-int-or-string": true | ||
| } | ||
| }, | ||
| "type": "object", | ||
| "additionalProperties": false | ||
| } | ||
| }, | ||
| "required": [ | ||
| "spec" | ||
| ], | ||
| "type": "object" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| { | ||
| "description": "VolumeSnapshotClass specifies parameters that a underlying storage system uses when creating a volume snapshot. A specific VolumeSnapshotClass is used by specifying its name in a VolumeSnapshot object. VolumeSnapshotClasses are non-namespaced", | ||
| "properties": { | ||
| "apiVersion": { | ||
| "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", | ||
| "type": "string" | ||
| }, | ||
| "deletionPolicy": { | ||
| "description": "deletionPolicy determines whether a VolumeSnapshotContent created through the VolumeSnapshotClass should be deleted when its bound VolumeSnapshot is deleted. Supported values are \"Retain\" and \"Delete\". \"Retain\" means that the VolumeSnapshotContent and its physical snapshot on underlying storage system are kept. \"Delete\" means that the VolumeSnapshotContent and its physical snapshot on underlying storage system are deleted. Required.", | ||
| "enum": [ | ||
| "Delete", | ||
| "Retain" | ||
| ], | ||
| "type": "string" | ||
| }, | ||
| "driver": { | ||
| "description": "driver is the name of the storage driver that handles this VolumeSnapshotClass. Required.", | ||
| "type": "string" | ||
| }, | ||
| "kind": { | ||
| "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", | ||
| "type": "string" | ||
| }, | ||
| "parameters": { | ||
| "additionalProperties": { | ||
| "type": "string" | ||
| }, | ||
| "description": "parameters is a key-value map with storage driver specific parameters for creating snapshots. These values are opaque to Kubernetes.", | ||
| "type": "object" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "deletionPolicy", | ||
| "driver" | ||
| ], | ||
| "type": "object" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| { | ||
| "description": "VolumeSnapshotClass specifies parameters that a underlying storage system uses when creating a volume snapshot. A specific VolumeSnapshotClass is used by specifying its name in a VolumeSnapshot object. VolumeSnapshotClasses are non-namespaced", | ||
| "properties": { | ||
| "apiVersion": { | ||
| "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", | ||
| "type": "string" | ||
| }, | ||
| "deletionPolicy": { | ||
| "description": "deletionPolicy determines whether a VolumeSnapshotContent created through the VolumeSnapshotClass should be deleted when its bound VolumeSnapshot is deleted. Supported values are \"Retain\" and \"Delete\". \"Retain\" means that the VolumeSnapshotContent and its physical snapshot on underlying storage system are kept. \"Delete\" means that the VolumeSnapshotContent and its physical snapshot on underlying storage system are deleted. Required.", | ||
| "enum": [ | ||
| "Delete", | ||
| "Retain" | ||
| ], | ||
| "type": "string" | ||
| }, | ||
| "driver": { | ||
| "description": "driver is the name of the storage driver that handles this VolumeSnapshotClass. Required.", | ||
| "type": "string" | ||
| }, | ||
| "kind": { | ||
| "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", | ||
| "type": "string" | ||
| }, | ||
| "parameters": { | ||
| "additionalProperties": { | ||
| "type": "string" | ||
| }, | ||
| "description": "parameters is a key-value map with storage driver specific parameters for creating snapshots. These values are opaque to Kubernetes.", | ||
| "type": "object" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "deletionPolicy", | ||
| "driver" | ||
| ], | ||
| "type": "object" | ||
| } |
Oops, something went wrong.