Endurance
v3.2 (latest) v3.1
Get started

System Maintenance

Backup & restore

Backups are created automatically and can also be created manuually as and when required.

Auto Backups

TODO What triggers an Auto Backup?? schedule ??

Manual Backups

To create a backup:

  1. Using the WebUI, navigate to Maintenance > Backup & restore.

  2. Click Backup.

  3. . The backup archive will be created and downloaded to your browser’s default location or you’ll be prompted to select a location depending on the settings configured.

Restore

  1. Using the WebUI, navigate to Maintenance > Backup & restore.

  2. Click Upload backup.

To restore an auto backup:

  1. Using the WebUI, navigate to Maintenance > Backup & restore.

  2. Click the three dots menu next to the auto backup you’d like to restore.

  3. Click Restore.

  4. Select the Restore Type.

    • If Part Restore is selected:

      • test

    • If <appliance-name> (i.e. a full restore) is selected:

      • test

To restore a manual backup:

  1. Using the WebUI, navigate to Maintenance > Backup & restore.

  2. Click Upload backup.

  3. Click Choose file, then navigate to the location of the backup archive, select the file and click Open.

  4. Click Upload to restore the backup.

System services

The various services running on the appliance can be manually reloaded or restarted if required. This is normally only required when a new configuration is added or an existing configuration is modified.

To restart or reload a service:

  1. Using the WebUI, navigate to Maintenance > System services.

  2. Click the three dots menu next to service you’d like to reload or restart.

  3. Select either Reload or Retart.

Appliance Software Update

We recommend that the appliance is kept up to date to ensure that you benefit from the latest bug fixes, security updates and feature improvements. Both online and offline update are supported.

Services may need to be restarted/reloaded after the update process completes or in some cases a full appliance restart may be required.

Online Update

The appliance periodically contacts the Loadbalancer.org update server (update.loadbalancer.org) and checks for updates. If an update is found, a notification will be displayed on the main dashboard in the SYSTEM UPDATES widget as shown in the example below:

update available msg

Click Update. Details of the update package(s) available will be displayed as shown in the example below:

update list

Click Online Update, then click Confirm in the popup to start the update process.

The update process can take several minutes depending on download speed and the number of updates.

If services need to be reloaded/restarted or the appliance needs a full restart, you’ll be prompted accordingly.

Offline Update

If the appliance does not have access to the Internet, offline update can be used. To check if updates are available, please contact our support team.

To perform an offline update:

  1. Using the WebUI, navigate to: Maintenance > Software update.

  2. Click Manual update.

  3. Click Choose File, then browse to and select the update file.

  4. If services need to be reloaded/restarted or the appliance needs a full restart, you’ll be prompted accordingly.

Fallback pages

Multiple fallback pages can be added to the appliance. Once added, a fallback page can be associated with one or more Virtual Services.

The fallback page is displayed when all Real Servers are down.

What about when taken offline???

To add a fallback page:

  1. Using the WebUI, navigate to Maintenance > Fallback pages.

  2. Click Add fallback page.

    add fallback page

  3. Enter an appropriate Name for the fallback page.

  4. If the page should be available on HTTPS, select the relevant Certificate.

  5. Select the Type.

    • If Internal is selected:

      • Specify the required page content.

    • If External is selected:

      • Specify the IP address and Port of the external fallback server.

  6. Click Update

To add a fallback page:

  1. Using the WebUI, navigate to Maintenance > Fallback pages.

  2. Click the three dots menu next to the fallback page you’d like to edit.

  3. Click Edit.

  4. Update the relevant setting(s), then click Update.

User Management

When first deployed, the appliance includes one system administrator account. This account is created when the setup wizard is run.

Adding Users

Additional user accounts can be added if required. Permissions granted to each user are based on the role(s) allocated either directly to the user or via group membership and the permissions configured for those role(s).

To add a new user:

  1. Using the WebUI, navigate to Maintenance > User management.

  2. Click the Add user button.

    add user

  3. Specify and confirm the Email address of the new user, then click Next.

  4. Select the required Role(s) and click Next.

  5. If any groups have already been configured, select the required Group(s) and click Next.

    At least one role or group must be selected.
    For more information on roles and groups, see Roles & Groups below.

  6. Click Submit.

  7. The account will be added in an "Invited" state and an activation email will be sent to the email address provided.

  8. Ask the new user to open the email and click on the link to complete the activation process.

    If the activation email doesn’t arrive, advise the user to check in any spam folders. The activation email will come from noreply-portal@loadbalancer.org.
    The new user will need to download their account private key during the activation process. This key is required if the user forgets their password and wants to reset it. Advise the user to store it in a safe location.

Deleting Users

To delete a user:

  1. Click the three dots menu next to the user to be deleted.

  2. Click Delete, then click Confirm to delete the user.

It’s not possible to delete the system admin user that was created when the setup wizard was run.

Roles & Groups

Roles

Roles define a set of permissions that can be assigned to users. Three roles are included by default:

  • Owner - full access to all data and settings.

  • Maintainer - full access to all data and settings except for user, group, role and account settings where read only access is provided.

  • Viewer - read only access to all data and settings.

In addition, custom roles can be configured either from scratch or by duplicating one of the default roles and then customizing permissions to suit specific requirements.

To create a new role from scratch:

  1. Click the Portal menu icon in the top right corner of the main menu bar and select Organisation.

  2. Select the Roles tab.

  3. Click the Add role button.

  4. The Add Role form will be displayed:

    add role

  5. Specify an appropriate Role name, e.g. Manage Schedules and click Next.

  6. Under the Role Management section either click Expand all or expand the relevant section(s) individually.

    add role management

  7. Select the required permissions. In the example above, all permissions related to schedules have been granted.

  8. click Next, then click Submit.

To create a role by duplicating an existing role:

  1. In the User Management form select the Roles tab.

  2. Click the three dots menu next to the role to be duplicated.

  3. Click Duplicate.

  4. Specify a name for the new role and click Next.

  5. Under the Role Management section either click Expand all or expand the relevant section(s) individually.

  6. Configure the required permissions.

  7. Click Next, then click submit.

To delete a role:

  1. Click the three dots menu next to the role to be deleted.

  2. Click Delete, then click Confirm to delete the role.

Groups

A group can have one or more associated roles and each group can contain multiple users. This enables user permissions to be assigned based on group membership.

To create a group:

  1. Click the Portal menu icon in the top right corner of the main menu bar and select Organisation.

  2. Select the Groups tab.

  3. Click the Add group button.

  4. The Add Group form will be displayed:

    add group

  5. Specify an appropriate Group name, e.g. Manage Schedules and click Next.

    add group select roles

  6. Select the role(s) to be allocated to the group (this can be done later if preferred), then click Next.

  7. Select the user(s) that will be members of the group (this can be done later if preferred), then click Next.

  8. Click Submit.

As an example, if multiple users were allocated the default Viewer role when first created, they would have read only access to all data and settings. If you wanted to allow those users to configure and manage schedules, they could be made members of the Manage Schedules group created above. Since the Manage Schedules role created above is associated with this group and provides full permissions to all scheduler related functionality, this would grant the required permissions.

To delete a group:

  1. Click the three dots menu next to the group to be deleted.

  2. Click Delete, then click Confirm to delete the group.

Account Settings

Various setting for the current user can be modifed if required.

To modify account settings:

  1. Using the WebUI, navigate to Maintenance > Account settings.

System Lock

What exactly happens when system is locked??? VIPS don’t work? WebUI not work??