https://github.com/octopusdeploy/octopus-permissions-controller
This controller acts as a permissions broker between Octopus Deploy workloads running using the Kubernetes Agent and Kubernetes itself.
https://github.com/octopusdeploy/octopus-permissions-controller
Last synced: about 1 month ago
JSON representation
This controller acts as a permissions broker between Octopus Deploy workloads running using the Kubernetes Agent and Kubernetes itself.
- Host: GitHub
- URL: https://github.com/octopusdeploy/octopus-permissions-controller
- Owner: OctopusDeploy
- License: apache-2.0
- Created: 2025-08-12T06:40:09.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2026-02-17T23:15:43.000Z (about 2 months ago)
- Last Synced: 2026-02-18T04:49:21.974Z (about 2 months ago)
- Language: Go
- Size: 513 KB
- Stars: 2
- Watchers: 0
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Octopus Permissions Controller
Octopus Permissions Controller connects your [Octopus Deploy](https://octopus.com) deployments with granular Kubernetes
RBAC controls.
## Description
Octopus Permissions Controller processes custom resources (`WorkloadServiceAccount`) into a set of Kubernetes
`ServiceAccounts`, with `Roles` and `RoleBindings` attached. These `ServiceAccounts` are then assigned to deployments
performed by the [Kubernetes agent](https://octopus.com/docs/kubernetes/targets/kubernetes-agent) based on the scope
of the deployment.
## Documentation
Documentation and installation instructions can be found at
[octopus.com/docs](https://oc.to/octopus-permissions-controller).
## Did you find a bug?
If the bug is a security vulnerability in Octopus Deploy, please refer to our
[security policy](https://github.com/OctopusDeploy/.github/blob/main/SECURITY.md).
Search our [public Issues repository](https://github.com/OctopusDeploy/Issues) to ensure the bug was not already
reported.
If you're unable to find an open issue addressing the problem, please follow our
[support guidelines](https://github.com/OctopusDeploy/.github/blob/main/SUPPORT.md).
## Development
This project is scaffolded using [Kubebuilder](https://github.com/kubernetes-sigs/kubebuilder), please refer
to [Kubebuilder documentation](https://book.kubebuilder.io/introduction.html) for details.
### Prerequisites
- go version v1.25.0+
- docker version 17.03+.
- kubectl version v1.11.3+.
- Access to a Kubernetes v1.11.3+ cluster.
### To Deploy on the cluster
**Build and push your image to the location specified by `IMG`:**
```sh
make docker-build docker-push IMG=/octopus-permissions-controller:tag
```
**NOTE:** This image ought to be published in the personal registry you specified.
And it is required to have access to pull the image from the working environment.
Make sure you have the proper permission to the registry if the above commands don’t work.
**Install the CRDs into the cluster:**
```sh
make install
```
**Deploy the Manager to the cluster with the image specified by `IMG`:**
```sh
make deploy IMG=/octopus-permissions-controller:tag
```
> **NOTE**: If you encounter RBAC errors, you may need to grant yourself cluster-admin
privileges or be logged in as admin.
**Create instances of your solution**
You can apply the samples (examples) from the config/sample:
```sh
kubectl apply -k config/samples/
```
>**NOTE**: Ensure that the samples has default values to test it out.
### To Uninstall
**Delete the instances (CRs) from the cluster:**
```sh
kubectl delete -k config/samples/
```
**Delete the APIs(CRDs) from the cluster:**
```sh
make uninstall
```
**UnDeploy the controller from the cluster:**
```sh
make undeploy
```
### Debugging directly with Octopus
**Spin up a test kind cluster**
This will create a kind cluster and install all the required CRDs, except for the Octopus Permissions Controller deployment
```sh
make setup-debug-env
```
**Run this project**
Via `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.
**Create a Kubernetes agent in the kind cluster**
Using 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.
You 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`
**Testing**
A 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.
## Project Distribution
When changes are made to the kubebuilder configuration, installation files must be regenerated.
1. Build the installer for the image built and published in the registry:
```sh
make build-installer
```
2. Build the chart using the optional helm plugin
```sh
kubebuilder edit --plugins=helm/v2-alpha
```
2. See that a chart was generated under 'dist/chart', and users
can obtain this solution from there.
**NOTE:** If you change the project, you need to update the Helm Chart
using the same command above to sync the latest changes. Furthermore, you may
need to use the above command with the '--force' flag and manually ensure that
any custom configuration previously added to 'dist/chart/values.yaml' or
'dist/chart/manager/manager.yaml' is manually re-applied afterwards.
## 🤝 Contributions
Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) for information about how to get involved in this project.
## License
Copyright 2025.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.