├── .gitignore ├── LICENSE ├── README.md └── rbac ├── Makefile ├── bar ├── dev │ └── k8s.cue ├── k8s.cue ├── prod │ └── k8s.cue ├── qa │ └── k8s.cue └── stage │ └── k8s.cue ├── cluster └── k8s.cue ├── cue.mod └── module.cue ├── dump_tool.cue ├── foo ├── dev │ └── k8s.cue ├── k8s.cue ├── prod │ └── k8s.cue ├── qa │ └── k8s.cue └── stage │ └── k8s.cue ├── k8s.cue ├── k8s_def.cue └── kube_tool.cue /.gitignore: -------------------------------------------------------------------------------- 1 | **/snapshot* 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Kubernetes RBAC Model 2 | 3 | This is a implementation of a RBAC model for a multi project multi tenant Kubernetes cluster. 4 | 5 | ## Current roles 6 | 7 | - `cluster-admin`: Cluster role binding of the cluster role `cluster-admin`. 8 | - `admin`: Role binding of the cluster role `admin`. 9 | - `dev`: Role binding of the cluster role `edit`. 10 | - `viewer`: Role binding of the cluster role `view`. 11 | - `bot`: Role binding of a custom role. 12 | 13 | More info: [user facing roles](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles) 14 | 15 | ## Criteria 16 | 17 | ### Roles scope 18 | 19 | - A `cluster-admin` role for all clusters. 20 | - Full privileges on the cluster. 21 | - A `admin` role per namespace that needs full namespace management privileges. 22 | - Full privileges on a namespace. 23 | - A `dev` role per namespace that needs edit privileges. 24 | - Edit and view access to most namespace objects including secrets, but no 25 | access to rolebindings and roles objects. 26 | - A `viewer` role per namespace that needs view privileges. 27 | - View access to most namespace objects besides roles, rolebindings and secrets objects. 28 | - A `bot` role per certain namespaces that needs edit privileges. 29 | - Limited to certain objects for automation purposes. 30 | - There can be more than one bot role. 31 | - Naming convention: `bot-[action]` 32 | - Implemented as service accounts or regular users. 33 | 34 | ### Projects scope 35 | 36 | - A cluster can have one or more projects. 37 | - A project can have one or more environments. 38 | - Each project environment is implemented as a namespace object. 39 | - A project can have one or more users. 40 | - A project can have different users including service accounts with different 41 | privileges for different environments. 42 | 43 | ### Environments 44 | - `dev`: A developers playground. Unrestricted access for developers. 45 | - `qa`: Integration environment with sanitize data. It usually requires a pipeline 46 | process to get things running in. `edit` privileges are usually limited. 47 | - `stage`: Pre production environment with replicated production data. It usually 48 | requires a pipeline process to get things running in. Restricted to many users. 49 | - `prod`: Production environment with customer data. Only `admins` or operators have 50 | access to this environment. 51 | 52 | ## Implementation 53 | 54 | | | Dev | QA | Stage | Prod | 55 | |-|-|-|-|-| 56 | | cluster-admin | x | x | x | x | 57 | | admin | x | x | x | x | 58 | | dev | x | | | | 59 | | viewer | | x | | | 60 | | bot | | x | x | x | 61 | 62 | 63 | ## Cuelang 64 | 65 | 66 | TODO: THIS COULD BE WAAAAAAAAY BETTER. 67 | 68 | Cue is a data validation languake with awesome support for kubernetes objects. 69 | This project gives a glance of its capabilities. 70 | 71 | rbac/ 72 | ├── bar 73 | │   ├── dev 74 | │   │   └── k8s.cue 75 | │   ├── k8s.cue 76 | │   ├── prod 77 | │   │   └── k8s.cue 78 | │   ├── qa 79 | │   │   └── k8s.cue 80 | │   └── stage 81 | │   └── k8s.cue 82 | ├── dump_tool.cue 83 | ├── foo 84 | │   ├── dev 85 | │   │   └── k8s.cue 86 | │   ├── k8s.cue 87 | │   ├── prod 88 | │   │   └── k8s.cue 89 | │   ├── qa 90 | │   │   └── k8s.cue 91 | │   └── stage 92 | │   └── k8s.cue 93 | ├── k8s.cue 94 | ├── k8s_def.cue 95 | └── kube_tool.cue 96 | 97 | To generate Kubernetes objects: 98 | 99 | project= 100 | namespace= 101 | # For cluster role bindings 102 | cue cmd dumpy ./rbac/${project} > crb-${project}.yaml 103 | 104 | # For role bindings in a specific namespace 105 | cue cmd dumpy ./rbac/${project}/${namespace} > rb-${project}-{namespace}.yaml 106 | 107 | ## Usage 108 | 109 | To use this project, the Kubernetes cluster *NEEDS* to have the authentication modules 110 | configured. 111 | 112 | ### Preparing files 113 | 114 | > Current implementation only supports Groups in `.subjects.name`. 115 | 116 | # switch in .subjects.name for each k8s.cue file with your 117 | # group name. 118 | 119 | ### Executing rules 120 | 121 | export OUTPUT_FILE=rbac-objects.yaml 122 | # Creating project environments 123 | PROJECT=bar make bootstrap-ns 124 | 125 | # Generating rbac objects 126 | PROJECT=bar bootstrap-rb > ${OUTPUT_FILE} 127 | 128 | # rbac-objects needs some clean up 129 | sed -i 's/^$/---/g' ${OUTPUT_FILE} 130 | 131 | # Deploy objects 132 | kubectl apply -f ${OUTPUT_FILE} 133 | 134 | # Running access control tests 135 | PROJECT=bar make test 136 | 137 | ## Slides 138 | 139 | - [DevOps Perú - Spanish](https://docs.google.com/presentation/d/1MpTRHOVlwNV9Q3_yk3pTaCTSnGPq7yms5MXPuuTBCpM/edit?usp=sharing) 140 | 141 | -------------------------------------------------------------------------------- /rbac/Makefile: -------------------------------------------------------------------------------- 1 | PROJECT?= 2 | PROJECTDIR=./${PROJECT} 3 | NS_PREFIX=prod stage qa dev 4 | 5 | bootstrap-ns: 6 | @kubectl create namespace ${PROJECT}-dev 7 | @kubectl create namespace ${PROJECT}-qa 8 | @kubectl create namespace ${PROJECT}-stage 9 | @kubectl create namespace ${PROJECT}-prod 10 | 11 | clean-ns: 12 | @kubectl delete namespace ${PROJECT}-dev 13 | @kubectl delete namespace ${PROJECT}-qa 14 | @kubectl delete namespace ${PROJECT}-stage 15 | @kubectl delete namespace ${PROJECT}-prod 16 | 17 | bootstrap-rb: 18 | @find ${PROJECTDIR} -type d -exec cue cmd dumpy {} \; 19 | 20 | create-rb: 21 | @$(MAKE) bootstrap-rb | kubectl apply -f - 22 | 23 | test: 24 | @$(foreach i, $(NS_PREFIX), echo "get pod in ns $(PROJECT)-$(i): " && kubectl auth can-i get pod -n $(PROJECT)-$(i);) 25 | @$(foreach i, $(NS_PREFIX), echo "create pod in ns $(PROJECT)-$(i): " && kubectl auth can-i create pod -n $(PROJECT)-$(i);) 26 | @$(foreach i, $(NS_PREFIX), echo "get secret in ns $(PROJECT)-$(i): " && kubectl auth can-i get secret -n $(PROJECT)-$(i);) 27 | @$(foreach i, $(NS_PREFIX), echo "get rolebinding in ns $(PROJECT)-$(i): " && kubectl auth can-i get rolebinding -n $(PROJECT)-$(i);) 28 | @$(foreach i, $(NS_PREFIX), echo "get roles in ns $(PROJECT)-$(i): " && kubectl auth can-i get roles -n $(PROJECT)-$(i);) 29 | 30 | .PHONY: .bootstrap-ns .bootstrap-rb 31 | -------------------------------------------------------------------------------- /rbac/bar/dev/k8s.cue: -------------------------------------------------------------------------------- 1 | package kube 2 | 3 | roleBinding: dev: { 4 | metadata: name: "dev" 5 | subjects: [{ 6 | name: "" 7 | }] 8 | roleRef: name: "edit" 9 | } 10 | roleBinding: admin: { 11 | metadata: name: "admin" 12 | subjects: [{ 13 | name: "" 14 | }] 15 | roleRef: name: "admin" 16 | } 17 | 18 | #Namespace: "dev" 19 | -------------------------------------------------------------------------------- /rbac/bar/k8s.cue: -------------------------------------------------------------------------------- 1 | package kube 2 | 3 | #Project: "bar" 4 | -------------------------------------------------------------------------------- /rbac/bar/prod/k8s.cue: -------------------------------------------------------------------------------- 1 | package kube 2 | 3 | roleBinding: admin: { 4 | metadata: name: "admin" 5 | subjects: [{ 6 | name: "" 7 | }] 8 | roleRef: name: "admin" 9 | } 10 | 11 | 12 | #Namespace: "prod" 13 | -------------------------------------------------------------------------------- /rbac/bar/qa/k8s.cue: -------------------------------------------------------------------------------- 1 | package kube 2 | 3 | roleBinding: admin: { 4 | metadata: name: "admin" 5 | subjects: [{ 6 | name: "" 7 | }] 8 | roleRef: name: "admin" 9 | } 10 | roleBinding: reader: { 11 | metadata: name: "reader" 12 | subjects: [{ 13 | name: "" 14 | }] 15 | roleRef: name: "view" 16 | } 17 | 18 | #Namespace: "qa" 19 | -------------------------------------------------------------------------------- /rbac/bar/stage/k8s.cue: -------------------------------------------------------------------------------- 1 | package kube 2 | 3 | roleBinding: admin: { 4 | metadata: name: "admin" 5 | subjects: [{ 6 | name: "" 7 | }] 8 | roleRef: name: "admin" 9 | } 10 | 11 | 12 | #Namespace: "stage" 13 | -------------------------------------------------------------------------------- /rbac/cluster/k8s.cue: -------------------------------------------------------------------------------- 1 | package kube 2 | 3 | clusterRoleBinding: clusteradmin: { 4 | metadata: name: "clusteradmin" 5 | subjects: [{ 6 | name: "" 7 | }] 8 | roleRef: name: "cluster-admin" 9 | } 10 | -------------------------------------------------------------------------------- /rbac/cue.mod/module.cue: -------------------------------------------------------------------------------- 1 | module: "" 2 | -------------------------------------------------------------------------------- /rbac/dump_tool.cue: -------------------------------------------------------------------------------- 1 | package kube 2 | 3 | import ( 4 | "encoding/yaml" 5 | "encoding/json" 6 | "tool/cli" 7 | ) 8 | 9 | command: dumpy: { 10 | task: print: cli.Print & { 11 | text: yaml.MarshalStream(objects) 12 | } 13 | } 14 | 15 | command: dumpj: { 16 | task: print: cli.Print & { 17 | text: json.MarshalStream(objects) 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /rbac/foo/dev/k8s.cue: -------------------------------------------------------------------------------- 1 | package kube 2 | 3 | roleBinding: dev: { 4 | metadata: name: "dev" 5 | subjects: [{ 6 | name: "" 7 | }] 8 | roleRef: name: "edit" 9 | } 10 | roleBinding: admin: { 11 | metadata: name: "admin" 12 | subjects: [{ 13 | name: "" 14 | }] 15 | roleRef: name: "admin" 16 | } 17 | -------------------------------------------------------------------------------- /rbac/foo/k8s.cue: -------------------------------------------------------------------------------- 1 | package kube 2 | 3 | #Project: "foo" 4 | -------------------------------------------------------------------------------- /rbac/foo/prod/k8s.cue: -------------------------------------------------------------------------------- 1 | package kube 2 | 3 | roleBinding: admin: { 4 | metadata: name: "admin" 5 | subjects: [{ 6 | name: "" 7 | }] 8 | roleRef: name: "admin" 9 | } 10 | -------------------------------------------------------------------------------- /rbac/foo/qa/k8s.cue: -------------------------------------------------------------------------------- 1 | package kube 2 | 3 | roleBinding: admin: { 4 | metadata: name: "admin" 5 | subjects: [{ 6 | name: "" 7 | }] 8 | roleRef: name: "admin" 9 | } 10 | roleBinding: reader: { 11 | metadata: name: "reader" 12 | subjects: [{ 13 | name: "" 14 | }] 15 | roleRef: name: "view" 16 | } 17 | -------------------------------------------------------------------------------- /rbac/foo/stage/k8s.cue: -------------------------------------------------------------------------------- 1 | package kube 2 | 3 | roleBinding: admin: { 4 | metadata: name: "admin" 5 | subjects: [{ 6 | name: "" 7 | }] 8 | roleRef: name: "admin" 9 | } 10 | -------------------------------------------------------------------------------- /rbac/k8s.cue: -------------------------------------------------------------------------------- 1 | package kube 2 | 3 | roleBinding: [ID=_]: { 4 | apiVersion: "rbac.authorization.k8s.io/v1" 5 | kind: "RoleBinding" 6 | metadata: { 7 | name: string 8 | namespace: "\( #Project )-\( #Namespace)" 9 | } 10 | subjects: [{ 11 | kind: "Group" 12 | name: string 13 | apiGroup: "rbac.authorization.k8s.io" 14 | }] 15 | roleRef: { 16 | kind: "ClusterRole" 17 | name: string 18 | apiGroup: "rbac.authorization.k8s.io" 19 | } 20 | } 21 | 22 | clusterRoleBinding: [ID=_]: { 23 | apiVersion: "rbac.authorization.k8s.io/v1" 24 | kind: "ClusterRoleBinding" 25 | metadata: name: string 26 | subjects: [{ 27 | kind: "Group" 28 | name: string 29 | apiGroup: "rbac.authorization.k8s.io" 30 | }] 31 | roleRef: { 32 | kind: "ClusterRole" 33 | name: string 34 | apiGroup: "rbac.authorization.k8s.io" 35 | } 36 | 37 | } 38 | 39 | #Project: string 40 | #Namespace: string 41 | -------------------------------------------------------------------------------- /rbac/k8s_def.cue: -------------------------------------------------------------------------------- 1 | package kube 2 | 3 | import ( 4 | "k8s.io/api/rbac/v1" 5 | ) 6 | 7 | rolebinding: [string]: v1.#RoleBinding 8 | clusterolebinding: [string]: v1.#ClusterRoleBinding 9 | -------------------------------------------------------------------------------- /rbac/kube_tool.cue: -------------------------------------------------------------------------------- 1 | package kube 2 | 3 | objects: [ for v in objectSets for x in v {x}] 4 | 5 | objectSets: [ 6 | roleBinding, 7 | clusterRoleBinding, 8 | ] 9 | --------------------------------------------------------------------------------