yonahd / kor

A Golang Tool to discover unused Kubernetes Resources
MIT License
1.04k stars 96 forks source link

feature: Discover unused ClusterRoleBindings #335

Open doronkg opened 3 months ago

doronkg commented 3 months ago

Is your feature request related to a problem? ClusterRoleBindings can be created while referencing non-existing users/groups/ServiceAccounts on one hand or ClusterRoles on the other hand.

Go through all existing ClusterRoleBindings and verify if they are applied to existing subjects and ClusterRoles. Utilize ShowReason flag to indicate that the reason the ClusterRoleBinding was considered unused was because it referenced an unused subject or ClusterRole.

NOTE: Since a ClusterRoleBinding can include multiple subject references, discovering a single non-existing subject (one of several existing ones) might indicate the ClusterRoleBinding as unused while it actually is, in that case, it shouldn't be considered as unused.

Examples In the attached example, we could see a ClusterRoleBinding with references to both users: `alice` & `bob`. 1. Assuming both users `alice` & `bob` does not exist, the ClusterRole is not applied to them, hence the ClusterRoleBinding will be considered as **UNUSED**. 2. Assuming both users `alice` & `bob` exist, but the ClusterRole does not exist, it is not applied to them, hence the ClusterRoleBinding will be considered as **UNUSED**. 3. Assuming user `alice` does exist and the ClusterRole is applied to it, even while `bob` does not exist - the ClusterRoleBinding will be considered as **USED**. ``` apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRoleBinding metadata: name: read-pods-global subjects: - kind: User name: alice apiGroup: rbac.authorization.k8s.io - kind: User name: bob apiGroup: rbac.authorization.k8s.io roleRef: kind: ClusterRole name: pod-reader apiGroup: rbac.authorization.k8s.io ```

Describe the solution you'd like

$ kor clusterrolebindings
Unused ClusterRoleBindings:
+---+----------------+----------------------------------------------+-----------------------------+
| # | NAMESPACE |   RESOURCE NAME |                         REASON                                |
+---+----------------+----------------------------------------------+-----------------------------+
| 1 |           | example-crb-1   | ClusterRoleBinding references a non-existing ServiceAccount   |  
| 2 |           | example-crb-2   | ClusterRoleBinding references a non-existing ClusterRole      |
+---+----------------+----------------------------------------------+-----------------------------+

Feature checklist

doronkg commented 1 month ago

@nati-elmaliach would you also like to claim this issue following #362? The logic would be pretty similar.

nati-elmaliach commented 1 month ago

@nati-elmaliach would you also like to claim this issue following #362? The logic would be pretty similar.

Sure thing. @yonahd please assign it to me.

nati-elmaliach commented 1 month ago

@doronkg @yonahd

Just a quick clarification:

yonahd commented 1 month ago

Great questions You can see how it is handled in the persistent volume resource. Let me know if this covers your questions