{"id":26198980,"url":"https://github.com/getdeck/beiboot-api","last_synced_at":"2025-06-20T12:07:15.264Z","repository":{"id":64827523,"uuid":"577347299","full_name":"Getdeck/beiboot-api","owner":"Getdeck","description":null,"archived":false,"fork":false,"pushed_at":"2024-09-23T08:01:43.000Z","size":855,"stargazers_count":7,"open_issues_count":21,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-15T04:49:38.901Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Getdeck.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2022-12-12T14:36:56.000Z","updated_at":"2024-06-24T07:33:50.000Z","dependencies_parsed_at":"2023-09-29T17:02:03.233Z","dependency_job_id":"f0fca0f9-9833-49ef-94bb-a89b898b8f3c","html_url":"https://github.com/Getdeck/beiboot-api","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Getdeck%2Fbeiboot-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Getdeck%2Fbeiboot-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Getdeck%2Fbeiboot-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Getdeck%2Fbeiboot-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Getdeck","download_url":"https://codeload.github.com/Getdeck/beiboot-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249010196,"owners_count":21197797,"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":[],"created_at":"2025-03-12T02:55:31.385Z","updated_at":"2025-04-15T04:49:57.222Z","avatar_url":"https://github.com/Getdeck.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Getdeck API\n\nIn order to make the API available for your Host Cluster, apply the provided settings, configuration and API resources:\n\n```bash\nkubectl apply -f manifests/api-settings.yaml\n```\n\n```bash\nkubectl apply -f manifests/api.yaml\n```\n\n## API Settings\n\nThe settings of the API can be configured using a `ConfigMap` (see [api-settings.example.yaml](manifests/api-settings.example.yaml)).\n\n| Parameter                  | Description              | Type | Default   | Example |\n| :------------------------- | :----------------------- | :--- | :-------- | :------ |\n| `sentry_dsn`               | Sentry DNS               | Str  | -         |         |\n| `sentry_environment`       | Sentry environment       | Str  | -         |         |\n| `config_default_name`      | Default config name      | Str  | `default` |         |\n| `config_default_namespace` | Default config namespace | Str  | `getdeck` |         |\n\n## Groups\n\nCurrently, the API supports the following fixed groups:\n\n- developer\n- free\n- (default)\n\nOnly one of the listed groups is selected based on the following priority:\n\n`developer \u003e free \u003e default`\n\nA user will be assigned to the `default` group, if no group is provided within the header.\nInvalid group names are ignored.\n\n\u003e **_NOTE:_** We plan to extend the group system later on in order to make it more flexible, including custom groups.\n\n## Group/Cluster Configuration\n\n| Parameter                              | Type   | Default | Example                                | Description / Comment  |\n| :------------------------------------- | :----- | :------ | :------------------------------------- | :--------------------- |\n| `k8s_versions`                         | List   | -       | `\"1.26.0,1.26.1,1.26.2,1.26.3,1.27.0\"` | Supported k8s versions |\n| `node_count_min`                       | Int    | `1`     |                                        | Minimum node count     |\n| `node_count_max`                       | Int    | `3`     |                                        | Maximum node count     |\n| `lifetime_limit`                       | String | `1h`    |                                        | Cluster lifetime limit |\n| `session_timeout_limit`                | String | `30m`   |                                        | Session timeout limit  |\n| `cluster_request_timeout_limit`        | String | `5m`    |                                        |                        |\n| `server_resources_requests_cpu_min`    | String | -       |                                        |                        |\n| `server_resources_requests_cpu_max`    | String | -       |                                        |                        |\n| `server_resources_requests_memory_min` | String | -       |                                        |                        |\n| `server_resources_requests_memory_max` | String | -       |                                        |                        |\n| `server_resources_limits_cpu_min`      | String | -       |                                        |                        |\n| `server_resources_limits_cpu_max`      | String | -       |                                        |                        |\n| `server_resources_limits_memory_min`   | String | -       |                                        |                        |\n| `server_resources_limits_memory_max`   | String | -       |                                        |                        |\n| `server_storage_requests_min`          | String | -       |                                        |                        |\n| `server_storage_requests_max`          | String | -       |                                        |                        |\n| `node_resources_requests_cpu_min`      | String | -       |                                        |                        |\n| `node_resources_requests_cpu_max`      | String | -       |                                        |                        |\n| `node_resources_requests_memory_min`   | String | -       |                                        |                        |\n| `node_resources_requests_memory_max`   | String | -       |                                        |                        |\n| `node_resources_limits_cpu_min`        | String | -       |                                        |                        |\n| `node_resources_limits_cpu_max`        | String | -       |                                        |                        |\n| `node_resources_limits_memory_min`     | String | -       |                                        |                        |\n| `node_resources_limits_memory_max`     | String | -       |                                        |                        |\n| `node_storage_requests_min`            | String | -       |                                        |                        |\n| `node_storage_requests_max`            | String | -       |                                        |                        |\n\nAlternatively to using a ConfigMap, default cluster config parameters can be set using an `.env` file, too. In order to work, all cluster config parameters have to be prefixed with `cd_`.\n\n```txt\ncd_k8s_versions=\"1.26.0,1.26.1,1.26.2,1.26.3,1.27.0\"\ncd_node_count_min=\"1\"\ncd_node_count_max=\"3\"\ncd_lifetime_limit=\"1h\"\ncd_session_timeout_limit=\"30m\"\n...\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetdeck%2Fbeiboot-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgetdeck%2Fbeiboot-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetdeck%2Fbeiboot-api/lists"}