Skip to content

Latest commit

 

History

History
19 lines (14 loc) · 2.33 KB

README.md

File metadata and controls

19 lines (14 loc) · 2.33 KB

sovrin-environments

Methods and scripts for standing up Sovrin test environments for different use-cases.

The following are among the methods that can be used to set up a Sovrin Validator cluster for testing. Others will be implemented in the future.

CloudFormation

Using the CloudFormation scripts, an admininstrator can create VPCs and VMs in AWS EC2. The scripts automate configuration tasks such as networking, installation of packages, and configuration of Sovrin Validator, Agent, and CLI client nodes. The administrator must have an existing AWS account with adequate permissions, where he will paste in the CloudFormation script, modify it as necessary, and execute it.

Vagrant

Using the Vagrant and bash scripts, an administrator can create VMs in his own PC (Linux, Mac, or Windows), provided that it has adequate storage, memory, and CPU cores. The scripts automate installation and configuration of Sovrin software on the VMs, creating Sovrin Validator, Agent, and CLI client nodes. Freely available VirtualBox and Vagrant software must be installed before executing these scripts. The "TestSovrinClusterSetup.md" file in the vagrant/training/vb-multi-vm/ directory documents the installation and use of the Vagrant scripts.

Docker

Using the Docker configuration and bash scripts, you can build and run Sovrin containers on your own PC (Linux, Mac, or Windows) docker environment, provided that it has adequate storage, memory, and CPU cores. The scripts automate the docker build process for Sovrin node and client images, and the steps for running the communicating containers. The only prerequisite is having a Docker installation running before executing the scripts. See the ReadMe for how to run the scripts, with additional details on starting the Agents (Faber College, etc.) needed for completing the Sovrin Tutorial - Alice and her Transcripts, Job, and Bank Applications.

Util

A collection of utilities/scripts intended to be reused/reusable by all sovrin environments. TODO: Decide how these utilities/scripts will be organized. It may be helpful to create a directory structure (component taxonomy/namespace) that aids in discovery.