{"id":23536221,"url":"https://github.com/appuio/control-api","last_synced_at":"2025-08-30T02:04:10.436Z","repository":{"id":39883904,"uuid":"435540935","full_name":"appuio/control-api","owner":"appuio","description":"APPUiO Cloud Control API","archived":false,"fork":false,"pushed_at":"2025-08-28T03:56:01.000Z","size":888,"stargazers_count":3,"open_issues_count":16,"forks_count":0,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-08-28T05:47:38.189Z","etag":null,"topics":["api","appuio","appuio-cloud","kubernetes","vshn-project-apub"],"latest_commit_sha":null,"homepage":"https://kb.vshn.ch/appuio-cloud/references/architecture/control-api.html","language":"Go","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/appuio.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":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-12-06T15:05:26.000Z","updated_at":"2024-09-26T11:31:19.000Z","dependencies_parsed_at":"2023-11-09T01:28:19.046Z","dependency_job_id":"cf96b664-0e14-4c39-9ffa-bee3023754b9","html_url":"https://github.com/appuio/control-api","commit_stats":null,"previous_names":[],"tags_count":69,"template":false,"template_full_name":null,"purl":"pkg:github/appuio/control-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appuio%2Fcontrol-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appuio%2Fcontrol-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appuio%2Fcontrol-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appuio%2Fcontrol-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/appuio","download_url":"https://codeload.github.com/appuio/control-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appuio%2Fcontrol-api/sbom","scorecard":{"id":204190,"data":{"date":"2025-08-11","repo":{"name":"github.com/appuio/control-api","commit":"fd065b51ed8e5ecd02b869c558ac35cb25f20425"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.6,"checks":[{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/appuio/control-api/lint.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/appuio/control-api/lint.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/appuio/control-api/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/appuio/control-api/release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/appuio/control-api/release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/appuio/control-api/release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/appuio/control-api/release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/appuio/control-api/release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/appuio/control-api/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/appuio/control-api/test.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/appuio/control-api/test.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/appuio/control-api/test.yml/master?enable=pin","Warn: containerImage not pinned by hash: Dockerfile:1","Info:   0 out of   6 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   6 third-party GitHubAction dependencies pinned","Info:   0 out of   1 containerImage dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Code-Review","score":8,"reason":"Found 11/13 approved changesets -- score normalized to 8","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/lint.yml:1","Warn: no topLevel permission defined: .github/workflows/release.yml:1","Warn: no topLevel permission defined: .github/workflows/test.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/release.yml:9"],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v0.33.4 not signed: https://api.github.com/repos/appuio/control-api/releases/177044223","Warn: release artifact v0.33.3 not signed: https://api.github.com/repos/appuio/control-api/releases/164037508","Warn: release artifact v0.33.2 not signed: https://api.github.com/repos/appuio/control-api/releases/157152404","Warn: release artifact v0.33.1 not signed: https://api.github.com/repos/appuio/control-api/releases/156278145","Warn: release artifact v0.33.0 not signed: https://api.github.com/repos/appuio/control-api/releases/141595466","Warn: release artifact v0.33.4 does not have provenance: https://api.github.com/repos/appuio/control-api/releases/177044223","Warn: release artifact v0.33.3 does not have provenance: https://api.github.com/repos/appuio/control-api/releases/164037508","Warn: release artifact v0.33.2 does not have provenance: https://api.github.com/repos/appuio/control-api/releases/157152404","Warn: release artifact v0.33.1 does not have provenance: https://api.github.com/repos/appuio/control-api/releases/156278145","Warn: release artifact v0.33.0 does not have provenance: https://api.github.com/repos/appuio/control-api/releases/141595466"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"13 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GO-2025-3770 / GHSA-vrw8-fxc6-2r93","Warn: Project is vulnerable to: GO-2023-2331 / GHSA-8pgv-569h-w5rw","Warn: Project is vulnerable to: GO-2023-2113 / GHSA-rcjv-mgp8-qvmr","Warn: Project is vulnerable to: GO-2023-2402 / GHSA-45x7-px36-x8w8","Warn: Project is vulnerable to: GO-2024-3321 / GHSA-v778-237x-gjrc","Warn: Project is vulnerable to: GO-2025-3487 / GHSA-hcg3-q754-cr77","Warn: Project is vulnerable to: GO-2024-2687 / GHSA-4v7x-pqxf-cx7m","Warn: Project is vulnerable to: GO-2024-3333","Warn: Project is vulnerable to: GO-2025-3503 / GHSA-qxp5-gwg8-xv66","Warn: Project is vulnerable to: GO-2025-3595 / GHSA-vvgc-356p-c3xw","Warn: Project is vulnerable to: GO-2025-3488 / GHSA-6v2p-p543-phr9","Warn: Project is vulnerable to: GO-2023-2153 / GHSA-m425-mq94-257g / GHSA-qppj-fm5r-hxr3","Warn: Project is vulnerable to: GO-2024-2611 / GHSA-8r3f-844c-mc37"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-16T23:21:01.245Z","repository_id":39883904,"created_at":"2025-08-16T23:21:01.245Z","updated_at":"2025-08-16T23:21:01.245Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272793017,"owners_count":24993830,"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-08-30T02:00:09.474Z","response_time":77,"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":["api","appuio","appuio-cloud","kubernetes","vshn-project-apub"],"created_at":"2024-12-26T02:17:46.004Z","updated_at":"2025-08-30T02:04:10.297Z","avatar_url":"https://github.com/appuio.png","language":"Go","readme":"[![Build](https://img.shields.io/github/workflow/status/appuio/control-api/Test)](https://github.com/appuio/control-api/actions?query=workflow%3ATest)\n![Go version](https://img.shields.io/github/go-mod/go-version/appuio/control-api)\n![Kubernetes version](https://img.shields.io/badge/k8s-v1.23-blue)\n[![Version](https://img.shields.io/github/v/release/appuio/control-api)](https://github.com/appuio/control-api/releases)\n[![Maintainability](https://img.shields.io/codeclimate/maintainability/appuio/control-api)](https://codeclimate.com/github/appuio/control-api)\n[![GitHub downloads](https://img.shields.io/github/downloads/appuio/control-api/total)](https://github.com/appuio/control-api/releases)\n\n# control-api\n\n\n## Generate Kubernetes code\n\nIf you make changes to the CRD structs you'll need to run code generation.\nThis can be done with make:\n\n```bash\nmake generate\n```\n\n## Building\n\nSee `make help` for a list of build targets.\n\n* `make build`: Build binary for linux/amd64\n* `make build -e GOOS=darwin -e GOARCH=arm64`: Build binary for macos/arm64\n* `make build.docker`: Build Docker image for local environment\n\n## Install CRDs\n\nCRDs can be installed on the cluster by running `kubectl apply -k config/crd/apiextensions.k8s.io/v1`.\n\n## Local development environment\n\nYou can setup a [kind]-based local environment with\n\n```bash\nmake local-env-setup\n```\n\nSee the [local-env/README.md](./local-env/README.md) for more details on the local environment setup.\n\nPlease be aware that the productive deployment of the control-api may run on a different Kubernetes distribution than [kind].\n\n[kind]: https://kind.sigs.k8s.io/\n\n\n### Running the control-api API server locally\n\nYou can run the control-api API server locally against the currently configured Kubernetes cluster with\n\n```bash\nmake run-api\n```\n\nTo access the locally running API server, you need to register it with the [kind]-based local environment.\nYou can do this by applying the following.\n\nThe `externalName` needs to be changed to your specific host IP.\nWhen running kind on Linux you can find it with `docker inspect`.\n\nOn some docker distributions the host IP is accessible via `host.docker.internal`.\n\n```bash\nHOSTIP=$(docker inspect control-api-v1.25.3-control-plane | jq '.[0].NetworkSettings.Networks.kind.Gateway')\n# HOSTIP=host.docker.internal # On some docker distributions\n\ncat \u003c\u003cEOF | sed -e \"s/172.21.0.1/$HOSTIP/g\" | kubectl apply -f -\napiVersion: apiregistration.k8s.io/v1\nkind: APIService\nmetadata:\n  name: v1.organization.appuio.io\nspec:\n  insecureSkipTLSVerify: true\n  group: organization.appuio.io\n  groupPriorityMinimum: 1000\n  versionPriority: 15\n  service:\n    name: apiserver\n    namespace: default\n    port: 9443\n  version: v1\n---\napiVersion: apiregistration.k8s.io/v1\nkind: APIService\nmetadata:\n  name: v1.billing.appuio.io\nspec:\n  insecureSkipTLSVerify: true\n  group: billing.appuio.io\n  groupPriorityMinimum: 1000\n  versionPriority: 15\n  service:\n    name: apiserver\n    namespace: default\n    port: 9443\n  version: v1\n---\napiVersion: apiregistration.k8s.io/v1\nkind: APIService\nmetadata:\n  name: v1.user.appuio.io\nspec:\n  insecureSkipTLSVerify: true\n  group: user.appuio.io\n  groupPriorityMinimum: 1000\n  versionPriority: 15\n  service:\n    name: apiserver\n    namespace: default\n    port: 9443\n  version: v1\n---\napiVersion: v1\nkind: Service\nmetadata:\n  name: apiserver\n  namespace: default\nspec:\n  ports:\n  - port: 9443\n    protocol: TCP\n    targetPort: 9443\n  type: ExternalName\n  externalName: 172.21.0.1 # Change to host IP\nEOF\n```\n\nAfter that you should be able to access your (with `make run` running) API server with\n\n```bash\nkubectl get organizations\n```\n\n### Running the control-api controller locally\n\nYou can run the control-api controller locally against the currently configured Kubernetes cluster with\n\n```bash\nmake run-controller\n```\n\nTo access the locally running controller webhook server, you need to register it with the [kind]-based local environment.\nYou can do this by applying the following manifests:\n\n```\nHOSTIP=$(docker inspect control-api-v1.25.3-control-plane | jq '.[0].NetworkSettings.Networks.kind.Gateway')\n\ncat \u003c\u003cEOF | sed -e \"s/172.21.0.1/$HOSTIP/g\" | kubectl apply -f -\napiVersion: v1\nkind: Service\nmetadata:\n  name: webhook-service\n  namespace: default\nspec:\n  ports:\n  - port: 9444\n    protocol: TCP\n    targetPort: 9444\n  type: ExternalName\n  externalName: 172.21.0.1 # Change to host IP\nEOF\n\nkubectl patch validatingwebhookconfiguration validating-webhook-configuration \\\n  -p '{\n    \"webhooks\": [\n      {\n        \"name\": \"validate-invitations.user.appuio.io\",\n        \"clientConfig\": {\n          \"caBundle\": \"'\"$(base64 -w0 \"./local-env/webhook-certs/tls.crt)\"'\",\n          \"service\": {\n            \"namespace\": \"default\",\n            \"port\": 9444\n          }\n        }\n      },\n      {\n        \"name\": \"validate-users.appuio.io\",\n        \"clientConfig\": {\n          \"caBundle\": \"'\"$(base64 -w0 \"./local-env/webhook-certs/tls.crt)\"'\",\n          \"service\": {\n            \"namespace\": \"default\",\n            \"port\": 9444\n          }\n        }\n      }\n    ]\n  }'\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappuio%2Fcontrol-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fappuio%2Fcontrol-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappuio%2Fcontrol-api/lists"}