cerc-io/stack-orchestrator
16
1
Fork 1
Code Issues 87 Pull Requests 14 Actions Packages Projects Releases 434 Wiki Activity
982 Commits 43 Branches 466 Tags 258 MiB
Python 47.2%
Shell 44.6%
Dockerfile 6.1%
TypeScript 1.4%
JavaScript 0.3%
Other 0.4%
40f362511b
Go to file
Prathamesh Musale 40f362511b
Some checks failed
Fixturenet-Laconicd-Test / Run Laconicd fixturenet and Laconic CLI tests (push) Successful in 16m7s
Details
Fixturenet-Eth-Plugeth-Arm-Test / Run an Ethereum plugeth fixturenet test (push) Failing after 1s
Details
K8s Deploy Test / Run deploy test suite on kind/k8s (push) Successful in 8m52s
Details
Fixturenet-Eth-Plugeth-Test / Run an Ethereum plugeth fixturenet test (push) Failing after 59m34s
Details
Lint Checks / Run linter (push) Successful in 43s
Details
Publish / Build and publish (push) Successful in 1m24s
Details
Deploy Test / Run deploy test suite (push) Successful in 6m9s
Details
Webapp Test / Run webapp test suite (push) Successful in 5m12s
Details
Smoke Test / Run basic test suite (push) Successful in 4m55s
Details
Database Test / Run database hosting test on kind/k8s (push) Successful in 11m55s
Details
Container Registry Test / Run contaier registry hosting test on kind/k8s (push) Successful in 4m33s
Details
Run CI alert steps only on main (#797) 
Part of https://www.notion.so/Alerting-for-failing-CI-jobs-d0183b65453947aeab11dbddf989d9c0

- Run CI alert steps only on main to avoid alerts for in-progress PRs
- The Slack alerts will be sent on a CI job failure if
  - A commit is pushed directly to main
  - A PR gets merged into main
  - A scheduled job runs on main

Reviewed-on: #797
Co-authored-by: Prathamesh Musale <prathamesh.musale0@gmail.com>
Co-committed-by: Prathamesh Musale <prathamesh.musale0@gmail.com>
2024-04-05 09:26:08 +00:00
.gitea/workflows Run CI alert steps only on main (#797) 2024-04-05 09:26:08 +00:00
.github/workflows Enable webapp test in GitHub CI. (#627) 2023-11-07 18:27:08 -06:00
docs Doc for fetch-containers command 2024-02-27 11:44:28 -07:00
scripts Container Registry Stack (#747) 2024-02-18 18:55:55 +00:00
stack_orchestrator Run registry CLI tests as part of laconicd fixturenet tests (#791) 2024-04-04 07:16:46 +00:00
tests Fix laconic registry CLI tests (#792) 2024-04-04 10:50:02 +00:00
.gitignore Rename app -> stack_orchestrator (#625) 2023-11-07 00:06:55 -07: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 Update links from github.com to git.vdb.to (#732) 2024-02-06 22:42:44 +00:00
requirements.txt Switch to Docker-style limits 2024-02-08 00:43:41 -06:00
setup.py Update links from github.com to git.vdb.to (#732) 2024-02-06 22:42:44 +00: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
  • git: git --version >= 2.10.3

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://git.vdb.to/cerc-io/stack-orchestrator/releases/download/latest/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

Save the distribution url to ~/.laconic-so/config.yml:

mkdir ~/.laconic-so
echo "distribution-url: https://git.vdb.to/cerc-io/stack-orchestrator/releases/download/latest/laconic-so" >  ~/.laconic-so/config.yml

Update

If Stack Orchestrator was installed using the process described above, it is able to subsequently self-update to the current latest version by running:

laconic-so update

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).