Merge pull request #38 from haoshuwei/doc/update-docs

update help doc for velero and restic

README.md

@@ -57,6 +57,8 @@ For more information, see [the AlibabaCloud documentation on RAM users guides][1
 
 2. Attach policies to give `velero` the necessary permissions:
 
+    > Note that you'd better release the velero's delete permissions once you have completed your backup or restore task for safety reasons.
+
     ```bash
     {
         "Version": "1",
@@ -105,29 +107,36 @@ For more information, see [the AlibabaCloud documentation on RAM users guides][1
 	REGION=<YOUR_REGION>
 	```
 	
-2. Create a namespace velero and a secret cloud-credentials
+2. Create and run velero and velero-plugin for alibabacloud
 
-	Run the following command to create a namespace named `velero`
+	Run the following command to create and run velero and velero-plugin for alibabacloud
 	
-	`kubectl create namespace velero`
+	```
+	velero install \
+      --provider alibabacloud \
+      --image registry.$REGION.aliyuncs.com/acs/velero:1.4.2-2b9dce65-aliyun \
+      --bucket $BUCKET \
+      --secret-file ./credentials-velero \
+      --use-volume-snapshots=false \
+      --backup-location-config region=$REGION \
+      --use-restic \
+      --plugins registry.$REGION.aliyuncs.com/acs/velero-plugin-alibabacloud:v1.0.0-2d33b89 \
+      --wait
+	```
 
-	Run the following command to create a secret named `cloud-credentials`
+    If you want use an internal oss endpoint, you can add params:
     
-	`kubectl create secret generic cloud-credentials --namespace velero --from-file cloud=install/credentials-velero`
+    `--backup-location-config region=$REGION,network=internal`
     
-3. Create and run velero and velero-plugin for alibabacloud
+    If you want use a oss prefix to store backup files, you can add params:
     
-	Run the following command to create and run velero and velero-plugin for alibabacloud
+    `--prefix <your oss bucket prefix>`
 	
-	```
-	kubectl apply -f install/00-crds.yaml
-	```
+3. Create ConfigMap for velero restic helper image in your restore cluster
 
-	```
-	sed -i "s#<BUCKET>#$BUCKET#" install/01-velero.yaml
-	sed -i "s#<REGION>#$REGION#" install/01-velero.yaml
-	kubectl apply -f install/01-velero.yaml
-	```
+  Run the following command to create a velero restic helper configmap in your restore cluster(optional for backup cluster).
+  
+  `kubectl -n velero apply -f install/02-configmap.yaml`
 
 4. Cleanup velero installation
 
@@ -166,6 +175,12 @@ For more information, see [the AlibabaCloud documentation on RAM users guides][1
 	kubectl apply -f examples/with-pv.yaml
 	```
 	
+	Add annotations to pod volume, restic will backup the volume data during backup process.
+	
+	```
+    kubectl -n nginx-example annotate pod/nginx-deployment-7477779c4f-dxspm backup.velero.io/backup-volumes=nginx-logs
+    ```
+ 
 	Create a backup:
 	
 	`velero backup create nginx-backup-volume --include-namespaces nginx-example --wait`

install/02-configmap.yaml

+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: restic-restore-action-config
+  labels:
+    velero.io/plugin-config: ""
+    velero.io/restic: RestoreItemAction
+data:
+  image: registry.cn-hangzhou.aliyuncs.com/acs/velero-restic-restore-helper:latest
+  cpuRequest: 200m
+  memRequest: 128Mi
+  cpuLimit: 200m
+  memLimit: 128Mi
\ No newline at end of file