rbac-sync

README

rbac-sync

[

What it does

rbac-sync's task is to synchronize the members of a Google IAM group into a Kubernetes rolebinding. What group to synchronize, and which role to map is specified as a Namespace annotation.

How it works

On the specified interval, it will:

1. Fetch information about all the namespaces in the cluster
2. Filter those namespaces who has enabled rbac-sync through the rbac-sync.nais.io/group-name annotation (see example below)
3. For each of these namespaces, it will fetch the members in the group (configured with rbac-sync.nais.io/group-name) from Google Admin and generate a RoleBinding containing these users and map these to the configured role (rbac-sync.nais.io/roles or default value provided as flag)
4. Remove orphan role bindings
5. Create new role bindings
6. Update existing role bindings
7. zZz

Example Namespace configuration

apiVersion: v1
kind: Namespace
metadata:
  name: myteam
  annotations:
    "rbac-sync.nais.io/group-name": myteam@domain.no # email/name of the google group, that will be synced into rolebinding
    "rbac-sync.nais.io/roles": team-member # optional, name of role to be mapped into rolebinding
    "rbac-sync.nais.io/rolebinding-prefix": myteam-members # optional, name of the rolebinding that rbac-sync creates
  ...

Requirements

• The service account's private key file in json format: -serviceaccount-keyfile flag
• The email of the a organisational user with access to the Google Admin Directory APIs -gcp-admin-user flag
• The service account must have set domain wide delegation in admin.google.com: https://developers.google.com/admin-sdk/directory/v1/guides/delegation. Manage API access must be configured with the client id, not the service account email address.
  • Add manage API client access with correct id and the following API Scopes: View group subscriptions on your domain https://www.googleapis.com/auth/admin.directory.group.member.readonly View groups on your domain https://www.googleapis.com/auth/admin.directory.group.readonly
• The namespaces to synchronize must have an annotation with the group name and optionally roles and role binding prefix to generate the role bindings. See https://github.com/nais/rbac-sync/examples.
• The role either specified with annotation rbac-sync.nais.io/roles or given as a flag to the rbac-sync binary is assumed to exist.

Flags

$ rbac-sync --help 
Usage of rbac-sync
  -bind-address string
        Bind address for application. (default ":8080")
  -debug
        enables debug logging
  -default-rolebinding-prefix string
        Default rolebinding-prefix if not specified in namespace annotation, rolebinding name format will be <prefix>-<role> (default "rbacsync-default")
  -default-roles string
        Default role(s) if not specified in namespace annotation. Comma-separated (default "rbacsync-default")
  -gcp-admin-user string
        The google admin user e-mail address.
  -kubeconfig string
        path to Kubernetes config file
  -mock-iam
        starts rbac-sync with a mocked version of the IAM client
  -serviceaccount-keyfile string
        The path to the service account private key file.
  -update-interval duration
        Update interval in seconds. (default 5m0s)

Development

make local # requires a running k8s as current kubeconfig context

This will spin up a rbac-sync in debug mode with a mock IAM client