Ecosystem/serai
Ecosystem/serai
1
0
Fork 0
mirror of https://github.com/serai-dex/serai.git synced 2024-11-16 17:07:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
serai/orchestration
History
Luke Parker d60e007126
Add a binaries feature to the processor to reduce dependencies when used as a lib 
processor isn't intended to be used as a library, yet serai-processor-tests
does pull it in as a lib. This caused serai-processor-tests to need to compile
rocksdb, which added multiple minutes to the compilation time.
2023-11-25 04:04:52 -05:00
..
coins Dockerfile Parts (#428) 2023-11-12 23:55:15 -05:00
coordinator Install wasm toolchain before ADDing files to docker images 2023-11-22 18:07:58 -05:00
Dockerfile.parts Install wasm toolchain before ADDing files to docker images 2023-11-22 18:07:58 -05:00
kubernetes Rename deploy to orchestration 2023-07-27 03:19:35 -04:00
message-queue Install wasm toolchain before ADDing files to docker images 2023-11-22 18:07:58 -05:00
processor Add a binaries feature to the processor to reduce dependencies when used as a lib 2023-11-25 04:04:52 -05:00
runtime Rust 1.74 2023-11-19 17:47:46 -05:00
serai Install wasm toolchain before ADDing files to docker images 2023-11-22 18:07:58 -05:00
docker-compose.yml Dockerfile Parts (#428) 2023-11-12 23:55:15 -05:00
dockerfiles.sh Dockerfile Parts (#428) 2023-11-12 23:55:15 -05:00
README.md Dockerfile Parts (#428) 2023-11-12 23:55:15 -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 /deploy, not the root folder.

Profiles:

  • bitcoin - Bitcoin node

  • monero - Monero node

  • ethereum - Ethereum node

  • coins - Nodes for all external networks (BTC, ETH, XMR)

  • message-queue - The message queue service.

  • processor - Serai processor for one external network.

  • coordinator - Serai coordinator for the entire Serai stack.

  • serai - Serai node

  • cluster-sm - "Alice", "Bob", "Charlie", and "Dave" Serai nodes, all as validators (enough to achieve BFT with one faulty node)

  • cluster-lg - cluster-sm with non-validators "Eve" and "Ferdie"

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

Example: docker compose --profile coins --profile serai up

Orchestration Approach

Builds

The Serai infrastructure is locally compiled. This may take several minutes.

Images for external networks download binaries, before verifying their checksums and signatures.

Stage 1 -- Builder

  • Configure environment.
  • Get the binary.
  • Verify binary using GPG.
  • Decompress 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.

Entrypoint

The Serai node and external networks' nodes are each 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