mochapowered/mocha-suv
1
0
Fork 0
Code Issues 2 Pull Requests Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
Michael Becker 2024-04-18 13:39:04 -04:00
parent a1bb967e10
commit ad4d75c339
1 changed files with 25 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -1,3 +1,27 @@
# mocha-suv
Single User Version - portable environments for Mocha advanced database infrastructure
## Prerequisites
The command-line Mocha SUV Manager (`./suv`) and the Mocha SUV Provisioner (`./provision`) were written with the assumption of a **BASH** scripting environment. They have not been tested on other shells, or written with the intention of being cross-platform. This may change in the future.
The SUV Provisioner uses `hexdump` to generate random ID numbers for newly-provisioned virtual machines. It also uses `shuf` to generate random IP address ranges for the SUVs.
The SUV Provisioner uses `vagrant` for virtual machine provisioning, which itself uses `virtualbox`.
The IP address ranges generated by the provisioner are outside the typically allowed range for VirtualBox host-only networks. To fix this, either change `SUV_IP_PREFIX` in `./provision` or create/open file `/etc/vbox/networks.conf` and add the following lines:
```
* 10.0.0.0/8 192.168.0.0/16
* 2001::/64
```
## Installation
1. Clone the repository with `git clone`
2. Initialize and update submodules with `git submodule init` and `git submodule update`
3. Provision a new Mocha Single User Version (SUV) with `./suv new`