Skip to content
This repository has been archived by the owner on Feb 27, 2023. It is now read-only.

Add team docs with sample RBAC permissions #88

Merged
merged 2 commits into from May 7, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/README.md
Expand Up @@ -17,6 +17,7 @@ These guides describe how the components of Gimbal function and how they interac
- [List Discovered Services](list-discovered-services.md)
- [Update Kubernetes Discoverer Credentials](kubernetes-discoverer.md#updating-credentials)
- [Update OpenStack Discoverer Credentials](openstack-discoverer.md#updating-credentials)
- [Teams with Gimbal](teams.md)

## User Topics

Expand Down
30 changes: 30 additions & 0 deletions docs/teams.md
@@ -0,0 +1,30 @@
# Teams with Gimbal

A key feature of Gimbal is team management. The idea is enable teams to configure and define their own Ingress resources within the Gimbal cluster without requiring an administrator to assist. To enable this, users will be isolated to one or more namespaces in the Gimbal cluster and should have capabilities to create Ingress routes and also view Services and Endpoints within their respective team namespace.

## RBAC Rules

A key component of any secure Kubernetes cluster are permissions implemented via Role-Based Access Control (RBAC). Following is a sample RBAC `ClusterRole` which can be assigned to users within a team namespace:

```yaml
apiVersion: rbac.authorization.k8s.io/v1beta1
kind: ClusterRole
metadata:
name: team-ingress
rules:
- apiGroups:
- ""
resources:
- services
- endpoints
verbs:
- get
- list
- watch
- apiGroups:
- extensions
resources:
- ingresses
verbs:
- "*"
```