cerc-io/stack-orchestrator
17
1
Fork 3
Code Issues 112 Pull Requests 19 Actions 1 Packages Projects Releases 480 Wiki Activity
738 Commits 39 Branches 512 Tags 260 MiB
Python 52.2%
Shell 40.5%
Dockerfile 5.5%
TypeScript 1.2%
JavaScript 0.3%
Other 0.2%
9c7726c334
Go to file
Prathamesh Musale 9c7726c334 Add a service for Nitro reverse payment proxy
2023-09-27 16:50:54 +05:30
.gitea/workflows Update fixturenet eth test (#506) 2023-08-17 13:24:06 -06:00
.github/workflows Add flake8 lint check in CI (#522) 2023-09-04 12:46:16 -06:00
app Add a service for Nitro reverse payment proxy 2023-09-27 16:50:54 +05:30
docs Add debian setup script (#501) 2023-08-15 11:49:17 -06:00
scripts Support ChromeOS Debian VM (#503) 2023-08-17 02:02:57 -06:00
tests Mainnet laconic setup (#510) 2023-08-23 15:20:28 -06:00
.gitignore Lotus (#392) 2023-05-17 17:11:56 -04:00
cli.py Update copyright messages (#530) 2023-09-10 13:28:26 -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 Add debian setup script (#501) 2023-08-15 11:49:17 -06:00
requirements.txt Mainnet laconic setup (#510) 2023-08-23 15:20:28 -06:00
setup.py Include all of app/data regardless of depth. (#535) 2023-09-19 20:26:48 -05:00
tox.ini Moar complex 2022-10-03 19:43:43 -06:00

README.md

Stack Orchestrator

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.

The Stack

Install

To get started quickly on a fresh Ubuntu instance (e.g, Digital Ocean); try this script. WARNING: always review scripts prior to running them so that you know what is happening on your machine.

For any other installation, follow along below and adapt these instructions based on the specifics of your system.

Ensure that the following are already installed:

  • Python3: python3 --version >= 3.8.10 (the Python3 shipped in Ubuntu 20+ is good to go)
  • Docker: docker --version >= 20.10.21
  • jq: jq --version >= 1.5

Note: if installing docker-compose via package manager on Linux (as opposed to Docker Desktop), you must install the plugin, e.g. :

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

Next decide on a directory where you would like to put the stack-orchestrator program. Typically this would be a "user" binary directory such as ~/bin or perhaps /usr/local/laconic or possibly just the current working directory.

Now, having selected that directory, download the latest release from this page into it (we're using ~/bin below for concreteness but edit to suit if you selected a different directory). Also be sure that the destination directory exists and is writable:

curl -L -o ~/bin/laconic-so https://github.com/cerc-io/stack-orchestrator/releases/latest/download/laconic-so

Give it execute permissions:

chmod +x ~/bin/laconic-so

Ensure laconic-so is on the PATH

Verify operation (your version will probably be different, just check here that you see some version output and not an error):

laconic-so version
Version: 1.1.0-7a607c2-202304260513

Usage

The various stacks each contain instructions for running different stacks based on your use case. For example:

Contributing

See the CONTRIBUTING.md for developer mode install.

Platform Support

Native aarm64 is not currently supported. x64 emulation on ARM64 macos should work (not yet tested).