{"id":20054585,"url":"https://github.com/crane-cloud/backend","last_synced_at":"2026-04-15T12:02:29.344Z","repository":{"id":37096042,"uuid":"188269313","full_name":"crane-cloud/backend","owner":"crane-cloud","description":"Managed Kubernetes Platform","archived":false,"fork":false,"pushed_at":"2026-04-14T13:15:10.000Z","size":1646,"stargazers_count":10,"open_issues_count":7,"forks_count":11,"subscribers_count":2,"default_branch":"staging","last_synced_at":"2026-04-14T13:25:37.005Z","etag":null,"topics":["cloud-computing","cloudnativecomputing","database-management","kubernetes","kubernetes-deployment","multicluster","paas","python"],"latest_commit_sha":null,"homepage":null,"language":"Python","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/crane-cloud.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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2019-05-23T16:22:23.000Z","updated_at":"2026-04-14T12:24:44.000Z","dependencies_parsed_at":"2023-10-24T22:26:11.964Z","dependency_job_id":"51f3c826-4d72-44fb-a3a8-d0ea5987665c","html_url":"https://github.com/crane-cloud/backend","commit_stats":null,"previous_names":[],"tags_count":33,"template":false,"template_full_name":null,"purl":"pkg:github/crane-cloud/backend","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crane-cloud%2Fbackend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crane-cloud%2Fbackend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crane-cloud%2Fbackend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crane-cloud%2Fbackend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/crane-cloud","download_url":"https://codeload.github.com/crane-cloud/backend/tar.gz/refs/heads/staging","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crane-cloud%2Fbackend/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31840114,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-15T11:29:19.690Z","status":"ssl_error","status_checked_at":"2026-04-15T11:29:19.171Z","response_time":63,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["cloud-computing","cloudnativecomputing","database-management","kubernetes","kubernetes-deployment","multicluster","paas","python"],"created_at":"2024-11-13T12:41:36.093Z","updated_at":"2026-04-15T12:02:29.335Z","avatar_url":"https://github.com/crane-cloud.png","language":"Python","readme":"# Crane Cloud\n\n[![Test](https://github.com/crane-cloud/backend/actions/workflows/test.yml/badge.svg)](https://github.com/crane-cloud/backend/actions/workflows/test.yml)\n[![Build](https://github.com/crane-cloud/backend/actions/workflows/staging.yml/badge.svg)](https://github.com/crane-cloud/backend/actions/workflows/staging.yml)\n[![Production](https://github.com/crane-cloud/backend/actions/workflows/prod.yml/badge.svg)](https://github.com/crane-cloud/backend/actions/workflows/prod.yml)\n[![codecov](https://codecov.io/gh/crane-cloud/backend/branch/develop/graph/badge.svg?token=kkuF1X6MWx)](https://codecov.io/gh/crane-cloud/backend)\n\nManaged Kubernetes Platform\n\n## Project Setup\n\nFollow these steps to have a local running copy of the app.\n\n### Clone The Repo\n\n```bash\ngit clone https://github.com/crane-cloud/backend.git\n```\n\n### Directly on your machine\n\n---\n\n#### Install PostgreSQL\n\nHere's a great resource to check out: [How To Install and Use PostgreSQL](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-18-04)\n\nCreate the two databases:\n\n- `cranecloud` (for development)\n- `cranecloud_test_db` (for unit testing)\n\n#### Create a Virtual Environment\n\nApp was developed with Python 3.6.\n\nMake sure you have `pip` installed on your machine.\n\nCreate a pip virtual environment called `venv`.\n\n```bash\npython -m venv venv\n```\n\nActivate the virtual environment:\n\n```bash\n.\\venv\\Scripts\\activate\n```\n\nInstall the dependencies:\n\n```bash\npip install -r requirements.txt\n```\n\nCreate a `.env` file (which defines the environment variables used) at the root of the app.\n\nAdd the following details, customizing as needed:\n\n```bash\nexport FLASK_APP=server.py\nexport FLASK_ENV=development\nexport FLASK_DEBUG=1\nexport FLASK_RUN_PORT=5000\nexport FLASK_APP_SECRET=\u003capp_secret\u003e\n```\n\nRun the application:\n\n```bash\nflask run\n```\n\n### Running application with Docker\n\n---\n\n`make` is a build automation tool that is used to manage the build process of a software project.\n\n- In the project directory, running `make` shows you a list of commands to use.\n- Run `make start` to start the application and required services.\n- Run `make connect-to-container` to connect to the Flask application container after running `make start`.\n\n---\n\n\u003e Application should be running on \u003chttp://localhost:5000\u003e and apidocs on \u003chttp://localhost:5000/apidocs/#/\u003e\n\n\u003c!-- --- --\u003e\n\n## Finishing up\n\n\u003e To run with Docker, you have to ssh into the container first by running `make connect-to-container`, and then execute the following commands.\n\n### Running Migrations\n\nThe application uses SQLAlchemy ORM to manage and run database migrations.\n\nTo run migration upgrade against the database relations, use the following command:\n\n```bash\nflask db upgrade\n```\n\nTo run migrations in case there are changes in the schema, use the following command:\n\n```bash\nflask db migrate\n```\n\n### Testing and Coverage\n\nThis app uses `nose` to run tests.\n\nTo run tests with coverage:\n\n```bash\nnosetests --with-coverage --cover-package=routes\n```\n\nTo run tests without coverage:\n\n```bash\nnosetests\n```\n\n### Creating default roles\n\nTo create the default roles, run:\n\n```bash\nflask create_roles\n```\n\n### Creating default admin account\n\nTo create an admin account, run:\n\n```bash\nflask admin_user --email=\u003cemail\u003e --password=\u003cpassword\u003e --confirm_password=\u003cpassword\u003e\n```\n\n### To add clusters locally\n\nRun the application using `flask run` and visit [http://127.0.0.1:5000/apidocs/#/clusters/post_clusters](http://127.0.0.1:5000/apidocs/#/clusters/post_clusters)\n\nUse the following JSON payload:\n\n```json\n{\n  \"description\": \"string\",\n  \"host\": \"string\",\n  \"name\": \"string\",\n  \"token\": \"string\"\n}\n```\n\nReach out to the backend team to get token and host values.\n\n## Optional things\n\n### Add image repositories\n\nTo add image repositories to the database, run:\n\n```bash\nflask create_registries\n```\n\n### Starting celery workers\n\n#### Run celery worker and beat on Linux\n\n```bash\ncelery -A server.celery worker --loglevel=info\ncelery -A server.celery beat --loglevel=info\n```\n\n#### Run celery worker and beat on Windows\n\n```bash\ncelery -A server.celery worker --pool=solo --loglevel=info\ncelery -A server.celery beat --loglevel=info\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrane-cloud%2Fbackend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrane-cloud%2Fbackend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrane-cloud%2Fbackend/lists"}