{"id":46296609,"url":"https://github.com/octopusdeploy/octopus-permissions-controller","last_synced_at":"2026-03-04T10:02:17.951Z","repository":{"id":310424716,"uuid":"1036489190","full_name":"OctopusDeploy/octopus-permissions-controller","owner":"OctopusDeploy","description":"This controller acts as a permissions broker between Octopus Deploy workloads running using the Kubernetes Agent and Kubernetes itself.","archived":false,"fork":false,"pushed_at":"2026-02-17T23:15:43.000Z","size":525,"stargazers_count":2,"open_issues_count":3,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-18T04:49:21.974Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/OctopusDeploy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-08-12T06:40:09.000Z","updated_at":"2025-12-17T04:00:20.000Z","dependencies_parsed_at":"2025-09-29T07:12:36.605Z","dependency_job_id":"bc1c58f0-ddd3-4997-8fa3-36eb8de7cb75","html_url":"https://github.com/OctopusDeploy/octopus-permissions-controller","commit_stats":null,"previous_names":["octopusdeploy/octopus-permissions-controller"],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/OctopusDeploy/octopus-permissions-controller","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OctopusDeploy%2Foctopus-permissions-controller","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OctopusDeploy%2Foctopus-permissions-controller/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OctopusDeploy%2Foctopus-permissions-controller/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OctopusDeploy%2Foctopus-permissions-controller/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OctopusDeploy","download_url":"https://codeload.github.com/OctopusDeploy/octopus-permissions-controller/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OctopusDeploy%2Foctopus-permissions-controller/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30078307,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-04T08:01:56.766Z","status":"ssl_error","status_checked_at":"2026-03-04T08:00:42.919Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: 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":[],"created_at":"2026-03-04T10:02:17.077Z","updated_at":"2026-03-04T10:02:17.944Z","avatar_url":"https://github.com/OctopusDeploy.png","language":"Go","readme":"# Octopus Permissions Controller\n\nOctopus Permissions Controller connects your [Octopus Deploy](https://octopus.com) deployments with granular Kubernetes\nRBAC controls.\n\n## Description\n\nOctopus Permissions Controller processes custom resources (`WorkloadServiceAccount`) into a set of Kubernetes \n`ServiceAccounts`, with `Roles` and `RoleBindings` attached. These `ServiceAccounts` are then assigned to deployments \nperformed by the [Kubernetes agent](https://octopus.com/docs/kubernetes/targets/kubernetes-agent) based on the scope \nof the deployment.\n\n## Documentation\n\nDocumentation and installation instructions can be found at\n[octopus.com/docs](https://oc.to/octopus-permissions-controller).\n\n## Did you find a bug?\n\nIf the bug is a security vulnerability in Octopus Deploy, please refer to our \n[security policy](https://github.com/OctopusDeploy/.github/blob/main/SECURITY.md).\n\nSearch our [public Issues repository](https://github.com/OctopusDeploy/Issues) to ensure the bug was not already\nreported.\n\nIf you're unable to find an open issue addressing the problem, please follow our \n[support guidelines](https://github.com/OctopusDeploy/.github/blob/main/SUPPORT.md).\n\n## Development\n\nThis project is scaffolded using [Kubebuilder](https://github.com/kubernetes-sigs/kubebuilder), please refer\nto [Kubebuilder documentation](https://book.kubebuilder.io/introduction.html) for details.\n\n### Prerequisites\n- go version v1.25.0+\n- docker version 17.03+.\n- kubectl version v1.11.3+.\n- Access to a Kubernetes v1.11.3+ cluster.\n\n### To Deploy on the cluster\n**Build and push your image to the location specified by `IMG`:**\n\n```sh\nmake docker-build docker-push IMG=\u003csome-registry\u003e/octopus-permissions-controller:tag\n```\n\n**NOTE:** This image ought to be published in the personal registry you specified.\nAnd it is required to have access to pull the image from the working environment.\nMake sure you have the proper permission to the registry if the above commands don’t work.\n\n**Install the CRDs into the cluster:**\n\n```sh\nmake install\n```\n\n**Deploy the Manager to the cluster with the image specified by `IMG`:**\n\n```sh\nmake deploy IMG=\u003csome-registry\u003e/octopus-permissions-controller:tag\n```\n\n\u003e **NOTE**: If you encounter RBAC errors, you may need to grant yourself cluster-admin\nprivileges or be logged in as admin.\n\n**Create instances of your solution**\nYou can apply the samples (examples) from the config/sample:\n\n```sh\nkubectl apply -k config/samples/\n```\n\n\u003e**NOTE**: Ensure that the samples has default values to test it out.\n\n### To Uninstall\n**Delete the instances (CRs) from the cluster:**\n\n```sh\nkubectl delete -k config/samples/\n```\n\n**Delete the APIs(CRDs) from the cluster:**\n\n```sh\nmake uninstall\n```\n\n**UnDeploy the controller from the cluster:**\n\n```sh\nmake undeploy\n```\n\n### Debugging directly with Octopus\n\n**Spin up a test kind cluster**\n\nThis will create a kind cluster and install all the required CRDs, except for the Octopus Permissions Controller deployment\n\n```sh\nmake setup-debug-env\n```\n\n**Run this project**\n\nVia `Build and Run octopus-permissions-controller` launch config in VSCode or `go build github.com_octopusdeploy_octopus-permissions-controller_cmd.run.xml` run config for Goland.\n\n**Create a Kubernetes agent in the kind cluster**\n\nUsing Octopus, create a new Kubernetes agent in the kind cluster. You can use the advanced options to configure the agent with the permissions controller enabled, but do not install the permissions controller helm chart when prompted to.\n\nYou will be able to confirm that the permissions controller is active on the agent's connectivity page, the Permissions Controller version should be `v0.0.0`\n\n**Testing**\n\nA good place to start is to apply `config/samples/v1beta1_workloadserviceaccount.yaml` to your cluster. This will need to be created in the namespace(s) you are making your deployments to.\n\n## Project Distribution\n\nWhen changes are made to the kubebuilder configuration, installation files must be regenerated.\n\n1. Build the installer for the image built and published in the registry:\n\n```sh\nmake build-installer\n```\n\n2. Build the chart using the optional helm plugin\n\n```sh\nkubebuilder edit --plugins=helm/v2-alpha\n```\n\n2. See that a chart was generated under 'dist/chart', and users\ncan obtain this solution from there.\n\n**NOTE:** If you change the project, you need to update the Helm Chart\nusing the same command above to sync the latest changes. Furthermore, you may \nneed to use the above command with the '--force' flag and manually ensure that\nany custom configuration previously added to 'dist/chart/values.yaml' or \n'dist/chart/manager/manager.yaml' is manually re-applied afterwards.\n\n## 🤝 Contributions\n\nContributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) for information about how to get involved in this project.\n\n## License\n\nCopyright 2025.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foctopusdeploy%2Foctopus-permissions-controller","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foctopusdeploy%2Foctopus-permissions-controller","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foctopusdeploy%2Foctopus-permissions-controller/lists"}