BackROLL is modern, containerized and open-source backup solution for KVM guests. It allows you to define logical KVM pools and backup policies to backup all your KVM guests according to your needs.
It's also
- A beautiful web UI to manage and monitor your backups, launch restore tasks, etc.
- No downtime during backups
- No agent on guests nor KVM hosts
- Fully containerized with minimum maintenance needed
- Docker and Docker Compose (minimal version 2.24)
- A Bash terminal (Ubuntu is recommended or use WSL)
Backroll has some default components that can be replaced by your own ones.
- An OpenID provider (Keycloak, Google/Microsoft, Okta, etc.)
If you choose to use the default provider, please harden it with SSL certificate, secure password, etc..
- A MySQL/MariaDB database
Backroll requires Docker and Docker Compose. Please refer to the official Docker documentation to install them :
- install Docker
- install Docker Compose
Backroll is distributed through git and structured as a Docker Compose project. We have baked quickstart script which clones the repository and runs the commands from the dedicated compose project README.
Use Bash to get and run the quickstart script of the release you target. You will be guided through the setup of the components and some accounts. To use your own OpenID provider or database please prepare your credentials.
After the setup process, the containers will be starting. The default database initialization lasts approximately one minute. Then open your host address in a web browser to access the Backroll UI.
source <(curl -L https://github.com/DIMSI-IS/BackROLL/releases/download/v0.4.0-alpha-1/quickstart.sh)Those are the basic commands you need to know. Find more details there dedicated compose project README.
Go to the compose project directory
cd compose_projectSet environment variables
source source-me.shStart the containers
docker compose $prod up -dStop the containers
docker compose $prod stopShow containers logs
docker compose $prod logsIf you are developer and want to contribute to the project, see the developers’ setup.
To perform backup and restore tasks, Backroll's workers need an access to the VMs storage and to a backup storage.
By default in the docker-compose.yml, /mnt/ is mapped to /mnt/ in the workers.
On the backroll VM, mount the VMs storage to a path that is mapped in docker-compose.yml. If you are mounting a Cloudstack Primary storage please respect the Cloudstack format such as: /mnt/PR_STORAGE_ID Repeat for each VM storage.
Example using a NFS storage:
# Create directory under /mnt/
mkdir /mnt/myVM_storage
# Optional, under Ubuntu nfs-common might be required
apt install nfs-common
# Mount using NFS, to make the mount persistent, edit fstab with corresponding values
mount -v -t nfs -o nolock NFS_server:/nfs_share1 /mnt/myVM_storage
# Once your NFS share is mounted, please restart the containers
docker compose $prod stop
docker compose $prod up -dExample using a Cloudstack NFS storage:
#If you are mounting a Cloudstack Primary storage please respect the Cloudstack format such as: /mnt/PR_STORAGE_ID
# Create directory under /mnt/ corresponding to your CS primary storage
mkdir /mnt/138338fb-xxxx-xxxx-b219-ff968ca3ed3d
# Mount using NFS, to make the mount persistent, edit fstab with corresponding values
mount -v -t nfs -o nolock NFS_server:/nfs_shareCS1 /mnt/138338fb-xxxx-xxxx-b219-ff968ca3ed3d
# Once your NFS share is mounted, please restart the containers
docker compose $prod stop
docker compose $prod up -dOn the backroll VM, mount the backup storage to a path that is mapped in docker-compose.yml.
Then in Backroll UI, Configuration > Storage > Add new storage > Input Name and the path > Validate\
Example using a NFS storage:
# Create directory under /mnt/
mkdir /mnt/backup_storage
# Mount using NFS, to make the mount persistent, edit fstab with corresponding values
mount -v -t nfs -o nolock NFS_server:/nfs_backup_share1 /mnt/backup_storage
Then add your storage in the Backroll UI.
Cloudstack Global Settings
In Cloudstack's Global settings, fill the fields with the appropriate value:
- Backup framework provider plugin: backroll
- Backup plugin backroll config appname: Name of your app name used for backroll api
- Backup plugin backroll config password: Secret for the backroll_api found in your oauth provider.
- Backup plugin backroll config url: URL of your backroll
Cloudstack user
Backroll uses an API key and secret to communicate with Cloudstack.
In Cloudstack, under accounts, create a user dedicated to backroll.
Generate API Keys and Secret.
Backroll side
In the backroll UI, under Configuration select Connectors.
Add a new connector and fill the field with the appropriate information:
- Name: Name of your connector
- Endpoint URL: _ URL of your cloudstack instance API https://x.x.x.x.com/client/api _
- Login: API_key of your user dedicated to backroll
- Password: API_secret of your user dedicated to backroll
Read more about Backroll at https://backroll.readthedocs.io.
We'd love to help you get started with BackROLL, so please feel free to open a case if you run into problems with the deployment or encounter bugs.
We are also looking for volunteers interested in the project to propose improvements, bug fixes or any other help that would be beneficial to this project.
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Please see the LICENCE file included in the root directory of the source tree for extended license details.
BackROLL is based on several open-source projects (without any modification), including
Everything else is provided with ❤ by DIMSI