🚂🚋🚋🚋🚋🚋
This repository is a one-click deployment solution for running a Cosmos RPC node (provider testnet) on Kubernetes (Kind) with integrated monitoring.Designed for developers and SREs working with cosmoshub ecosystem.
- Overview
- Dashboard
- Features
- Getting Started
- Project Structure
- Tech Stack
- References
- Contributing
- License
This project provides a comprehensive setup for deploying a Cosmos-based blockchain node using Kubernetes. It leverages Kind (Kubernetes in Docker) for local cluster management, ensuring a seamless development experience. The monitoring stack, powered by Prometheus and Grafana, offers real-time insights into node performance and health metrics.
Key features include:
- Automated deployment scripts for easy setup and management.
- Prometheus rules for alerting on critical metrics such as node downtime and CPU usage.
- Grafana dashboards for visualizing node status, storage metrics, and network performance.
- Compatibility with both Linux and MacOS, making it accessible for a wide range of developers.
Important
- Please note that the cometbft metrics may experience delays before they start providing data to Grafana.
- This project is compatible with Linux operating systems. Ensure that you have the following Prerequisites.
- 🚀 Single-command local Kubernetes cluster setup via Kind
- ₿ Cosmos testnet node with pruning enabled
- 📊 Prometheus/Grafana monitoring stack
- 📈 Real-time dashboard for key node statistics
- 🔄 Full automation with idempotent deployment script
Useful tools (Cluster Management):
- Clone the repository:
git clone https://github.com/your-username/cosmos-node.git- Navigate to the project directory:
cd cosmos-node- Install the dependencies of the project:
make install
cosmos-node/
├── Makefile # Automation for build, deployment and management tasks
├── README.md # Project documentation and guide
├── docs/ # Documentation and assets
│ └── assets/ # Screenshots, diagrams, and other visual resources
│ ├── cli/ # CLI usage examples and screenshots
│ └── dashboard/ # Grafana dashboard screenshots
├── kind/ # Kind (Kubernetes in Docker) configuration
├── kube/ # Kubernetes manifests and resources
│ ├── base/ # Base Kustomize configuration
│ ├── monitoring/ # Prometheus and Grafana setup
│ │ ├── dashboards/ # Custom Grafana dashboards
│ │ ├── metrics/ # Prometheus metrics
│ └── overlays/ # Environment-specific Kustomize overlays
│ └── dev/ # Development environment configuration
├── logs/ # Application and deployment logs
└── scripts/ # Utility scripts
├── cluster/ # Cluster management scripts
└── tools/ # Useful automation scripts
The project uses:
- Fork the repository
- Create your feature branch:
git checkout -b feature/AmazingFeature - Commit your changes:
git commit -m 'Add some AmazingFeature' - Push to the branch:
git push origin feature/AmazingFeature - Open a Pull Request
This project is licensed under the Apache License 2.0 file for more details.