cerc-io/stack-orchestrator
17
1
Fork 1
Code Issues 110 Pull Requests 12 Actions Packages Projects Releases 473 Wiki Activity
44 Commits 37 Branches 505 Tags 259 MiB
Python 50%
Shell 42.3%
Dockerfile 5.7%
TypeScript 1.3%
JavaScript 0.3%
Other 0.3%
d9142e2bc9
Go to file
David Boreham d9142e2bc9 Change command name, add doc
2022-08-24 14:31:44 -06:00
app Fixes 2022-08-24 13:53:48 -06:00
compose Rebrand 2022-08-23 16:02:38 -06:00
config/ipld-eth-server Add config file 2022-08-21 17:25:55 -06:00
container-build More rebranding 2022-08-24 12:40:15 -06:00
cli.py Clean up 2022-08-24 13:01:35 -06:00
cluster-list.txt Remove db component 2022-08-14 21:38:01 -06:00
container-image-list.txt Rebrand 2022-08-23 16:02:38 -06:00
docker-compose-test.yaml Initial commit 2022-08-03 20:37:16 -06:00
LICENSE Initial version of pip packaging 2022-08-23 11:32:55 -06:00
MANIFEST.in Initial version of pip packaging 2022-08-23 11:32:55 -06:00
README.md Change command name, add doc 2022-08-24 14:31:44 -06:00
repository-list.txt Unbrand repo names 2022-08-24 13:03:22 -06:00
requirements.txt Add new module 2022-08-23 20:51:18 -06:00
setup.py Change command name, add doc 2022-08-24 14:31:44 -06:00

README.md

Stack Orchestrator

Stack Orchestrator allows building and deployment of a Laconic stack on a single machine.

Setup

Developer Mode

Developer mode runs the orchestrator from a cloned git repository.

Prerequisites

  1. Python3
  2. Docker

Install

  1. Clone this repository: 
    $ git clone (https://github.com/cerc-io/stack-orchestrator.git
  2. Enter the project directory: 
    $ cd stack-orchestrator
  3. Create and activate a venv: 
    $ python3 -m venv venv
$ source ./venv/bin/activate
(venv) $
  4. Install the cli in edit mode: 
    $ pip install --editable .
  5. Verify installation: 
    (venv) $ laconic-so
Usage: laconic-so [OPTIONS] COMMAND [ARGS]...

 Laconic Stack Orchestrator

Options:
 --quiet
 --verbose
 --dry-run
 -h, --help  Show this message and exit.

Commands:
 build-containers    build the set of containers required for a complete...
 deploy-system       deploy a stack
 setup-repositories  git clone the set of repositories required to build...

CI Mode

write-me

Usage

There are three sub-commands: setup-repositories, build-containers and deploy-system that are generally run in order:

Setup Repositories

Clones the set of git repositories necessary to build a system.

$ laconic-so --verbose setup-repositories

Build Containers

Builds the set of docker container images required to run a system.

$ laconic-so --verbose build-containers

Deploy System

Uses docker compose to deploy a system.

$ laconic-so --verbose deploy-system --include db-sharding,contract,ipld-eth-server,go-ethereum-foundry up

Implementation

├── cluster-list.txt
├── compose
│   ├── docker-compose-contract.yml
│   ├── docker-compose-db-sharding.yml
│   ├── docker-compose-db.yml
│   ├── docker-compose-eth-statediff-fill-service.yml
│   ├── docker-compose-go-ethereum-foundry.yml
│   ├── docker-compose-ipld-eth-beacon-db.yml
│   ├── docker-compose-ipld-eth-beacon-indexer.yml
│   ├── docker-compose-ipld-eth-server.yml
│   ├── docker-compose-lighthouse.yml
│   └── docker-compose-prometheus-grafana.yml
├── config
│   └── ipld-eth-server
├── container-build
│   ├── cerc-eth-statediff-fill-service
│   ├── cerc-go-ethereum
│   ├── cerc-go-ethereum-foundry
│   ├── cerc-ipld-eth-beacon-db
│   ├── cerc-ipld-eth-beacon-indexer
│   ├── cerc-ipld-eth-db
│   ├── cerc-ipld-eth-server
│   ├── cerc-lighthouse
│   └── cerc-test-contract
├── container-image-list.txt
├── repository-list.txt

write-more-of-me