absolutebi/serai
1
0
Fork 0
mirror of https://github.com/serai-dex/serai.git synced 2025-12-08 20:29:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Dockerfiles

Browse Source 
Cleans files, updates Bitcoin and Monero versions, fixes Monero immediately
exiting.
This commit is contained in:
Luke Parker
2023-07-19 19:22:49 -04:00
parent c2f32e7882
commit b6579d5a2a
9 changed files with 148 additions and 178 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
deploy/README.md
View File

@@ -1,37 +1,46 @@
# 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.
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.
All commands are assumed to be ran from `/deploy`, not the 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.
* `bitcoin` - Bitcoin node
* `monero` - Monero node
* `ethereum` - Ethereum node
* `coins` - Nodes for all external networks (BTC, ETH, XMR)
**Example:** `docker compose --profile base --profile bitcoin up`
* `serai` - Serai node
* `cluster-sm` - "Alice", "Bob", and "Charlie" Serai nodes, all validators
* `cluster-lg` - `cluster-sm` with non-validators "Dave", "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 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:
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.
* Uncompress binary to prepare image.
* Decompress binary to prepare image.
**Stage 2 -- Image**
* Copy needed files from builder.
@@ -40,13 +49,17 @@ The Serai node is the only piece of our infrastructure that we compile locally a
* 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.
The best way is to build using `docker compose`. If you'd prefer to build using
`docker` directly, each image can be built independently.
**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.
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`