diff --git a/README.md b/README.md index f0f29986..5103f6d0 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ wallet. Serai, none neatly fitting under another category. - `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 needed for Bitcoin-Monero atomic swaps. @@ -25,6 +25,9 @@ wallet. wider community. This means they will always support the functionality Serai 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 events from Serai, executing transactions as expected and needed. @@ -33,7 +36,11 @@ wallet. - `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 diff --git a/docs/Getting Started.md b/docs/Getting Started.md index 236a84d5..f88dfeaf 100644 --- a/docs/Getting Started.md +++ b/docs/Getting Started.md @@ -83,10 +83,10 @@ cargo test --all-features ### Run Serai with Orchestration -Under `/deploy`, you can find our orchestration components for running the -entire infrastructure of Serai in a local environment using Docker Compose or -Kubernetes. +Under `/orchestration`, you can find our orchestration components for running +the entire infrastructure of Serai in a local environment using Docker Compose +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) diff --git a/deploy/README.md b/orchestration/README.md similarity index 100% rename from deploy/README.md rename to orchestration/README.md diff --git a/deploy/coins/bitcoin/Dockerfile b/orchestration/coins/bitcoin/Dockerfile similarity index 100% rename from deploy/coins/bitcoin/Dockerfile rename to orchestration/coins/bitcoin/Dockerfile diff --git a/deploy/coins/bitcoin/scripts/entry-dev.sh b/orchestration/coins/bitcoin/scripts/entry-dev.sh similarity index 100% rename from deploy/coins/bitcoin/scripts/entry-dev.sh rename to orchestration/coins/bitcoin/scripts/entry-dev.sh diff --git a/deploy/coins/ethereum/Dockerfile b/orchestration/coins/ethereum/Dockerfile similarity index 100% rename from deploy/coins/ethereum/Dockerfile rename to orchestration/coins/ethereum/Dockerfile diff --git a/deploy/coins/ethereum/scripts/entry-dev.sh b/orchestration/coins/ethereum/scripts/entry-dev.sh similarity index 100% rename from deploy/coins/ethereum/scripts/entry-dev.sh rename to orchestration/coins/ethereum/scripts/entry-dev.sh diff --git a/deploy/coins/monero/Dockerfile b/orchestration/coins/monero/Dockerfile similarity index 100% rename from deploy/coins/monero/Dockerfile rename to orchestration/coins/monero/Dockerfile diff --git a/deploy/coins/monero/scripts/entry-dev.sh b/orchestration/coins/monero/scripts/entry-dev.sh similarity index 100% rename from deploy/coins/monero/scripts/entry-dev.sh rename to orchestration/coins/monero/scripts/entry-dev.sh diff --git a/deploy/coins/monero/temp/hashes-v0.18.2.2.txt b/orchestration/coins/monero/temp/hashes-v0.18.2.2.txt similarity index 100% rename from deploy/coins/monero/temp/hashes-v0.18.2.2.txt rename to orchestration/coins/monero/temp/hashes-v0.18.2.2.txt diff --git a/deploy/docker-compose.yml b/orchestration/docker-compose.yml similarity index 94% rename from deploy/docker-compose.yml rename to orchestration/docker-compose.yml index 53bc81c0..4c3d16c6 100644 --- a/deploy/docker-compose.yml +++ b/orchestration/docker-compose.yml @@ -57,7 +57,7 @@ services: - message-queue build: context: ../ - dockerfile: ./deploy/message-queue/Dockerfile + dockerfile: ./orchestration/message-queue/Dockerfile restart: unless-stopped volumes: - "./message-queue/scripts:/scripts" @@ -70,7 +70,7 @@ services: - processor build: context: ../ - dockerfile: ./deploy/processor/Dockerfile + dockerfile: ./orchestration/processor/Dockerfile restart: unless-stopped volumes: - "./processor/scripts:/scripts" @@ -86,7 +86,7 @@ services: - _ build: context: ../ - dockerfile: ./deploy/serai/Dockerfile + dockerfile: ./orchestration/serai/Dockerfile args: TAG: serai entrypoint: /scripts/entry-dev.sh diff --git a/deploy/kubernetes/Makefile b/orchestration/kubernetes/Makefile similarity index 100% rename from deploy/kubernetes/Makefile rename to orchestration/kubernetes/Makefile diff --git a/deploy/kubernetes/README.md b/orchestration/kubernetes/README.md similarity index 100% rename from deploy/kubernetes/README.md rename to orchestration/kubernetes/README.md diff --git a/deploy/kubernetes/charts/bitcoin/Chart.yaml b/orchestration/kubernetes/charts/bitcoin/Chart.yaml similarity index 100% rename from deploy/kubernetes/charts/bitcoin/Chart.yaml rename to orchestration/kubernetes/charts/bitcoin/Chart.yaml diff --git a/deploy/kubernetes/charts/bitcoin/templates/_helpers.tpl b/orchestration/kubernetes/charts/bitcoin/templates/_helpers.tpl similarity index 100% rename from deploy/kubernetes/charts/bitcoin/templates/_helpers.tpl rename to orchestration/kubernetes/charts/bitcoin/templates/_helpers.tpl diff --git a/deploy/kubernetes/charts/bitcoin/templates/configmap.yaml b/orchestration/kubernetes/charts/bitcoin/templates/configmap.yaml similarity index 100% rename from deploy/kubernetes/charts/bitcoin/templates/configmap.yaml rename to orchestration/kubernetes/charts/bitcoin/templates/configmap.yaml diff --git a/deploy/kubernetes/charts/bitcoin/templates/deployment.yaml b/orchestration/kubernetes/charts/bitcoin/templates/deployment.yaml similarity index 100% rename from deploy/kubernetes/charts/bitcoin/templates/deployment.yaml rename to orchestration/kubernetes/charts/bitcoin/templates/deployment.yaml diff --git a/deploy/kubernetes/charts/bitcoin/templates/ingress.yaml b/orchestration/kubernetes/charts/bitcoin/templates/ingress.yaml similarity index 100% rename from deploy/kubernetes/charts/bitcoin/templates/ingress.yaml rename to orchestration/kubernetes/charts/bitcoin/templates/ingress.yaml diff --git a/deploy/kubernetes/charts/bitcoin/templates/service.yaml b/orchestration/kubernetes/charts/bitcoin/templates/service.yaml similarity index 100% rename from deploy/kubernetes/charts/bitcoin/templates/service.yaml rename to orchestration/kubernetes/charts/bitcoin/templates/service.yaml diff --git a/deploy/kubernetes/charts/bitcoin/values.yaml b/orchestration/kubernetes/charts/bitcoin/values.yaml similarity index 100% rename from deploy/kubernetes/charts/bitcoin/values.yaml rename to orchestration/kubernetes/charts/bitcoin/values.yaml diff --git a/deploy/kubernetes/charts/ethereum/Chart.yaml b/orchestration/kubernetes/charts/ethereum/Chart.yaml similarity index 100% rename from deploy/kubernetes/charts/ethereum/Chart.yaml rename to orchestration/kubernetes/charts/ethereum/Chart.yaml diff --git a/deploy/kubernetes/charts/ethereum/templates/_helpers.tpl b/orchestration/kubernetes/charts/ethereum/templates/_helpers.tpl similarity index 100% rename from deploy/kubernetes/charts/ethereum/templates/_helpers.tpl rename to orchestration/kubernetes/charts/ethereum/templates/_helpers.tpl diff --git a/deploy/kubernetes/charts/ethereum/templates/configmap.yaml b/orchestration/kubernetes/charts/ethereum/templates/configmap.yaml similarity index 100% rename from deploy/kubernetes/charts/ethereum/templates/configmap.yaml rename to orchestration/kubernetes/charts/ethereum/templates/configmap.yaml diff --git a/deploy/kubernetes/charts/ethereum/templates/deployment.yaml b/orchestration/kubernetes/charts/ethereum/templates/deployment.yaml similarity index 100% rename from deploy/kubernetes/charts/ethereum/templates/deployment.yaml rename to orchestration/kubernetes/charts/ethereum/templates/deployment.yaml diff --git a/deploy/kubernetes/charts/ethereum/templates/ingress.yaml b/orchestration/kubernetes/charts/ethereum/templates/ingress.yaml similarity index 100% rename from deploy/kubernetes/charts/ethereum/templates/ingress.yaml rename to orchestration/kubernetes/charts/ethereum/templates/ingress.yaml diff --git a/deploy/kubernetes/charts/ethereum/templates/service.yaml b/orchestration/kubernetes/charts/ethereum/templates/service.yaml similarity index 100% rename from deploy/kubernetes/charts/ethereum/templates/service.yaml rename to orchestration/kubernetes/charts/ethereum/templates/service.yaml diff --git a/deploy/kubernetes/charts/ethereum/values.yaml b/orchestration/kubernetes/charts/ethereum/values.yaml similarity index 100% rename from deploy/kubernetes/charts/ethereum/values.yaml rename to orchestration/kubernetes/charts/ethereum/values.yaml diff --git a/deploy/kubernetes/charts/monero/Chart.yaml b/orchestration/kubernetes/charts/monero/Chart.yaml similarity index 100% rename from deploy/kubernetes/charts/monero/Chart.yaml rename to orchestration/kubernetes/charts/monero/Chart.yaml diff --git a/deploy/kubernetes/charts/monero/templates/_helpers.tpl b/orchestration/kubernetes/charts/monero/templates/_helpers.tpl similarity index 100% rename from deploy/kubernetes/charts/monero/templates/_helpers.tpl rename to orchestration/kubernetes/charts/monero/templates/_helpers.tpl diff --git a/deploy/kubernetes/charts/monero/templates/configmap.yaml b/orchestration/kubernetes/charts/monero/templates/configmap.yaml similarity index 100% rename from deploy/kubernetes/charts/monero/templates/configmap.yaml rename to orchestration/kubernetes/charts/monero/templates/configmap.yaml diff --git a/deploy/kubernetes/charts/monero/templates/deployment.yaml b/orchestration/kubernetes/charts/monero/templates/deployment.yaml similarity index 100% rename from deploy/kubernetes/charts/monero/templates/deployment.yaml rename to orchestration/kubernetes/charts/monero/templates/deployment.yaml diff --git a/deploy/kubernetes/charts/monero/templates/ingress.yaml b/orchestration/kubernetes/charts/monero/templates/ingress.yaml similarity index 100% rename from deploy/kubernetes/charts/monero/templates/ingress.yaml rename to orchestration/kubernetes/charts/monero/templates/ingress.yaml diff --git a/deploy/kubernetes/charts/monero/templates/service.yaml b/orchestration/kubernetes/charts/monero/templates/service.yaml similarity index 100% rename from deploy/kubernetes/charts/monero/templates/service.yaml rename to orchestration/kubernetes/charts/monero/templates/service.yaml diff --git a/deploy/kubernetes/charts/monero/values.yaml b/orchestration/kubernetes/charts/monero/values.yaml similarity index 100% rename from deploy/kubernetes/charts/monero/values.yaml rename to orchestration/kubernetes/charts/monero/values.yaml diff --git a/deploy/kubernetes/charts/serai/Chart.yaml b/orchestration/kubernetes/charts/serai/Chart.yaml similarity index 100% rename from deploy/kubernetes/charts/serai/Chart.yaml rename to orchestration/kubernetes/charts/serai/Chart.yaml diff --git a/deploy/kubernetes/charts/serai/templates/_helpers.tpl b/orchestration/kubernetes/charts/serai/templates/_helpers.tpl similarity index 100% rename from deploy/kubernetes/charts/serai/templates/_helpers.tpl rename to orchestration/kubernetes/charts/serai/templates/_helpers.tpl diff --git a/deploy/kubernetes/charts/serai/templates/configmap.yaml b/orchestration/kubernetes/charts/serai/templates/configmap.yaml similarity index 100% rename from deploy/kubernetes/charts/serai/templates/configmap.yaml rename to orchestration/kubernetes/charts/serai/templates/configmap.yaml diff --git a/deploy/kubernetes/charts/serai/templates/deployment.yaml b/orchestration/kubernetes/charts/serai/templates/deployment.yaml similarity index 100% rename from deploy/kubernetes/charts/serai/templates/deployment.yaml rename to orchestration/kubernetes/charts/serai/templates/deployment.yaml diff --git a/deploy/kubernetes/charts/serai/templates/ingress.yaml b/orchestration/kubernetes/charts/serai/templates/ingress.yaml similarity index 100% rename from deploy/kubernetes/charts/serai/templates/ingress.yaml rename to orchestration/kubernetes/charts/serai/templates/ingress.yaml diff --git a/deploy/kubernetes/charts/serai/templates/service.yaml b/orchestration/kubernetes/charts/serai/templates/service.yaml similarity index 100% rename from deploy/kubernetes/charts/serai/templates/service.yaml rename to orchestration/kubernetes/charts/serai/templates/service.yaml diff --git a/deploy/kubernetes/charts/serai/values.yaml b/orchestration/kubernetes/charts/serai/values.yaml similarity index 100% rename from deploy/kubernetes/charts/serai/values.yaml rename to orchestration/kubernetes/charts/serai/values.yaml diff --git a/deploy/message-queue/Dockerfile b/orchestration/message-queue/Dockerfile similarity index 100% rename from deploy/message-queue/Dockerfile rename to orchestration/message-queue/Dockerfile diff --git a/deploy/message-queue/scripts/entry-dev.sh b/orchestration/message-queue/scripts/entry-dev.sh similarity index 100% rename from deploy/message-queue/scripts/entry-dev.sh rename to orchestration/message-queue/scripts/entry-dev.sh diff --git a/deploy/processor/Dockerfile b/orchestration/processor/Dockerfile similarity index 100% rename from deploy/processor/Dockerfile rename to orchestration/processor/Dockerfile diff --git a/deploy/processor/scripts/entry-dev.sh b/orchestration/processor/scripts/entry-dev.sh similarity index 100% rename from deploy/processor/scripts/entry-dev.sh rename to orchestration/processor/scripts/entry-dev.sh diff --git a/deploy/serai/Dockerfile b/orchestration/serai/Dockerfile similarity index 100% rename from deploy/serai/Dockerfile rename to orchestration/serai/Dockerfile diff --git a/deploy/serai/scripts/entry-dev.sh b/orchestration/serai/scripts/entry-dev.sh similarity index 100% rename from deploy/serai/scripts/entry-dev.sh rename to orchestration/serai/scripts/entry-dev.sh diff --git a/tests/docker/README.md b/tests/docker/README.md new file mode 100644 index 00000000..eb1018fa --- /dev/null +++ b/tests/docker/README.md @@ -0,0 +1,3 @@ +# Docker Tests + +Test infrastructure based around Docker. diff --git a/tests/docker/src/lib.rs b/tests/docker/src/lib.rs index 9aace14f..9429226c 100644 --- a/tests/docker/src/lib.rs +++ b/tests/docker/src/lib.rs @@ -27,8 +27,8 @@ pub fn build(name: String) { assert!(repo_path.as_path().ends_with("target")); repo_path.pop(); - let mut deploy_path = repo_path.clone(); - deploy_path.push("deploy"); + let mut orchestration_path = repo_path.clone(); + orchestration_path.push("orchestration"); // 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 @@ -50,7 +50,7 @@ pub fn build(name: String) { .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()) { dockerfile_path = dockerfile_path.join("coins"); } @@ -119,7 +119,7 @@ pub fn build(name: String) { // Version which always prints if !Command::new("docker") - .current_dir(deploy_path) + .current_dir(orchestration_path) .arg("compose") .arg("build") .arg(&name) @@ -135,7 +135,7 @@ pub fn build(name: String) { // Version which only prints on error /* let res = Command::new("docker") - .current_dir(deploy_path) + .current_dir(orchestration_path) .arg("compose") .arg("build") .arg(&name)