Multi-tenancy: Difference between revisions
Paul Holden (talk | contribs) (Can't manually assign Workplace roles.) |
|||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Workplace}} | {{Workplace}} | ||
Moodle Workplace allows main administrator to create multiple "tenants" and allocate | = Overview = | ||
Moodle Workplace allows the main administrator to create multiple "tenants" and allocate users to each of them. Tenant users will all be using the same site but will not see each other. Each tenant can have their own site name, logo and colour scheme. | |||
{{MediaPlayer | url = https://youtu.be/JbJwSzHSJKk | desc = Moodle Workplace | Training | Multi Tenancy}} | {{MediaPlayer | url = https://youtu.be/JbJwSzHSJKk | desc = Moodle Workplace | Training | Multi Tenancy}} | ||
When Moodle Workplace is installed, the site is prepared to be multi-tenant. The capability 'moodle/category:viewcourselist' is removed from the roles "Authenticated user" and "Guest". If you don't want to use Multitenancy functionality, you may consider allowing these capabilities. | |||
= Managing tenants = | |||
The main administrator or a user with the capability '[[Capabilities/tool/tenant:manage|tool/tenant:manage]]' is able to create tenants, change their settings, associate tenants with course categories and assign tenant administrators. Three additional roles are automatically created when Moodle Workplace is installed, automatically assigned to the following users: | |||
* "[[Tenant administrator role|Tenant administrator]]" role is assigned to the tenant administrator in the system context | * "[[Tenant administrator role|Tenant administrator]]" role is assigned to the tenant administrator in the system context | ||
* "[[Tenant manager role|Tenant manager]]" role is assigned to the tenant administrator in the context of this tenant's course category | * "[[Tenant manager role|Tenant manager]]" role is assigned to the tenant administrator in the context of this tenant's course category | ||
* "[[Tenant user role|Tenant user]]" role is assigned to any user allocated to the tenant in the context of this tenant's course category. By default this role only has | * "[[Tenant user role|Tenant user]]" role is assigned to any user allocated to the tenant in the context of this tenant's course category. By default this role only has the capability 'moodle/category:viewcourselist' | ||
These roles and role assignments can not be manually deleted, nor can a site administrator manually assign these roles to users. However the main administrator can modify the roles if necessary. For example, the "Tenant administrator" role by default contains the capability '[[Capabilities/tool/tenant:managetheme|tool/tenant:managetheme]]' that allows the tenant administrator to change the look of their tenant (logo and colours). The main administrator may decide that theme customisation should only be done centrally and prohibit this capability in the "Tenant administrator" role. The same can be done for the '[[Capabilities/tool/tenant:manageusers|tool/tenant:manageusers]]' capability. | |||
The main administrator or a user with the capability '[[Capabilities/tool/tenant:allocate|tool/tenant:allocate]]' is able to move users between tenants. | |||
== Limiting number of tenants == | |||
A site administrator can restrict the number of tenants that can be created on the site from "Site administration > Advanced features > Enable tenant limit". Enabling this setting and configuring "Tenant limit" to a specific value will prevent more than this number of tenants from being created. Note that archived tenants are also counted towards this limit. It's also possible to add the following lines to your [[Configuration_file|site configuration]] to hardcode this configuration: | |||
== | <code php> | ||
$CFG->tool_tenant_tenantlimitenabled = true; | |||
$CFG->tool_tenant_tenantlimit = <VALUE>; | |||
</code> | |||
= Tenant administration = | |||
Tenant administrator can | The [[Tenant administrator role]] by default has the capability '[[Capabilities/tool/tenant:manageusers|tool/tenant:manageusers]]'. Unless this capability is removed from the role by the main administrator, the tenant administrator can create and edit users inside their tenant. | ||
If the tenant has its own course category, tenant administrator is also a "[[Tenant manager role|Tenant manager]]" in this course category and | The tenant administrator can assign other roles to their users, for example "Program manager" or "Organisation structure manager" in the system context. | ||
If the tenant has its own course category, the tenant administrator is also a "[[Tenant manager role|Tenant manager]]" in this course category and is able to assign roles in the context of this course category, for example "Course creator". For easier management there is a single page that lists all the roles that the tenant administrator can assign in both system and category context. It can be accessed through '''Workplace launcher -> Users -> Roles'''. | |||
[[File:workplace_rolesmanagement.png|thumb|600px|center|Managing roles for tenant administrator]] | [[File:workplace_rolesmanagement.png|thumb|600px|center|Managing roles for tenant administrator]] | ||
The tenant administrator is also able to manage their course category and all courses in it. Access to the course management is done through '''Workplace launcher -> Courses'''. Hint: check out the "Edit" menu for the course category. | |||
[[File:workplace_categorymanagement.png|thumb|600px|center|Category management]] | [[File:workplace_categorymanagement.png|thumb|600px|center|Category management]] | ||
==See also== | = Shared courses = | ||
Normally each tenant has its own course category and its own courses. The manual enrolment method has been modified so the user picker only displays users from the current tenant. | |||
However there are some situations when an organisation wants to have courses that are shared between tenants. Please note that '''multitenancy will not apply to the course content'''. This means that if a user (either a learner or a trainer) is enrolled in a course, they will see users from other tenants while browsing the course. This could be forum posts, list of course participants, gradebook, reports or any other module that displays course participants. | |||
There are various reasons for this behaviour: | |||
# If the organisation wants to have shared courses they may actually expect this behaviour since they want the learners to study together and/or the trainer from one tenant to be a teacher for all learners regardless of their tenant | |||
# It is simply impossible to modify all activity modules and reports to add multitenancy restrictions, especially considering that there can be third party plugins | |||
# The same functionality can be achieved by using separate group mode if needed | |||
If you share courses between different tenants and you want users from each tenants to learn independently they must belong to different groups and '''the course has to be in separate group mode''' (preferably forced). Please review the "Trainer" and "Non-editing trainer" roles in the course and make sure that they do not have the [[Capabilities/moodle/site:accessallgroups|accessallgroups]] capability, and the trainers are also allocated to the relevant groups. | |||
Allocation to separate groups is done automatically when a shared course is part of a program. See also [[Programs#Shared_courses|Shared courses in programs]] | |||
= Privacy considerations = | |||
All user information from each tenant is stored in the same database and in the same table. This may be a concern for you if your tenants are completely independent and you must comply with [[GDPR|GDPR requirements]] to store data separately. The benefit of the multi-tenancy feature is that you have a single Moodle Workplace instance for all tenants and users, making it easier for you to maintain and have shared data. If you are required by law to separate them, unfortunately you may not benefit from multi-tenancy and may need to set up separate sites. | |||
= See also = | |||
* [[Capabilities/tool/tenant:manage]] | * [[Capabilities/tool/tenant:manage]] | ||
Latest revision as of 12:22, 20 January 2020
This feature is part of Moodle Workplace, which is available through Moodle Partners.
Overview
Moodle Workplace allows the main administrator to create multiple "tenants" and allocate users to each of them. Tenant users will all be using the same site but will not see each other. Each tenant can have their own site name, logo and colour scheme.
When Moodle Workplace is installed, the site is prepared to be multi-tenant. The capability 'moodle/category:viewcourselist' is removed from the roles "Authenticated user" and "Guest". If you don't want to use Multitenancy functionality, you may consider allowing these capabilities.
Managing tenants
The main administrator or a user with the capability 'tool/tenant:manage' is able to create tenants, change their settings, associate tenants with course categories and assign tenant administrators. Three additional roles are automatically created when Moodle Workplace is installed, automatically assigned to the following users:
- "Tenant administrator" role is assigned to the tenant administrator in the system context
- "Tenant manager" role is assigned to the tenant administrator in the context of this tenant's course category
- "Tenant user" role is assigned to any user allocated to the tenant in the context of this tenant's course category. By default this role only has the capability 'moodle/category:viewcourselist'
These roles and role assignments can not be manually deleted, nor can a site administrator manually assign these roles to users. However the main administrator can modify the roles if necessary. For example, the "Tenant administrator" role by default contains the capability 'tool/tenant:managetheme' that allows the tenant administrator to change the look of their tenant (logo and colours). The main administrator may decide that theme customisation should only be done centrally and prohibit this capability in the "Tenant administrator" role. The same can be done for the 'tool/tenant:manageusers' capability.
The main administrator or a user with the capability 'tool/tenant:allocate' is able to move users between tenants.
Limiting number of tenants
A site administrator can restrict the number of tenants that can be created on the site from "Site administration > Advanced features > Enable tenant limit". Enabling this setting and configuring "Tenant limit" to a specific value will prevent more than this number of tenants from being created. Note that archived tenants are also counted towards this limit. It's also possible to add the following lines to your site configuration to hardcode this configuration:
$CFG->tool_tenant_tenantlimitenabled = true;
$CFG->tool_tenant_tenantlimit = <VALUE>;
Tenant administration
The Tenant administrator role by default has the capability 'tool/tenant:manageusers'. Unless this capability is removed from the role by the main administrator, the tenant administrator can create and edit users inside their tenant.
The tenant administrator can assign other roles to their users, for example "Program manager" or "Organisation structure manager" in the system context.
If the tenant has its own course category, the tenant administrator is also a "Tenant manager" in this course category and is able to assign roles in the context of this course category, for example "Course creator". For easier management there is a single page that lists all the roles that the tenant administrator can assign in both system and category context. It can be accessed through Workplace launcher -> Users -> Roles.
The tenant administrator is also able to manage their course category and all courses in it. Access to the course management is done through Workplace launcher -> Courses. Hint: check out the "Edit" menu for the course category.
Normally each tenant has its own course category and its own courses. The manual enrolment method has been modified so the user picker only displays users from the current tenant.
However there are some situations when an organisation wants to have courses that are shared between tenants. Please note that multitenancy will not apply to the course content. This means that if a user (either a learner or a trainer) is enrolled in a course, they will see users from other tenants while browsing the course. This could be forum posts, list of course participants, gradebook, reports or any other module that displays course participants.
There are various reasons for this behaviour:
- If the organisation wants to have shared courses they may actually expect this behaviour since they want the learners to study together and/or the trainer from one tenant to be a teacher for all learners regardless of their tenant
- It is simply impossible to modify all activity modules and reports to add multitenancy restrictions, especially considering that there can be third party plugins
- The same functionality can be achieved by using separate group mode if needed
If you share courses between different tenants and you want users from each tenants to learn independently they must belong to different groups and the course has to be in separate group mode (preferably forced). Please review the "Trainer" and "Non-editing trainer" roles in the course and make sure that they do not have the accessallgroups capability, and the trainers are also allocated to the relevant groups.
Allocation to separate groups is done automatically when a shared course is part of a program. See also Shared courses in programs
Privacy considerations
All user information from each tenant is stored in the same database and in the same table. This may be a concern for you if your tenants are completely independent and you must comply with GDPR requirements to store data separately. The benefit of the multi-tenancy feature is that you have a single Moodle Workplace instance for all tenants and users, making it easier for you to maintain and have shared data. If you are required by law to separate them, unfortunately you may not benefit from multi-tenancy and may need to set up separate sites.
