Server Roles
This tool is only available to the Master Organisation.
About
Each role (also known as a service) provided by LxRoot is containerised. This allows for each server within your cluster to provide all or a combination of Application, Email, Database, Backup and/or DNS roles.
The LxRoot role is specific to your control panel server. It cannot be removed or uninstalled. Only one control server is possible within an LxRoot cluster. Automatic failover of this role to a subordinate server is an upcoming feature.
Install a Role
When a new role is installed it will provision a number of docker containers to the target server. These containers are managed by LxRoot and will be destroyed, restarted and re-created automatically as required. All data which is required to be persistent is stored within persistent volumes or mounts to the host system.
To add a role to a server:
- Open Servers in the left side bar.
- Select Manage on the server you’d like to add the service to.
- Scroll to Roles and click the Add Role tab.
- Select the roles you would like to enable and click Add services to finish.
New roles will not automatically be mapped to websites. If you are installing a role which did not previously exist on your LxRoot cluster and you want to map existing websites to it so they can use the new functionality, use the "move server" option from the left hand menu.
Override Global Role Settings
By default all services installed on a server role automatically inherit the global Service settings configured in your ‘Service settings'. Once installed some global service settings can be overridden on a per server basis.
Email role
SMTP Settings: Configure the server to relay through a designated smart host (outbound SMTP filtering/scrubbing service).
Application role
PHP FPM/INI: Affects every website's default settings but can be overridden on a per-website basis.
Database role
my.cnf: Set custom directives. LxRoot verifies validity, but incorrect settings can cause corruption.
Delete a Role
Deleting a role will remove it from the server. All relevant containers and their data will be removed.
Restriction: You cannot delete a role which has websites mapped to it. You must delete all websites or migrate them to other servers first.
Restart a Role
There are two different types of role restarts:
Graceful restart: Waits for all processes to finish before restarting. Websites relying on the service will be offline during the cycle.
Forceful restart: Immediately kills all processes running on the service. Websites will be offline during the cycle.
- Open Servers in the left sidebar.
- Select Manage on the target server.
- Navigate to Services and click on the specific service tab.
- Click either Graceful restart or Forceful restart.