Skip to content

Commit 56a992d

Browse files
committed
Update documentation and user guides for beta snapshotter
1 parent b581803 commit 56a992d

File tree

4 files changed

+35
-38
lines changed

4 files changed

+35
-38
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ that represents availability by zone.
7070
| Snapshots | Alpha | 1.13 | Any | v0.3.0 | Alpha |
7171
| Resize (Expand) | Alpha | 1.14 | 1.14 | v0.6.0 | Alpha |
7272
| Resize (Expand) | Beta | 1.16 | 1.16 | v0.7.0 | Stable |
73-
73+
| Snapshots | Beta | 1.17 | Any | master | Stable |
7474

7575
### Future Features
7676

docs/kubernetes/user-guides/snapshots.md

+27-29
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,8 @@
1-
# Kubernetes Snapshots User Guide (Alpha)
1+
# Kubernetes Snapshots User Guide (Beta)
22

3-
>**Attention:** VolumeSnapshot is an alpha feature. Make sure you have enabled it in Kubernetes API server using `--feature-gates=VolumeSnapshotDataSource=true` flag.
3+
>**Attention:** Attention: VolumeSnapshot is a Beta feature enabled by default in Kubernetes 1.17+. Attention: VolumeSnapshot is only available in the driver version "master".
44
5-
### Install Driver with alpha snapshot feature
6-
7-
1. [One-time per project] Create GCP service account for the CSI driver and set required roles
8-
9-
```
10-
PROJECT=your-project-here # GCP project
11-
GCE_PD_SA_NAME=my-gce-pd-csi-sa # Name of the service account to create
12-
GCE_PD_SA_DIR=/my/safe/credentials/directory # Directory to save the service account key
13-
./deploy/setup-project.sh
14-
```
15-
16-
1. Deploy driver to Kubernetes Cluster
17-
18-
```
19-
GCE_PD_SA_DIR=/my/safe/credentials/directory # Directory to get the service account key
20-
GCE_PD_DRIVER_VERSION=alpha # Driver version to deploy
21-
./deploy/kubernetes/deploy-driver.sh
22-
```
5+
### Install Driver with beta snapshot feature as described [here] (driver-install.md)
236

247
### Snapshot Example
258

@@ -79,19 +62,34 @@
7962
The output is similar to this:
8063

8164
```yaml
82-
apiVersion: snapshot.storage.k8s.io/v1alpha1
8365
kind: VolumeSnapshot
8466
metadata:
85-
...
86-
name: snapshot-source-pvc
87-
namespace: default
88-
...
67+
creationTimestamp: "2020-05-13T21:48:08Z"
68+
finalizers:
69+
- snapshot.storage.kubernetes.io/volumesnapshot-as-source-protection
70+
- snapshot.storage.kubernetes.io/volumesnapshot-bound-protection
71+
generation: 1
72+
managedFields:
73+
- apiVersion: snapshot.storage.k8s.io/v1beta1
74+
fieldsType: FieldsV1
75+
fieldsV1:
76+
f:status:
77+
f:readyToUse: {}
78+
manager: snapshot-controller
79+
operation: Update
80+
time: "2020-05-13T21:49:42Z"
81+
name: snapshot-source-pvc
82+
namespace: default
83+
resourceVersion: "531499"
84+
selfLink: /apis/snapshot.storage.k8s.io/v1beta1/namespaces/default/volumesnapshots/snapshot-source-pvc
85+
uid: a10fd0ff-b868-4527-abe7-74d5b420731e
8986
spec:
90-
snapshotClassName: default-snapshot-class
91-
snapshotContentName: snapcontent-b408076b-720b-11e9-b9e3-42010a800014
92-
...
87+
source:
88+
persistentVolumeClaimName: source-pvc
89+
volumeSnapshotClassName: csi-gce-pd-snapshot-class
9390
status:
94-
creationTime: "2019-05-09T03:37:01Z"
91+
boundVolumeSnapshotContentName: snapcontent-a10fd0ff-b868-4527-abe7-74d5b420731e
92+
creationTime: "2020-05-13T21:48:43Z"
9593
readyToUse: true
9694
restoreSize: 6Gi
9795
```
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
apiVersion: snapshot.storage.k8s.io/v1alpha1
1+
apiVersion: snapshot.storage.k8s.io/v1beta1
22
kind: VolumeSnapshotClass
33
metadata:
4-
annotations:
5-
snapshot.storage.kubernetes.io/is-default-class: "true"
6-
name: default-snapshot-class
7-
snapshotter: pd.csi.storage.gke.io
4+
name: csi-gce-pd-snapshot-class
5+
driver: pd.csi.storage.gke.io
6+
deletionPolicy: Delete
+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
apiVersion: snapshot.storage.k8s.io/v1alpha1
1+
apiVersion: snapshot.storage.k8s.io/v1beta1
22
kind: VolumeSnapshot
33
metadata:
44
name: snapshot-source-pvc
55
spec:
6+
volumeSnapshotClassName: csi-gce-pd-snapshot-class
67
source:
7-
kind: PersistentVolumeClaim
8-
name: source-pvc
8+
persistentVolumeClaimName: source-pvc

0 commit comments

Comments
 (0)