Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/minio/lxmin

Backup and Restore LXC instances from MinIO
https://github.com/minio/lxmin

Last synced: about 2 months ago
JSON representation

Backup and Restore LXC instances from MinIO

Host: GitHub
URL: https://github.com/minio/lxmin
Owner: minio
License: agpl-3.0
Created: 2022-02-15T09:55:28.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2023-12-18T23:19:45.000Z (9 months ago)
Last Synced: 2024-06-19T03:02:19.167Z (3 months ago)
Language: Go
Homepage:
Size: 214 KB
Stars: 28
Watchers: 7
Forks: 4
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# lxmin

Backup and restore LXC instances with MinIO

## Install

### Binary Releases

### Usage

```sh
NAME:
lxmin - backup and restore LXC instances with MinIO

USAGE:
lxmin [FLAGS] COMMAND [COMMAND FLAGS | -h] [ARGUMENTS...]

COMMANDS:
backup backup an instance image to MinIO
restore restore an instance image from MinIO
info pretty print tags on an instance image on MinIO
list, ls list all backups from MinIO
delete, rm deletes a specific backup by 'name' for an instance from MinIO

GLOBAL FLAGS:
--endpoint value endpoint for MinIO server [$LXMIN_ENDPOINT]
--bucket value bucket to save/restore backup(s) [$LXMIN_BUCKET]
--access-key value access key credential [$LXMIN_ACCESS_KEY]
--secret-key value secret key credential [$LXMIN_SECRET_KEY]
--address value enable TLS REST API service [$LXMIN_ADDRESS]
--cert value TLS server certificate [$LXMIN_TLS_CERT]
--key value TLS server private key [$LXMIN_TLS_KEY]
--capath value TLS trust certs for incoming clients [$LXMIN_TLS_CAPATH]
--notify-endpoint value HTTP(S) POST endpoint to send notifications for REST API [$LXMIN_NOTIFY_ENDPOINT]
--staging value root path for staging the backups before uploading to MinIO [$LXMIN_STAGING_ROOT]
--help, -h show help

ENVIRONMENT VARIABLES:
LXMIN_ENDPOINT endpoint for MinIO server
LXMIN_BUCKET bucket to save/restore backup(s)
LXMIN_ACCESS_KEY access key credential
LXMIN_SECRET_KEY secret key credential
LXMIN_ADDRESS enable TLS REST API service
LXMIN_TLS_CERT TLS server certificate
LXMIN_TLS_KEY TLS server private key
LXMIN_TLS_CAPATH TLS trust certs for incoming clients
LXMIN_NOTIFY_ENDPOINT HTTP(S) POST endpoint to send notifications for REST API
LXMIN_STAGING_ROOT root path for staging the backups before uploading to MinIO

```

## REST API

`lxmin` exposes an mTLS authentication based REST API. HTTPs is mandatory for this service so you would need relevant server and client public certs. We recommend that you re-use your LXD server certificates.

```sh
export LXMIN_ENDPOINT=http://147.75.71.77:9000
export LXMIN_BUCKET="backups"
export LXMIN_ACCESS_KEY="minioadmin"
export LXMIN_SECRET_KEY="minioadmin"
export LXMIN_ADDRESS=":8000"
export LXMIN_NOTIFY_ENDPOINT="https://webhook.site/9d86f64f-78dd-4cbc-bd6c-5fbd90ef1701"
export LXMIN_TLS_CERT="/var/snap/lxd/common/lxd/server.crt"
export LXMIN_TLS_KEY="/var/snap/lxd/common/lxd/server.key"
export LXMIN_TLS_CAPATH="${HOME}/.lxc/"

lxmin
2022/02/26 08:31:51 Server listening on :8000
```

The spirit of this this API is to be close to LXD REST API documentation, authentication shall be achieved using the similar mTLS based authentication as per LXD REST API documentation

| Method | API | Desc |
|:-------|:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------|
| POST | /1.0/instances/{name}/backups | Create a backup to MinIO (Optionally you can add x-amz-tagging: "key=value" format to add additional tags on the backup) |
| GET | /1.0/instances/{name}/backups/{backup} | Get backup specific metadata and information |
| POST | /1.0/instances/{name}/backups/{backup} | Restore a backup from MinIO |
| GET | /1.0/instances/{name}/backups | Get the backups (Returns a list of instance backups on MinIO, along with some addtional metadata) |
| DELETE | /1.0/instances/{name}/backups/{backup} | Delete a backup from MinIO |

Response type for this API will be always `application/json`

### POST /1.0/instances/{name}/backups

| Query Params | Desc |
|:---------------|:------------------------------------------------------------------------------------|
| optimize | enables optimized backup for faster restore operations |
| tags | allow custom tags on the current backup |
| notifyEndpoint | notification endpoint for success/failed backup operation (overrides env/CLI value) |
| partSize | custom part size used for uploading to MinIO storage, defaults to '67108864' |

Response example:

```json
{
"metadata": {
"name": "backup_2022-02-26-07-5218",
"optimized": true,
"compressed": true
},
"status": "Operation created",
"status_code": 100,
"type": "async"
}
```

### GET /1.0/instances/{name}/backups/{backup}

Response example when backup is generated:

```json
{
"metadata": {
"name": "backup_2022-03-01-00-2142.tar.gz",
"state": "generating",
"progress": 0
},
"status": "Success",
"status_code": 200,
"type": "sync"
}
```

Response example when backup is being uploaded:

```json
{
"metadata": {
"name": "backup_2022-03-01-00-2530.tar.gz",
"size": 555339059,
"state": "uploading",
"progress": 40206336
},
"status": "Success",
"status_code": 200,
"type": "sync"
}
```

Response example when backup is persisted:

```json
{
"metadata": {
"name": "backup_2022-02-26-08-2027.tar.gz",
"created": "2022-02-26T08:22:12Z",
"size": 1302974262,
"optimized": true,
"compressed": true,
"tags": {
"os": "Ubuntu",
"version": "20.04"
}
},
"status": "Success",
"status_code": 200,
"type": "sync"
}
```

### POST /1.0/instances/{name}/backups/{backup}

| Query Params | Desc |
|:---------------|:-------------------------------------------------------------------------------------|
| notifyEndpoint | notification endpoint for success/failed restore operation (overrides env/CLI value) |

Response example:

```json
{
"status": "Operation created",
"status_code": 100,
"type": "async"
}
```

### GET /1.0/instances/{name}/backups

Response example:

```json
{
"metadata": [
{
"name": "backup_2022-02-17-08-3732",
"created": "2022-02-17T08:38:47.609Z",
"size": 913921606,
"optimized": true,
"compressed": false
},
{
"name": "backup_2022-02-17-09-0524",
"created": "2022-02-17T09:06:39.324Z",
"size": 913898354,
"optimized": true,
"compressed": false
},
{
"name": "backup_2022-02-17-09-3329",
"created": "2022-02-17T09:34:44.868Z",
"size": 913879736,
"optimized": true,
"compressed": false
},
{
"name": "backup_2022-02-26-07-3921",
"created": "2022-02-26T07:41:07.868Z",
"size": 1303072030,
"optimized": true,
"compressed": true
}
],
"status": "Success",
"status_code": 200,
"type": "sync"
}
```

### DELETE /1.0/instances/{name}/backups/{backup}

Response example:

```json
{
"status": "Success",
"status_code": 200,
"type": "sync"
}
```

## CLI (command line)

`lxmin` can be run as a manual tool to manage your `lxc` backups.

### Create a backup

```sh
export LXMIN_ENDPOINT=http://147.75.71.77:9000
export LXMIN_BUCKET="backups"
export LXMIN_ACCESS_KEY="minioadmin"
export LXMIN_SECRET_KEY="minioadmin"

lxmin backup u2 --tags "OS=Ubuntu&Version=20.04&Build=10"
Preparing backup for (u2) instance: success
Uploading backup_2022-02-17-09-3329.tar.gz ┃▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓┃ 100.12 MiB/s
```

### Create an optimized backup

Optimize flag enables faster restore time. It is only supported for ZFS, BTRFS, RBD based storage pools.

```sh
lxmin backup u2 --optimize
Preparing backup for (u2) instance: success
Uploading backup_2022-02-17-09-3329.tar.gz ┃▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓┃ 100.12 MiB/s
```

### List all backups

```sh
lxmin list
┌──────────┐┌───────────────────────────┐┌─────────────────────────┐┌─────────┐┌───────────┐
│ Instance ││ Name ││ Created ││ Size ││ Optimized │
│ ││ ││ ││ ││ │
│ u2 ││ backup_2022-02-17-08-3732 ││ 2022-02-17 08:38:47 UTC ││ 872 MiB ││ ✔ │
│ u2 ││ backup_2022-02-17-09-0524 ││ 2022-02-17 09:06:39 UTC ││ 872 MiB ││ ✔ │
│ u2 ││ backup_2022-02-17-09-3329 ││ 2022-02-17 09:34:44 UTC ││ 872 MiB ││ ✔ │
└──────────┘└───────────────────────────┘└─────────────────────────┘└─────────┘└───────────┘
```

### Restore a backup

```sh
lxmin restore u2 backup_2022-02-17-09-3329
Downloading backup_2022-02-17-09-3329.tar.gz ┃▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓┃ 209.10 MiB/s
Launching instance (u2) from backup: success
```

### Display backup info

```sh
Name : backup_2022-02-17-09-3329
Date : 2022-02-17 09:34:44 UTC
Size : 872 MiB
Tags :
Version : 20.04
Build : 10
OS : Ubuntu
Metadata :
Optimized : ✔
Compressed: ✔
```

### Delete a backup

Delete a backup by name `backup_2022-02-16-04-1040`

```sh
lxmin delete u2 backup_2022-02-16-04-1040
Backup backup_2022-02-16-04-1040 deleted successfully
```

Delete all backups (dangerous operation)

```sh
lxmin delete u2 --all --force
All backups for u2 deleted successfully
```