Deploying the Encrypted Object Store
Practical guide to deploying the Object Store
Local Deployment
A local environment can help get you acquainted with the object store. Typical use cases will require at least two object stores, to simulate data being shared between two separate participants.
A script for deploying a local environment in Docker with two object stores and a Provenance node is available in the BlockVault CEE API repository. It stands up two object stores backed by a PostgreSQL data store along with a single Provenance Blockchain node. The object stores and blockchain node provide an environment to exercise the various operations needed to understand how data is stored in BlockVault. This repository also provides a web-server you can use to exercise and manipulate your environment to meet your needs.
Requirements
The general system requirements to spin up this test environment locally are as follows, but do check out README for more details.
- Git command line
- Terminal that can run shell scripts (e.b. Mac Terminal, Bash)
- Docker and Docker Compose
- Gradle
- Vault installed on your local OS
Setup
Download the repo.
git clone https://github.com/provenance-io/p8e-cee-api
cd p8e-cee-api
./gradlew clean build
Setup Docker containers as detailed in the image above using a script.
./dc.sh up
Start the web server.
./gradlew bootRun
Default Configuration
Depending on your testing needs, you may choose to just operate on one of the two Object Stores, but two have been provided to support simulating operations across two separate Object Stores.
By default, the components are listening on the following ports:
| Component | Container Name | Port(s) |
|---|---|---|
| Provenance Blockchain Node | provenance | 1317:1317 |
| Postgres | postgres | 5432:5432 |
| Vault | vault | 8200:8200 |
| Object Store 1 | object-store-1 | 5001:8081 |
| Object Store 2 | object-store-2 | 5002:8082 |
Sandbox Environment
Figure hosts and operates a sandbox BlockVault environment that is configured to work with the Provenance testnet for potential asset originators to play with. Contact Figure for more information.