{"id":24118919,"url":"https://github.com/ktp0li/crocum","last_synced_at":"2025-09-18T09:30:55.063Z","repository":{"id":63847748,"uuid":"563554590","full_name":"ktp0li/crocum","owner":"ktp0li","description":"OpenNebula-based PaaS for deployment and checking network labs","archived":false,"fork":false,"pushed_at":"2023-07-10T11:11:18.000Z","size":149,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"fastapi","last_synced_at":"2023-07-10T12:27:11.662Z","etag":null,"topics":["opennebula","pytest","qemu-guest-agent","terraform","testinfra"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ktp0li.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}},"created_at":"2022-11-08T21:18:33.000Z","updated_at":"2023-05-09T14:34:58.000Z","dependencies_parsed_at":"2023-02-15T23:45:58.985Z","dependency_job_id":null,"html_url":"https://github.com/ktp0li/crocum","commit_stats":null,"previous_names":[],"tags_count":0,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ktp0li%2Fcrocum","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ktp0li%2Fcrocum/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ktp0li%2Fcrocum/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ktp0li%2Fcrocum/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ktp0li","download_url":"https://codeload.github.com/ktp0li/crocum/tar.gz/refs/heads/fastapi","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":233465454,"owners_count":18680436,"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","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":["opennebula","pytest","qemu-guest-agent","terraform","testinfra"],"created_at":"2025-01-11T09:37:49.470Z","updated_at":"2025-09-18T09:30:54.625Z","avatar_url":"https://github.com/ktp0li.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Crocum [WIP]\n\u003ca href=\"https://olymp.hse.ru/data/2023/04/03/2025606431/%D0%91%D0%B8%D0%B7%D0%BD%D0%B5%D1%81-%D0%B8%D0%BD%D1%84%D0%BE%D1%80%D0%BC%D0%B0%D1%82%D0%B8%D0%BA%D0%B0%20(%D0%92%D1%8B%D1%81%D1%88%D0%B8%D0%B9%20%D0%BF%D0%B8%D0%BB.pdf\"\u003e\u003cimg src=https://badgen.net/badge/olymp.hse.ru%2Fprojects%2023/winner/\u003e\n\n\u003ca href=\"https://nnb.etu.ru/shkolnikam/pobediteli-konferencii-2023-goda\"\u003e\u003cimg src=https://badgen.net/badge/nnb.etu.ru%2023/winner/\u003e\n## TL:DR\nCrocum is a PaaS designed to train network engineers on automatically created, deleted, and checked by terms of reference network labs.\nEducational platforms can access Crocum via the RESTful API written on ~~Flask~~ FastAPI (WIP).\n\nTest instance: crocum.ktp0li.su [WIP, ip whitelist]\n\n## Why?\n~~Because I can.~~ None of the existing solutions on the market, whether for personal or corporate use, can automate the checking of labs. I was very sad to see my teachers spending hours on manual checks. Crocum is suitable for both personal and corporate use, in which case I take care of the servers, the client only needs to use the provided API. \n\n## Architerture\n\u003cimg src=\"./pics/architecture.png\" width=\"500\"/\u003e\n\n- #### OpenNebula\nUsed for globally control VMs, nets, storage, etc on multiple hosts. It is also ideal for horizontal scaling.\n- #### Terraform\n Used for declarative description of labs infra (VMs, nets, address ranges, templates, etc).\n- #### PyTest \u0026 QEMU Guest Agent\nVMs are in isolated networks, making it impossible to use Ansible/Salt. So I decided to use for checking purposes tests written on PyTest with module testinfra. Then tests are run on VMs using QEMU Guest Agent, tracing their output.\n- #### ~~Flask~~ FastAPI (WIP)\nCrocum's final form, allowing create, destroy and check labs by one request. PostgreSQL is used for storing info about users and labs.\n\n- #### DB model\nComing soon...\n## Example of lab (named lab1)\n\u003cimg src=\"./pics/netplan.svg\" width=\"400\"/\u003e\n\nTerraform configs for this lab are stored in ./terraform/lab1, tests are stored in ./tests\n\n## TODO\n- [X] Write a delightful README\n- [X] Deploy Crocum on my home server\n- [X] Finalize qemu-ga module for API\n- [ ] Rewrite API on FastAPI\n- [ ] DOCKERIZE!!111!!\n- [ ] Deploy a pretty cluster of \u003e= 3 OpenNebula instances \n- [ ] Fix phantom problem with Terraform (troubles with OpenNebula provider???)\n- [ ] Draw cute logo\n- [ ] Maybe create simple frontend??? \n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fktp0li%2Fcrocum","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fktp0li%2Fcrocum","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fktp0li%2Fcrocum/lists"}