velero-plugin-for-openstack

KO | EN

gitlite — search

#javascript #ai #typescript #golang #android #machine-learning #deep-learning #docker #nodejs #java #awesome #cli #mcp #openai

velero-plugin-for-openstack

(★ 31)

Openstack Cinder, Manila and Swift plugin for Velero backups

velero-plugin-for-openstack Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Velero Plugin for OpenStack

OpenStack Cinder, Manila and Swift plugin for [velero](https://github.com/vmware-tanzu/velero/) backups.

This plugin is [included as community supported plugin by Velero organization](https://velero.io/plugins/).

Official images are provided from [DockerHub](https://hub.docker.com/r/lirt/velero-plugin-for-openstack/tags).

## Table of Contents

- [Velero Plugin for OpenStack](#velero-plugin-for-openstack)
  - [Compatibility](#compatibility)
  - [OpenStack Authentication Configuration](#openstack-authentication-configuration)
  - [Installation](#installation)
    - [Swift Container Setup](#swift-container-setup)
  - [Volume Backups](#volume-backups)
    - [Backup Methods](#backup-methods)
    - [Consistency and Durability](#consistency-and-durability)
    - [Native VolumeSnapshots](#native-volumesnapshots)
    - [Restic and Kopia](#restic-and-kopia)
  - [Known Issues](#known-issues)
  - [Test & Build](#test--build)
  - [Development](#development)

## Compatibility

Below is a matrix of plugin versions and Velero versions for which the compatibility is tested and guaranteed.

| Plugin Version | Velero Version |
| :------------- | :------------- |
| v0.8.x         | 1.15.x, 1.16.x 1.17.x |
| v0.7.x         | 1.11.x 1.12.x 1.13.x |
| v0.6.x         | 1.9.x, 1.10.x 1.11.x |
| v0.5.x         | v1.4.x, v1.5.x, v1.6.x, v1.7.x, v1.8.x, 1.9.x, 1.10.x 1.11.x |

## OpenStack Authentication Configuration

The order of authentication methods is following:
1. Authentication using environment variables takes precedence (including [Application Credentials](https://docs.openstack.org/keystone/queens/user/application_credentials.html#using-application-credentials)). You **must not** set env. variable `OS_CLOUD` when you want to authenticate using env. variables because authenticator will try to look for `clouds.y(a)ml` file and use it.
1. Authentication using files is second option. Note: you will also need to set `OS_CLOUD` environment variable to tell which cloud from `clouds.y(a)ml` will be used:
  1. If `OS_CLIENT_CONFIG_FILE` env. variable is specified, code will authenticate using this file.
  1. Look for file `clouds.y(a)ml` in current directory.
  1. Look for file in `~/.config/openstack/clouds.y(a)ml`.
  1. Look for file in `/etc/openstack/clouds.y(a)ml`.

For authentication using application credentials you first need to create credentials using openstack CLI command such as `openstack application credential create <NAME>`.

For more information about how to configure authentication, see one of following documents:
1. [Authentication using Environment Variables](docs/authentication-env.md)
1. [Authentication using Files](docs/authentication-file.md)

Both authentication options also allow you to authenticate against multiple OpenStack Clouds at the same time. The way you can leverage this functionality is scenario where you want to store backups in 2 different locations. This scenario doesn't apply for Volume Snapshots as they always need to be created in the same cloud and region as where your PVCs are created!

Example of multi-cloud BSL setup:
```yaml
---
apiVersion: velero.io/v1
kind: BackupStorageLocation
metadata:
  name: my-backup-in-cloud1
  namespace: velero
spec:
  accessMode: ReadWrite
  config:
    cloud: cloud1
    # optional region
    region: fra1
  default: false
  objectStorage:
    bucket: velero-backup-cloud1
  provider: community.openstack.org/openstack
---
apiVersion: velero.io/v1
kind: BackupStorageLocation
metadata:
  name: my-backup-in-cloud2
  namespace: velero
spec:
  accessMode: ReadWrite
  config:
    cloud: cloud2
    # optional region
    region: lon
  default: false
  objectStorage:
    bucket: velero-backup-cloud2
  provider: community.openstack.org/openstack
```

## Installation

There are 2 options how to install this plugin. Each method has a documentation subpage:
1. [Installation using CLI](docs/installation-using-cli.md)
1. [Installation using Helm](docs/installation-using-helm.md)

### Swift Container Setup

Swift container must have [Temporary URL Key](https://docs.openstack.org/swift/latest/api/temporary_url_middleware.html) configured to make it possible to download Velero backups. In your Swift project you can execute following command to configure it:

```bash
SWIFT_TMP_URL_KEY=$(dd if=/dev/urandom | LC_ALL=C tr -dc A-Za-z0-9 | head -c 40)
swift post -m "Temp-URL-Key:${SWIFT_TMP_URL_KEY}"
```

Or per container Temporary URL key:

```bash
SWIFT_TMP_URL_KEY=$(dd if=/dev/urandom | LC_ALL=C tr -dc A-Za-z0-9 | head -c 40)
swift post -m "Temp-URL-Key:${SWIFT_TMP_URL_KEY}" my-container
```

> **Note:** If the Swift account ID is overridden (for example, if the current authentication project scope does not correspond to the destination container project ID), you must set the corresponding valid `OS_SWIFT_TEMP_URL_KEY` environment variable.

## Volume Backups

### Backup Methods

Plugin supports multiple methods of creating a backup.

Cinder backup methods:
- **Snapshot** - Create a snapshot using Cinder.
- **Clone** - Clone a volume using Cinder.
- **Backup** - Create a backup using Cinder backup functionality (known in CLI as `cinder backup create`) - see [docs](https://docs.openstack.org/cinder/latest/admin/volume-backups.html).
- **Image** - Upload a volume into Glance image service (requires `enable_force_upload` Cinder option enabled on the server side).

Manila backup methods:
- **Snapshot** - Create a snapshot using Manila.
- **Clone** - Create a snapshot using Manila, but immediatelly create a volume from this snapshot and afterwards cleanup original snapshot.

#### Incremental backups

For backup method `backups`, incremental backups are supported. This will however lead to the inability to delete backups in a reverse order, since it is not possible to delete a (older) backup that has dependant (newer) backups.

**Important: TTL is not working correctly with expiration, so set a large value such as (43800h, approx. 5 years)** since TTL inherently use a `First In, First Out` algorithm, where incremental backups should be deleted on a `Last In, First Out` basis. To cleanup these incremental backups, it's suggested to use the Velero CLI to perform deletion on this `Last In, First Out` basis.

Next to that, when incremental backups are enabled, the first backup of a volume will always be a full backup, since this is needed to create increments on.

### Consistency and Durability

Please note two facts regarding volume backups:
1. The snapshots are done using flag `--force`. The reason is that volumes in state `in-use` cannot be snapshotted without it (they would need to be detached in advance). In some cases this can make snapshot contents inconsistent!
2. Durability of backups in the Cinder or Manila backend depends on backup method that you will use. In most cases for proper availability, the snapshot needs to be backed up to off-site storage (in order to survive real datacenter incident). Please consult if chosen backup method and your Cinder or Manila backend setup will result in durable backups with your cloud provider.

### Native VolumeSnapshots

Alternative Kubernetes native solution (GA since 1.20) for volume snapshots are [VolumeSnapshots](https://kubernetes.io/docs/concepts/storage/volume-snapshots/) using [snapshot-controller](https://kubernetes-csi.github.io/docs/snapshot-controller.html).

### File System Backups: Restic and Kopia

Please understand that this repository and plugin does not provide any functionality for file system backups such as Kopia. Implementation of file system backups is done purely in the Velero code!

Kopia is at the moment supported only in [official Velero plugins](https://velero.io/docs/main/supported-providers/) (AWS, Azure, GCP). The missing support for community plugins is tracked locally in [this issue](https://github.com/Lirt/velero-plugin-for-openstack/issues/125) and in [upstream Velero repository](https://github.com/vmware-tanzu/velero/issues/9497).

Since Openstack Swift supports S3 compatible API, it is possible that Kopia can be used together with Swift backend and AWS plugin for Velero. This is not tested or supported by this repository.

Restic was deprecated in Velero since version 1.15. This plugin does not support users at using Restic anymore and recommends to migrate to Kopia.

### When to use File System Backups or Volume Snapshots?

Openstack plugin for Velero creates backups using various Openstack block volume methods (Cinder snapshot|clone|backup, Glance image, Manila snapshot|clone) to perform the backup. This means it's not reading content of volumes and copying/pushing them to a remote backup location. Persistence of these backups depends on Openstack Cinder or Manila backend setup.

If your snapshot|clone|backup is saved in the same datacenter and availability zone as the original volume or has a dependency on the original volume (is not usable when original volume is removed) you might not be able to recover your data from the backup. Proper backup should always be made to an offsite location with no dependency on original volumes.

File system backups (FSB) using Kopia or Restic read the content of volumes and push them to a remote backup location (object storage). This means that FSB backups are independent of the original volume and can be used to recover data even when the original volume is removed or the whole datacenter is lost. The file system backup process can however suffer from data consistency issues when the volume is in-use during the backup procedure or the filesystem is not quiesced.

It is very important not only to make backups, but also do regular restores and validation of restored backups.

This plugin holds no warranty for your backups or restores. If you happen to not understand the plugin, differences between FSB, volume snapshots or anything else in this repository, please search for a professional help with implementation of your backups.

## Known Issues

- [Incompatibility with Cinder version 13.0.0 (Rocky)](https://github.com/Lirt/velero-plugin-for-openstack/issues/20)

## Test & Build

```bash
# test and build code
go test -v -count 1 ./...
go mod tidy
go build

# Build and push image for linux amd64, arm64, arm
docker buildx build \
              --file docker/Dockerfile \
              --platform linux/amd64,linux/arm/v6,linux/arm/v7,linux/arm64 \
              --tag lirt/velero-plugin-for-openstack:v0.8.1 \
              --build-arg VERSION=v0.8.1 \
              --build-arg GIT_SHA=somesha \
              --no-cache \
              --push \
              .
```

## Development

The plugin interface is built based on the [official Velero plugin example](https://github.com/vmware-tanzu/velero-plugin-example).

velero-plugin-for-openstack

velero-plugin-for-openstack Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

velero-plugin-for-openstack

velero-plugin-for-openstack Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README