Fauna Dev is a Docker image that runs a single Fauna node in your own environment, for development and testing purposes.
|We do not license or support use of Fauna Dev multi-node clusters.|
This section includes the following topics:
Fauna Dev has the following requirements:
CPU: (minimum) Dual-core, x86 CPU running at 2GHz.
Memory: (minimum) 8GB RAM (physical).
Storage: Local, block-based storage device (SSD, hard disk, EBS, iSCSI).
Network file systems, such as CIFS or NFS, are not supported.
Pull the latest Docker container:
docker pull fauna/faunadb:latest
Verify that the container executes correctly:
docker run fauna/faunadb --help FaunaDB Enterprise Docker Image Options: --help Print this message and exit. --init Initialize the node (default action). --no-init Doesn't initialize the node. --join host[:port] Join a cluster through an active node specified in host and port. --config <path> Specify a custom config file. Should be accessible inside the docker image.
There are several approaches to running Fauna Dev with Docker:
As a single developer node, with ephemeral data:
docker run --rm --name faunadb -p 8443:8443 fauna/faunadb
This command starts a Fauna Dev node and initializes the single-node cluster. However, when the Docker container is stopped/killed, all of the data it contains is lost. This can be very useful for testing, where the database starts with a known state.
As a single developer node, with persisted data:
docker run --rm --name faunadb -p 8443:8443 \ -v <host-directory or named-volume>:/var/lib/faunadb \ fauna/faunadb
This command starts Fauna Dev with a specified folder or volume bound to the Docker container data folder. When the Docker container is stopped/killed, all of your data is maintained in the specified folder/volume.
As a single developer node, with persisted data and logs:
docker run --rm --name faunadb -p 8443:8443 \ -v <host-directory or named-volume>:/var/lib/faunadb \ -v <host-directory>:/var/log/faunadb \ fauna/faunadb
This command starts Fauna Dev, binding a local folder/volume to the Docker container’s data folder, and another local folder/volume to the Docker container’s log folder. When the Docker container is stopped/killed, all of your data and logs are maintained in the specified folders/volumes.
With managed configuration:
docker run --rm --name faunadb -p 8443:8443 \ -v <host-directory or named-volume>:/var/lib/faunadb \ -v <host-directory>:/var/log/faunadb \ -v <path-to-config-file>:/etc/faunadb.yml \ fauna/faunadb --config /etc/faunadb.yml
This command starts Fauna Dev with path binds for the data, log, and configuration file, as well as specifying that the non-default configuration should be used.
Here is an example configuration file. Adjust the configuration as appropriate:
--- auth_root_key: secret cluster_name: fauna storage_data_path: /var/lib/faunadb log_path: /var/log/faunadb shutdown_grace_period_seconds: 0 network_listen_address: 172.17.0.2 network_broadcast_address: 172.17.0.2 network_admin_http_address: 172.17.0.2 network_coordinator_http_address: 172.17.0.2
|We do not provide documentation for the configuration because we do not license Fauna for on-premise production use.|
Is this article helpful?
Tell Fauna how the article can be improved:
Visit Fauna's forums or email firstname.lastname@example.org
Thank you for your feedback!