https://github.com/aliyuncontainerservice/velero-plugin
https://github.com/aliyuncontainerservice/velero-plugin
velero velero-plugin
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/aliyuncontainerservice/velero-plugin
- Owner: AliyunContainerService
- License: apache-2.0
- Created: 2019-06-05T02:42:33.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-14T03:50:15.000Z (almost 2 years ago)
- Last Synced: 2025-07-26T19:20:40.661Z (3 months ago)
- Topics: velero, velero-plugin
- Language: Go
- Size: 9.47 MB
- Stars: 82
- Watchers: 7
- Forks: 24
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
## Overview
[![GoReportCard Widget]][GoReportCardResult]
Velero is a utility to back up and restore your Kubernetes resource and persistent volumes.
To do backup/restore on Alibaba Cloud through Velero utility, you need to install and configure velero and velero-plugin for alibabacloud.
## Run velero on AlibabaCloud
To set up Velero on AlibabaCloud, you:
* Download an official release of Velero
* Create your OSS bucket
* Create an RAM user for Velero
* Install the velero and velero-plugin for alibabacloud
## Download Velero
1. Download the [latest official release's](https://github.com/heptio/velero/releases) tarball for your client platform.
_We strongly recommend that you use an [official release](https://github.com/heptio/velero/releases) of
Velero. The tarballs for each release contain the `velero` command-line client. The code in the master branch
of the Velero repository is under active development and is not guaranteed to be stable!_
1. Extract the tarball:
```bash
tar -xvf .tar.gz -C /dir/to/extract/to
```
We'll refer to the directory you extracted to as the "Velero directory" in subsequent steps.
2. Move the `velero` binary from the Velero directory to somewhere in your PATH.
## Create OSS bucket
Velero requires an object storage bucket to store backups in, preferrably unique to a single Kubernetes cluster. Create an OSS bucket, replacing placeholders appropriately:
```bash
BUCKET=
REGION=
ossutil mb oss://$BUCKET \
--storage-class Standard \
--acl=private
```
## Create RAM user
For more information, see [the AlibabaCloud documentation on RAM users guides][14].
1. Create the RAM user:
Follow [the AlibabaCloud documentation on RAM users][22].
> If you'll be using Velero to backup multiple clusters with multiple OSS buckets, it may be desirable to create a unique username per cluster rather than the default `velero`.
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",
"Statement": [
{
"Action": [
"ecs:DescribeSnapshots",
"ecs:CreateSnapshot",
"ecs:DeleteSnapshot",
"ecs:DescribeDisks",
"ecs:CreateDisk",
"ecs:Addtags",
"oss:PutObject",
"oss:GetObject",
"oss:DeleteObject",
"oss:GetBucket",
"oss:ListObjects",
"oss:ListBuckets"
],
"Resource": [
"*"
],
"Effect": "Allow"
}
]
}
```
3. Create an access key for the user:
Follow [the AlibabaCloud documentation on create AK][24].
4. Create a Velero-specific credentials file (`credentials-velero`) in your `install` directory:
```
ALIBABA_CLOUD_ACCESS_KEY_ID=
ALIBABA_CLOUD_ACCESS_KEY_SECRET=
```
where the access key id and secret are the values get from the step 3.
## Install velero and velero-plugin for alibabacloud
1. Set some environment variables
```bash
BUCKET=
REGION=
```
2. Create and run velero and velero-plugin for alibabacloud
Run the following command to create and run velero and velero-plugin for alibabacloud
```
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
```
If you want use an internal oss endpoint, you can add params:
`--backup-location-config region=$REGION,network=internal`
If you want use a oss prefix to store backup files, you can add params:
`--prefix `
3. Create ConfigMap for velero restic helper image in your restore cluster
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
Run the following command to cleanup the velero installation
```
kubectl delete namespace/velero clusterrolebinding/velero
kubectl delete crds -l component=velero
```
## Installing the nginx example (optional)
1. nginx example without persistent volumes
Run the following command to create a nginx example without persistent volumes:
`kubectl apply -f examples/base.yaml`
Create a backup:
`velero backup create nginx-backup --include-namespaces nginx-example --wait`
Destroy the nginx example:
`kubectl delete namespaces nginx-example`
Create a restore from nginx-backup:
`velero restore create --from-backup nginx-backup --wait`
2. nginx example with persistent volumes
Run the following command to create a nginx example with persistent volumes:
```
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`
Destroy the nginx example:
```
kubectl delete namespaces nginx-example
```
Create a restore from nginx-backup-volume:
`velero restore create --from-backup nginx-backup-volume --wait`
[14]: https://www.alibabacloud.com/help/doc-detail/28645.htm
[22]: https://www.alibabacloud.com/help/doc-detail/93720.htm
[23]: https://www.alibabacloud.com/help/doc-detail/50452.htm
[24]: https://www.alibabacloud.com/help/doc-detail/53045.htm
[GoReportCard Widget]: https://goreportcard.com/badge/github.com/AliyunContainerService/velero-plugin
[GoReportCardResult]: https://goreportcard.com/report/github.com/AliyunContainerService/velero-plugin