Merge pull request #128 from cerc-io/dboreham/stack-for-setup-repositories

Implement stack config file for setup-repositories

Former-commit-id: 4e1366df60

.github/CONTRIBUTING.md

@@ -0,0 +1,91 @@
+# Contributing
+
+Thank you for taking the time to make a contribution to Stack Orchestrator.
+
+## Install (developer mode)
+
+Suitable for developers either modifying or debugging the orchestrator Python code:
+#### Prerequisites
+In addition to the binary install prerequisites listed above, the following are required:
+1. Python venv package
+   This may or may not be already installed depending on the host OS and version. Check by running:
+   ```
+   $ python3 -m venv
+   usage: venv [-h] [--system-site-packages] [--symlinks | --copies] [--clear] [--upgrade] [--without-pip] [--prompt PROMPT] ENV_DIR [ENV_DIR ...]
+   venv: error: the following arguments are required: ENV_DIR
+   ```
+   If the venv package is missing you should see a message indicating how to install it, for example with:
+   ```
+   $ apt install python3.10-venv
+   ```
+#### Install
+1. Clone this repository:
+   ```
+   $ git clone (https://github.com/cerc-io/stack-orchestrator.git
+   ```
+4. Enter the project directory:
+   ```
+   $ cd stack-orchestrator
+   ```
+5. Create and activate a venv:
+   ```
+   $ python3 -m venv venv
+   $ source ./venv/bin/activate
+   (venv) $
+   ```
+6. Install the cli in edit mode:
+   ```
+   $ pip install --editable .
+   ```
+7. 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...
+   ```
+
+#### Build a zipapp (single file distributable script)
+Use shiv to build a single file Python executable zip archive of laconic-so:
+1. Install [shiv](https://github.com/linkedin/shiv):
+   ```
+   $ (venv) pip install shiv
+   $ (venv) pip install wheel
+   ```
+1. Run shiv to create a zipapp file:
+   ```
+   $ (venv)  shiv -c laconic-so -o laconic-so .
+   ```
+   This creates a file `./laconic-so` that is executable outside of any venv, and on other machines and OSes and architectures, and requiring only the system Python3:
+1. Verify it works:
+   ```
+   $ cp stack-orchetrator/laconic-so ~/bin
+   $ laconic-so
+      Usage: python -m 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...
+   ```
+
+

README.md

@@ -1,218 +1,105 @@
 # Stack Orchestrator
 
-Stack Orchestrator allows building and deployment of a Laconic stack on a single machine with minimial prerequisites.
+Stack Orchestrator allows building and deployment of a Laconic Stack on a single machine with minimial prerequisites. It is a Python3 CLI tool that runs on any OS with Python3 and Docker. The following diagram summarizes the relevant repositories in the Laconic Stack - and the relationship to Stack Orchestrator.
 
-## Setup
-### Prerequisites
-Stack Orchestrator is a Python3 CLI tool that runs on any OS with Python3 and Docker. Tested on: Ubuntu 20/22.
+![The Stack](/docs/images/laconic-stack.png)
+
+## Install
 
 Ensure that the following are already installed:
 
-1. Python3 (the stock Python3 version available in Ubuntu 20 and 22 is suitable)
-   ```
-   $ python3 --version
-   Python 3.8.10
-   ```
-2. 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
-   ```
-3. If installed from regular package repository (not Docker Desktop), BE AWARE that the compose plugin may need to be installed, as well.
-   ```
-   DOCKER_CONFIG=${DOCKER_CONFIG:-$HOME/.docker}
-   mkdir -p $DOCKER_CONFIG/cli-plugins
-   curl -SL https://github.com/docker/compose/releases/download/v2.11.2/docker-compose-linux-x86_64 -o $DOCKER_CONFIG/cli-plugins/docker-compose
-   chmod +x ~/.docker/cli-plugins/docker-compose
-   
-   # see https://docs.docker.com/compose/install/linux/#install-the-plugin-manually for further details
-   # or to install for all users.
-   ```
+- [Python3](https://wiki.python.org/moin/BeginnersGuide/Download)
+- [Docker](https://docs.docker.com/get-docker/) 
+- [Docker Compose](https://docs.docker.com/compose/install/)
 
-### User Mode Install
+Note: if installing docker-compose via package manager (as opposed to Docker Desktop), you must [install the plugin](https://docs.docker.com/compose/install/linux/#install-the-plugin-manually), e.g., on Linux:
 
-User mode runs the orchestrator from a "binary" single-file release and does not require special Python environment setup. Use this mode unless you plan to make changes to the orchestrator source code.
+```bash
+mkdir -p ~/.docker/cli-plugins
+curl -SL https://github.com/docker/compose/releases/download/v2.11.2/docker-compose-linux-x86_64 -o ~/.docker/cli-plugins/docker-compose
+chmod +x ~/.docker/cli-plugins/docker-compose
+```
 
-*NOTE: User Mode is currently broken, use "Developer mode" described below for now.*
+Next, download the latest release from [this page](https://github.com/cerc-io/stack-orchestrator/tags), into a suitable directory (e.g. `~/bin`):
 
-1. Download the latest release from [this page](https://github.com/cerc-io/stack-orchestrator/tags), into a suitable directory (e.g. `~/bin`):
-   ```
-   $ cd ~/bin
-   $ curl -L https://github.com/cerc-io/stack-orchestrator/releases/download/v1.0.3-alpha/laconic-so
-   ```
-1. Ensure `laconic-so` is on the `PATH`
-1. Verify operation:
-   ```
-   $ ~/bin/laconic-so --help
-   Usage: python -m laconic-so [OPTIONS] COMMAND [ARGS]...
+```bash
+curl -L -o ~/bin/laconic-so https://github.com/cerc-io/stack-orchestrator/releases/latest/download/laconic-so
+```
 
-     Laconic Stack Orchestrator
+Give it permissions:
+```bash
+chmod +x ~/bin/laconic-so
+```
 
-   Options:
-     --quiet
-     --verbose
-     --dry-run
-     --local-stack
-     -h, --help     Show this message and exit.
+Ensure `laconic-so` is on the [`PATH`](https://unix.stackexchange.com/a/26059)
 
-   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...
-   ```
-### Developer mode Install
-Suitable for developers either modifying or debugging the orchestrator Python code:
-#### Prerequisites
-In addition to the binary install prerequisites listed above, the following are required:
-1. Python venv package
-   This may or may not be already installed depending on the host OS and version. Check by running:
-   ```
-   $ python3 -m venv
-   usage: venv [-h] [--system-site-packages] [--symlinks | --copies] [--clear] [--upgrade] [--without-pip] [--prompt PROMPT] ENV_DIR [ENV_DIR ...]
-   venv: error: the following arguments are required: ENV_DIR
-   ```
-   If the venv package is missing you should see a message indicating how to install it, for example with:
-   ```
-   $ apt install python3.8-venv
-   ```
-#### Install
-1. Clone this repository:
-   ```
-   $ git clone (https://github.com/cerc-io/stack-orchestrator.git
-   ```
-4. Enter the project directory:
-   ```
-   $ cd stack-orchestrator
-   ```
-5. Create and activate a venv:
-   ```
-   $ python3 -m venv venv
-   $ source ./venv/bin/activate
-   (venv) $
-   ```
-6. Install the cli in edit mode:
-   ```
-   $ pip install --editable .
-   ```
-7. Verify installation:
-   ```
-   (venv) $ laconic-so
-   Usage: laconic-so [OPTIONS] COMMAND [ARGS]...
+Verify operation:
 
-    Laconic Stack Orchestrator
+```
+laconic-so --help
+Usage: python -m laconic-so [OPTIONS] COMMAND [ARGS]...
 
-   Options:
-    --quiet
-    --verbose
-    --dry-run
-    -h, --help  Show this message and exit.
+  Laconic Stack Orchestrator
 
-   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...
-   ```
+Options:
+  --quiet
+  --verbose
+  --dry-run
+  --local-stack
+  -h, --help     Show this message and exit.
 
-#### Build a zipapp (single file distributable script)
-Use shiv to build a single file Python executable zip archive of laconic-so:
-1. Install [shiv](https://github.com/linkedin/shiv):
-   ```
-   $ (venv) pip install shiv
-   $ (venv) pip install wheel
-   ```
-1. Run shiv to create a zipapp file:
-   ```
-   $ (venv)  shiv -c laconic-so -o laconic-so .
-   ```
-   This creates a file `./laconic-so` that is executable outside of any venv, and on other machines and OSes and architectures, and requiring only the system Python3:
-1. Verify it works:
-   ```
-   $ cp stack-orchetrator/laconic-so ~/bin
-   $ laconic-so
-      Usage: python -m 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_
+Commands:
+  build-containers    build the set of containers required for a complete...
+  build-npms          build the set of npm packages required for a...  
+  deploy-system       deploy a stack
+  setup-repositories  git clone the set of repositories required to build...
+```
 
 ## Usage
-There are three sub-commands: `setup-repositories`, `build-containers` and `deploy-system` that are generally run in order:
 
-Note: $ laconic-so will run the version installed to ~/bin, while ./laconic-so can be invoked to run locally built 
-version in a checkout
+Three sub-commands: `setup-repositories`, `build-containers` and `deploy-system` are generally run in order. The following is a slim example for standing up the `erc20-watcher`. Go further with the [erc20 watcher demo](/app/data/stacks/erc20) and other pieces of the stack, within the [`stacks` directory](/app/data/stacks).
+
 ### Setup Repositories
-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 #this will default to ~/cerc or CERC_REPO_BASE_DIR from an env file
-#$ ./laconic-so --verbose --local-stack setup-repositories #this will use cwd ../ as dev_root_path
+Clone the set of git repositories necessary to build a system:
+
+```bash
+laconic-so --verbose setup-repositories --include cerc-io/go-ethereum,cerc-io/ipld-eth-db,cerc-io/ipld-eth-server,cerc-io/watcher-ts
 ```
+
+This will default to `~/cerc` or - if set - the environment variable `CERC_REPO_BASE_DIR`
+
 ### Build Containers
-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 #this will default to ~/cerc or CERC_REPO_BASE_DIR from an env file
-#$ ./laconic-so --verbose --local-stack build-containers #this will use cwd ../ as dev_root_path
 
+Build the set of docker container images required to run a system. It takes around 10 minutes to build all the containers from scratch.
+
+```bash
+laconic-so --verbose build-containers --include cerc/go-ethereum,cerc/go-ethereum-foundry,cerc/ipld-eth-db,cerc/ipld-eth-server,cerc/watcher-erc20
 ```
+
 ### Deploy System
-Uses `docker compose` to deploy a system.
 
-Use `---include <list of components>` to deploy a subset of all containers:
+Uses `docker-compose` to deploy a system (with most recently built container images).
+
+```bash
+laconic-so --verbose deploy-system --include ipld-eth-db,go-ethereum-foundry,ipld-eth-server,watcher-erc20 up
 ```
-$ laconic-so --verbose deploy-system --include db-sharding,contract,ipld-eth-server,go-ethereum-foundry up
+
+Check out he GraphQL playground here: [http://localhost:3002/graphql](http://localhost:3002/graphql)
+
+See the [erc20 watcher demo](/app/data/stacks/erc20) to continue further.
+
+### Cleanup
+
+```bash
+laconic-so --verbose deploy-system --include ipld-eth-db,go-ethereum-foundry,ipld-eth-server,watcher-erc20 down
 ```
-```
-$ laconic-so --verbose deploy-system --include db-sharding,contract,ipld-eth-server,go-ethereum-foundry down
-```
-Note: deploy-system command interacts with most recently built container images.
+
+## Contributing
+
+See the [CONTRIBUTING.md](.github/CONTRIBUTING.md) for developer mode install.
 
 ## Platform Support
-Native aarm64 is _not_ currently supported. x64 emulation on ARM64 macos should work (not yet tested).
-## 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>`
-```
-├── pod-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_
+Native aarm64 is _not_ currently supported. x64 emulation on ARM64 macos should work (not yet tested).
+

app/build_containers.py

@@ -24,7 +24,7 @@ import os
 from decouple import config
 import subprocess
 import click
-import importlib
+import importlib.resources
 from pathlib import Path
 from .util import include_exclude_check
 

app/build_npms.py

@@ -21,7 +21,7 @@
 import os
 from decouple import config
 import click
-import importlib
+import importlib.resources
 from python_on_whales import docker
 from .util import include_exclude_check
 

app/data/compose/docker-compose-fixturenet-eth.yml

@@ -14,6 +14,12 @@ services:
 
   fixturenet-eth-geth-1:
     hostname: fixturenet-eth-geth-1
+    cap_add:
+      - SYS_PTRACE
+    environment:
+      CERC_REMOTE_DEBUG: "true"
+      CERC_RUN_STATEDIFF: "detect"
+      CERC_STATEDIFF_DB_NODE_ID: 1
     env_file:
       - ../config/fixturenet-eth/fixturenet-eth.env
     image: cerc/fixturenet-eth-geth:local
@@ -27,12 +33,11 @@ services:
       - fixturenet-eth-bootnode-geth
     ports:
       - "8545"
+      - "40000"
+      - "6060"
 
   fixturenet-eth-geth-2:
     hostname: fixturenet-eth-geth-2
-    environment:
-      CERC_RUN_STATEDIFF: "detect"
-      CERC_STATEDIFF_DB_NODE_ID: 2
     healthcheck:
       test: ["CMD", "nc", "-v", "localhost", "8545"]
       interval: 30s

app/data/config/fixturenet-eth/fixturenet-eth.env

@@ -18,3 +18,4 @@ CERC_STATEDIFF_DB_NAME="cerc_testing"
 CERC_STATEDIFF_DB_USER="vdbm"
 CERC_STATEDIFF_DB_PASSWORD="password"
 CERC_STATEDIFF_DB_GOOSE_MIN_VER=23
+CERC_STATEDIFF_DB_LOG_STATEMENTS="false"

app/data/container-build/cerc-fixturenet-eth-geth/Dockerfile

@@ -1,10 +1,17 @@
 FROM skylenet/ethereum-genesis-generator@sha256:210353ce7c898686bc5092f16c61220a76d357f51eff9c451e9ad1b9ad03d4d3 AS ethgen
 
-FROM cerc/go-ethereum:local
+# Using the same golang image as used to build geth: https://github.com/cerc-io/go-ethereum/blob/HEAD/Dockerfile
+FROM golang:1.18-alpine as delve
+RUN go install github.com/go-delve/delve/cmd/dlv@latest
+
+FROM cerc/go-ethereum:local as geth
+
+FROM alpine:latest
 RUN apk add --no-cache python3 python3-dev py3-pip curl wget jq build-base gettext libintl openssl bash bind-tools postgresql-client
 
-COPY --from=ethgen /usr/local/bin/eth2-testnet-genesis /usr/local/bin/eth2-testnet-genesis
-COPY --from=ethgen /usr/local/bin/eth2-val-tools /usr/local/bin/eth2-val-tools
+COPY --from=delve  /go/bin/dlv /usr/local/bin/
+COPY --from=ethgen /usr/local/bin/eth2-testnet-genesis /usr/local/bin/
+COPY --from=ethgen /usr/local/bin/eth2-val-tools /usr/local/bin/
 COPY --from=ethgen /apps /apps
 
 RUN cd /apps/el-gen && pip3 install -r requirements.txt
@@ -14,6 +21,7 @@ COPY run-el.sh /opt/testnet/run.sh
 
 RUN cd /opt/testnet && make genesis-el
 
+COPY --from=geth  /usr/local/bin/geth /usr/local/bin/
 RUN geth init /opt/testnet/build/el/geth.json && rm -f ~/.ethereum/geth/nodekey
 
 ENTRYPOINT ["/opt/testnet/run.sh"]

app/data/container-build/cerc-fixturenet-eth-geth/run-el.sh

@@ -9,13 +9,18 @@ cd /opt/testnet/build/el
 python3 -m http.server 9898 &
 cd $HOME_DIR
 
-if [ "true" == "$RUN_BOOTNODE" ]; then 
-    geth \
+START_CMD="geth"
+if [ "true" == "$CERC_REMOTE_DEBUG" ] && [ -x "/usr/local/bin/dlv" ]; then
+    START_CMD="/usr/local/bin/dlv --listen=:40000 --headless=true --api-version=2 --accept-multiclient exec /usr/local/bin/geth --continue --"
+fi
+
+if [ "true" == "$RUN_BOOTNODE" ]; then
+    $START_CMD \
       --nodekeyhex="${BOOTNODE_KEY}" \
       --nodiscover \
       --ipcdisable \
       --networkid=${NETWORK_ID} \
-      --netrestrict="${NETRESTRICT}"  2>&1 | tee /var/log/geth_bootnode.log
+      --netrestrict="${NETRESTRICT}"
 else
     cd /opt/testnet/accounts
     ./import_keys.sh
@@ -56,17 +61,18 @@ else
       --statediff.db.password=$CERC_STATEDIFF_DB_PASSWORD \
       --statediff.db.port=$CERC_STATEDIFF_DB_PORT \
       --statediff.db.user=$CERC_STATEDIFF_DB_USER \
+      --statediff.db.logstatements=${CERC_STATEDIFF_DB_LOG_STATEMENTS:-false} \
       --statediff.waitforsync=true \
       --statediff.writing=true"
     fi
 
-    geth \
+    $START_CMD \
       --bootnodes="${ENODE}" \
       --allow-insecure-unlock \
       --http \
       --http.addr="0.0.0.0" \
       --http.vhosts="*" \
-      --http.api="eth,web3,net,admin,personal" \
+      --http.api="eth,web3,net,admin,personal,debug,statediff" \
       --http.corsdomain="*" \
       --authrpc.addr="0.0.0.0" \
       --authrpc.vhosts="*" \
@@ -79,6 +85,9 @@ else
       --syncmode=full \
       --mine \
       --miner.threads=1 \
-      --verbosity=5 \
-      --miner.etherbase="${ETHERBASE}" ${STATEDIFF_OPTS} 2>&1 | tee /var/log/geth.log
+      --metrics \
+      --metrics.addr="0.0.0.0" \
+      --verbosity=${CERC_GETH_VERBOSITY:-3} \
+      --vmodule="${CERC_GETH_VMODULE:-statediff/*=5}" \
+      --miner.etherbase="${ETHERBASE}" ${STATEDIFF_OPTS}
 fi

app/data/repository-list.txt

@@ -2,8 +2,8 @@ cerc-io/ipld-eth-db
 cerc-io/go-ethereum
 cerc-io/ipld-eth-server
 cerc-io/eth-statediff-service
-vulcanize/eth-statediff-fill-service
-vulcanize/ipld-eth-db-validator
+cerc-io/eth-statediff-fill-service
+cerc-io/ipld-eth-db-validator
 cerc-io/ipld-eth-beacon-indexer
 cerc-io/ipld-eth-beacon-db
 cerc-io/laconicd

app/data/stacks/erc20/README.md

@@ -1,157 +1,157 @@
 # ERC20 Watcher
 
-Instructions to deploy a local ERC20 watcher stack (core + watcher) for demonstration and testing purposes using [laconic-stack-orchestrator](../../README.md#setup)
+Instructions to deploy a local ERC20 watcher stack (core + watcher) for demonstration and testing purposes using [stack orchestrator](/README.md#install)
 
 ## Setup
 
-* Clone / pull required repositories:
+Clone required repositories:
 
-  ```bash
-  $ laconic-so setup-repositories --include cerc-io/go-ethereum,cerc-io/ipld-eth-db,cerc-io/ipld-eth-server,cerc-io/watcher-ts --pull
-  ```
+```bash
+laconic-so setup-repositories --include cerc-io/go-ethereum,cerc-io/ipld-eth-db,cerc-io/ipld-eth-server,cerc-io/watcher-ts 
+```
 
-* Build the core and watcher container images:
+Build the core and watcher container images:
 
-  ```bash
-  $ laconic-so build-containers --include cerc/go-ethereum,cerc/go-ethereum-foundry,cerc/ipld-eth-db,cerc/ipld-eth-server,cerc/watcher-erc20
-  ```
+```bash
+laconic-so build-containers --include cerc/go-ethereum,cerc/go-ethereum-foundry,cerc/ipld-eth-db,cerc/ipld-eth-server,cerc/watcher-erc20
+```
 
-  This should create the required docker images in the local image registry.
+This should create the required docker images in the local image registry.
 
-* Deploy the stack:
+Deploy the stack:
 
-  ```bash
-  $ laconic-so deploy-system --include db,go-ethereum-foundry,ipld-eth-server,watcher-erc20 up
-  ```
+```bash
+laconic-so deploy-system --include ipld-eth-db,go-ethereum-foundry,ipld-eth-server,watcher-erc20 up
+```
 
 ## Demo
 
-* Find the watcher container's id using `docker ps` and export it for later use:
+Find the watcher container's id using `docker ps` and export it for later use:
 
-  ```bash
-  $ export CONTAINER_ID=<CONTAINER_ID>
-  ```
+```bash
+export CONTAINER_ID=<CONTAINER_ID>
+```
 
-* Deploy an ERC20 token:
+Deploy an ERC20 token:
 
-  ```bash
-  $ docker exec $CONTAINER_ID yarn token:deploy:docker
-  ```
+```bash
+docker exec $CONTAINER_ID yarn token:deploy:docker
+```
 
-  Export the address of the deployed token to a shell variable for later use:
+Export the address of the deployed token to a shell variable for later use:
 
-  ```bash
-  $ export TOKEN_ADDRESS=<TOKEN_ADDRESS>
-  ```
+```bash
+export TOKEN_ADDRESS=<TOKEN_ADDRESS>
+```
 
-* Open `http://localhost:3002/graphql` (GraphQL Playground) in a browser window
+Open `http://localhost:3002/graphql` (GraphQL Playground) in a browser window
 
-* Connect MetaMask to `http://localhost:8545` (with chain ID `99`)
+Connect MetaMask to `http://localhost:8545` (with chain ID `99`)
 
-* Add the deployed token as an asset in MetaMask and check that the initial balance is zero
+Add the deployed token as an asset in MetaMask and check that the initial balance is zero
 
-* Export your MetaMask account (second account) address to a shell variable for later use:
+Export your MetaMask account (second account) address to a shell variable for later use:
 
-  ```bash
-  $ export RECIPIENT_ADDRESS=<RECIPIENT_ADDRESS>
-  ```
+```bash
+export RECIPIENT_ADDRESS=<RECIPIENT_ADDRESS>
+```
 
-* To get the primary account's address, run:
+To get the primary account's address, run:
 
-  ```bash
-  $ docker exec $CONTAINER_ID yarn account:docker
-  ```
+```bash
+docker exec $CONTAINER_ID yarn account:docker
+```
 
-* To get the current block hash at any time, run:
+To get the current block hash at any time, run:
 
-  ```bash
-  $ docker exec $CONTAINER_ID yarn block:latest:docker
-  ```
+```bash
+docker exec $CONTAINER_ID yarn block:latest:docker
+```
 
-* Fire a GQL query in the playground to get the name, symbol and total supply of the deployed token:
+Fire a GQL query in the playground to get the name, symbol and total supply of the deployed token:
 
-  ```graphql
-  query {
-    name(
-      blockHash: "LATEST_BLOCK_HASH"
-      token: "TOKEN_ADDRESS"
-    ) {
-      value
-      proof {
-        data
-      }
-    }
-
-    symbol(
-      blockHash: "LATEST_BLOCK_HASH"
-      token: "TOKEN_ADDRESS"
-    ) {
-      value
-      proof {
-        data
-      }
-    }
-
-    totalSupply(
-      blockHash: "LATEST_BLOCK_HASH"
-      token: "TOKEN_ADDRESS"
-    ) {
-      value
-      proof {
-        data
-      }
+```graphql
+query {
+  name(
+    blockHash: "LATEST_BLOCK_HASH"
+    token: "TOKEN_ADDRESS"
+  ) {
+    value
+    proof {
+      data
     }
   }
-  ```
 
-* Fire the following query to get balances for the primary and the recipient account at the latest block hash:
-
-  ```graphql
-  query {
-    fromBalanceOf: balanceOf(
-        blockHash: "LATEST_BLOCK_HASH"
-        token: "TOKEN_ADDRESS",
-        # primary account having all the balance initially
-        owner: "PRIMARY_ADDRESS"
-      ) {
-      value
-      proof {
-        data
-      }
-    }
-    toBalanceOf: balanceOf(
-        blockHash: "LATEST_BLOCK_HASH"
-        token: "TOKEN_ADDRESS",
-        owner: "RECIPIENT_ADDRESS"
-      ) {
-      value
-      proof {
-        data
-      }
+  symbol(
+    blockHash: "LATEST_BLOCK_HASH"
+    token: "TOKEN_ADDRESS"
+  ) {
+    value
+    proof {
+      data
     }
   }
-  ```
 
-  * The initial balance for the primary account should be `1000000000000000000000`
-  * The initial balance for the recipient should be `0`
+  totalSupply(
+    blockHash: "LATEST_BLOCK_HASH"
+    token: "TOKEN_ADDRESS"
+  ) {
+    value
+    proof {
+      data
+    }
+  }
+}
+```
 
-* Transfer tokens to the recipient account:
+Fire the following query to get balances for the primary and the recipient account at the latest block hash:
 
-  ```bash
-  $ docker exec $CONTAINER_ID yarn token:transfer:docker --token $TOKEN_ADDRESS --to $RECIPIENT_ADDRESS --amount 100
-  ```
+```graphql
+query {
+  fromBalanceOf: balanceOf(
+      blockHash: "LATEST_BLOCK_HASH"
+      token: "TOKEN_ADDRESS",
+      # primary account having all the balance initially
+      owner: "PRIMARY_ADDRESS"
+    ) {
+    value
+    proof {
+      data
+    }
+  }
+  toBalanceOf: balanceOf(
+      blockHash: "LATEST_BLOCK_HASH"
+      token: "TOKEN_ADDRESS",
+      owner: "RECIPIENT_ADDRESS"
+    ) {
+    value
+    proof {
+      data
+    }
+  }
+}
+```
 
-* Fire the above GQL query again with the latest block hash to get updated balances for the primary (`from`) and the recipient (`to`) account:
+- The initial balance for the primary account should be `1000000000000000000000`
+- The initial balance for the recipient should be `0`
 
-  * The balance for the primary account should be reduced by the transfer amount (`100`)
-  * The balance for the recipient account should be equal to the transfer amount (`100`)
+Transfer tokens to the recipient account:
 
-* Transfer funds between different accounts using MetaMask and use the playground to query the balance before and after the transfer.
+```bash
+docker exec $CONTAINER_ID yarn token:transfer:docker --token $TOKEN_ADDRESS --to $RECIPIENT_ADDRESS --amount 100
+```
+
+Fire the above GQL query again with the latest block hash to get updated balances for the primary (`from`) and the recipient (`to`) account:
+
+- The balance for the primary account should be reduced by the transfer amount (`100`)
+- The balance for the recipient account should be equal to the transfer amount (`100`)
+
+Transfer funds between different accounts using MetaMask and use the playground to query the balance before and after the transfer.
 
 ## Clean up
 
-* To stop all the services running in background run:
+To stop all the services running in background run:
 
-  ```bash
-  $ laconic-so deploy-system --include db,go-ethereum-foundry,ipld-eth-server,watcher-erc20 down
-  ```
+```bash
+laconic-so deploy-system --include ipld-eth-db,go-ethereum-foundry,ipld-eth-server,watcher-erc20 down
+```

app/data/stacks/laconicd/stack.yml

@@ -1,5 +1,5 @@
 version: "1.0"
-name: laconicd-fixturenet
+name: fixturenet-laconicd
 repos:
   - cerc-io/laconicd
   - cerc-io/laconic-sdk

app/data/version.txt

@@ -0,0 +1,2 @@
+# This file should be re-generated running: scripts/update-version-file.sh script
+v1.0.9-alpha-04a3049

app/deploy_system.py

@@ -20,7 +20,7 @@ import os
 import sys
 from python_on_whales import DockerClient
 import click
-import importlib
+import importlib.resources
 from pathlib import Path
 from .util import include_exclude_check
 

app/setup_repositories.py

@@ -22,7 +22,9 @@ from decouple import config
 import git
 from tqdm import tqdm
 import click
-import importlib
+import importlib.resources
+from pathlib import Path
+import yaml
 from .util import include_exclude_check
 
 
@@ -64,9 +66,11 @@ def command(ctx, include, exclude, git_ssh, check_only, pull, branches_file):
     quiet = ctx.obj.quiet
     verbose = ctx.obj.verbose
     dry_run = ctx.obj.dry_run
+    stack = ctx.obj.stack
 
     branches = []
 
+    # TODO: branches file needs to be re-worked in the context of stacks
     if branches_file:
         if verbose:
             print(f"loading branches from: {branches_file}")
@@ -96,11 +100,25 @@ def command(ctx, include, exclude, git_ssh, check_only, pull, branches_file):
     with importlib.resources.open_text(data, "repository-list.txt") as repository_list_file:
         all_repos = repository_list_file.read().splitlines()
 
+    repos_in_scope = []
+    if stack:
+        # In order to be compatible with Python 3.8 we need to use this hack to get the path:
+        # See: https://stackoverflow.com/questions/25389095/python-get-path-of-root-project-structure
+        stack_file_path = Path(__file__).absolute().parent.joinpath("data", "stacks", stack, "stack.yml")
+        with stack_file_path:
+            stack_config = yaml.safe_load(open(stack_file_path, "r"))
+            # TODO: syntax check the input here
+            repos_in_scope = stack_config['repos']
+    else:
+        repos_in_scope = all_repos
+
     if verbose:
-        print(f"Repos: {all_repos}")
+        print(f"Repos: {repos_in_scope}")
+        if stack:
+            print(f"Stack: {stack}")
 
     repos = []
-    for repo in all_repos:
+    for repo in repos_in_scope:
         if include_exclude_check(repo, include, exclude):
             repos.append(repo)
         else:

app/version.py

@@ -0,0 +1,30 @@
+# Copyright © 2023 Cerc
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http:#www.gnu.org/licenses/>.
+
+import click
+import importlib.resources
+
+@click.command()
+@click.pass_context
+def command(ctx):
+    '''print tool version'''
+
+    # See: https://stackoverflow.com/a/20885799/1701505
+    from . import data
+    with importlib.resources.open_text(data, "version.txt") as version_file:
+        # TODO: code better version that skips comment lines
+        version_string = version_file.read().splitlines()[1]
+
+    print(f"Version: {version_string}")

cli.py

@@ -19,12 +19,16 @@ from app import setup_repositories
 from app import build_containers
 from app import build_npms
 from app import deploy_system
+from app import version
 
 CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'])
 
 
+# TODO: this seems kind of weird and heavy on boilerplate -- check it is
+# the best Python can do for us.
 class Options(object):
-    def __init__(self, quiet, verbose, dry_run, local_stack, debug):
+    def __init__(self, stack, quiet, verbose, dry_run, local_stack, debug):
+        self.stack = stack
         self.quiet = quiet
         self.verbose = verbose
         self.dry_run = dry_run
@@ -33,6 +37,7 @@ class Options(object):
 
 
 @click.group(context_settings=CONTEXT_SETTINGS)
+@click.option('--stack', help="specify a stack to build/deploy")
 @click.option('--quiet', is_flag=True, default=False)
 @click.option('--verbose', is_flag=True, default=False)
 @click.option('--dry-run', is_flag=True, default=False)
@@ -40,12 +45,13 @@ class Options(object):
 @click.option('--debug', is_flag=True, default=False)
 # See: https://click.palletsprojects.com/en/8.1.x/complex/#building-a-git-clone
 @click.pass_context
-def cli(ctx, quiet, verbose, dry_run, local_stack, debug):
+def cli(ctx, stack, quiet, verbose, dry_run, local_stack, debug):
     """Laconic Stack Orchestrator"""
-    ctx.obj = Options(quiet, verbose, dry_run, local_stack, debug)
+    ctx.obj = Options(stack, quiet, verbose, dry_run, local_stack, debug)
 
 
 cli.add_command(setup_repositories.command, "setup-repositories")
 cli.add_command(build_containers.command, "build-containers")
 cli.add_command(build_npms.command, "build-npms")
 cli.add_command(deploy_system.command, "deploy-system")
+cli.add_command(version.command, "version")

docs/cli.md

@@ -0,0 +1,3 @@
+# laconic-so
+
+Sub-commands and flags

docs/images/laconic-stack.png.REMOVED.git-id

@@ -0,0 +1 @@
+8f6452ed13e85a447103a7fff7cf3fb8ff5ea51a

docs/spec.md

@@ -0,0 +1,37 @@
+# Spec
+
+TODO: update
+
+## 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>`
+```
+├── pod-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
+```

requirements.txt

@@ -3,3 +3,4 @@ GitPython>=3.1.27
 tqdm>=4.64.0
 python-on-whales>=0.52.0
 click>=8.1.3
+pyyaml>=6.0

scripts/build_shiv_package.sh

@@ -0,0 +1,4 @@
+# Builds the shiv "package" for distribution
+mkdir -p ./package
+version_string=$( ./scripts/update_version_file.sh)
+shiv -c laconic-so -o package/laconic-so-${version_string} .

scripts/update_version_file.sh

@@ -0,0 +1,7 @@
+version_file_name=./app/data/version.txt
+echo "# This file should be re-generated running: scripts/update-version-file.sh script" > $version_file_name
+tag_string=$( git describe --tags --abbrev=0 )
+commit_string=$( git rev-parse --short HEAD )
+version_string=${tag_string}-${commit_string}
+echo ${version_string} >> $version_file_name
+echo ${version_string}

setup.py

@@ -6,7 +6,7 @@ with open("requirements.txt", "r", encoding="utf-8") as fh:
     requirements = fh.read()
 setup(
     name='laconic-stack-orchestrator',
-    version='0.0.5',
+    version='1.0.9',
     author='Cerc',
     author_email='info@cerc.io',
     license='GNU Affero General Public License',
@@ -20,7 +20,7 @@ setup(
     python_requires='>=3.7',
     include_package_data=True,
     # See: https://github.com/pypa/setuptools/issues/1806
-    package_data={'': ['data/*', 'data/*/*', 'data/*/*/*']},
+    package_data={'': ['data/*', 'data/*/*', 'data/*/*/*', 'data/*/*/*/*', 'data/*/*/*/*/*']},
     classifiers=[
         "Programming Language :: Python :: 3.8",
         "Operating System :: OS Independent",

tests/smoke-test/run-smoke-test.sh

@@ -0,0 +1,25 @@
+# Basic simple test of stack-orchestrator functionality
+echo "Running stack-orchestrator smoke test"
+# Bit of a hack, test the most recent package
+TEST_TARGET_SO=$( ls -t1 ./package/laconic-so* | head -1 )
+# Set a non-default repo dir
+export CERC_REPO_BASE_DIR=~/stack-orchestrator-test/repo-base-dir
+echo "Testing this package: $TEST_TARGET_SO"
+echo "Test version command"
+reported_version_string=$( $TEST_TARGET_SO version )
+echo "Version reported is: ${reported_version_string}"
+echo "Cloning repositories into: $CERC_REPO_BASE_DIR"
+rm -rf $CERC_REPO_BASE_DIR
+mkdir -p $CERC_REPO_BASE_DIR
+# Pull an example small public repo to test we can pull a repo
+$TEST_TARGET_SO setup-repositories --include cerc-io/laconic-sdk
+# TODO: test building the repo into a container
+# Build two example containers
+# TODO: 
+$TEST_TARGET_SO build-containers --include cerc/builder-js,cerc/test-container
+# Deploy the test container
+$TEST_TARGET_SO deploy-system --include test up
+# TODO: test that we can use the deployed container somehow
+# Clean up
+$TEST_TARGET_SO deploy-system --include test down
+echo "Test passed"