https://github.com/paritytech/testnet-manager
DevOps toolkit to operate Polkadot testnets
https://github.com/paritytech/testnet-manager
Last synced: 8 months ago
JSON representation
DevOps toolkit to operate Polkadot testnets
- Host: GitHub
- URL: https://github.com/paritytech/testnet-manager
- Owner: paritytech
- License: gpl-3.0
- Created: 2022-07-29T09:21:20.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T11:51:55.000Z (about 1 year ago)
- Last Synced: 2024-10-29T13:32:02.094Z (about 1 year ago)
- Language: Python
- Size: 646 KB
- Stars: 17
- Watchers: 9
- Forks: 5
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Parity Testnet Manager
A simple UI and REST API to operate Polkadot multi-chains testnets in Kubernetes.
The **testnet-manager** let you view the following information about nodes running in your cluster:
- List Substrate nodes running in Kubernetes and query their status over RPC
- List Validators running in Kubernetes
- List Parachains and collator nodes
When provided with the relay-chain Sudo account, the **testnet-manager** can perform the following actions:
- Register/Deregister validator nodes
- Rotate validator session keys
- Onboard/Offboard a parachain
- Register/Deregister parachain collators
- Execute runtime upgrades on relay-chains and common good parachains
## Running tests
python -m pytest
## Running locally
Note that running with those commands will fail to connect to your Kubernetes cluster and running nodes without adapting them to your setup.
As such, it is recommended to refer to the next section for instructions to run a complete local stack in Kubernetes.
Setup the local environment:
```shell
poetry install
poetry shell
```
Set environment variables, eg:
NAMESPACE=rococo
HEALTHY_MIN_PEER_COUNT="1"
RELAY_CHAIN_RPC_URL="wss://rococo-rpc.polkadot.io"
RPC_NODE_URL_PATTERN="NODE_NAME.rococo:9944"
HEALTHY_MIN_PEER_COUNT="1"
SUDO_SEED=***
DERIVATION_ROOT_SEED=***
RELAY_CHAIN_CONSENSUS=poa
Start the app:
# Dev
poetry run uvicorn main:app --reload
# Prod
python -m gunicorn -k uvicorn.workers.UvicornWorker main:app --bind 0.0.0.0:5000 --timeout=3600 --capture-output --enable-stdio-inheritance --workers 4
## Running in a Local Kubernetes cluster
Install either [Minikube](https://minikube.sigs.k8s.io/docs/start/) or [Rancher-Desktop](https://rancherdesktop.io/).
Then, start your Kubernetes cluster in a VM and run:
```shell
cd local-kubernetes
make setup
make apply
```
Remark: Wait for the "setup" step (chainspec building) to complete before installing to prevent the nodes from failing to pull chainspecs files.
For more information see [helm/minikube/README.md](local-kubernetes/README.md)
Continuously deploy to Kubernetes with [Skaffold](https://skaffold.dev/):
```shell
skaffold dev
```