web.roles-mgt.docs.userguide.html Maven / Gradle / Ivy
Server Roles Management - User Guide
Server Roles Manager
Introduction
Server Roles Manager is a component to manage server roles property for
WSO2Carbon based products. Read more about
Server Roles.
As carbon supports adding different product features into one product instance original concept
of the server role property being added into carbon.xml is hard to manage as users may have to
manually modify the carbon.xml to include the server-roles related to the product feature they
have added to a carbon product instance. As WSO2 Stratos and WSO2 Mars are introduced above
action is not possible for a tenant since the tenant user is remote to the server instance.
To overcome those issues server role manager is introduced. Server role manager will store the
both carbon.xml default product roles and user/tenant specified server roles in Configuration
registry. So when a C-App is deploying in carbon the C-App deployer will check for afro-mentioned
server roles from the registry instead of carbon.xml.
How It Works
You can access the server roles manager UI clicking 'Configure -> Server Roles'
or directly from https://<host>:<port>/carbon/roles-mgt/server-roles-mgt.jsp
.
Server Roles Manager Displays all the server roles included in the current product instance in the
landing page.
Figure 1: Server Roles Manager Landing page.
In server roles manager, server roles properties will be of two types, Default and
Custom. Default type will be all the server roles picked from that particular
product instance's carbon.xml and all other server roles added by the user will have type custom.
Functionality
Server Roles Manager has two basic functionalities,
- Add Server Role
You can add any textual name as a server role without special characters except
underscore.
Figure 2: Add Server Role.
Click the link 'Add New Server Role' and a drop down menu will appear to
give the new role name. Just enter the preferred server role name than click
Add, and it will add the server role name.
- Remove Server Role
Simply click the garbage/delete icon
(
) at the right side of the any existing server
role. It will prompt a confirmation dialog and once confirmed it will
delete the server role.
Figure 2: Remove Server Role.
Note: Here users can even delete a default server role. Once it is deleted
when next time loading server role manager will not pick it up from the carbon.xml.