RBAC Authentication

Using Role-Based Access Control (RBAC) to control Trilio UI access

Before proceeding, make sure to read the Kubernetes published documentation entitled Using RBAC Authorization.

Background

Trilio uses RBAC provided by Kubernetes to control access to Trilio resources. Trilio pre-installs some standard roles, but a cluster administrator must create bindings to give the access defined in that standard role to a user, group, or service_account.

Additionally, custom roles may be defined to fulfill more granular access control. For example, you might wish to provide write permission for only Target and Backup resources in a specific namespace, but not for other namespaces. This page explains how you might approach situations like this.

Trilio aims to keep the UI completely stateless, where each Kubernetes user is able to configure their bespoke UI experience based on the specific clusters that they have access to (only clusters installed with Trilio). Since Trilio supports both namespace installation and cluster scope installation, understanding the resulting user experience becomes important. Refer to the following side-by-side scenarios and their results to understand this more.

Scenario 1

Scenario 2

Installation

Cluster scope level

Namespace level scope within Namespace 1

User 'A' access

Namespace 1, 2 and 3

User 'B' access

Namespace 2 and 3

RBAC set on the Trilio CRDs

Scenario result

User A and User B will only see the namespaces that they have access to when they access the UI. Both users will be able to perform Trilio actions without any restrictions.

User A will only see namespace 1 when logged into the UI. Namespace 1 will show as a single namespace cluster within the UI. User B will not see any clusters (or namespaces) in the UI when they log in.

Default Cluster Roles

Every user must have secret create permission in the Trilio installation namespace in order to login to the Trilio UI (web portal)

Example Role with the verb create for the resource secrets

kind: Role
apiVersion: rbac.authorization.k8s.io/v1
metadata:
 name: k8s-triliovault-secrets
 namespace: trilio-system
rules:
 - verbs:
   - create
  apiGroups:
   - ''
  resources:
   - secrets

Example RoleBinding for each user who needs access to the Trilio UI

kind: RoleBinding
apiVersion: rbac.authorization.k8s.io/v1
metadata:
 name: k8s-triliovault-secrets-testuser
 namespace: trilio-system
subjects:
 - kind: User
  apiGroup: rbac.authorization.k8s.io
  name: testuser
roleRef:
 apiGroup: rbac.authorization.k8s.io
 kind: Role
 name: k8s-triliovault-secrets

triliovault-admin

This role provides full access to all Trilio resources across all namespaces. Below is the definition of the triliovault-admin cluster role:

apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: triliovault-admin
rules:
- apiGroups:
  - triliovault.trilio.io/v1
  resources:
  - '*'
  verbs:
  - '*'
- apiGroups:
  - ""
  resources:
  - secrets
  verbs:
  - create

To make users a tvk-admin in group or service_account, clusterrolebinding must be created using the command:

kubectl create clusterrolebinding <binding-name> --clusterrole=triliovault-admin --user=<user-name>
kubectl create clusterrolebinding <binding-name> --clusterrole=triliovault-admin --group=<user-name>
kubectl create clusterrolebinding <binding-name> --clusterrole=triliovault-admin --serviceaccount=<serviceaccount_namespace>:<serviceaccount_name>

Created Cluster Role Bindings

The above command creates a cluster role binding as below:

apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
  name: <binding-name>
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: ClusterRole
  name: triliovault-admin
subjects:
- apiGroup: rbac.authorization.k8s.io
  kind: User
  name: <user-name>

apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
  name: <binding-name>
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: ClusterRole
  name: triliovault-admin
subjects:
- apiGroup: rbac.authorization.k8s.io
  kind: Group
  name: <group-name>

apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
  name: <binding-name>
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: ClusterRole
  name: triliovault-admin
subjects:
  - kind: ServiceAccount
    name: <serviceaccount_name>
    namespace: <serviceaccount_namespace>

apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
  name: <binding-name>
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: ClusterRole
  name: triliovault-admin
subjects:
- apiGroup: rbac.authorization.k8s.io
  kind: User
  name: <user-name>
- apiGroup: rbac.authorization.k8s.io
  kind: Group
  name: <group-name>
- kind: ServiceAccount
  name: <serviceaccount_name>
  namespace: <serviceaccount_namespace>

triliovault-reader

This role provides read-only access to all Trilio resources across all namespaces. Below is the definition of the triliovault-reader cluster role:

apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: triliovault-reader
rules:
- apiGroups:
  - triliovault.trilio.io/v1
  resources:
  - '*'
  verbs:
  - get
  - watch
  - list
- apiGroups:
  - ""
  resources:
  - secrets
  verbs:
  - create

To make users or service account a triliovault-reader, clusterrolebinding must be created using the command:

kubectl create clusterrolebinding <binding-name> --clusterrole=triliovault-reader --user=<user-name>
kubectl create clusterrolebinding <binding-name> --clusterrole=triliovault-reader --serviceaccount=<serviceaccount_namespace>:<serviceaccount_name>

This will create clusterrolebindings similar to Created Cluster Role Bindings.

triliovault-admin for specific namespace

This role provides full access to all Trilio resources for specific namespaces only. It uses the definition of the triliovault-admin cluster role:

apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: triliovault-admin
rules:
- apiGroups:
  - triliovault.trilio.io/v1
  resources:
  - '*'
  verbs:
  - '*'
- apiGroups:
  - ""
  resources:
  - secrets
  verbs:
  - create

However, whilst it uses the above cluster role triliovault-admin, instead of creating clusterRoleBinding, you must create rolebinding in required namespaces. To make users or a service account a triliovault-admin for namespace-a and namespace-b, rolebinding must be created for both the namespaces, as follows:

kubectl create rolebinding <binding-name> --clusterrole=triliovault-admin --user=<user-name> -n namespace-a
kubectl create rolebinding <binding-name> --clusterrole=triliovault-admin --user=<user-name> -n namespace-b
# similarly for service account
kubectl create rolebinding <binding-name> --clusterrole=triliovault-admin --serviceaccount=<serviceaccount_namespace>:<serviceaccount_name> -n namespace-a
kubectl create rolebinding <binding-name> --clusterrole=triliovault-admin --serviceaccount=<serviceaccount_namespace>:<serviceaccount_name> -n namespace-b

triliovault-reader for specific namespace

This role provides read-only access to all Trilio resources for specific namespaces only. It uses the definition of the triliovault-reader cluster role:

apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: triliovault-reader
rules:
- apiGroups:
  - triliovault.trilio.io/v1
  resources:
  - '*'
  verbs:
  - get
  - watch
  - list
- apiGroups:
  - ""
  resources:
  - secrets
  verbs:
  - create

However, whilst it uses the above cluster role triliovault-reader, instead of creating clusterRoleBinding, you must create rolebinding in required namespaces. To make users or a service account a triliovault-reader for namespace-a and namespace-b, rolebinding must be created for both the namespaces, as follows:

kubectl create rolebinding <binding-name> --clusterrole=triliovault-reader --user=<user-name> -n namespace-a
kubectl create rolebinding <binding-name> --clusterrole=triliovault-reader --user=<user-name> -n namespace-b
# similarly for service account
kubectl create rolebinding <binding-name> --clusterrole=triliovault-reader --serviceaccount=<serviceaccount_namespace>:<serviceaccount_name> -n namespace-a
kubectl create rolebinding <binding-name> --clusterrole=triliovault-reader --serviceaccount=<serviceaccount_namespace>:<serviceaccount_name> -n namespace-b

For specific namespaces, access role can be used instead of cluster role, but the role must be created in each namespace where the rolebinding is to be created.

This role provides only login access to all Trilio resources. The user may explore the Trilio UI, but cannot take any actions. It uses the definition of the triliovault-login-only role:

apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
  name: triliovault-login-only
rules:
- apiGroups:
  - ""
  resources:
  - secrets
  verbs:
  - create

To provide login access only for users or service account, rolebinding (in the Trilio installation namespace) must be created using the command:

kubectl create rolebinding <binding-name> --role=triliovault-login-only --user=<user-name>
kubectl create rolebinding <binding-name> --role=triliovault-login-only --serviceaccount=<serviceaccount_namespace>:<serviceaccount_name>

This will create clusterrolebindings similar to Created Cluster Role Bindings.

Custom role

To provide custom permissions, you must create clusterRoles/roles and create clusterRoleBindings/roleBindings for this respectively.

Example: Let's say that a cluster admin wishes to create a customRole in which targets and policies across the entire cluster may be read. Perhaps the cluster admin wishes that the user can create backups/restores/hooks in namespace 'namespace-a' only. This scenario means that two clusterRoles must be created; one for granting targets/policies 'read' access across the entire cluster and another for granting backups/restores/hooks 'create' access. Also needed, is one clusterRoleBinding for 'read' access and another roleBinding for the 'create' permission for a single namespace

For the above example, the cluster role for the target/policy 'read' access across all namespaces can be configured using the following:

apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: triliovault-target-policy-reader
rules:
- apiGroups:
  - triliovault.trilio.io/v1
  resources:
  - targets
  - policies
  verbs:
  - get
  - list
  - watch
- apiGroups:
  - ""
  resources:
  - secrets
  verbs:
  - create

For the same example, now create cluster role binding for the user or service account, using the following commands:

kubectl create clusterrolebinding <binding-name> --clusterrole=triliovault-target-policy-reader --user=<user-name>
# or for service account
kubectl create clusterrolebinding <binding-name> --clusterrole=triliovault-target-policy-reader --serviceaccount=<serviceaccount_namespace>:<serviceaccount_name>

Now, configure the cluster role for 'write' access to backups/restores/hooks.

apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: backups-restore-hooks-creator
rules:
- apiGroups:
  - triliovault.trilio.io/v1
  resources:
  - backups
  - restores
  - hooks
  verbs:
  - create

Finally, create role binding for the user or service account to give clusterscope 'create' access

kubectl create rolebinding <binding-name> --clusterrole=backups-restore-hooks-creator --user=<user-name> -n namespace-a
# or for service account
kubectl create rolebinding <binding-name> --clusterrole=backups-restore-hooks-creator --serviceaccount=<serviceaccount_namespace>:<serviceaccount_name> -n namespace-a

You may also add rules for Trilio resources in your existing cluster role or role directly, to avoid creating clusterrolebinding/rolebindings.

Application view permission

To view applications such as Helm charts, Labels, or Objects in particular namespaces; the logged-in user/service-account/group that a user belongs to must have a permission to list backupplans in that particular namespace.

Cluster wide permissions

To view Cluster scope resources like ClusterBackupPlan, ClusterBackup, ClusterRestore, ContinuousRestorePlan, and ConsistentSet only cluster-wide permissions are needed, namespace level permissions won't work

PreviousKubeConfig Authenticaton NextAuthentication Methods Via Dex

Last updated 1 year ago