Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/strangelove-ventures/cosmos-operator
Cosmos Operator is a kubernetes operator for managing cosmos nodes
https://github.com/strangelove-ventures/cosmos-operator
Last synced: about 1 month ago
JSON representation
Cosmos Operator is a kubernetes operator for managing cosmos nodes
- Host: GitHub
- URL: https://github.com/strangelove-ventures/cosmos-operator
- Owner: strangelove-ventures
- License: apache-2.0
- Created: 2022-07-25T17:26:52.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-05T18:32:17.000Z (8 months ago)
- Last Synced: 2024-04-13T02:15:37.394Z (8 months ago)
- Language: Go
- Size: 925 KB
- Stars: 65
- Watchers: 11
- Forks: 11
- Open Issues: 38
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-ccamel - strangelove-ventures/cosmos-operator - Cosmos Operator is a kubernetes operator for managing cosmos nodes (Go)
- awesome-cosmos - cosmos-operator - Cosmos Operator is a kubernetes operator for managing cosmos nodes. (Node Operations / Utilities)
README
[](https://github.com/strangelove-ventures/readme-dot-lint)
[](https://www.repostatus.org/#active)
[](https://pkg.go.dev/github.com/strangelove-ventures/cosmos-operator)
[](https://goreportcard.com/report/github.com/strangelove-ventures/cosmos-operator)
[](https://github.com/strangelove-ventures/cosmos-operator/blob/main/LICENSE)
[](https://github.com/cosmos/strangelove-ventures/cosmos-operator)
Cosmos Operator is a [Kubernetes Operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) primarily for blockchains built with the [Cosmos SDK](https://github.com/cosmos/cosmos-sdk). It also supports [Penumbra](https://github.com/penumbra-zone/penumbra) and other chains which use [CometBFT](https://github.com/cometbft/cometbft) for consensus.
🌌 Why use Cosmos Operator?
=============================
Kubernetes ("K8") makes DevOps easier. Cosmos Operator makes Kubernetes easier for use in the Cosmos Ecosystem.
K8 provides a foundation for creating highly-available, scalable, fault-tolerant applications. It provides well-known DevOps patterns and abstractions (as opposed to traditional DevOps which often requires "re-inventing the wheel").
Furthermore, the [Operator Pattern][] allows us to mix infrastructure with business logic,
thus minimizing human intervention and human error.
🌌🌌 Who benefits from Cosmos Operator?
=============================
People who'd like to use the [Operator Pattern][] to "configure it and forget it".
> The [operator pattern][] aims to capture the key aim of a human operator who is managing a service or set of services. Human operators who look after specific applications and services have deep knowledge of how the system ought to behave, how to deploy it, and how to react if there are problems.
> People who run workloads on Kubernetes often like to use automation to take care of repeatable tasks. The [operator pattern][] captures how you can write code to automate a task beyond what Kubernetes itself provides.
🌌🌌🌌 What does Cosmos Operator do?
=============================
Cosmos Operator is a [Kubernetes Operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) for blockchains built with the [Cosmos SDK](https://github.com/cosmos/cosmos-sdk). Write your own Custom Resource Definition ("CRD") as a `yaml` file and deploy with ease!
🌌🌌🌌🌌 How do I use Cosmos Operator?
=============================
## Quick Start
See the [quick start guide](./docs/quick_start.md).
## CosmosFullNode CRD
CosmosFullNode is the flagship CRD. Its purpose is to deploy highly-available, fault-tolerant blockchain nodes.
The CosmosFullNode controller is like a StatefulSet for running Cosmos SDK blockchains.
A CosmosFullNode can be configured to run as an RPC node, a validator sentry, or a seed node. All configurations can be used as persistent peers.
As of this writing, Strangelove has been running CosmosFullNode in production for over a year.
## Samples
- [Minimal example yaml](./config/samples/cosmos_v1_cosmosfullnode.yaml)
- [Full example yaml](./config/samples/cosmos_v1_cosmosfullnode_full.yaml)
- [Penumbra example yaml](./config/samples/cosmos_v1_cosmosfullnode_penumbra.yaml)
## Support CRDs
These CRDs are part of the operator and serve to support CosmosFullNodes.
- [ScheduledVolumeSnapshot](./docs/scheduled_volume_snapshot.md)
- [StatefulJob](./docs/stateful_job.md)
### Why not a StatefulSet?
Each pod requires different config, such as peer settings in config.toml and mounted node keys. Therefore, a blanket
template as found in StatefulSet did not suffice.
Additionally, CosmosFullNode gives you more control over individual pod and pvc pairs vs. a StatefulSet to help the human operator debug and recover from situations such as a corrupted PVCs.
🌌🌌🌌🌌🌌 Extras
=============================
# Disclaimers
- Tested on Google's GKE and Bare-metal with `Kubeadm`. Although kubernetes is portable, we cannot guarantee or provide support for AWS, Azure, or other kubernetes providers.
- Requires a recent version of kubernetes: v1.23+.
- CosmosFullNode: The chain must be built from the [Cosmos SDK](https://github.com/cosmos/cosmos-sdk).
- CosmosFullNode: Validator sentries require a remote signer such as [horcrux](https://github.com/strangelove-ventures/horcrux).
- CosmosFullNode: The controller requires [heighliner](https://github.com/strangelove-ventures/heighliner) images. If you build your own image, you will need a shell `sh` and set the uid:gid to 1025:1025. If running as a validator sentry, you need `sleep` as well.
- CosmosFullNode: May not work for all Cosmos chains. (Some chains diverge from common conventions.) Strangelove has yet to encounter a Cosmos chain that does not work with this operator.
# Contributing
See the [contributing guide](./CONTRIBUTING.md).
# Best Practices
See the [best practices guide for CosmosFullNode](./docs/fullnode_best_practices.md).
# Roadmap
Disclaimer: Strangelove has not committed to these enhancements and cannot estimate when they will be completed.
- [x] Scheduled upgrades. Set the upgrade height and image version, optionally setting halt height. The controller performs a rolling update with the new image version after the committed height.
- [x] Support configuration suitable for validator sentries.
- [x] Reliable, persistent peer support.
- [x] Quicker p2p discovery using private peers.
- [ ] Advanced readiness probe behavior. (The CometBFT rpc status endpoint is not always reliable.)
- [x] Automatic rollout for PVC resizing. (Currently human intervention required to restart pods after PVC resized.) Requires ExpandInUsePersistentVolumes feature gate.
- [x] Automatic PVC resizing. The controller increases PVC size once storage reaches a configured threshold; e.g. 80% full.
- [ ] Bootstrap config using the chain registry. Query the chain registry and set config based on the registry.
- [ ] Validate p2p such as peers, seeds, etc. and filter out non-responsive peers.
- [ ] HPA support.
- [ ] Automatic upgrades. Controller monitors governance and performs upgrade without any human intervention.
- [ ] Corrupt data recovery. Detect when a PVC may have corrupted data. Restore data from a recent VolumeSnapshot.
- [x] Safe, automatic backups. Create periodic VolumeSnapshots of PVCs while minimizing chance of data corruption during snapshot creation.
# License
Copyright 2023 Strangelove Ventures LLC.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
---
[Operator Pattern]: https://kubernetes.io/docs/concepts/extend-kubernetes/operator/#operators-in-kubernetes