Skip to main content

Fluent Manager Database Reference

The Fluent Manager database is a PostgreSQL database that stores all the data related to your Fluent Manager instance. This includes data about users, templates store in manager, deployment environments, and other settings.

How is the Fluent Database Hosted?

The Fluent Manager database is hosted on it's own container image that is running PostgreSQL. This container is deployed as part of the Fluent Manager deployment process. The database container is connected to the Fluent Manager backend container, and the Fluent Manager backend container uses the database to store and retrieve data. How data for the database container is persisted depends on whether you've deployed using Docker Compose or Kubernetes.

If you've deployed using Docker Compose, the data for the database container is stored in a volume that is mounted to the database container. This volume is managed by Docker Compose, and the data is persisted even if the database container is stopped or removed.

If you've deployed using Kubernetes, the data for the database container is stored in a Persistent Volume Claim (PVC) that is mounted to the database container. This PVC is managed by Kubernetes, and the data is persisted even if the database container is stopped or removed.

How is the Database Migrated to New Versions?

danger

Always backup your database before updating Fluent Manager to a new version.

When you update Fluent Manager to a new version, the database is automatically migrated to the new version. This is done by the Fluent Manager application itself. The database migration process is handled by the Fluent Manager application, and you do not need to do anything manually. The Fluent Manager backend application handles this using a tool called Liquibase. Liquibase is a database migration tool that is used to manage changes to the database schema. When you update Fluent Manager, the Fluent Manager application will check the database schema version and apply any necessary changes to the database schema to bring it up to date with the new version of Fluent Manager.

How to Backup the Database?

If you've installed Fluent Manager using Docker Compose with our deployment script, you can backup the database by running the following command:

kotlin fluent-deploy-docker-compose-x.y.z.main.kts db-full-backup

You can then restore the database using the following command:

kotlin fluent-deploy-docker-compose-x.y.z.main.kts db-full-restore

If you've installed Fluent Manager using Kubernetes without our deployment script, you can backup the database using the pg_dump utility.