Skip to main content
Version: 10.x (Current)

Console levels and permission management

Assigning different roles and permissions to each user is a key action for defining responsibilities within your platform ecosystem. The Console is based on hierarchical levels, and for each of them, specific permissions and capabilities have been identified and assigned to users. Let's see how they are configured.

Console Levels

The Console resources are organized in a hierarchical structure on three levels:

  1. Console level is the highest level and allows the general configuration of your Console, at this level you can configure the companies, the different templates for project creation and you have control of your projects and the marketplace;

  2. Company level is the second hierarchical level. The companycan group several projects within it, with the company a lot of information can be inherited from the underlying projects without having to configure them;

  3. Project Level is the third level of the Console. The projects are the heart of the Console, it is in fact at this level that developers find themselves developing to create their own platform.

alt text

Users Capabilities inside Console

Users can perform a set of predetermined actions along Console levels in accordance with a set of permissions grouped within a specific role; a set of default roles have been defined:

  • Company Owner: A Company Owner has the ability to manage Company users and has full administrative capabilities on all the Projects (and Runtime Environments) within the Company
  • Project Administrator: A Project Administrator is able to manage users and the whole Project it is assigned to, thus being able to perform any actions on all the Runtime Environments of the Project, too
  • Maintainer: A Maintainer can edit Project configuration and Runtime Environments
  • Developer: A Developer can edit the Project configuration and can view Runtime Environments
  • Reporter: A Reporter can view Project configuration and Runtime Environments
  • Guest: A Guest has restricted access on data and can only view basic information of resources it is assigned to

The following table describes the capabilities and how they are mapped on the default Roles.

CapabilitiesPermissions keyGuestReporterDeveloperMaintainerProject AdministratorCompany Owner
View Company basic informationconsole.company.view
Edit company informationconsole.company.details.update
Create a Projects inside a Companyconsole.company.project.create
View all Projects in this Companyconsole.company.project.view
View Project basic informationconsole.project.view
View all the Environments in all the Projects of this Companyconsole.company.project.environment.view
View all Environments of this Projectconsole.project.environment.view
View this Environment of the Projectconsole.environment.view
Create a service repository for all the Projects of this companyconsole.company.project.service.repository.create
Create a service repository for this Projectconsole.project.service.repository.create
Commit changes on all the Project configurations of this Companyconsole.company.project.configuration.update
Commit changes on Project configurationconsole.project.configuration.update
Edit project informationconsole.project.details.update
Manage secreted environment variables for all the Projects of this Companyconsole.company.project.secreted_variables.manage
Manage secreted environment variablesconsole.project.secreted_variables.manage
Trigger deploy on all the Environments of all the Projects of this Company console.company.project.environment.deploy.trigger
Trigger deploy on any Environment of this Projectconsole.project.environment.deploy.trigger
Trigger deploy on this specific Environmentconsole.environment.deploy.trigger
Restart pods on all the Environments of all the Projects of this Companyconsole.company.project.environment.k8s.pod.delete
Restart pods on any project Environmentconsole.project.environment.k8s.pod.delete
Restart pods on this specific Environmentconsole.environment.k8s.pod.delete
Manage dashboards on all the Project of this Company console.company.project.environment.dashboard.manage
Manage dashboards on any Project Environmentconsole.project.environment.dashboard.manage
Manage dashboards on this specific Environmentconsole.environment.dashboard.manage
Manage users of this Companyconsole.company.users.manage
Edit project information of all the Projects of this Companyconsole.company.project.details.update
Manage users of all the Projects of this Companyconsole.company.project.users.manage
Manage users for this Projectconsole.project.users.manage
Delete a Companyconsole.company.delete
Delete a single Projectconsole.project.delete
Delete all the Projects of a Companyconsole.company.project.delete
Manage Providers for a Companyconsole.company.providers.manage
View Company Providers informationconsole.company.providers.view
Manage Clusters for a Companyconsole.company.cluster.manage
View Company Clusters informationconsole.company.cluster.view
Create a new Companyconsole.root.company.create
Delete any Companyconsole.root.company.delete
View all Console resourcesconsole.root.view
Manage user roles, groups and bindingsconsole.root.user.bind
Manage all private and public Project Templatesconsole.root.templates.manage
Manage available featuresconsole.root.features.manage
Manage Company Project Templatesconsole.company.templates.manage

User roles are manageable from CMS by the Console administrators, as they are the only one having access to the Console CMS and thus being able to manage the entire Console, including companies, projects, Marketplace.

Role binding example

Suppose you have a feature team composed by: 1 Project Manager and 1 Technical Leader, 1 Senior Developer and 2 Junior Developers and 2 Designers. This team works on a single Project with two environments:

  1. Production, on which only the Project Manager, the Technical Leader and Senior Developer can perform actions, and
  2. Staging on which the 2 Junior Developers can perform actions, too.

What you might want could be a similar Role Binding organization:

  • The Project Manager and the Technical Leader may want to have full access to the Project so they can be assigned the Project Administrator Role on the Project resource
  • The Designers should be able to access the project but they cannot perform any editing action on them, so they can be assigned the Reporter Role on the Project resource
  • The Senior Developers can be assigned the Maintainer Role on the Project
  • The Junior Developers can be assigned the Developer Role on the Project resource and then can be assigned the Maintainer Role only on the Staging environment

Assigning Roles on Resources

When you wish to assign a Role on a specific resource what you have to do is create a binding with a properly configured resource object.

info

For more information regarding how a binding is defined and how to configure the resources check out the following documentation page.