serai/deploy/kubernetes/README.md

42 lines
1.2 KiB
Markdown
Raw Normal View History

Cluster Orchestration with Kubernetes (#121) * add file * builds + caching fixed * bitcoin orchestration * remove default entrypoint * eth image and cleanup * working monero * remove signature file * cleanup on aisle eth * cleanup on aisle btc * eth working * remove docker ignore * remove bitcoin image readme * fix serai builds * serai clusters * added readme for docker * formatting * share the image * newlines at EOF * add multi profile example * coin order * coin order * profile order * fix grammar * fix whitespace * reduce trusted signature set, require at least 3 signatures. * remove echo * update comment to ref trusted keys * comment fix * use 16 keys, check for laanwj, name compose * don't use bash * monero fingerprints & eth fixes * eth fixes * remove extra eth keys * kubernetes deployment implemented with helm charts * deleted helmignores & added new lines at the end of the file * deleted duplications & delete unnecessary comments & deactivated service accounts * deleted generators files * added a new line to monero/values.yaml * deleted support for old kubernetes version - ingress.yaml * added new like to serai/values.yaml * serai's port name changed * serai's port name changed * release name limit was changed to 253 * README.md updated * fixed Makefile * deleted platform dependant instructions * deleted appVersion from .yamls * added -i parameter for deleting process * added \ for Makefile Co-authored-by: TheArchitect108 <75815740+TheArchitect108@users.noreply.github.com> Co-authored-by: TheArchitect <TheArchitect108@protonmail.com>
2022-10-11 10:27:03 +00:00
# Kubernetes
## Run with Kubernetes
Running the Serai infrastructure is easy with Kubernetes.
We utilize Makefile to easily orchestrate various pieces of the infrastructure on kubernetes.
**Example to deploy:** `make deploy-<Profile_Name>`
```bash
make deploy-cluster-sm
```
**Example to delete:** `make -i delete-<Profile_Name>`
```bash
make delete-cluster-sm
```
All commands are assumed to be ran from the kubernetes folder, not the serai root folder.
### Profiles:
* deploy-base - single node, named base
* deploy-coins - node clients for coins only (BTC, ETH, XMR)
* deploy-cluster-sm - Alice (Validator), Bob, Charlie
* deploy-cluster-coins-sm - cluster-sm with coins
* deploy-cluster-lg - Alice (Validator), Bob, Charlie, Dave, Eve, Ferdie
* deploy-cluster-coins-lg - cluster-lg with coins
* deploy-monero - full node monero only
* deploy-bitcoin - full node bitcoin only
* deploy-ethereum - full node ethereum only
## Requirements for Linux
* Local built images of serai and coins, please follow the Instructions [here](../README.md)
* Running kubernetes cluster (version >= 1.19)
* Curl tool
* Make tool
* Kubectl, check if not installed
```bash
make check-kubectl
```
* Helm, check if not installed
```bash
make check-helm
```