Skip to main content
Omni uses etcd as its database. Depending on how you deployed Omni, etcd runs in one of two modes: embedded or external. Follow the instructions for your deployment mode below.

​
Back up an embedded etcd

If you started Omni with the --etcd-embedded=true flag, Omni manages an internal etcd server that listens on the addresses specified by --etcd-endpoints (which defaults to http://localhost:2379). To back up the database, run the following command on the same host where Omni is running. If Omni is running in Docker, make sure the container is started with --network=host. 
etcdctl --endpoints http://localhost:2379 snapshot save snapshot.db
This command saves a snapshot of the database to snapshot.db in your current directory. We recommend scheduling periodic snapshots, for example, using a cron job, and storing them in a secure location such as an S3 bucket.

​
Backup an external etcd

If you started Omni with --etcd-embedded=false, etcd is managed outside of Omni and is not backed up automatically. You are responsible for backing it up regularly. For guidance on backup and recovery procedures, see the etcd disaster recovery documentation.