{"id":29859422,"url":"https://github.com/jaypyles/ryomk","last_synced_at":"2025-07-30T02:13:32.253Z","repository":{"id":306663817,"uuid":"1022737873","full_name":"jaypyles/ryomk","owner":"jaypyles","description":"Roll your own managed kubernetes (cluster).","archived":false,"fork":false,"pushed_at":"2025-07-26T20:51:57.000Z","size":59,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-07-27T00:24:39.101Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jaypyles.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-07-19T18:04:44.000Z","updated_at":"2025-07-26T20:52:00.000Z","dependencies_parsed_at":"2025-07-27T00:26:50.844Z","dependency_job_id":"97d4d31a-6968-4682-9fd1-94cf2ea49673","html_url":"https://github.com/jaypyles/ryomk","commit_stats":null,"previous_names":["jaypyles/ryomk"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/jaypyles/ryomk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaypyles%2Fryomk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaypyles%2Fryomk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaypyles%2Fryomk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaypyles%2Fryomk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jaypyles","download_url":"https://codeload.github.com/jaypyles/ryomk/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaypyles%2Fryomk/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267797778,"owners_count":24145711,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-30T02:00:09.044Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-07-30T02:13:31.567Z","updated_at":"2025-07-30T02:13:32.242Z","avatar_url":"https://github.com/jaypyles.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Roll Your Own Managed Kubernetes (ryomk)\n\nA comprehensive solution for managing K3s clusters with KVM virtualization, featuring a Spring Boot backend API and a Python CLI tool.\n\n## 🏗️ Architecture\n\nThis project consists of two main components:\n\n- **Spring Boot Backend API** - RESTful API for VM and cluster management\n- **Python CLI Tool** - Command-line interface for easy interaction with the API\n\n## 🚀 Quick Start\n\n### Prerequisites\n\n- Docker and Docker Compose\n- Java 17+ (for local development)\n- Python 3.12+ (for CLI development)\n- PDM (Python dependency manager)\n- Maven (for local backend development)\n\n### Using Docker (Recommended)\n\n1. **Clone and start the services:**\n   ```bash\n   git clone \u003crepository-url\u003e\n   cd ryomk\n   make build up\n   ```\n\n2. **Verify the API is running:**\n   ```bash\n   curl http://localhost:8080/actuator/health\n   ```\n\n3. **Install and use the CLI:**\n   ```bash\n   cd cli\n   pdm install\n   pdm run ryomk vm list\n   ```\n\n## 📋 Project Structure\n\n```\nryomk/\n├── src/                    # Spring Boot application source\n│   ├── main/java/\n│   │   └── com/k3skvmmaster/\n│   │       ├── controller/ # REST API controllers\n│   │       ├── service/    # Business logic services\n│   │       ├── model/      # Data models and DTOs\n│   │       ├── config/     # Configuration classes\n│   │       └── util/       # Utility classes\n│   └── resources/          # Configuration files\n├── cli/                    # Python CLI application\n│   ├── src/cli/           # CLI source code\n│   ├── pyproject.toml     # Python dependencies\n│   └── README.md          # CLI-specific documentation\n├── docker-compose.yaml    # Docker services configuration\n├── Dockerfile            # Backend container definition\n├── Makefile              # Build and deployment commands\n└── pom.xml               # Maven dependencies\n```\n\n## 🔧 Backend API (Spring Boot)\n\n### Features\n\n- **VM Management**: Create, delete, start, stop, and list virtual machines\n- **Cluster Management**: Join nodes to K3s cluster, manage join tokens\n- **Kubernetes Integration**: Direct interaction with K3s cluster\n- **Libvirt Integration**: KVM virtualization management\n- **SSH Operations**: Remote system management\n- **Cloud-Init Support**: Automated VM provisioning\n\n### API Endpoints\n\nView all API endpoint documentation at: `http://localhost:8080/swagger-ui.html`\n\n### Configuration\n\nThe backend uses environment variables for configuration:\n\n```bash\n# Libvirt Configuration\nLIBVIRT_URI=qemu+ssh://user@host/system\nVM_BASE_IMAGE_PATH=/path/to/base.qcow2\nVM_IMAGES_DIRECTORY=/var/lib/libvirt/images\n\n# K3s Configuration\nK3S_MASTER_IP=192.168.50.34\nK3S_MASTER_VERSION=v1.30.5+k3s1\nK3S_MASTER_NETWORK=kube-net\nK3S_MASTER_BRIDGE=br0\n```\n\n### Local Development\n\n```bash\n# Install dependencies\nmvn clean install\n\n# Run the application\n./mvnw spring-boot:run\n\n# Run tests\n./mvnw test\n```\n\n## 🐍 Python CLI Tool\n\n### Features\n\n- **Modern CLI Interface**: Intuitive command structure\n- **Type Safety**: Full type checking with Pyright\n- **Error Handling**: Clear error messages and proper exit codes\n- **Configuration**: Customizable API endpoints\n- **Legacy Support**: Backward compatibility with numeric commands\n\n### Installation\n\n```bash\ncd cli\npdm install\n```\n\n### Usage Examples\n\nView usage examples at `/examples/example.sh`\n\n### Development\n\n```bash\n# Run in development mode\npdm run python -m ryomk\n```\n\n## 🐳 Docker Deployment\n\n### Using Makefile Commands\n\n```bash\nmake # show all available commands\n```\n\n## 🆘 Support\n\nFor issues and questions:\n- Check the API documentation at `/swagger-ui.html`\n- Review the CLI help with `pdm run ryomk --help`\n- Check the logs with `make logs`","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaypyles%2Fryomk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjaypyles%2Fryomk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaypyles%2Fryomk/lists"}