octopus-permissions-controller

Octopus Permissions Controller

Octopus Permissions Controller connects your Octopus Deploy 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 based on the scope of the deployment.

Documentation

Documentation and installation instructions can be found at octopus.com/docs.

Did you find a bug?

If the bug is a security vulnerability in Octopus Deploy, please refer to our security policy.

Search our public Issues repository 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.

Development

This project is scaffolded using Kubebuilder, please refer to Kubebuilder documentation 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:

make docker-build docker-push IMG=<some-registry>/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:

make install

Deploy the Manager to the cluster with the image specified by IMG:

make deploy IMG=<some-registry>/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:

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:

kubectl delete -k config/samples/

Delete the APIs(CRDs) from the cluster:

make uninstall

UnDeploy the controller from the cluster:

make undeploy

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:

make build-installer

1. Build the chart using the optional helm plugin

kubebuilder edit --plugins=helm/v2-alpha

1. 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 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.