github.com/verrazzano/verrazzano@v1.7.0/platform-operator/thirdparty/charts/velero/README.md (about) 1 # Velero 2 3 Velero is an open source tool to safely backup and restore, perform disaster recovery, and migrate Kubernetes cluster resources and persistent volumes. 4 5 Velero has two main components: a CLI, and a server-side Kubernetes deployment. 6 7 ## Installing the Velero CLI 8 9 See the different options for installing the [Velero CLI](https://velero.io/docs/v1.9/basic-install/#install-the-cli). 10 11 ## Installing the Velero server 12 13 ### Installation Requirements 14 15 Kubernetes v1.16+, because this helm chart uses CustomResourceDefinition `apiextensions.k8s.io/v1`. This API version was introduced in Kubernetes v1.16. 16 17 ### Velero version 18 19 This helm chart installs Velero version v1.9 https://velero.io/docs/v1.9/. See the [#Upgrading](#upgrading) section for information on how to upgrade from other versions. 20 21 ### Provider credentials 22 23 When installing using the Helm chart, the provider's credential information will need to be appended into your values. The easiest way to do this is with the `--set-file` argument, available in Helm 2.10 and higher. See your cloud provider's documentation for the contents and creation of the `credentials-velero` file. 24 25 ### Installing 26 27 The default configuration values for this chart are listed in values.yaml. 28 29 See Velero's full [official documentation](https://velero.io/docs/v1.9/basic-install/). More specifically, find your provider in the Velero list of [supported providers](https://velero.io/docs/v1.9/supported-providers/) for specific configuration information and examples. 30 31 #### Set up Helm 32 33 See the main [README.md](https://github.com/vmware-tanzu/helm-charts#kubernetes-helm-charts-for-vmware-tanzu). 34 35 #### Using Helm 3 36 37 ##### Option 1) CLI commands 38 39 Note: You may add the flag `--set cleanUpCRDs=true` if you want to delete the Velero CRDs after deleting a release. 40 Please note that cleaning up CRDs will also delete any CRD instance, such as BackupStorageLocation and VolumeSnapshotLocation, which would have to be reconfigured when reinstalling Velero. The backup data in object storage will not be deleted, even though the backup instances in the cluster will. 41 42 Specify the necessary values using the --set key=value[,key=value] argument to helm install. For example, 43 44 ```bash 45 helm install velero vmware-tanzu/velero \ 46 --namespace <YOUR NAMESPACE> \ 47 --create-namespace \ 48 --set-file credentials.secretContents.cloud=<FULL PATH TO FILE> \ 49 --set configuration.provider=<PROVIDER NAME> \ 50 --set configuration.backupStorageLocation.name=<BACKUP STORAGE LOCATION NAME> \ 51 --set configuration.backupStorageLocation.bucket=<BUCKET NAME> \ 52 --set configuration.backupStorageLocation.config.region=<REGION> \ 53 --set configuration.volumeSnapshotLocation.name=<VOLUME SNAPSHOT LOCATION NAME> \ 54 --set configuration.volumeSnapshotLocation.config.region=<REGION> \ 55 --set initContainers[0].name=velero-plugin-for-<PROVIDER NAME> \ 56 --set initContainers[0].image=velero/velero-plugin-for-<PROVIDER NAME>:<PROVIDER PLUGIN TAG> \ 57 --set initContainers[0].volumeMounts[0].mountPath=/target \ 58 --set initContainers[0].volumeMounts[0].name=plugins 59 ``` 60 61 Users of zsh might need to put quotes around key/value pairs. 62 63 ##### Option 2) YAML file 64 65 Add/update the necessary values by changing the values.yaml from this repository, then run: 66 67 ```bash 68 helm install vmware-tanzu/velero --namespace <YOUR NAMESPACE> -f values.yaml --generate-name 69 ``` 70 ##### Upgrade the configuration 71 72 If a value needs to be added or changed, you may do so with the `upgrade` command. An example: 73 74 ```bash 75 helm upgrade <RELEASE NAME> vmware-tanzu/velero --namespace <YOUR NAMESPACE> --reuse-values --set configuration.provider=<NEW PROVIDER> 76 ``` 77 78 #### Using Helm 2 79 80 We're no longer support Helm v2 since it's deprecated in November 2020. 81 82 ##### Upgrade the configuration 83 84 If a value needs to be added or changed, you may do so with the `upgrade` command. An example: 85 86 ```bash 87 helm upgrade vmware-tanzu/velero <RELEASE NAME> --reuse-values --set configuration.provider=<NEW PROVIDER> 88 ``` 89 90 ## Upgrading 91 92 ### Upgrading to v1.9 93 94 The [instructions found here](https://velero.io/docs/v1.9/upgrade-to-1.9/) will assist you in upgrading from version v1.8.x to v1.9. 95 96 ### Upgrading to v1.8 97 98 The [instructions found here](https://velero.io/docs/v1.8/upgrade-to-1.8/) will assist you in upgrading from version v1.7.x to v1.8. 99 100 ### Upgrading to v1.7 101 102 The [instructions found here](https://velero.io/docs/v1.7/upgrade-to-1.7/) will assist you in upgrading from version v1.6.x to v1.7. 103 104 ### Upgrading to v1.6 105 106 The [instructions found here](https://velero.io/docs/v1.6/upgrade-to-1.6/) will assist you in upgrading from version v1.5.x to v1.6. 107 108 ### Upgrading to v1.5 109 110 The [instructions found here](https://velero.io/docs/v1.5/upgrade-to-1.5/) will assist you in upgrading from version v1.4.x to v1.5. 111 112 ### Upgrading to v1.4 113 114 The [instructions found here](https://velero.io/docs/v1.4/upgrade-to-1.4/) will assist you in upgrading from version v1.3.x to v1.4. 115 116 ### Upgrading to v1.3.1 117 118 The [instructions found here](https://velero.io/docs/v1.3.1/upgrade-to-1.3/) will assist you in upgrading from version v1.2.0 or v1.3.0 to v1.3.1. 119 120 ### Upgrading to v1.2.0 121 122 The [instructions found here](https://velero.io/docs/v1.2.0/upgrade-to-1.2/) will assist you in upgrading from version v1.0.0 or v1.1.0 to v1.2.0. 123 124 ### Upgrading to v1.1.0 125 126 The [instructions found here](https://velero.io/docs/v1.1.0/upgrade-to-1.1/) will assist you in upgrading from version v1.0.0 to v1.1.0. 127 128 ## Uninstall Velero 129 130 Note: when you uninstall the Velero server, all backups remain untouched. 131 132 ### Using Helm 3 133 134 ```bash 135 helm uninstall <RELEASE NAME> -n <YOUR NAMESPACE> 136 ```