cerc-io/stack-orchestrator
17
1
Fork 3
Code Issues 112 Pull Requests 19 Actions Packages Projects Releases 480 Wiki Activity
619 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%
a6a1399138
Go to file
iskay a6a1399138 add shared volume
2023-05-09 19:09:19 +00:00
.gitea/workflows Enable in-container docker 2023-04-20 16:21:26 -06:00
.github/workflows Add github actions 2023-04-17 13:11:45 -06:00
app add shared volume 2023-05-09 19:09:19 +00:00
build/lib manual peer connect 2023-05-08 16:00:59 +00:00
docs Update CONTRIBUTING.md (#383) 2023-05-04 09:47:59 -04:00
scripts Update setuptools in case the version on the machine is old (#352) 2023-04-19 15:16:34 -06:00
tests Add more debugging 2023-04-20 16:58:13 -06:00
.gitignore add build to gitignore 2023-05-08 19:29:24 +00:00
cli.py Make cluster/docker-compose project name unique 2023-02-28 08:47:02 -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 better direction to stacks 2023-04-27 13:16:53 -04:00
requirements.txt Update python on whales 2023-02-19 17:46:47 -07:00
setup.py Update version 2023-01-19 14:21:33 -07: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).