HomepageFilebase DashboardDiscordBlog

Backup and Restore InFluxDB to Filebase with TrilioVault

Learn how to backup and restore an InFluxDB to Filebase using TrilioVault deployed on a Kubernetes cluster.

What is InFluxDB?

InFluxDB is an open source database developed in the Go programming language. It is developed to handle high write and query loads using time series data.

What is TrilioVault?

TrilioVault is a backup and restore service that natively integrates with OpenStack clouds. Trilio a leader in cloud-native data protection for Kubernetes containers, OpenStack clouds and Red Hat Virtualization hypervisors.

What is Kubernetes?

Kubernetes is an open-source container system designed for automating computer application deployment, scaling, and management.

Read below to learn how to backup InFluxDB to Filebase using TrilioVault for Kubernetes.

Prerequisites:

Note: This guide assumes you already have a Kubernetes cluster deployed with networking enabled.

Kubernetes has a wide range of implementations, deployments, and environment configurations. The examples used in this guide use a basic example Kubernetes cluster that does not include packages or configurations other than the ones displayed in this guide. Filebase is unable to provide troubleshooting or custom configurations for custom Kubernetes environments due to their individualized nature.

Create and Apply Backup Target

The Backup Target specifies the backup storage location. TrilioVault supports S3-compatible object storage such as Filebase. Save the following configuration (with your Filebase access and secret keys) as tv-backup-target.yaml:

apiVersion: triliovault.trilio.io/v1
kind: Target
metadata:
  name: filebase
spec:
  type: ObjectStore
  vendor: Other
  objectStoreCredentials:
    url: "https://s3.filebase.com"
    accessKey: "Filebase-Access-Key"
    secretKey: "Filebase-Secret-Key"
    bucketName: "Filebase-Bucket"
    region: "us-east-1"
  thresholdCapacity: 1000Gi

Then, run the following command to apply the backup target configuration:

kubectl create -f tv-backup-target.yaml

Deploy an InfluxDB database

InfluxDB databases can be deployed using Helm charts. In the following example below, a database is deployed using the helm install command with the name filebase-database from the helm chart bitnami/influxdb.

helm repo add bitnami <https://charts.bitnami.com/bitnami>

helm repo update

helm install name bitnami/influxdb

Add Test Data To The Database

To add test data to the InfluxDB database, follow the commands below that create a test database, table and records.

ocexec -it influxdb-deployment-54c5c78664-f7z7n -- influx
Connected to http://localhost:8086 version 1.7.4
InfluxDB shell version 1.7.4
Enter an InfluxQL query
>
>auth
username: ******
password: *******
>
>CREATE DATABASE filebase
>use filebase
Using database filebase
>INSERT name,color=red value=8
>INSERT name,color=blue value=2
>INSERT name,color=yellow value=3
>INSERT name,color=green value=4
>INSERT name,color=black value=10
>
>SELECT * FROM name
name:name
time                color          value
----                ----------          -----
1613634634180857624 red 8
1613634654035942732 blue                2
1613634666125641798 yellow              3
1613634676936723375 green               4
1613634694340402128 black               10
>
>exit

Create Hooks

Hooks create the ability to inject commands into Kubernetes pods or containers before or after a backup through pre-backup or post-backup commands.

InfluxDB has native backup and restore abilities. The scope of these backups can range from individual databases to shards and policies.

  • A backup creates a copy of the metastore and shard data at a specific point in time and stores the copy in the specified directory.

  • A full backup creates a copy of the metastore and shard data.

  • An incremental backup creates a copy of whatever metastore and shard data has changed since the last incremental backup.

If there are no existing incremental backups, the system automatically performs a complete backup.

Save the following code as tv-test-hook.yaml:

apiVersion: triliovault.trilio.io/v1
kind: Hook
metadata:
  name: test-hook
spec:
  pre:
    execAction:
      command:
        - "bash"
        - "-c"
        - "bkpfile=/tmp/snap
date +%Y%m%dT%H%M
; influxdbackup $bkpfile"
    ignoreFailure: false
    maxRetryCount: 1
    timeoutSeconds: 10
  post:
    execAction:
      command:
        - "bash"
        - "-c"
        - "echo 'post hook action completed'"
    ignoreFailure: false
    maxRetryCount: 1
    timeoutSeconds: 10

Then, use the following command to create the hook:

kubectl create -f tv-test-hook.yaml

Create a Backup Plan

The Backup Plan specifies the backup job, which includes the backup schedule, backup target and the resources to backup.

Save the following configuration as tv-test-backupplan.yaml:

apiVersion: triliovault.trilio.io/v1
kind: BackupPlan
metadata:
 name: backup-plan
spec:
 backupNamespace: default
 backupConfig:
   target:
     name: filebase
backupPlanComponents:
  custom:
- matchLabels:
app:influxdb
 hookConfig:
   mode: Sequential
   hooks:
     - hook:
         name: test-hook
       podSelector:
         labels:
           - matchLabels:
               app: influxdb
         regex: influxdb*

Then, use the following command to apply the backup plan:

kubectl create -f tv-test-backupplan.yaml

Create Backups

The first backup will always be a full backup, even if the backup plan specifies the backup type as incremental.

Save the following configuration as tvk-test-backup.yaml:

apiVersion: triliovault.trilio.io/v1
kind: Backup
metadata:
  name: test-backup
spec:
  type: Full
  scheduleType: Periodic
  backupPlan:
    Name: backup-plan

Then, use the following command to run the backup:

kubectl create -f tv-test-restore.yaml

The Restore

The restore specifies which resources should be restored from the backup. These resources can be restored to the same location or a new one.

Save the following configuration as tvk-test-restore.yaml:

apiVersion: triliovault.trilio.io/v1
kind: Restore
metadata:
  name: test-restore
spec:
  backupPlan:
    name: backup-plan
  source:
    type: Backup
    backup:
      name: test-backup
    target:
      name: filebase
  restoreNamespace: restore-test
  skipIfAlreadyExists: true

Then, use the following command to run the restore:

kubectl create -f tv-test-restore.yaml

PreviousKubernetesNextCSI-S3

Last updated