Radish alpha
h
Radicle Heartwood Protocol & Stack
Radicle
Git (anonymous pull)
Log in to clone via SSH
REVIEW: Spell "pods" without a mixture of quotes
Lorenz Leutgeb committed 1 month ago
commit 6abe107d0166687890eb9bf01d47f0991182a33a
parent 40487a0feb3bb1770a7eea7193c7ce20ff82c49b
1 file changed +2 -2
modified simulation/README.md
@@ -3,7 +3,7 @@
A suite of tools to create simulated Radicle networks to run tests in:

- **Talos**: A lightweight, immutable Linux operating system built specifically to run Kubernetes. It can run locally on your machine (via QEMU or Docker) or as a baremetal OS (amongst other deploy options).
-
- **Kubernetes (K8s)**: The orchestrator that runs the Radicle nodes in isolated "Pods" (containers) and manages their networking and storage.
+
- **Kubernetes (K8s)**: The orchestrator that runs the Radicle nodes in isolated pods (containers) and manages their networking and storage.
- **Timoni** & **CUE**: The configuration engine. Instead of writing YAML, we use CUE files to define network topologies. Timoni translates these into Kubernetes instructions.
- **Cargo test**: The test runner. Write tests in Rust that will execute over the provisioned networks.

@@ -22,7 +22,7 @@ The simulation environment is intended to remedy these gaps and more. See the [G
## Overview

The Garden team currently deploys containerised versions of `radicle-node` into [Quay.io](https://quay.io/repository/radicle_garden/radicle-node?tab=tags&tag=latest).
-
We can utilise these containers inside of K8s configuration files to compose sets of 'pods'. These pods can act as different kinds of `radicle-node`'s e.g. peer, seed or bootstrap, running different `heartwood` versions on platforms of our choosing.
+
We can utilise these containers inside of K8s configuration files to compose sets of pods. These pods can act as different kinds of `radicle-node`'s e.g. peer, seed or bootstrap, running different `heartwood` versions on platforms of our choosing.
Each of these 'sets of pods' configuration will be considered a network topology, and defined in [CUE](https://cuelang.org/). It allows us to write type safe configuration definitions instead of YAML.
We'll then use [Timoni](https://timoni.sh/) to transpile these CUE defined network topologies into [K8s object definition files](https://kubernetes.io/docs/concepts/overview/working-with-objects/) and deploy them.
[Talos](https://talos.dev) will be used to run the K8s pods on; so we can easily switch between locally deployed, via QEMU or Docker, to baremetal on SBC's like Raspberry Pi's, or remotely in Cloud environments.