mirror of
https://github.com/serai-dex/serai.git
synced 2025-12-08 04:09:23 +00:00
Rename deploy to orchestration
Also updates README to note prior unnoted folders.
This commit is contained in:
11
README.md
11
README.md
@@ -17,7 +17,7 @@ wallet.
|
|||||||
Serai, none neatly fitting under another category.
|
Serai, none neatly fitting under another category.
|
||||||
|
|
||||||
- `crypto`: A series of composable cryptographic libraries built around the
|
- `crypto`: A series of composable cryptographic libraries built around the
|
||||||
`ff`/`group` APIs achieving a variety of tasks. These range from generic
|
`ff`/`group` APIs, achieving a variety of tasks. These range from generic
|
||||||
infrastructure, to our IETF-compliant FROST implementation, to a DLEq proof as
|
infrastructure, to our IETF-compliant FROST implementation, to a DLEq proof as
|
||||||
needed for Bitcoin-Monero atomic swaps.
|
needed for Bitcoin-Monero atomic swaps.
|
||||||
|
|
||||||
@@ -25,6 +25,9 @@ wallet.
|
|||||||
wider community. This means they will always support the functionality Serai
|
wider community. This means they will always support the functionality Serai
|
||||||
needs, yet won't disadvantage other use cases when possible.
|
needs, yet won't disadvantage other use cases when possible.
|
||||||
|
|
||||||
|
- `message-queue`: An ordered message server so services can talk to each other,
|
||||||
|
even when the other is offline.
|
||||||
|
|
||||||
- `processor`: A generic chain processor to process data for Serai and process
|
- `processor`: A generic chain processor to process data for Serai and process
|
||||||
events from Serai, executing transactions as expected and needed.
|
events from Serai, executing transactions as expected and needed.
|
||||||
|
|
||||||
@@ -33,7 +36,11 @@ wallet.
|
|||||||
|
|
||||||
- `substrate`: Substrate crates used to instantiate the Serai network.
|
- `substrate`: Substrate crates used to instantiate the Serai network.
|
||||||
|
|
||||||
- `deploy`: Scripts to deploy a Serai node/test environment.
|
- `orchestration`: Dockerfiles and scripts to deploy a Serai node/test
|
||||||
|
environment.
|
||||||
|
|
||||||
|
- `tests`: Tests for various crates. Generally, `crate/src/tests` is used, or
|
||||||
|
`crate/tests`, yet any tests requiring crates' binaries are placed here.
|
||||||
|
|
||||||
### Links
|
### Links
|
||||||
|
|
||||||
|
|||||||
@@ -83,10 +83,10 @@ cargo test --all-features
|
|||||||
|
|
||||||
### Run Serai with Orchestration
|
### Run Serai with Orchestration
|
||||||
|
|
||||||
Under `/deploy`, you can find our orchestration components for running the
|
Under `/orchestration`, you can find our orchestration components for running
|
||||||
entire infrastructure of Serai in a local environment using Docker Compose or
|
the entire infrastructure of Serai in a local environment using Docker Compose
|
||||||
Kubernetes.
|
or Kubernetes.
|
||||||
|
|
||||||
[Run Serai with Docker Compose](../deploy/README.md)
|
[Run Serai with Docker Compose](../orchestration/README.md)
|
||||||
|
|
||||||
[Run Serai with Kubernetes](../deploy/kubernetes/README.md)
|
[Run Serai with Kubernetes](../orchestration/kubernetes/README.md)
|
||||||
|
|||||||
@@ -57,7 +57,7 @@ services:
|
|||||||
- message-queue
|
- message-queue
|
||||||
build:
|
build:
|
||||||
context: ../
|
context: ../
|
||||||
dockerfile: ./deploy/message-queue/Dockerfile
|
dockerfile: ./orchestration/message-queue/Dockerfile
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
volumes:
|
volumes:
|
||||||
- "./message-queue/scripts:/scripts"
|
- "./message-queue/scripts:/scripts"
|
||||||
@@ -70,7 +70,7 @@ services:
|
|||||||
- processor
|
- processor
|
||||||
build:
|
build:
|
||||||
context: ../
|
context: ../
|
||||||
dockerfile: ./deploy/processor/Dockerfile
|
dockerfile: ./orchestration/processor/Dockerfile
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
volumes:
|
volumes:
|
||||||
- "./processor/scripts:/scripts"
|
- "./processor/scripts:/scripts"
|
||||||
@@ -86,7 +86,7 @@ services:
|
|||||||
- _
|
- _
|
||||||
build:
|
build:
|
||||||
context: ../
|
context: ../
|
||||||
dockerfile: ./deploy/serai/Dockerfile
|
dockerfile: ./orchestration/serai/Dockerfile
|
||||||
args:
|
args:
|
||||||
TAG: serai
|
TAG: serai
|
||||||
entrypoint: /scripts/entry-dev.sh
|
entrypoint: /scripts/entry-dev.sh
|
||||||
3
tests/docker/README.md
Normal file
3
tests/docker/README.md
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
# Docker Tests
|
||||||
|
|
||||||
|
Test infrastructure based around Docker.
|
||||||
@@ -27,8 +27,8 @@ pub fn build(name: String) {
|
|||||||
assert!(repo_path.as_path().ends_with("target"));
|
assert!(repo_path.as_path().ends_with("target"));
|
||||||
repo_path.pop();
|
repo_path.pop();
|
||||||
|
|
||||||
let mut deploy_path = repo_path.clone();
|
let mut orchestration_path = repo_path.clone();
|
||||||
deploy_path.push("deploy");
|
orchestration_path.push("orchestration");
|
||||||
|
|
||||||
// If this Docker image was created after this repo was last edited, return here
|
// If this Docker image was created after this repo was last edited, return here
|
||||||
// This should have better performance than Docker and allows running while offline
|
// This should have better performance than Docker and allows running while offline
|
||||||
@@ -50,7 +50,7 @@ pub fn build(name: String) {
|
|||||||
.0,
|
.0,
|
||||||
);
|
);
|
||||||
|
|
||||||
let mut dockerfile_path = repo_path.join("deploy");
|
let mut dockerfile_path = orchestration_path.clone();
|
||||||
if HashSet::from(["bitcoin", "ethereum", "monero"]).contains(name.as_str()) {
|
if HashSet::from(["bitcoin", "ethereum", "monero"]).contains(name.as_str()) {
|
||||||
dockerfile_path = dockerfile_path.join("coins");
|
dockerfile_path = dockerfile_path.join("coins");
|
||||||
}
|
}
|
||||||
@@ -119,7 +119,7 @@ pub fn build(name: String) {
|
|||||||
|
|
||||||
// Version which always prints
|
// Version which always prints
|
||||||
if !Command::new("docker")
|
if !Command::new("docker")
|
||||||
.current_dir(deploy_path)
|
.current_dir(orchestration_path)
|
||||||
.arg("compose")
|
.arg("compose")
|
||||||
.arg("build")
|
.arg("build")
|
||||||
.arg(&name)
|
.arg(&name)
|
||||||
@@ -135,7 +135,7 @@ pub fn build(name: String) {
|
|||||||
// Version which only prints on error
|
// Version which only prints on error
|
||||||
/*
|
/*
|
||||||
let res = Command::new("docker")
|
let res = Command::new("docker")
|
||||||
.current_dir(deploy_path)
|
.current_dir(orchestration_path)
|
||||||
.arg("compose")
|
.arg("compose")
|
||||||
.arg("build")
|
.arg("build")
|
||||||
.arg(&name)
|
.arg(&name)
|
||||||
|
|||||||
Reference in New Issue
Block a user