🐛 Report Bugs
Found a bug? Open an Issue with a detailed description, steps to reproduce, and expected behavior.
GreenKube is an open-source, community-driven project. We welcome contributions from everyone, especially new recommendation sources and support for more GitOps layouts.
🐛 Report Bugs
Found a bug? Open an Issue with a detailed description, steps to reproduce, and expected behavior.
💡 Suggest Features
Have an idea? Start a Discussion to propose and discuss new features with the community.
🔧 Submit Code
Ready to code? Fork the repo, create a branch, make your changes, and submit a Pull Request.
📖 Improve Docs
Documentation improvements are always welcome! Fix typos, add examples, or write new guides.
# Clone the repositorygit clone https://github.com/GreenKubeCloud/GreenKube.gitcd GreenKube
# Install uv (if not already installed)pip install uv# or: curl -LsSf https://astral.sh/uv/install.sh | sh
# Create virtual environment and install all dependencies (dev + test)uv syncsource .venv/bin/activate # Linux/macOS# .venv\Scripts\activate # Windows
# Install pre-commit hookspre-commit install
# Run tests to verify everything worksuv run pytestcd frontendnpm installnpm run dev # Start dev server with hot reloadnpm run build # Build for productioncore/core/factory.pyasync def for network, database, and file operationsasyncio.gather for parallel operationsis_estimated: truelogging.getLogger(__name__)# Format codeuv run ruff format .
# Lint codeuv run ruff check .
# Auto-fix lint issuesuv run ruff check --fix .
# Type-check with Pyreflyuv run pyrefly check
# Run testsuv run pytest
# Run tests with coverageuv run pytest --cov=greenkube --cov-report=html| Level | Use Case |
|---|---|
DEBUG | Detailed flow, cache hits, parsing details |
INFO | Major pipeline events, collection start/end |
WARNING | Recoverable issues, fallback to defaults |
ERROR | Failures requiring attention |
Follow Conventional Commits:
feat: add GPU power profilingfix: handle missing node labels gracefullydocs: add storage backend comparisontest: add unit tests for rightsizing recommendationsrefactor: extract zone mapping to utility moduleperf: optimize batch database insertsmain: git checkout -b feat/my-featurepytest)ruff format --check .)ruff check .)Source (discover, health, collect) that emits signals, package it under the greenkube.sources entry point group, and run the contract test suite. See Sources overview and the example package.make e2e runs the whole loop on Minikube with a sample app, Argo CD, Flux and Gitea (Quick Start).The repository’s CONTRIBUTING.md is the reference for the development workflow.
GreenKube is licensed under the Apache License 2.0. By contributing, you agree that your contributions will be licensed under the same license.