roysc/stack-orchestrator
1
0
Fork 0
Code Pull Requests Activity

More doc

Browse Source
This commit is contained in:
David Boreham 2022-08-24 14:48:55 -06:00
parent d9142e2bc9
commit c13faa9630
1 changed files with 27 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -1,13 +1,25 @@
# Stack Orchestrator # Stack Orchestrator
Stack Orchestrator allows building and deployment of a Laconic stack on a single machine. Stack Orchestrator allows building and deployment of a Laconic stack on a single machine with minimial prerequisites.
## Setup ## Setup
### Developer Mode ### Developer Mode
Developer mode runs the orchestrator from a cloned git repository. Developer mode runs the orchestrator from a cloned git repository.
#### Prerequisites #### Prerequisites
1. Python3 Stack Orchestrator is a Python3 CLI tool that runs on any OS with Python3 and Docker. Tested on: Ubuntu 20/22.
1. Docker
Ensure that the following are already installed:
1. Python3 (the version 3.8 available in Ubuntu 20/22 works)
```
$ python3 --version
Python 3.8.10
```
1. Docker (Install a current version from dockerco, don't use the version from any Linux distro)
```
$ docker --version
Docker version 20.10.17, build 100c701
```
#### Install #### Install
1. Clone this repository: 1. Clone this repository:
``` ```
@ -52,21 +64,31 @@ _write-me_
There are three sub-commands: `setup-repositories`, `build-containers` and `deploy-system` that are generally run in order: There are three sub-commands: `setup-repositories`, `build-containers` and `deploy-system` that are generally run in order:
### Setup Repositories ### Setup Repositories
Clones the set of git repositories necessary to build a system. Clones the set of git repositories necessary to build a system.
Note: the use of `ssh-agent` is recommended in order to avoid entering your ssh key passphrase for each repository.
``` ```
$ laconic-so --verbose setup-repositories $ laconic-so --verbose setup-repositories
``` ```
### Build Containers ### Build Containers
Builds the set of docker container images required to run a system. Builds the set of docker container images required to run a system. It takes around 10 minutes to build all the containers from cold.
``` ```
$ laconic-so --verbose build-containers $ laconic-so --verbose build-containers
``` ```
### Deploy System ### Deploy System
Uses `docker compose` to deploy a system. Uses `docker compose` to deploy a system.
Use `---include <list of components>` to deploy a subset of all containers:
``` ```
$ laconic-so --verbose deploy-system --include db-sharding,contract,ipld-eth-server,go-ethereum-foundry up $ laconic-so --verbose deploy-system --include db-sharding,contract,ipld-eth-server,go-ethereum-foundry up
``` ```
```
$ laconic-so --verbose deploy-system --include db-sharding,contract,ipld-eth-server,go-ethereum-foundry down
```
## Implementation ## Implementation
The orchestrator's operation is driven by files shown below. `repository-list.txt` container the list of git repositories; `container-image-list.txt` contains
the list of container image names, while `clister-list.txt` specifies the set of compose components (corresponding to individual docker-compose-xxx.yml files which may in turn specify more than one container).
Files required to build each container image are stored under `./container-build/<container-name>`
Files required at deploy-time are stored under `./config/<component-name>`
``` ```
├── cluster-list.txt ├── cluster-list.txt
├── compose ├── compose