Skip to content

Latest commit

 

History

History
171 lines (125 loc) · 6.87 KB

README.md

File metadata and controls

171 lines (125 loc) · 6.87 KB
Raw

access-manager

test

The Access-Manager is a Kubernetes-Operator using the Operator-SDK to simplify complex RBAC configurations in your cluster and spread secrets across namespaces.

Motivation

The idea for this came up, when managing many different RBAC-Roles on namespace-basis. This was getting more complex over time, and the administrator always has to ensure that the correct roles are applied for different people or ServiceAccounts in multiple namespaces. The scope of the operator is limited to the creation and removal of RoleBindings and ClusterRoleBindings. So all referenced Roles and ClusterRoles have to exist. Let's automate it.

Kubernetes Compatibility

The image contains versions of k8s.io/client-go. Kubernetes aims to provide forwards & backwards compatibility of one minor version between client and server:

access-manager k8s.io/client-go k8s.io/apimachinery expected kubernetes compatibility
main v0.28.1 v0.28.1 1.27.x, 1.28.x, 1.29.x
0.12.x v0.28.1 v0.28.1 1.27.x, 1.28.x, 1.29.x
0.11.x v0.26.0 v0.26.0 1.25.x, 1.26.x, 1.27.x
0.10.x v0.24.3 v0.24.3 1.23.x, 1.24.x, 1.25.x
0.9.x v0.23.5 v0.23.5 1.22.x, 1.23.x, 1.24.x
0.8.x v0.23.0 v0.23.0 1.22.x, 1.23.x, 1.24.x
0.7.x v0.22.1 v0.22.1 1.21.x, 1.22.x, 1.23.x
0.6.x v0.21.1 v0.21.1 1.20.x, 1.21.x, 1.22.x
0.5.x v0.20.1 v0.20.1 1.19.x, 1.20.x, 1.21.x
0.4.x v0.19.2 v0.19.2 1.18.x, 1.19.x, 1.20.x
0.3.x v0.18.8 v0.18.8 1.17.x, 1.18.x, 1.19.x
0.2.x v12.0.0 v0.18.5 1.17.x, 1.18.x, 1.19.x
0.1.x v12.0.0 v0.18.3 1.17.x, 1.18.x, 1.19.x

See the release notes for specific version compatibility information, including which combination have been formally tested.

Installation

Note: The ServiceAccount must have at least the permissions that it should grant. The cluster-admin ClusterRole is assigned to the ServiceAccount by default.

Manifests

kubectl apply -f config/crd/access-manager.io_rbacdefinitions.yaml
kubectl apply -f config/crd/access-manager.io_syncsecretdefinitions.yaml
kubectl apply -f config/rbac
kubectl apply -f config/manager

Helm-Chart

helm repo add ckotzbauer https://ckotzbauer.github.io/helm-charts
helm install ckotzbauer/access-manager

Examples

RBAC-Definition

The RbacDefinition itself is cluster-scoped.

apiVersion: access-manager.io/v1beta1
kind: RbacDefinition
metadata:
  name: example-definition
spec:
  namespaced:
  - namespace:
      name: my-product
    bindings:
    - roleName: my-product-management
      kind: Role
      subjects:
      - name: my-product-team
        kind: Group
      - name: devops-team
        kind: Group
  - namespaceSelector:
      matchLabels:
        ci: "true"
    bindings:
    - roleName: ci-deploy
      kind: ClusterRole
      subjects:
      - name: ci
        namespace: ci-service
        kind: ServiceAccount
  cluster:
  - name: john-view-binding
    clusterRoleName: view
    subjects:
    - name: john
      kind: User

This would create the following objects:

  • A RoleBinding named my-product-management in the namespace my-product assigning the my-product-management Role to the Groups my-product-team and devops-team.
  • A RoleBinding named ci-deploy in each namespace labeled with ci: true assigning the ci-deploy ClusterRole to the ServiceAccount ci in the ci-service namespace.
  • A ClusterRoleBinding named john-view-binding assigning the view ClusterRole to the User john.

For more details, please read the api-docs and view YAMLs in the examples directory.

Behaviors

  • A RbacDefinition can be marked as "paused" (set spec.paused to true), so that the operator will not interfere you.
  • The RoleBindings and ClusterRoleBindings are named the same as the given Role or ClusterRole unless the name is explicitly specified.
  • If there is a existing binding with the same name that is not owned by the RbacDefinition it is not touched.
  • The operator detects changes to all RbacDefinitions, Namespaces and ServiceAccounts automatically.

SyncSecret-Definition

The SyncSecretDefinition itself is cluster-scoped.

apiVersion: access-manager.io/v1beta1
kind: SyncSecretDefinition
metadata:
  name: example-definition
spec:
  source:
    name: source-secret
    namespace: default
  targets:
  - namespace:
      name: my-product
  - namespaceSelector:
      matchLabels:
        ci: "true"

This would create the following secret:

  • A Secret named source-secret in the namespace my-product and each namespace labeled with ci: true.

For more details, please read the api-docs and view YAMLs in the examples directory.

Behaviors

  • A SyncSecretDefinition can be marked as "paused" (set spec.paused to true), so that the operator will not interfere you.
  • The Secretss are named the same as the given Secret in "source".
  • If there is a existing secret with the same name that is not owned by the SyncSecretDefinition it is not touched.
  • The operator detects changes to all SyncSecretDefinitions, Namespaces and source Secretss automatically.

Roadmap

  • Expose Prometheus metrics about created bindings and reconcile errors.

Credits

This projects was inspired by the RBACManager.

License

Changelog

Contributing

Please refer to the Contribution guildelines.

Code of conduct

Please refer to the Conduct guildelines.

Security

Please refer to the Security process.