diff --git a/README.md b/README.md index 6d618b2..b8d7ac1 100644 --- a/README.md +++ b/README.md @@ -4,22 +4,22 @@ The Intelliflash Container Storage Interface (CSI) Block Driver provides a CSI interface used by Container Orchestrators (CO) to manage the lifecycle of Intelliflash volumes over iSCSI protocol. ## Feature List -|Feature|Feature Status|CSI Driver Version|CSI Spec Version|Kubernetes Version| -|--- |--- |--- |--- |--- | -|Static Provisioning|GA|>= v1.0.0|>= v1.0.0|>=1.13| -|Dynamic Provisioning|GA|>= v1.0.0|>= v1.0.0|>=1.13| -|RW mode|GA|>= v1.0.0|>= v1.0.0|>=1.13| -|RO mode|GA|>= v1.0.0|>= v1.0.0|>=1.13| -|Creating and deleting snapshot|GA|>= v1.2.0|>= v1.0.0|>=1.17| -|Provision volume from snapshot|GA|>= v1.2.0|>= v1.0.0|>=1.17| -|Provision volume from another volume|GA|>= v1.3.0|>= v1.0.0|>=1.17| -|List snapshots of a volume|Beta|>= v1.2.0|>= v1.0.0|>=1.17| -|Expand volume|GA|>= v1.3.0|>= v1.1.0|>=1.16| -|Access list for volume (NFS only)|GA|>= v1.3.0|>= v1.0.0|>=1.13| -|Topology|Beta|>= v1.4.0|>= v1.0.0|>=1.17| -|Raw block device|In development|future|>= v1.0.0|>=1.14| -|StorageClass Secrets|Beta|>= v1.3.0|>=1.0.0|>=1.13| -|Mount options|GA|>=v1.0.0|>=v1.0.0|>=v1.13| +|Feature|Feature Status|CSI Driver Version|CSI Spec Version|Kubernetes Version|Intelliflash Version| +|--- |--- |--- |--- |--- |--- | +|Static Provisioning|GA|>= v1.0.0|>= v1.0.0|>=1.13|>=3.11.2| +|Dynamic Provisioning|GA|>= v1.0.0|>= v1.0.0|>=1.13|>=3.11.2| +|RW mode|GA|>= v1.0.0|>= v1.0.0|>=1.13|>=3.11.2| +|RO mode|GA|>= v1.0.0|>= v1.0.0|>=1.13|>=3.11.2| +|Creating and deleting snapshot|GA|>= v1.2.0|>= v1.0.0|>=1.20|>=3.11.2| +|Provision volume from snapshot|GA|>= v1.2.0|>= v1.0.0|>=1.20|>=3.11.2| +|Provision volume from another volume|GA|>= v1.3.0|>= v1.0.0|>=1.20|>=3.11.2| +|List snapshots of a volume|Beta|>= v1.2.0|>= v1.0.0|>=1.20|>=3.11.2| +|Expand volume|GA|>= v1.3.0|>= v1.1.0|>=1.16|>=3.11.2| +|Access list for volume (NFS only)|GA|>= v1.3.0|>= v1.0.0|>=1.13|>=3.11.2| +|Topology|Beta|>= v1.4.0|>= v1.0.0|>=1.17|>=3.11.2| +|Raw block device|In development|future|>= v1.0.0|>=1.14|>=3.11.2| +|StorageClass Secrets|Beta|>= v1.3.0|>=1.0.0|>=1.13|>=3.11.2| +|Mount options|GA|>=v1.0.0|>=v1.0.0|>=v1.13|>=3.11.2| ## Requirements @@ -46,25 +46,27 @@ The Intelliflash Container Storage Interface (CSI) Block Driver provides a CSI i 2. Clone driver repository ```bash - git clone https://github.com/DDNStorage/intelliflash-csi-block-driver.git + git clone https://bitbucket.eng-us.tegile.com/eco/intelliflash-csi-block-driver.git cd intelliflash-csi-block-driver ``` 3. Edit `deploy/kubernetes/intelliflash-csi-block-driver-config.yaml` file. Driver configuration example: - ```yaml - arrays: - array1: - restIp: https://172.27.10.30:443 # [required] IntelliFlash REST API endpoint - username: admin # [required] IntelliFlash REST API username - password: t # [required] IntelliFlash REST API password - defaultProject: csi-block # default project name for driver's volume - defaultDataIp: 172.27.10.30 # default IntelliFlash data IP - useChapAuth: true # Defines whether CHAP authentication is enabled - chapUser: admin # CHAP username - chapSecret: chapsecretif # CHAP secret - initiatorGroup: csi-block-chap-initiator-group # Initiator group associated with project, required for CHAP - debug: true - ``` +```yaml +arrays: + array1: + restIp: https://172.27.10.30:443 # [required] IntelliFlash REST API endpoint + username: admin # [required] IntelliFlash REST API username + password: t # [required] IntelliFlash REST API password + defaultProject: csi-block # default project name for driver's volume + defaultDataIp: 172.27.10.30 # default IntelliFlash data IP + +useChapAuth: true # Defines whether CHAP authentication is enabled +chapUser: admin # CHAP username +chapSecret: chapsecretif # CHAP secret +initiatorGroup: csi-block-chap-initiator-group # Initiator group associated with project, required for CHAP +debug: true +``` + 4. Create Kubernetes secret from the file: ```bash kubectl create secret generic intelliflash-csi-block-driver-config --from-file=deploy/kubernetes/intelliflash-csi-block-driver-config.yaml @@ -259,6 +261,65 @@ Example: initiatorGroup: csi-chap-initiator-group # Initiator group associated with project, required for CHAP ``` +## InheritProjectSettings option + +This option tells the driver whether it should inherit iSCSI options from the project or use what is provided via storage class parameters or config. If this option is set to `true`, no additional settings are required. If you want to use a separate iSCSI target/target group, use `false` and provide the following parameters. For storageClass parameters: +- target +- targetGroup +- iSCSIPort (optional) + +Example storageClass: + +```yaml +apiVersion: v1 +kind: PersistentVolumeClaim +metadata: + name: intelliflash-csi-block-driver-pvc-nginx-dynamic-clone +spec: + storageClassName: intelliflash-csi-block-driver-cs-nginx-dynamic + dataSource: + kind: PersistentVolumeClaim + apiGroup: "" + name: intelliflash-csi-block-driver-pvc-nginx-dynamic # pvc name + accessModes: + - ReadWriteMany + resources: + requests: + storage: 1Gi +parameters: + targetGroup: non-default + target: non-default + inheritProjectSettings: "false" +``` + + +For config values a prefix 'Default' is added to each parameter, as follows: +- DefaultTarget +- DefaultTargetGroup +- DefaultISCSIPort + +Example config file: +```yaml +arrays: + array1: + restIp: https://172.27.10.30:443 # [required] IntelliFlash REST API endpoint + username: admin # [required] IntelliFlash REST API username + password: t # [required] IntelliFlash REST API password + defaultProject: csi-block # default project name for driver's volume + defaultDataIp: 172.27.10.30 # default IntelliFlash data IP + inheritProjectSettings: false # defines whether the volume should inherit iscsi mapping from the project or create depending on csi config + defaultTarget: csi # default target to use when inheritProjectSettings=false + defaultTargetGroup: csi # default target group to use when inheritProjectSettings=false + defaultHostGroup: csi # default host group to use when inheritProjectSettings=false + defaultISCSIPort: 3260 # default iSCSI port to use when inheritProjectSettings=false + +useChapAuth: true # Defines whether CHAP authentication is enabled +chapUser: admin # CHAP username +chapSecret: chapsecretif # CHAP secret +initiatorGroup: csi-block-chap-initiator-group # Initiator group associated with project, required for CHAP +debug: true +``` + ## Uninstall Using the same files as for installation: diff --git a/deploy/kubernetes/intelliflash-csi-block-driver-config.yaml b/deploy/kubernetes/intelliflash-csi-block-driver-config.yaml index 1620612..da5dfee 100644 --- a/deploy/kubernetes/intelliflash-csi-block-driver-config.yaml +++ b/deploy/kubernetes/intelliflash-csi-block-driver-config.yaml @@ -3,17 +3,19 @@ # $ kubectl create secret generic intelliflash-csi-block-driver-config \ # --from-file=deploy/kubernetes/intelliflash-csi-block-driver-config.yaml # - arrays: - array: - restIp: https://10.204.86.70:443 # [required] IntelliFlash REST API endpoint - username: admin # [required] IntelliFlash REST API username - password: t # [required] IntelliFlash REST API password - defaultProject: csi-block-chap # default project name for driver's volume - defaultDataIp: 10.204.86.71 # default IntelliFlash data IP - -useChapAuth: true # Defines whether CHAP authentication is enabled -chapUser: admin # CHAP username -chapSecret: chapsecretif # CHAP secret -initiatorGroup: csi-block-chap-initiator-group # Initiator group associated with project, required for CHAP -debug: true # more logs + array1: + restIp: https://10.204.86.70:443 + username: admin + password: t + defaultProject: csi-block-test1 + defaultDataIp: 10.204.86.71 + zone: zone-1 + array2: + restIp: https://10.204.86.70:443 + username: admin + password: t + defaultProject: csi-block-test2 + defaultDataIp: 10.204.86.75 + zone: zone-2 +debug: true \ No newline at end of file diff --git a/deploy/kubernetes/intelliflash-csi-block-driver.yaml b/deploy/kubernetes/intelliflash-csi-block-driver.yaml index 3080b00..ef7366c 100644 --- a/deploy/kubernetes/intelliflash-csi-block-driver.yaml +++ b/deploy/kubernetes/intelliflash-csi-block-driver.yaml @@ -13,13 +13,13 @@ # IntelliFlash CSI Driver # ---------------------- -apiVersion: storage.k8s.io/v1beta1 #k8s =>1.14 +apiVersion: storage.k8s.io/v1 #k8s =>1.20 kind: CSIDriver metadata: name: intelliflash-csi-block-driver.intelliflash.com spec: - attachRequired: false - podInfoOnMount: false + attachRequired: true + podInfoOnMount: true --- @@ -72,7 +72,10 @@ rules: verbs: ['get', 'list', 'watch'] - apiGroups: ['storage.k8s.io'] resources: ['volumeattachments'] - verbs: ['get', 'list', 'watch', 'update'] + verbs: ['get', 'list', 'watch', 'update', 'patch'] + - apiGroups: ['storage.k8s.io'] + resources: ['volumeattachments/status'] + verbs: ['get', 'list', 'watch', 'update', 'patch'] # snapshotter specific - apiGroups: ['snapshot.storage.k8s.io'] resources: ['volumesnapshotclasses'] @@ -83,6 +86,12 @@ rules: - apiGroups: ['snapshot.storage.k8s.io'] resources: ['volumesnapshots'] verbs: ['get', 'list', 'watch', 'update'] + - apiGroups: ["snapshot.storage.k8s.io"] + resources: ["volumesnapshots/status"] + verbs: ["update"] + - apiGroups: ["snapshot.storage.k8s.io"] + resources: ["volumesnapshotcontents/status"] + verbs: ["update"] - apiGroups: ['apiextensions.k8s.io'] resources: ['customresourcedefinitions'] verbs: ['create', 'list', 'watch', 'delete'] @@ -210,22 +219,35 @@ spec: # csi-provisioner: sidecar container that watches Kubernetes PersistentVolumeClaim objects # and triggers CreateVolume/DeleteVolume against a CSI endpoint - name: csi-provisioner - image: quay.io/k8scsi/csi-provisioner:v1.4.0 + image: k8s.gcr.io/sig-storage/csi-provisioner:v2.2.0 imagePullPolicy: IfNotPresent args: - - --connection-timeout=25s - - --provisioner=intelliflash-csi-block-driver.intelliflash.com - --csi-address=/var/lib/csi/sockets/pluginproxy/csi.sock - --volume-name-prefix=pvc-intelliflash - --feature-gates=Topology=true + - --strict-topology + - --immediate-topology=false volumeMounts: - name: socket-dir mountPath: /var/lib/csi/sockets/pluginproxy + - name: csi-attacher + image: k8s.gcr.io/sig-storage/csi-attacher:v3.5.0 + imagePullPolicy: IfNotPresent + args: + - --csi-address=$(ADDRESS) + - --v=2 + - --leader-election=true + env: + - name: ADDRESS + value: /var/lib/csi/sockets/pluginproxy/csi.sock + volumeMounts: + - name: socket-dir + mountPath: /var/lib/csi/sockets/pluginproxy/ - name: csi-snapshotter - image: quay.io/k8scsi/csi-snapshotter:v1.1.0 # v1.2.0 doesn't work + image: k8s.gcr.io/sig-storage/csi-snapshotter:v4.1.1 imagePullPolicy: IfNotPresent args: - - --connection-timeout=25s + - -v=3 - --csi-address=/var/lib/csi/sockets/pluginproxy/csi.sock volumeMounts: - name: socket-dir @@ -242,8 +264,8 @@ spec: - name: socket-dir mountPath: /var/lib/csi/sockets/pluginproxy/ - name: driver - image: intelliflash-csi-block-driver:master - imagePullPolicy: Always + image: 10.204.86.117:5000/intelliflash-csi-block-driver:master + imagePullPolicy: IfNotPresent args: - --nodeid=$(KUBE_NODE_NAME) - --endpoint=unix://csi/csi.sock @@ -287,9 +309,9 @@ apiVersion: rbac.authorization.k8s.io/v1 metadata: name: intelliflash-csi-block-node-cluster-role rules: - - apiGroups: [""] - resources: ["events"] - verbs: ["get", "list", "watch", "create", "update", "patch"] + # - apiGroups: [""] + # resources: ["events"] + # verbs: ["get", "list", "watch", "create", "update", "patch"] - apiGroups: [""] resources: ["secrets"] verbs: ["get", "list"] @@ -346,7 +368,7 @@ spec: # 1) registers the CSI driver with kubelet # 2) adds the drivers custom NodeId to a label on the Kubernetes Node API Object - name: driver-registrar - image: quay.io/k8scsi/csi-node-driver-registrar:v1.1.0 + image: k8s.gcr.io/sig-storage/csi-node-driver-registrar:v2.5.0 imagePullPolicy: IfNotPresent args: - --v=3 @@ -368,8 +390,8 @@ spec: capabilities: add: ['SYS_ADMIN'] allowPrivilegeEscalation: true - image: intelliflash-csi-block-driver:master - imagePullPolicy: Always + image: 10.204.86.117:5000/intelliflash-csi-block-driver:master + imagePullPolicy: IfNotPresent args: - --nodeid=$(KUBE_NODE_NAME) - --endpoint=unix://csi/csi.sock diff --git a/deploy/kubernetes/snapshots/crds.yaml b/deploy/kubernetes/snapshots/crds.yaml new file mode 100644 index 0000000..a78abd2 --- /dev/null +++ b/deploy/kubernetes/snapshots/crds.yaml @@ -0,0 +1,630 @@ + +--- +apiVersion: apiextensions.k8s.io/v1 +kind: CustomResourceDefinition +metadata: + annotations: + controller-gen.kubebuilder.io/version: v0.4.0 + api-approved.kubernetes.io: "https://github.com/kubernetes-csi/external-snapshotter/pull/419" + creationTimestamp: null + name: volumesnapshotclasses.snapshot.storage.k8s.io +spec: + group: snapshot.storage.k8s.io + names: + kind: VolumeSnapshotClass + listKind: VolumeSnapshotClassList + plural: volumesnapshotclasses + singular: volumesnapshotclass + scope: Cluster + versions: + - additionalPrinterColumns: + - jsonPath: .driver + name: Driver + type: string + - description: Determines whether a VolumeSnapshotContent created through the VolumeSnapshotClass should be deleted when its bound VolumeSnapshot is deleted. + jsonPath: .deletionPolicy + name: DeletionPolicy + type: string + - jsonPath: .metadata.creationTimestamp + name: Age + type: date + name: v1 + schema: + openAPIV3Schema: + 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 + served: true + storage: false + subresources: {} + - additionalPrinterColumns: + - jsonPath: .driver + name: Driver + type: string + - description: Determines whether a VolumeSnapshotContent created through the VolumeSnapshotClass should be deleted when its bound VolumeSnapshot is deleted. + jsonPath: .deletionPolicy + name: DeletionPolicy + type: string + - jsonPath: .metadata.creationTimestamp + name: Age + type: date + name: v1beta1 + schema: + openAPIV3Schema: + 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 + served: true + storage: true + subresources: {} +status: + acceptedNames: + kind: "" + plural: "" + conditions: [] + storedVersions: [] + +--- +apiVersion: apiextensions.k8s.io/v1 +kind: CustomResourceDefinition +metadata: + annotations: + controller-gen.kubebuilder.io/version: v0.4.0 + api-approved.kubernetes.io: "https://github.com/kubernetes-csi/external-snapshotter/pull/419" + creationTimestamp: null + name: volumesnapshotcontents.snapshot.storage.k8s.io +spec: + group: snapshot.storage.k8s.io + names: + kind: VolumeSnapshotContent + listKind: VolumeSnapshotContentList + plural: volumesnapshotcontents + singular: volumesnapshotcontent + scope: Cluster + versions: + - additionalPrinterColumns: + - description: Indicates if the snapshot is ready to be used to restore a volume. + jsonPath: .status.readyToUse + name: ReadyToUse + type: boolean + - description: Represents the complete size of the snapshot in bytes + jsonPath: .status.restoreSize + name: RestoreSize + type: integer + - description: Determines whether this VolumeSnapshotContent and its physical snapshot on the underlying storage system should be deleted when its bound VolumeSnapshot is deleted. + jsonPath: .spec.deletionPolicy + name: DeletionPolicy + type: string + - description: Name of the CSI driver used to create the physical snapshot on the underlying storage system. + jsonPath: .spec.driver + name: Driver + type: string + - description: Name of the VolumeSnapshotClass to which this snapshot belongs. + jsonPath: .spec.volumeSnapshotClassName + name: VolumeSnapshotClass + type: string + - description: Name of the VolumeSnapshot object to which this VolumeSnapshotContent object is bound. + jsonPath: .spec.volumeSnapshotRef.name + name: VolumeSnapshot + type: string + - jsonPath: .metadata.creationTimestamp + name: Age + type: date + name: v1 + schema: + openAPIV3Schema: + description: VolumeSnapshotContent represents the actual "on-disk" snapshot object in the underlying storage system + 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 properties of a VolumeSnapshotContent created by the underlying storage system. Required. + properties: + deletionPolicy: + description: deletionPolicy determines whether this VolumeSnapshotContent and its physical snapshot on the underlying storage system 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. For dynamically provisioned snapshots, this field will automatically be filled in by the CSI snapshotter sidecar with the "DeletionPolicy" field defined in the corresponding VolumeSnapshotClass. For pre-existing snapshots, users MUST specify this field when creating the VolumeSnapshotContent object. Required. + enum: + - Delete + - Retain + type: string + driver: + description: driver is the name of the CSI driver used to create the physical snapshot on the underlying storage system. This MUST be the same as the name returned by the CSI GetPluginName() call for that driver. Required. + type: string + source: + description: source specifies whether the snapshot is (or should be) dynamically provisioned or already exists, and just requires a Kubernetes object representation. This field is immutable after creation. Required. + properties: + snapshotHandle: + description: snapshotHandle specifies the CSI "snapshot_id" of a pre-existing snapshot on the underlying storage system for which a Kubernetes object representation was (or should be) created. This field is immutable. + type: string + volumeHandle: + description: volumeHandle specifies the CSI "volume_id" of the volume from which a snapshot should be dynamically taken from. This field is immutable. + type: string + type: object + oneOf: + - required: ["snapshotHandle"] + - required: ["volumeHandle"] + volumeSnapshotClassName: + description: name of the VolumeSnapshotClass from which this snapshot was (or will be) created. Note that after provisioning, the VolumeSnapshotClass may be deleted or recreated with different set of values, and as such, should not be referenced post-snapshot creation. + type: string + volumeSnapshotRef: + description: volumeSnapshotRef specifies the VolumeSnapshot object to which this VolumeSnapshotContent object is bound. VolumeSnapshot.Spec.VolumeSnapshotContentName field must reference to this VolumeSnapshotContent's name for the bidirectional binding to be valid. For a pre-existing VolumeSnapshotContent object, name and namespace of the VolumeSnapshot object MUST be provided for binding to happen. This field is immutable after creation. Required. + properties: + apiVersion: + description: API version of the referent. + type: string + fieldPath: + description: 'If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.' + type: string + kind: + description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' + type: string + name: + description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' + type: string + namespace: + description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/' + type: string + resourceVersion: + description: 'Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency' + type: string + uid: + description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids' + type: string + type: object + required: + - deletionPolicy + - driver + - source + - volumeSnapshotRef + type: object + status: + description: status represents the current information of a snapshot. + properties: + 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 CSI snapshotter sidecar 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 indicates the creation time is unknown. The format of this field is a Unix nanoseconds time encoded as an int64. On Unix, the command `date +%s%N` returns the current time in nanoseconds since 1970-01-01 00:00:00 UTC. + format: int64 + type: integer + error: + description: error is the last observed error during snapshot creation, if any. Upon success after retry, 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 + readyToUse: + description: readyToUse indicates if a snapshot is ready to be used to restore a volume. In dynamic snapshot creation case, this field will be filled in by the CSI snapshotter sidecar 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 complete size of the snapshot in bytes. In dynamic snapshot creation case, this field will be filled in by the CSI snapshotter sidecar 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. + format: int64 + minimum: 0 + type: integer + snapshotHandle: + description: snapshotHandle is the CSI "snapshot_id" of a snapshot on the underlying storage system. If not specified, it indicates that dynamic snapshot creation has either failed or it is still in progress. + type: string + type: object + required: + - spec + type: object + served: true + storage: false + subresources: + status: {} + - additionalPrinterColumns: + - description: Indicates if the snapshot is ready to be used to restore a volume. + jsonPath: .status.readyToUse + name: ReadyToUse + type: boolean + - description: Represents the complete size of the snapshot in bytes + jsonPath: .status.restoreSize + name: RestoreSize + type: integer + - description: Determines whether this VolumeSnapshotContent and its physical snapshot on the underlying storage system should be deleted when its bound VolumeSnapshot is deleted. + jsonPath: .spec.deletionPolicy + name: DeletionPolicy + type: string + - description: Name of the CSI driver used to create the physical snapshot on the underlying storage system. + jsonPath: .spec.driver + name: Driver + type: string + - description: Name of the VolumeSnapshotClass to which this snapshot belongs. + jsonPath: .spec.volumeSnapshotClassName + name: VolumeSnapshotClass + type: string + - description: Name of the VolumeSnapshot object to which this VolumeSnapshotContent object is bound. + jsonPath: .spec.volumeSnapshotRef.name + name: VolumeSnapshot + type: string + - jsonPath: .metadata.creationTimestamp + name: Age + type: date + name: v1beta1 + schema: + openAPIV3Schema: + description: VolumeSnapshotContent represents the actual "on-disk" snapshot object in the underlying storage system + 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 properties of a VolumeSnapshotContent created by the underlying storage system. Required. + properties: + deletionPolicy: + description: deletionPolicy determines whether this VolumeSnapshotContent and its physical snapshot on the underlying storage system 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. For dynamically provisioned snapshots, this field will automatically be filled in by the CSI snapshotter sidecar with the "DeletionPolicy" field defined in the corresponding VolumeSnapshotClass. For pre-existing snapshots, users MUST specify this field when creating the VolumeSnapshotContent object. Required. + enum: + - Delete + - Retain + type: string + driver: + description: driver is the name of the CSI driver used to create the physical snapshot on the underlying storage system. This MUST be the same as the name returned by the CSI GetPluginName() call for that driver. Required. + type: string + source: + description: source specifies whether the snapshot is (or should be) dynamically provisioned or already exists, and just requires a Kubernetes object representation. This field is immutable after creation. Required. + properties: + snapshotHandle: + description: snapshotHandle specifies the CSI "snapshot_id" of a pre-existing snapshot on the underlying storage system for which a Kubernetes object representation was (or should be) created. This field is immutable. + type: string + volumeHandle: + description: volumeHandle specifies the CSI "volume_id" of the volume from which a snapshot should be dynamically taken from. This field is immutable. + type: string + type: object + volumeSnapshotClassName: + description: name of the VolumeSnapshotClass from which this snapshot was (or will be) created. Note that after provisioning, the VolumeSnapshotClass may be deleted or recreated with different set of values, and as such, should not be referenced post-snapshot creation. + type: string + volumeSnapshotRef: + description: volumeSnapshotRef specifies the VolumeSnapshot object to which this VolumeSnapshotContent object is bound. VolumeSnapshot.Spec.VolumeSnapshotContentName field must reference to this VolumeSnapshotContent's name for the bidirectional binding to be valid. For a pre-existing VolumeSnapshotContent object, name and namespace of the VolumeSnapshot object MUST be provided for binding to happen. This field is immutable after creation. Required. + properties: + apiVersion: + description: API version of the referent. + type: string + fieldPath: + description: 'If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.' + type: string + kind: + description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' + type: string + name: + description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' + type: string + namespace: + description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/' + type: string + resourceVersion: + description: 'Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency' + type: string + uid: + description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids' + type: string + type: object + required: + - deletionPolicy + - driver + - source + - volumeSnapshotRef + type: object + status: + description: status represents the current information of a snapshot. + properties: + 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 CSI snapshotter sidecar 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 indicates the creation time is unknown. The format of this field is a Unix nanoseconds time encoded as an int64. On Unix, the command `date +%s%N` returns the current time in nanoseconds since 1970-01-01 00:00:00 UTC. + format: int64 + type: integer + error: + description: error is the last observed error during snapshot creation, if any. Upon success after retry, 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 + readyToUse: + description: readyToUse indicates if a snapshot is ready to be used to restore a volume. In dynamic snapshot creation case, this field will be filled in by the CSI snapshotter sidecar 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 complete size of the snapshot in bytes. In dynamic snapshot creation case, this field will be filled in by the CSI snapshotter sidecar 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. + format: int64 + minimum: 0 + type: integer + snapshotHandle: + description: snapshotHandle is the CSI "snapshot_id" of a snapshot on the underlying storage system. If not specified, it indicates that dynamic snapshot creation has either failed or it is still in progress. + type: string + type: object + required: + - spec + type: object + served: true + storage: true + subresources: + status: {} +status: + acceptedNames: + kind: "" + plural: "" + conditions: [] + storedVersions: [] + +--- +apiVersion: apiextensions.k8s.io/v1 +kind: CustomResourceDefinition +metadata: + annotations: + controller-gen.kubebuilder.io/version: v0.4.0 + api-approved.kubernetes.io: "https://github.com/kubernetes-csi/external-snapshotter/pull/419" + creationTimestamp: null + name: volumesnapshots.snapshot.storage.k8s.io +spec: + group: snapshot.storage.k8s.io + names: + kind: VolumeSnapshot + listKind: VolumeSnapshotList + plural: volumesnapshots + singular: volumesnapshot + scope: Namespaced + versions: + - additionalPrinterColumns: + - description: Indicates if the snapshot is ready to be used to restore a volume. + jsonPath: .status.readyToUse + name: ReadyToUse + type: boolean + - description: If a new snapshot needs to be created, this contains the name of the source PVC from which this snapshot was (or will be) created. + jsonPath: .spec.source.persistentVolumeClaimName + name: SourcePVC + type: string + - description: If a snapshot already exists, this contains the name of the existing VolumeSnapshotContent object representing the existing snapshot. + jsonPath: .spec.source.volumeSnapshotContentName + name: SourceSnapshotContent + type: string + - description: Represents the minimum size of volume required to rehydrate from this snapshot. + jsonPath: .status.restoreSize + name: RestoreSize + type: string + - description: The name of the VolumeSnapshotClass requested by the VolumeSnapshot. + jsonPath: .spec.volumeSnapshotClassName + name: SnapshotClass + type: string + - description: Name of the VolumeSnapshotContent object to which the VolumeSnapshot object intends to bind to. Please note that verification of binding actually requires checking both VolumeSnapshot and VolumeSnapshotContent to ensure both are pointing at each other. Binding MUST be verified prior to usage of this object. + jsonPath: .status.boundVolumeSnapshotContentName + name: SnapshotContent + type: string + - description: Timestamp when the point-in-time snapshot was taken by the underlying storage system. + jsonPath: .status.creationTime + name: CreationTime + type: date + - jsonPath: .metadata.creationTimestamp + name: Age + type: date + name: v1 + schema: + openAPIV3Schema: + 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 + oneOf: + - required: ["persistentVolumeClaimName"] + - required: ["volumeSnapshotContentName"] + 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 + 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 occurrs 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 + 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: + type: string + 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]+))))?$ + x-kubernetes-int-or-string: true + type: object + required: + - spec + type: object + served: true + storage: false + subresources: + status: {} + - additionalPrinterColumns: + - description: Indicates if the snapshot is ready to be used to restore a volume. + jsonPath: .status.readyToUse + name: ReadyToUse + type: boolean + - description: If a new snapshot needs to be created, this contains the name of the source PVC from which this snapshot was (or will be) created. + jsonPath: .spec.source.persistentVolumeClaimName + name: SourcePVC + type: string + - description: If a snapshot already exists, this contains the name of the existing VolumeSnapshotContent object representing the existing snapshot. + jsonPath: .spec.source.volumeSnapshotContentName + name: SourceSnapshotContent + type: string + - description: Represents the minimum size of volume required to rehydrate from this snapshot. + jsonPath: .status.restoreSize + name: RestoreSize + type: string + - description: The name of the VolumeSnapshotClass requested by the VolumeSnapshot. + jsonPath: .spec.volumeSnapshotClassName + name: SnapshotClass + type: string + - description: Name of the VolumeSnapshotContent object to which the VolumeSnapshot object intends to bind to. Please note that verification of binding actually requires checking both VolumeSnapshot and VolumeSnapshotContent to ensure both are pointing at each other. Binding MUST be verified prior to usage of this object. + jsonPath: .status.boundVolumeSnapshotContentName + name: SnapshotContent + type: string + - description: Timestamp when the point-in-time snapshot was taken by the underlying storage system. + jsonPath: .status.creationTime + name: CreationTime + type: date + - jsonPath: .metadata.creationTimestamp + name: Age + type: date + name: v1beta1 + schema: + openAPIV3Schema: + 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 + 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 + 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 occurrs 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 + 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: + type: string + 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]+))))?$ + x-kubernetes-int-or-string: true + type: object + required: + - spec + type: object + served: true + storage: true + subresources: + status: {} +status: + acceptedNames: + kind: "" + plural: "" + conditions: [] + storedVersions: [] + diff --git a/deploy/kubernetes/snapshots/snapshotter.yaml b/deploy/kubernetes/snapshots/snapshotter.yaml new file mode 100644 index 0000000..37d1be7 --- /dev/null +++ b/deploy/kubernetes/snapshots/snapshotter.yaml @@ -0,0 +1,118 @@ +# RBAC file for the snapshot controller. +# +# The snapshot controller implements the control loop for CSI snapshot functionality. +# It should be installed as part of the base Kubernetes distribution in an appropriate +# namespace for components implementing base system functionality. For installing with +# Vanilla Kubernetes, kube-system makes sense for the namespace. + +apiVersion: v1 +kind: ServiceAccount +metadata: + name: snapshot-controller + namespace: default # TODO: replace with the namespace you want for your controller, e.g. kube-system + +--- +kind: ClusterRole +apiVersion: rbac.authorization.k8s.io/v1 +metadata: + # rename if there are conflicts + name: snapshot-controller-runner +rules: + - apiGroups: [""] + resources: ["persistentvolumes"] + verbs: ["get", "list", "watch"] + - apiGroups: [""] + resources: ["persistentvolumeclaims"] + verbs: ["get", "list", "watch", "update"] + - apiGroups: ["storage.k8s.io"] + resources: ["storageclasses"] + verbs: ["get", "list", "watch"] + - apiGroups: [""] + resources: ["events"] + verbs: ["list", "watch", "create", "update", "patch"] + - apiGroups: ["snapshot.storage.k8s.io"] + resources: ["volumesnapshotclasses"] + verbs: ["get", "list", "watch"] + - apiGroups: ["snapshot.storage.k8s.io"] + resources: ["volumesnapshotcontents"] + verbs: ["create", "get", "list", "watch", "update", "delete"] + - apiGroups: ["snapshot.storage.k8s.io"] + resources: ["volumesnapshots"] + verbs: ["get", "list", "watch", "update"] + - apiGroups: ["snapshot.storage.k8s.io"] + resources: ["volumesnapshots/status"] + verbs: ["update"] + +--- +kind: ClusterRoleBinding +apiVersion: rbac.authorization.k8s.io/v1 +metadata: + name: snapshot-controller-role +subjects: + - kind: ServiceAccount + name: snapshot-controller + namespace: default # TODO: replace with the namespace you want for your controller, e.g. kube-system +roleRef: + kind: ClusterRole + # change the name also here if the ClusterRole gets renamed + name: snapshot-controller-runner + apiGroup: rbac.authorization.k8s.io + +--- +kind: Role +apiVersion: rbac.authorization.k8s.io/v1 +metadata: + namespace: default # TODO: replace with the namespace you want for your controller, e.g. kube-system + name: snapshot-controller-leaderelection +rules: +- apiGroups: ["coordination.k8s.io"] + resources: ["leases"] + verbs: ["get", "watch", "list", "delete", "update", "create"] + +--- +kind: RoleBinding +apiVersion: rbac.authorization.k8s.io/v1 +metadata: + name: snapshot-controller-leaderelection + namespace: default # TODO: replace with the namespace you want for your controller, e.g. kube-system +subjects: + - kind: ServiceAccount + name: snapshot-controller + namespace: default # TODO: replace with the namespace you want for your controller, e.g. kube-system +roleRef: + kind: Role + name: snapshot-controller-leaderelection + apiGroup: rbac.authorization.k8s.io + +# This YAML file shows how to deploy the snapshot controller + +# The snapshot controller implements the control loop for CSI snapshot functionality. +# It should be installed as part of the base Kubernetes distribution in an appropriate +# namespace for components implementing base system functionality. For installing with +# Vanilla Kubernetes, kube-system makes sense for the namespace. + +--- +kind: StatefulSet +apiVersion: apps/v1 +metadata: + name: snapshot-controller + namespace: default # TODO: replace with the namespace you want for your controller, e.g. kube-system +spec: + serviceName: "snapshot-controller" + replicas: 1 + selector: + matchLabels: + app: snapshot-controller + template: + metadata: + labels: + app: snapshot-controller + spec: + serviceAccount: snapshot-controller + containers: + - name: snapshot-controller + image: k8s.gcr.io/sig-storage/snapshot-controller:v4.0.0 + args: + - "--v=5" + - "--leader-election=false" + imagePullPolicy: IfNotPresent \ No newline at end of file diff --git a/examples/kubernetes/nginx-deployment-grace-period.yaml b/examples/kubernetes/nginx-deployment-grace-period.yaml new file mode 100644 index 0000000..24c9d40 --- /dev/null +++ b/examples/kubernetes/nginx-deployment-grace-period.yaml @@ -0,0 +1,73 @@ +# Nginx pod with dynamic storage creation using NexentaStor Block CSI driver +# +# $ kubectl apply -f examples/kubernetes/nginx-dynamic-volume.yaml +# +# -------------------------------------- +# NexentaStor CSI Driver - Storage Class +# -------------------------------------- + +apiVersion: storage.k8s.io/v1 +kind: StorageClass +metadata: + name: intelliflash-csi-block-driver-sc-nginx-dynamic +provisioner: intelliflash-csi-block-driver.intelliflash.com +allowVolumeExpansion: true +--- + +# ------------------------------------------------ +# NexentaStor CSI Driver - Persistent Volume Claim +# ------------------------------------------------ + +apiVersion: v1 +kind: PersistentVolumeClaim +metadata: + name: intelliflash-block-csi-driver-pvc-nginx-dynamic +spec: + storageClassName: intelliflash-csi-block-driver-sc-nginx-dynamic + accessModes: + - ReadWriteOnce + # - ReadWriteMany + # volumeMode: Block + resources: + requests: + storage: 1Gi +--- + +# --------- +# Nginx deployment +# --------- + +apiVersion: apps/v1 +kind: Deployment +metadata: + name: nginx-deployment-dynamic + labels: + app.kubernetes.io/name: nginx-deployment-dynamic +spec: + replicas: 1 + selector: + matchLabels: + app.kubernetes.io/name: nginx-deployment-dynamic + template: + metadata: + labels: + app.kubernetes.io/name: nginx-deployment-dynamic + spec: + terminationGracePeriodSeconds: 5 + containers: + - image: nginx + imagePullPolicy: IfNotPresent + name: nginx + command: ["bash"] + args: ["-c", "while true; do echo $(date) >> /mountedDisk/datefile; sleep 0.1; done"] #--hdd-noclean + ports: + - containerPort: 80 + protocol: TCP + volumeMounts: + - mountPath: /mountedDisk + name: intelliflash-block-csi-driver-data + volumes: + - name: intelliflash-block-csi-driver-data + persistentVolumeClaim: + claimName: intelliflash-block-csi-driver-pvc-nginx-dynamic + readOnly: false diff --git a/examples/kubernetes/nginx-dynamic-volume.yaml b/examples/kubernetes/nginx-dynamic-volume.yaml index a8ff443..3f2f506 100644 --- a/examples/kubernetes/nginx-dynamic-volume.yaml +++ b/examples/kubernetes/nginx-dynamic-volume.yaml @@ -21,7 +21,10 @@ allowVolumeExpansion: true # values: # - zone-1 # parameters: -# configName: nstor-box3 +# targetGroup: csi-new-no-chap +# target: csi-new-no-chap +# inheritProjectSettings: "false" + # configName: nstor-box3 #project: customProject # to overwrite "defaultProject" config property [project] #dataIp: 20.20.20.253 # to overwrite "defaultDataIp" config property --- diff --git a/examples/kubernetes/snapshot-class.yaml b/examples/kubernetes/snapshot-class.yaml index c41441c..2313aa6 100644 --- a/examples/kubernetes/snapshot-class.yaml +++ b/examples/kubernetes/snapshot-class.yaml @@ -5,11 +5,12 @@ # $ kubectl apply -f examples/kubernetes/snapshot-class.yaml # -apiVersion: snapshot.storage.k8s.io/v1alpha1 +apiVersion: snapshot.storage.k8s.io/v1 kind: VolumeSnapshotClass metadata: name: intelliflash-csi-block-snapshot-class -snapshotter: intelliflash-csi-block-driver.intelliflash.com +driver: intelliflash-csi-block-driver.intelliflash.com +deletionPolicy: Delete # parameters: # csiSnapshotterSecretName: csi-secret # csiSnapshotterSecretNamespace: csi-namespace diff --git a/examples/kubernetes/take-snapshot.yaml b/examples/kubernetes/take-snapshot.yaml index 5e0d565..2ebed9a 100644 --- a/examples/kubernetes/take-snapshot.yaml +++ b/examples/kubernetes/take-snapshot.yaml @@ -6,12 +6,12 @@ # $ kubectl apply -f examples/kubernetes/take-snapshot.yaml # -apiVersion: snapshot.storage.k8s.io/v1alpha1 #TODO check for beta +apiVersion: snapshot.storage.k8s.io/v1 kind: VolumeSnapshot metadata: name: snapshot-test spec: - snapshotClassName: intelliflash-csi-block-snapshot-class + volumeSnapshotClassName: intelliflash-csi-block-snapshot-class source: - name: intelliflash-csi-block-driver-pvc-nginx-persistent - kind: PersistentVolumeClaim + persistentVolumeClaimName: intelliflash-csi-block-driver-pvc-nginx-persistent +