Within Rancher, roles determine what actions a user can make within a cluster or project.

Note that roles are different from permissions, which determine what clusters and projects you can access.

This section covers the following topics:

Prerequisites

To complete the tasks on this page, one of the following permissions are required:

Creating A Custom Role for a Cluster or Project

While Rancher comes out-of-the-box with a set of default user roles, you can also create default custom roles to provide users with very specific permissions within Rancher.

The steps to add custom roles differ depending on the version of Rancher.

  1. From the Global view, select Security > Roles from the main menu.

  2. Select a tab to determine the scope of the roles you’re adding. The tabs are:

    • Cluster: The role is valid for assignment when adding/managing members to only clusters.
    • Project: The role is valid for assignment when adding/managing members to only projects.
  3. Click Add Cluster/Project Role.

  4. Name the role.

  5. Optional: Choose the Cluster/Project Creator Default option to assign this role to a user when they create a new cluster or project. Using this feature, you can expand or restrict the default roles for cluster/project creators.

    Out of the box, the Cluster Creator Default and the Project Creator Default roles are Cluster Owner and Project Owner respectively.

  6. Use the Grant Resources options to assign individual Kubernetes API endpoints to the role.

    When viewing the resources associated with default roles created by Rancher, if there are multiple Kubernetes API resources on one line item, the resource will have (Custom) appended to it. These are not custom resources but just an indication that there are multiple Kubernetes API resources as one resource.

    The Resource text field provides a method to search for pre-defined Kubernetes API resources, or enter a custom resource name for the grant. The pre-defined or (Custom) resource must be selected from the dropdown, after entering a resource name into this field.

    You can also choose the individual cURL methods (Create, Delete, Get, etc.) available for use with each endpoint you assign.

  7. Use the Inherit from a Role options to assign individual Rancher roles to your custom roles. Note: When a custom role inherits from a parent role, the parent role cannot be deleted until the child role is deleted.

  8. Click Create.

  1. From the Global view, select Security > Roles from the main menu.

  2. Click Add Role.

  3. Name the role.

  4. Choose whether to set the role to a status of locked.

    Note: Locked roles cannot be assigned to users.

  5. In the Context dropdown menu, choose the scope of the role assigned to the user. The contexts are:

    • All: The user can use their assigned role regardless of context. This role is valid for assignment when adding/managing members to clusters or projects.

    • Cluster: This role is valid for assignment when adding/managing members to only clusters.

    • Project: This role is valid for assignment when adding/managing members to only projects.

  6. Use the Grant Resources options to assign individual Kubernetes API endpoints to the role.

    When viewing the resources associated with default roles created by Rancher, if there are multiple Kubernetes API resources on one line item, the resource will have (Custom) appended to it. These are not custom resources but just an indication that there are multiple Kubernetes API resources as one resource.

    The Resource text field provides a method to search for pre-defined Kubernetes API resources, or enter a custom resource name for the grant. The pre-defined or (Custom) resource must be selected from the dropdown, after entering a resource name into this field.

    You can also choose the individual cURL methods (Create, Delete, Get, etc.) available for use with each endpoint you assign.

  7. Use the Inherit from a Role options to assign individual Rancher roles to your custom roles. Note: When a custom role inherits from a parent role, the parent role cannot be deleted until the child role is deleted.

  8. Click Create.

Creating a Custom Global Role

Available as of v2.4.0

Creating a Custom Global Role that Copies Rules from an Existing Role

If you have a group of individuals that need the same level of access in Rancher, it can save time to create a custom global role in which all of the rules from another role, such as the administrator role, are copied into a new role. This allows you to only configure the variations between the existing role and the new role.

The custom global role can then be assigned to a user or group so that the custom global role takes effect the first time the user or users sign into Rancher.

To create a custom global role based on an existing role,

  1. Go to the Global view and click Security > Roles.
  2. On the Global tab, go to the role that the custom global role will be based on. Click ⋮ (…) > Clone.
  3. Enter a name for the role.
  4. Optional: To assign the custom role default for new users, go to the New User Default section and click Yes: Default role for new users.
  5. In the Grant Resources section, select the Kubernetes resource operations that will be enabled for users with the custom role.

    The Resource text field provides a method to search for pre-defined Kubernetes API resources, or enter a custom resource name for the grant. The pre-defined or (Custom) resource must be selected from the dropdown, after entering a resource name into this field.

  6. Click Save.

Creating a Custom Global Role that Does Not Copy Rules from Another Role

Custom global roles don’t have to be based on existing roles. To create a custom global role by choosing the specific Kubernetes resource operations that should be allowed for the role, follow these steps:

  1. Go to the Global view and click Security > Roles.
  2. On the Global tab, click Add Global Role.
  3. Enter a name for the role.
  4. Optional: To assign the custom role default for new users, go to the New User Default section and click Yes: Default role for new users.
  5. In the Grant Resources section, select the Kubernetes resource operations that will be enabled for users with the custom role.

    The Resource text field provides a method to search for pre-defined Kubernetes API resources, or enter a custom resource name for the grant. The pre-defined or (Custom) resource must be selected from the dropdown, after entering a resource name into this field.

  6. Click Save.

Deleting a Custom Global Role

Available as of v2.4.0

When deleting a custom global role, all global role bindings with this custom role are deleted.

If a user is only assigned one custom global role, and the role is deleted, the user would lose access to Rancher. For the user to regain access, an administrator would need to edit the user and apply new global permissions.

Custom global roles can be deleted, but built-in roles cannot be deleted.

To delete a custom global role,

  1. Go to the Global view and click Security > Roles.
  2. On the Global tab, go to the custom global role that should be deleted and click ⋮ (…) > Delete.
  3. Click Delete.

Assigning a Custom Global Role to a Group

Available as of v2.4.0

If you have a group of individuals that need the same level of access in Rancher, it can save time to create a custom global role. When the role is assigned to a group, the users in the group have the appropriate level of access the first time they sign into Rancher.

When a user in the group logs in, they get the built-in Standard User global role by default. They will also get the permissions assigned to their groups.

If a user is removed from the external authentication provider group, they would lose their permissions from the custom global role that was assigned to the group. They would continue to have their individual Standard User role.

Prerequisites: You can only assign a global role to a group if:

To assign a custom global role to a group, follow these steps:

  1. From the Global view, go to Security > Groups.
  2. Click Assign Global Role.
  3. In the Select Group To Add field, choose the existing group that will be assigned the custom global role.
  4. In the Custom section, choose any custom global role that will be assigned to the group.
  5. Optional: In the Global Permissions or Built-in sections, select any additional permissions that the group should have.
  6. Click Create.

Result: The custom global role will take effect when the users in the group log into Rancher.