Update documentation for 1.4 (#128)

Signed-off-by: Carlisia <[email protected]>

charts/velero/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v1
 appVersion: 1.4.0
 description: A Helm chart for velero
 name: velero
-version: 2.12.3
+version: 2.12.4
 home: https://github.com/vmware-tanzu/velero
 icon: https://cdn-images-1.medium.com/max/1600/1*-9mb3AKnKdcL_QD3CMnthQ.png
 sources:

charts/velero/README.md

@@ -31,16 +31,18 @@ First, create the namespace: `kubectl create namespace <YOUR NAMESPACE>`
 
 ##### Option 1) CLI commands
 
+Note: you may add the flag `--skip-crds` if you don't want to install the CRDs.
+
 Specify the necessary values using the --set key=value[,key=value] argument to helm install. For example,
 
 ```bash
 helm install vmware-tanzu/velero --namespace <YOUR NAMESPACE> \
 --set-file <FULL PATH TO FILE> \
---set configuration.provider=aws \
---set configuration.backupStorageLocation.name=<PROVIDER NAME> \
+--set configuration.provider=<PROVIDER NAME> \
+--set configuration.backupStorageLocation.name=<BACKUP STORAGE LOCATION NAME> \
 --set configuration.backupStorageLocation.bucket=<BUCKET NAME> \
 --set configuration.backupStorageLocation.config.region=<REGION> \
---set configuration.volumeSnapshotLocation.name=<PROVIDER NAME> \
+--set configuration.volumeSnapshotLocation.name=<VOLUME SNAPSHOT LOCATION NAME> \
 --set configuration.volumeSnapshotLocation.config.region=<REGION> \
 --set image.repository=velero/velero \
 --set image.tag=v1.4.0 \
@@ -81,16 +83,18 @@ helm init --service-account=tiller --wait --upgrade
 
 ##### Option 1) CLI commands
 
+Note: you may add the flag `--set installCRDs=false` if you don't want to install the CRDs.
+
 Specify the necessary values using the --set key=value[,key=value] argument to helm install. For example,
 
 ```bash
 helm install vmware-tanzu/velero --namespace <YOUR NAMESPACE> \
 --set-file <FULL PATH TO FILE> \
 --set configuration.provider=aws \
---set configuration.backupStorageLocation.name=<PROVIDER NAME> \
+--set configuration.backupStorageLocation.name=<BACKUP STORAGE LOCATION NAME> \
 --set configuration.backupStorageLocation.bucket=<BUCKET NAME> \
 --set configuration.backupStorageLocation.config.region=<REGION> \
---set configuration.volumeSnapshotLocation.name=<PROVIDER NAME> \
+--set configuration.volumeSnapshotLocation.name=<VOLUME SNAPSHOT LOCATION NAME> \
 --set configuration.volumeSnapshotLocation.config.region=<REGION> \
 --set image.repository=velero/velero \
 --set image.tag=v1.4.0 \

charts/velero/values.yaml

@@ -81,17 +81,23 @@ configuration:
   provider:
 
   # Parameters for the `default` BackupStorageLocation. See
-  # https://velero.io/docs/v1.0.0/api-types/backupstoragelocation/
+  # https://velero.io/docs/v1.4/api-types/backupstoragelocation/
   backupStorageLocation:
-    # Cloud provider where backups should be stored. Usually should
-    # match `configuration.provider`. Required.
+    # name is the name of the backup storage location where backups should be stored. If a name is not provided,
+    # a backup storage location will be created with the name "default". Optional.
     name:
-    # Provider for the backup storage location. If omitted
+    # provider is the name for the backup storage location provider. If omitted
     # `configuration.provider` will be used instead.
     provider:
-    # Bucket to store backups in. Required.
+    # bucket is the name of the bucket to store backups in. Required.
     bucket:
-    # Prefix within bucket under which to store backups. Optional.
+    # caCert defines a CA bundle to use when verifying TLS connections to the provider.
+    caCert:
+      # type is byte
+      format:
+      # type is string
+      type:
+    # prefix is the directory under which all Velero data should be stored within the bucket. Optional.
     prefix:
     # Additional provider-specific configuration. See link above
     # for details of required/optional fields for your provider.
@@ -110,12 +116,11 @@ configuration:
     #  serviceAccount:
 
   # Parameters for the `default` VolumeSnapshotLocation. See
-  # https://velero.io/docs/v1.0.0/api-types/volumesnapshotlocation/
+  # https://velero.io/docs/v1.4/api-types/volumesnapshotlocation/
   volumeSnapshotLocation:
-    # Cloud provider where volume snapshots are being taken. Usually
-    # should match `configuration.provider`. Required.,
+    # name is the name of the volume snapshot location where snapshots are being taken. Required.
     name:
-    # Provider for the backup storage location. If omitted
+    # provider is the name for the volume snapshot provider. If omitted
     # `configuration.provider` will be used instead.
     provider:
     # Additional provider-specific configuration. See link above