Ecosystem/serai
Ecosystem/serai
1
0
Fork 0
mirror of https://github.com/serai-dex/serai.git synced 2024-11-17 01:17:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
serai/deploy
History
Luke Parker aea6ac104f
Remove Tendermint for GRANDPA 
Updates to polkadot-v0.9.40, with a variety of dependency updates accordingly.
Substrate thankfully now uses k256 0.13, pathing the way for #256. We couldn't
upgrade to polkadot-v0.9.40 without this due to polkadot-v0.9.40 having
fundamental changes to syncing. While we could've updated tendermint, it's not
worth the continued development effort given its inability to work with
multiple validator sets.

Purges sc-tendermint. Keeps tendermint-machine for #163.

Closes #137, #148, #157, #171. #96 and #99 should be re-scoped/clarified. #134
and #159 also should be clarified. #169 is also no longer a priority since
we're only considering temporal deployments of tendermint. #170 also isn't
since we're looking at effectively sharded validator sets, so there should
be no singular large set needing high performance.
2023-03-26 16:49:18 -04:00
..
coins Processor (#259) 2023-03-16 22:59:40 -04:00
genesis Initial Tendermint implementation (#145) 2022-12-03 18:38:02 -05:00
kubernetes serai Dockerfile & Makefile fixed 2022-10-15 19:03:33 -05:00
serai Remove Tendermint for GRANDPA 2023-03-26 16:49:18 -04:00
docker-compose.yml Bitcoin processor (#232) 2023-01-31 07:48:14 -05:00
README.md Cluster Orchestration with Docker Compose (#114) 2022-09-12 15:01:14 -05:00

README.md

Deploy

Run with Docker Compose

Running the Serai infrastructure is easy with Docker.

We utilize compose profiles to easily orchestrate various pieces of the infrastructure.

Example: docker compose --profile cluster-coins-sm up

All commands are assumed to be ran from the deploy folder, not the serai root folder.

Profiles:

  • base - single node, named base
  • coins - node clients for coins only (BTC, ETH, XMR)
  • cluster-sm - Alice (Validator), Bob, Charlie
  • cluster-coins-sm - cluster-sm with coins
  • cluter-lg - Alice (Validator), Bob, Charlie, Dave, Eve, Ferdie
  • cluster-coins-lg - cluster-lg with coins
  • monero - full node monero only
  • bitcoin - full node bitcoin only
  • ethereum - full node ethereum only

You can supply one or more profiles to the docker compose command to orchestrate the desired components.

Example: docker compose --profile base --profile bitcoin up

Orchestration Approach

Builds

The Serai node is the only piece of our infrastructure that we compile locally and for the first build, it can take 10 minutes or more to complete the image. Images for external coins download binaries, then verify the signatures and checksums of the build. Overall the standard image build process looks like:

Stage 1 -- Builder

  • Configure environment.
  • Get the binary.
  • Verify binary using GPG.
  • Uncompress binary to prepare image.

Stage 2 -- Image

  • Copy needed files from builder.
  • Move executables to bin folder.
  • Copy scripts folder.
  • Expose necessary ports.
  • Map necessary volumes.

The best way is to build using docker compose, but if you prefer to build using docker directly, each image can be built directly.

Example: docker build ./coins/bitcoin

Entrypoint

The Serai full node and external full nodes each are started from an entrypoint script inside the /scripts folder.

To update the scripts on the image you must rebuild the updated images using the --build flag after "up" in docker compose.

Example: docker compose --profile bitcoin up --build