Install and Run
The Tranquil DataTM Trusted Flow Edition is provided as a container image that you install and run in your environment wherever you already run containerized infrastructure.
Native Binaries
Native binaries for Linux amd64 and MacOS amd64/arm64 are available on an on-demand basis. Additional platform binaries are available on a experimental basis. Please contact support if you are interested in any of these.
Pre-Requisites#
Your host should have at least 2 GB of memory available and at least 10GB of free space on a durable volume.
Install the Software#
Installation will vary depending on whether you're running Docker Desktop, installing for AWS ECS, deploying to a Kubernetes cluster, etc. The simplest way to get started is with Docker installed locally. Simply load the provided docker image (where the Xs represent the version of the software you're installing) like this:
You should see several lines with Loading layer and then it will say that the image is loaded. You can verify the product is installed by running docker images tranquildata/trusted-flow and you should see the appropriate version.
Set Up Durable Storage#
Tranquil Data requires a durable store for its internal state. To get started, create a directory that contains etc and var sub-directories. This will be the root directory for your Tranquil Data service, and must be readable and writable by the product.
When you run the product, the etc directory will be populated with your service's key-pair. The var directory will contain internal state like the ledger, consensus log, and context data. It should never be modified directly. Each time you re-start Tranquil Data be sure to set the root environment variable to the same directory.
Run the Service#
With the software installed, and a root directory available, you can now start the service:
docker run -p 8890:8890 -v ./tqdroot:/tqdroot -e TRANQUIL_ROOT=/tqdroot \
-e TRANQUIL_CONTEXT_STORE=local tranquildata/trusted-flow:latest
Context Stores
The "context store" is the durable component used to store and retrieve context state. In this example the local store type means that all context state is stored within the tqdroot/var directory. This is a valid and supportable model for production. Tranquil Data also supports using external databases to store context, and uses a Write Ahead Log locally when one of these stores is configured. You can read more about this under Product Configuration.
You should see several lines of the logging to the console, ending in something like service is ready to accept requests {"address": "[::]:8890"}. At this point your Tranquil Data service is up and running. You can can test this via a REST call:
Now you're ready to setup basic policies and learn about the common touch-points where integration begins.