TABLE OF CONTENTS


Introduction

SERVERware Architecture

A SERVERware environment consists of:

  •  A redudant storage server which holds virtual resources like virtual server volumes and templates.
  •  Virtual private server's hosts that use Linux Containers (LXC) as a virtualization technology.
  •  Agents and tools running on hosts. These tools provide local management for virtual private servers.
  •  Controller, a centralized management platform for the SERVERware environment. It provides a graphical user interface
    which can be used to view, provision and manage resoures. It runs on the storage server within a dedicated linux container.
  •  A database that tracks the states and changes of the environment.
  •  Networking links the environment together. This includes physical network links as well as logical subnets.

SERVERware network topology is shown on the following image:

serverware3.2-topology.jpg

SERVERware resources


The components of the SERVERware environment fall into two categories: physical resources, and logical resources. Physical resources are physical objects
such as storage and host servers. Logical resources are nonphysical groupings and processes, such as domains, logical subnets and virtual server templates.

  •  Network - A SERVERware network is the highest level container for all physical and logical resources within a managed virtual environment. It is a collection of hosts, domains, virtual servers, storage, and networks.
  •  Storage - SERVERware uses a centralized shared storage system for virtual server volumes and templates. SERVERware storage is implemented using ZFS as a storage engine and Internet Small Computer System Interface (iSCSI) protocol for exporting VPS volumes to the processing hosts.
  •  Hosts - A SERVERware host is a physical server which hosts virtual servers.
  •  Logical Subnets - SERVERware defines a couple of logical subnets to the physical network interface cards. Logical subnets are used for traffic management, storage mirroring and storage, traffic between storage and processing hosts.
  •  Domains - A SERVERware Domain is a logical group of physical, virtual resources and users.
  •  Virtual Private Servers - A VPS (Virtual Private Server) is an equivalent to a dedicated physical server. Since it is software-defined, it is much more easily configured and managed.
  •  Templates - A Template is a pre-configured VPS that is loaded with all the necessary software for its specific role. A couple of Templates can be used together to form an even more specific VPS.
  •  Backups - Backup is a feature that is used for data protection and recovery.
  •  Users - SERVERware allows a couple of different users accounts to be created. Accounts can have different roles and various permission levels.
  •  System Logs - A SERVERware System Logs is a logging system that records events that occur in SERVERware. It can be used for system management, analysis and debugging.
  •  Alarms - Alarm is an alert that can be triggered under certain abnormal operating conditions. Alarms can be received by a group of recipients via various notifications.
  •  Statistics - SERVERware statistics collects resource usage data. Data is stored and presented for Hosts and VPSs.

Accessing the Web Control Panel

Logging in to the Web Control Panel (Administration UI)

Log in to the SERVERware Web Control Panel directly from your web browser.

  1. Enter IP Address of SERVERware Web Control Panel into the web browser to access the login screen.

    sw3 login.png
  2. Enter your Username and Password.
  3. Press the Enter or click Login. SERVERware Dashboard appears.

Logging out of the Web Control Panel

At the title bar of the Web Control Panel, click Logout. You are logged out and the Web Control Panel login screen displays.


Network Administration

Dashboard

SERVERware network dashboard is a visual display of the most important performance indicators of a SERVERware network. Given that a storage server is a crucial component of a SERVERware network, most of the dashboard performance indicators (widgets) in some way reflect a status of the storage server itself.

sw3.1 dash.png

The following is list of dashboard widgets:

  1.  Running VPSs Indicator - Shows total number of VPSs as well as number of running VPSs
  2.  Active Calls Indicator - Shows total number of concurrent calls on all running VPSs within the SERVERware network
  3.  CPU Usage Indicator
  4.  Storage Usage Indicator
  5.  Resource Monitor
  6.  Recent Activity List
  7.  Triggered Alarm List

In SERVERware 3.1 there is a new chart for Most Active VPS.

sw3.1 dashboard.png


This will help an administrator to quickly identify a VPS that generate high I/O load on the system.

Most Active VPS's can be viewed in several time periods:

  •  HOUR
  •  DAY
  •  WEEK

Also there is a filter by resources used:

  •  CPU
  •  DISK I/O
  •  CALLS

Domains

A SERVERware Domain is a logical group of physical resources, users and virtual servers. The main purpose of a domain is to define the administrative boundaries for management of virtual private servers. A domain can represent an individual, department or company.

Managing Domains

The Domains menu item provides access to a graphical view of all the domains in the system. The Domains view consists of a domain list pane and a domain details pane. You can perform a management task on an individual domain by selecting the domain and then clicking the relevant action button.

sw3 domains.png

The following properties of the domain are displayed on the Domains view as well as on the Create and Edit dialog boxes.


 Field Description
 Name The domain name. Provide a descriptive name.
 Company Provide a company name to which domain belongs.
 Account URL An URL to a site or a CRM system containing more details about the company.
 User Quota A maximum number of domain members.
VPS Quota A maximum number of VPSs that can be created within the domain.
 Memory Quota A maximum amount of RAM memory that can be utilized by the domain VPSs.
 Storage Quota A maximum amount of Storage space that can be utilized by the domain VPSs.

The General tab on the Details pane provides information on an individual domain such as domain owner and resource quotas.


Creating Domain

Follow this procedure to create a new domain:

  1. On the Domains view click Create Domain button.
  2. The Create Domain dialog appears.

    sw3 create domain general.png
  3. On the Generaltab enter the details in the following fields:
    • Name: a descriptive domain name.
    • Company: the company name to which the domain belongs.
    • Account URL: enter the company URL or leave empty.
    • User Quota: select max number of domain members.
    • VPS Quota: select max number of domain VPSs.
    • Memory Quota: select max amount of RAM memory for domain VPSs.
    • Storage Quota: select max amount of Storage space for domain VPSs.
  4. Click the Next button to configure domain members on the Domain Members tab.

    sw3 create domain members.png
  5. To add a user, on the Domain Members tab, select or search an existing user in the dropdown list.
  6. Selected user with a pre-assigned role appears in the list of domain members. Next time when logged in to the web interface, the new domain member will be able to login to the assigned domain and manage belonging VPSs.
  7. To remove a user, click the Remove Member button for the selected user. A confirmation dialog appears. Click Remove. The user disappears from the domain member list.
  8. Click the Next button to configure domain networking on the Networking tab.

    sw3 create domain networking.png
  9. On the Networking tab select the logical subnet to which you want to connect domain VPSs.
  10. Click on Reserve Address to open IP Address Resevation dialog. To add a domain IP Address, select or search IP address in the list and click Reserve. Reserved IP Address shows up in the list. If there are no IP Addresses to select for reservation, use Settings/Networking menu to extend IP Address pool.
  11. To release a domain IP address, click the Release Address button for selected IP address. A confirmation dialog appears. Click Release. The IP address disappears from the domain IP pool.
  12. Click the Next button to configure Flavors tab and select resource flavors for domain VPSs.

    sw3 create domain flavors.png
  13. Turn on the resource flavors that you want to be accessible to the domain.
  14. Click the Finish button to initialize the domain creation.
  15. A new entry presenting the new domain appears in the list.


Editing Domain

You can edit the details of a domain, such as its name, resource quotas, domain members, networking and flavors.

Follow this procedure to edit domain details:

  1.  In the Domains view, select the domain that you want to edit.
  2.  Click the Edit button. The Edit Domain dialog appears (see Create Domain dialog).
  3.  Edit the details as required.
  4.  Click Save to save the changes.
Removing Domain

A SERVERware domain can be removed only if there is no VPSs that belong to it.

Follow this procedure to remove a domain:

  1.  In the Domains view, select the domain to be removed.
  2.  Click the Remove button. A confirmation dialog appears.
  3.  Click Yes. Domain disappears from the list.

Hosts

A SERVERware host is a physical 64-bit server running a special build of Gentoo Linux, configured with packages required to host virtual servers. Based on a purpose, SERVERware defines the following three types of hosts:

  •  Storage host is a crucial component of SERVERware environment and is usually implemented as a mirrored pair of physical servers to provide a fault tolerant and redundant storage infrastructure for virtual servers running on processing hosts.
  •  Processing hosts are the physical servers which run virtual private servers. The server virtualization technology used is LXC (Linux Containers). LXC runs stateless and without disk writes unless explicitly requested.
  •  Backup hosts are dedicated servers for storing backups of virtual server volumes.

Managing Host

The Hosts menu item provides access to a graphical view of all the hosts in the system. The Hosts view consists of a host list pane and a host details pane. You can perform a management task on an individual host by selecting the host and then clicking the relevant action button. If an action is not possible, the button is disabled.

sw3 hosts.png

The following properties of the host are displayed on the Hosts view as well as on the Add and Edit dialog boxes.

 Field Description
 Name The host name. Provide a descriptive name.
 IP Address The IP Address of the host provided during installation.
 Port The port through which the controller communicates with the host agent.
 Root Password The password of the designated host; used during installation of the host.
 Purpose The host purpose is one of the following: storage, processing or backup.
 Storage Location The storage location (network/local) for VPSs running on the processing hosts.
 Service Pool The service pool to which host belongs. Use Mixed pool.

The General tab on the Details pane provides information on an individual host, including hardware and software versions. The Network Interfaces tab on the Details pane provides information about logical and physical networks of the host. This allows you to define the attachment of the logical subnets to the physical network interface cards of the host.

Adding Host

Hosts must be correctly installed before you can add them to the SERVERware virtualization platform. Before adding hosts ensure that the IP Address have been assigned correctly. There is no need to additionally configure Network Bridge which is automatically created during the installation. Network Bridge allows Virtual Servers to interact with the network as if they were using physical NICs.

To add a SERVERware host, follow the next steps:

  1. On the Hosts view, click Add Host button.
  2. The Add Host dialog appears.

    sw3 add host.png
  3. Enter the details in the following fields:
    • Purpose: the purpose of the host.
    • Storage Location: the storage location field appears only when the selected host purpose is the processing. Select the Network Storage as a storage location for VPS volumes.
    • Service Pool: the service pool such as the storage location makes sense only for the processing hosts. Select the Mixed pool.
    • Name: a descriptive name for the host. Use a button for generating random host name if the name is not so important.
    • IP Address: the IP address of the host which was provided during installation.
    • Port: the port number for the communication with the sw-connector agent running on the host. Leave default port number 4433.
    • Root Password: the password of the designated host. If not manually changed on the host, default password is serverware so you will be asked to provide a new password as soon as you enter the default one into the field.
  4. Click Add button to submit the form.

The new host appears in the list of hosts with a disabled state. Host health indicators for the connection and sw-connector should be green circles. Depending on it whether the host SAN network interface was pre-configured or not, the Storage connectivity indicator will be green or red circle.


Enabling Host

After a host has been added, updated or an existing host has been taken down for maintenance, it needs to be enabled before it can be used.

  1.  In the Hosts view, select the host to be enabled.
  2.  Click the Enable button. A confirmation dialog appears.
  3.  Click Yes.

The host state changes to UP. Virtual servers can now run on the host.

Managing Host Network Interfaces

The Network Interfaces tab on the Details pane of a host allows you to define the attachment of the logical subnet to the physical network interface cards (or NICs) of the host. This is a simple operation in which you attach one or more of the host's physical network interface cards (NICs) to a predefined logical subnets in the SERVERware environment.

There are three logical subnets defined by SERVERware during installation:

  •  LAN - Local Area Network used for SERVERware management traffic as well as for VPSs services.
  •  RAN - Replication Area Network is used for the storage mirroring. It is implemented as a direct connection between two storage hosts that constitute a fault tolerant storage solution.
  •  SAN - Storage Area Network is used for storing traffic between storage and processing hosts.

The Network Interfaces tab displays name, logical subnet name, IP address, subnet mask, MAC address and link status for each host interface. There is an Edit button next to each interface. The network interface configured during the host installation is automatically assigned to the LAN subnet. Given that the LAN interface is used for the host management, it is not safe to edit LAN interface from the administration GUI. RAN interface is used by storage servers only and is configured automatically by setup wizard. The SAN interface is only used in the SERVERware Cluster Edition. It is automatically setup on the storage servers by the setup wizard but needs to be configured upon new processing host addition.

  1. In the Hosts view, select the appropriate host.
  2. Click Maintenance button to switch host into maintenance mode.
  3. Click Network Interface tab on the Details pane to display the list of NICs on the host, their address and other specifications.
  4. Click the Edit button next to NIC that you want to edit. Edit Host Network Interface dialog appears.

    sw3 edit host net.png
  5. Select a logical subnet from the list to attach NIC to a different logical subnet.
  6. Provide an IP address belonging to the selected logical subnet.
  7. Click Save button to apply the changes.
  8. Click Enable button to enable host.


Maintaining Hosts

Moving host into Maintenance Mode

Hosts must occasionally be brought down for maintenance. You have to manually migrate or stop all virtual servers, before shutting it down. Placing a Host into maintenance mode is a way to notify SERVERware Controller that the host is no longer a stable resource for VPS hosting and cannot be used as a target host for new VPSs as well as a target for VPSs migration or failover.

WARNING: If any virtual servers stay running on the host placed into maintenance mode, be aware that they will not be automatically failed over in the case of a host failure.

Follow the below mentioned steps to move a host into maintenance mode:

  1.  In the Hosts view, select the host to be placed in maintenance.
  2.  Click the Maintenance button. A confirmation dialog appears.
  3.  Click Yes.
  4.  The State field of the host changes to MAINT (maintenance). The icon changes to indicate that the host is in maintenance.
  5.  Perform any required task. When the host is ready to be re-enabled, click the Enable button to enable host. The State field of the host changes to UP.

NOTE: The host status stay unchanged if SERVERware Controller is unable to communicate with and control the host.


Editing Host Details

You can edit the details of a host, such as its name or network configuration.

Follow this procedure to edit host details:

  1.  In the Hosts view, select the host that you want to edit.
  2.  Click the Edit button. The Edit Host dialog appears (see Add Host dialog).
  3.  Edit the details as required.
  4.  Click Save to save the changes.
Removing Host

Hosts that are no longer being used by SERVERware can be permanently removed. A host removing action is allowed only for the processing hosts. A processing host can be removed only if there is no hosted VPSs on it. So, in order to remove a processing host for any reason make sure that you have previously moved all VPSs to another processing host.

Follow this procedure to remove a host:

  1.  In the Host view, select the host to be removed.
  2.  Click the Remove button. A confirmation dialog appears.
  3.  Click Yes. Host disappears from the list.
Updating Host SW-Connector

The sw-connector service agent running on hosts is a crucial component for a proper functioning of the SERVERware environment, so it has to be updated if there are new features or bug fixes. A host should be moved to maintenance mode before updating the sw-connector.

Follow this procedure to update sw-connector:

  1.  In the Host view, select the host which sw-connector has to be updated.
  2.  Move the host into maintenance mode.
  3.  Click the Update SW-Connector button.
  4.  Open the System Logs view to track the progress of updating.
  5.  When the update is complete, click the Enable button to enable host.

Virtual Private Servers (VPSs)

The VPSs menu provides graphical view of virtual servers that connected user is permitted to administer. The VPS list pane allows you to perform a management task on an individual VPSs while VPS details pane provides information such as details about allocated resources, owner name, network interfaces and storage.

sw3-1 vpss.png

The following properties of the VPS are displayed on the Virtual Private Servers view as well as on the Add and Edit dialog boxes.

 Field Description
 Name The VPS name. Provide a descriptive name.
 IP Address The IP Address of the VPS.
 Host The name of a processing host that hosts and runs VPS.
 Domain The domain represents a department or customer which VPS belongs to.
 Type The VPS type can be either Service or System. VPSs such as PBXware,
TELCOware, or SIPmon are the service type VPSs while VPSs based on a plain Gentoo or
Ubuntu templates are classified as the system type VPSs.
 Service The exact name of a service that VPS provides.
 System The base operating system that VPS relies on.
 Template The exact version of either service or system template that VPS is based on.
 Flavor The flavor is a predefined ratio of resources such as CPU, Memory and Storage to be assigned to the VPS.


The General tab on the Details pane provides information on an individual VPS such as base template version, domain it belongs to, owner name as well as details about allocated resources.

The Network Interfaces tab provides information about logical subnets which VPS is attached to.

The Storage tab provides information about VPS storage volume, its location and size. It allows you to increase size of the storage assigned to the VPS.


Creating New Virtual Private Server

In order to provide a simple and fast way of creating a new virtual server instance, SERVERware provides virtual server templates. Atemplate is a base virtual server that is set with a unique configuration and settings. A virtual server that is based on a particular template acquires the configurations and settings from the template. Thus, templates are used to conveniently and efficiently create a set of identical virtual servers. By default, virtual servers created from templates use thin provisioning. In the context of templates, thin provisioning means that all virtual machines based on a given template share the same base image as the template.

Follow this procedure to create a new virtual server:

  1. On the Virtual Private Servers view click Create VPS button.
  2. The Create VPS dialog appears.

    sw3-1 add vps general.png

  3. On the Generaltab enter the details in the following fields:
    • Type: the type of virtual server to be created.
    • Service: a service that VPS has to provide. This field appears if a selected VPS type is the service. Select a service name from the list.
    • Template: the base virtual server version for selected VPS type. Select a template from the list.
    • Domain: the domain which VPS belongs to.
    • Name: a descriptive name of VPS.
    • Highly Available: enable failover of VPS to storage host.
    • Exclude From Backup: if selected the VPS will be excluded from backup.
    • Enable Protected Mode: if selected only administrator can manage VPS  ( start, stop, restart).
    • Description: Describe VPS if necessary.
  4. Click the Next button to configure VPS resources on the Resources tab.

    sw3.1 add vps resources.png

  5. On the Resourcestab enter the details in the following fields:
    • Flavor: a resource flavor. Select a flavor from the list that provides a resource ratio which fits the VPS needs.
    • Bandwith: limit disk read/write bandwith in MB/s
    • IOPS Limit: Limiting IOPS per VPS. The default value to be 150 With several other options included:
      1.  • 50
      2.  • 100
      3.  • 150
      4.  • 500
      5.  • 1000
      6.  • Unlimited
    • The default values for Read/Write IOPS limits are inherited from the selected resource flavor.
    • AstDB RAM Disk: a size of RAM disk to keep Asterisk database. This affects PBXware based VPSs only and should be configured only if you detect a performance issue.
    • Call Recordings RAM Disk: a size of RAM disk to keep call recordings. (PBXware only)
  6. Click the Next button to configure VPS networking on the Networking tab.

    sw3 add vps networking.png

  7. On the Networking tab select the logical subnet to which you want to connect the VPS.
  8. Enter an IP Address belonging to the selected logical subnet.
  9. Click the Next button to show the Summary tab.
  10. Review the summary information and click Finish button to initialize VPS creation.
  11. A new entry presenting the new VPS showing a current task status appears in the list.

Managing Virtual Private Servers

Administrative tasks for virtual servers include:

  •  Starting, Stopping and Restarting virtual servers,
  •  Changing virtual server ownership,
  •  Increasing virtual server storage,
  •  Cloning and migrating virtual servers,
  •  Restoring virtual servers.
Editing VPSs

You can edit details of a virtual server such as its name or memory size. However, you cannot change the template or the domain to which virtual server belongs. The VPS network configuration changes take effects after the virtual server is stopped and restarted.

Follow this procedure to edit VPS details:

  1.  In the Virtual Private Servers view, select the VPS that you want to edit.
  2.  If the VPS that you want to edit is not visible in the list, perform a search.
  3.  Click the Edit button. The Edit VPS dialog appears with the disabled fields that cannot be changed.
  4.  Edit the required details of enabled fields under a desired tab.
  5.  Click the Save button. The details of the VPS are updated in the view.
Starting, Stopping and Restarting VPSs

Management actions such as VPS starting, stopping and restart are performed directly on the virtual server by using dedicated buttons for that purpose located on the top of virtual server list.

sw3-1 start stop btns.png

Follow this procedure to trigger a VPS management action:

  1.  In the Virtual Private Servers view, select the VPS that you want to edit.
  2.  If the VPS that you want to manage is not visible in the list, perform a search.
  3.  Depending on action that you want to perform click either Start, Stop or Restart button.
  4.  Monitor VPS state change in the VPS view.


Changing VPS Ownership

sw3-1 changing ownership.png


Follow this procedure to change VPS owner:

  1.  In the Virtual Private Servers view, select the VPS for which you need to change owner.
  2.  If the VPS that you want to change is not visible in the list, perform a search.
  3.  Click the Change Owner button.
  4.  Change Owner dialog appears.
  5.  Select a new owner from the list and click the Change button to change ownership of the VPS.
Increasing VPS storage

Follow this procedure to increase VPS storage space:

  1. In the Virtual Private Servers view, select the VPS for which you need to increase storage space.
  2. If the VPS that you want to change is not visible in the list, perform a search.
  3. Select Storage tab and click the Extend Volume button.

    sw3 vps increase storage.png
  4. Extend Volume dialog appears.
  5. Select an amount you wish to increase storage space for and click the Extend button to increase storage.


Moving VPSs

A stopped VPS can be moved to any processing host within SERVERware network. This is especially useful if the load on a particular host is too high, and is essential before bringing a server down for maintenance. A live VPS migration is not yet supported. Also, while VPS is stopped, it is possible to move a VPS to another domain.

sw3 vps moving.png

Follow this procedure to move VPS to another host:

  1.  In the Virtual Private Servers view, select the VPS that you want to move.
  2.  If the VPS that you want to move is not visible in the list, perform a search.
  3.  Click the Move VPS button.
  4.  The Move VPS dialog appears.
  5.  Select Host Change as Move Type.
  6.  Select a destination host from the list and click the Move button to initiate move operation.
  7.  Monitor task progress in the VPS view. The host column should show a new host name for the moved VPS.

sw3 vps move.png


Follow this procedure to move VPS to another domain:

  1.  In the Virtual Private Servers view, select the VPS that you want to move.
  2.  If the VPS that you want to move is not visible in the list, perform a search.
  3.  Click the Move VPS button.
  4.  The Move VPS dialog appears.
  5.  Select Domain Change as Move Type.
  6.  Select a new Domain from the list and click the Move button to initiate move operation.
  7.  Monitor task progress in the VPS view. The domain should show a new name for the moved VPS.
Cloning VPSs

In SERVERware, a VPS can be cloned regardless if VPS is stopped or still running. This is especially useful for creating multiple instances of already configured and running VPSs.

Follow this procedure to clone VPS:

  1. In the Virtual Private Servers view, select the VPS that you want to clone.
  2. If the VPS that you want to clone is not visible in the list, perform a search.
  3. Click the Clone VPS button.
  4. The Clone VPS dialog appears.

    sw3-1 vpss copy.png
  5. Enter a description and a new name for a VPS and click the Clone button.
  6. Monitor task progress in the VPS view. The name column should show a new name for the cloned VPS.
  7. To finish configuration of VPS click Edit and then select Networking tab.
  8. On the Networking tab select the logical subnet to which you want to connect the VPS.
  9. Enter an IP Address belonging to the selected logical subnet and then click Save.
Removing VPSs

VPS can be removed only if it is stopped.

Follow this procedure to remove a VPS:

  1.  In the VPSs view, select VPS that needs to be removed.
  2.  Click the Remove button. A confirmation dialog appears.
  3.  Click Yes. VPS disappears from the list.
Removing VPSs from the Removed VPSs list

When removed, VPSs move to the Removed VPSs list which acts like a recycle bin as it is possible to restore listed VPSs.

sw3 vpss remove list.png

Removed VPS will be automatically removed from SERVERware inventory once their latest backup expires

Statistics

The SERVERware statistics module collects data about the resource usage by Hosts as well as VPSs. Data on a wide range of metrics is collected at frequent intervals, processed and archived in the SERVERware database.

View Host/VPS Performance Charts

The Statistics menu item provides access to a statistic charts view. The Statistics view consists of a chart settings pane and a chart view pane. On the statistic view you can see both Host and VPS performance charts as well as do a performance comparison between Hosts/VPSs. The following metrics are available on the chart settings:

  •  CPU Usage (Utilization/IO Wait)
  •  CPU Load
  •  Memory Usage
  •  Network Bandwidth Utilization
  •  Concurrent Calls

sw3 statistics.png

Follow this procedure to view Host/VPS performance charts:

  1. In the Statistics view select a view category. Select either Host Charts or VPS Charts depending on which statistics charts you want to show.
  2. Select which data series you want to show Average or Maximum.
  3. Select metrics that you want to show on the chart view pane.
  4. Select a period for which you want to show the performance charts.

    sw3 statistics custom range.png
  5. Select a Host/VPS which performance charts you want to show.
  6. Click the Compare button if you want to compare the performance of different Hosts/VPSs.

    sw3 statistics compare.png

Backup

In order to provide a fault tolerant storage, SERVERware relies on a mirrored pair of storage servers. Given that the storage mirror by definition and purpose is not a backup, SERVERware provides a built-in backup feature to protect data of hosted VPSs in the event of a disaster.

Manage Backup Jobs

The Backup menu item provides access to a backup schedule view. The Backup view consists of a list of scheduled backup jobs below which is a pane showing the backup job history for a selected backup job.

sw3 backup.png

The following properties of a backup job are displayed on the Backup view as well as on the Add and Edit dialog boxes.

 Field Description
 Name The backup job name. Provide a descriptive name.
 Frequency The frequency explain how often the backup job occurs. Available choices for the backup frequency are daily, weekly and monthly.
 Source The name of domain from which you want to backup VPSs. It may be an individual domain or all domains in the network.
 Destination The name of a host dedicated for backup. It may be the existing Network Storage host, however this is not recommended.
 Backup Type The type of backup. It may be either full or incremental.
 Backup Retention The backup retention specify how long backup sets are kept.
Schedule Backup Job

Follow this procedure to schedule a backup job:

  1. On the Backup view click Add Job button.
  2. The Create Backup Job dialog appears.

    sw3 create backup job.png
  3. Enter the details in the following fields:
    • Job Name: Descriptive backup job name (e.g. Daily Backup).
    • VPSs From: Select a source domain if you want to create a backup job for VPSs running on that domain only or leave default (All Domains) to backup all VPSs running on all domains.
    • Destination: Select a host for backup destination. It is recommended to have a dedicated host for storing backups.
    • Path: File system path on which to store backups.
    • Backup Type: Select either a full or incremental backup job type. The full backup type means that a full backup will always be performed at a set time and frequency. The incremental backup means that a full backup will be performed only once a week while incremental backup will be performed on other days.
Removing Backup Job

When removing a backup job, it is important to note that this action will not remove already created restore points, created by that backup job.

Follow this procedure to remove a backup job:

  1.  In the Backup view, select the backup job to be removed.
  2.  Click the Remove button. A confirmation dialog appears.
  3.  Click Yes. Backup job disappears from the list.
VPS Restore

VPS restoration will revert a VPS to a previously saved restore point. There are 2 types of restoration: Overwrite and Create New. For Overwrite procedure, VPS needs to be stopped. Create New will create a new copy of a VPS. Follow this procedure to restore a VPS:

  1. In the VPSs view select a VPS you wish to restore.
  2. From the menu select Restore VPS.

    sw3-1 restore vps.png
  3. Restore dialog appears. Select a restore point you wish to revert to.

    sw3-1 restore points.png
  4. If you want to create a new VPS without overwriting an existing one, in the new window, leave default settings selected, enter a new name and then click Restore. If you wish to Overwrite existing VPS, change Restore Type to Overwrite and click Restore.

    sw3-1 restore vps new.png

Settings

Settings menu expands into Storage, Networking and sipPROT.

sw3 settings menu.png

Storage

Storage view provides detailed information about storage hosts. Information provided is iSCSI IP Address and Storage Pools.

sw3 network storage.png

Advanced section allows you to enable/disable Failover to Storage, Processing on Storage options as well as set the Failover Timeout. Processing on Storage enables VPS creation on storage hosts. Running VPSs on storage hosts is not recommended but if needed, this additional option is available on Cluster Edition.

sw3 network high availability.png

Networking

Networking view allows you to add, configure and remove SERVERware network logical subnets.

sw3 network logical subnets edit.png

Adding logical subnet

To add a logical subnet, do the following:

  1. In the Settings menu, select Networking view and click Add.
  2. Add Subnet dialog appears. Select Type, enter Name and relevant network information. Check Use this subnet for VPS networking and provide bridge interface name if you need to use this subnet for VPS networking. Use netsetup to preconfigure bridge interface with the same name on all hosts in SERVERware cluster.

    sw3 network logical subnets add.png
  3. Click Add to add logical subnet.
Removing logical subnet

Follow this procedure to remove a logical subnet:

  1.  In the Settings menu, select Networking view.
  2.  Click Remove next to the logical subnet you want to remove. A confirmation dialog appears.
  3.  Click Yes. Logical subnet disappears from the list.
Extending IP address pool

To configure existing logical subnet, do the following:

  1. In the Settings menu, select Networking view, logical subnet you need to configure and click Configure. Configure Subnet dialog appears.

    sw3 network logical subnets configure.png
  2. To extend IP Pool, click on Extend button. Extend IP Address Pool dialog appears.

    sw3 network logical subnets extend.png
  3. Enter the IP address range to extend the pool and click Save to extend IP address pool.
  4. When done, click Close to exit Configure Subnet dialog.
Removing IP address from the pool
  1. In the Settings menu, select Networking view, logical subnet you need to configure and click Configure. Configure Subnet dialog appears.
  2. To remove an IP address from the pool, click on Release button next to IP address in the list. Confirmation dialog appears.

    sw3 domain ip address release.png
  3. Click Yes to release IP address.
  4. When done, click Close to exit Configure Subnet dialog.

sipPROT

sipPROT is a module for SERVERware, PBXware and serves as a protection against brute-force SIP attacks coming from the network. sipPROT view can be used to make configuration changes to the sipPROT General settings that will be relayed to the SERVERware Hosts, as well as perform a White List, Black List and Notification Recipients list maintenance.

sw3 sipprot.png

After making changes to the sipPROT General settings, click Save & Apply to save and apply new configuration.

sw3 sipprot lists.png

To update Lists, select Whitelist & Blacklist tab, enter Network or IP Address and click on Add button. To remove Network or IP Address from the List, click on the Remove button in the same line. Confirmation dialog appears. Click Yes to remove Network or IP Address. Changes made to the Lists are applied automatically.

sw3 sipprot notifications.png

To update Notification Recipients List, select Notification Recipients tab, select or search a user in the list and click on Add button. To remove Notification Recipient from the List, click on the Remove button in the same line. Confirmation dialog appears. Click Yes to remove Notification Recipient.


New menu item for sipPROT > Dynamic Blacklist, from list of blocked dresses in this menu one can unblock IP address manually or wait for timeout and block will be removed automatically.

sw3 sipprot dynamic.png

Reports

Reports menu expands into System Logs and User Sessions.

System Logs

All events that occur in SERVERware are recorded in System Logs. Apart from general information and system management, System Logs can also be used for debugging and analysis.

sw3 system logs.png

User Sessions

User Sessions view provides information on current connections to the SERVERware GUI as well as connection history and activity. The following information is provided: user, start/end time of connection, IP address and user agent.

sw3 user sessions.png

System Settings

System Settings mode allows you to manage various system settings in SERVERware.

sw3 system settings menu.png

To enter/exit System Settings mode, click on the button System Settings.

sw3 system settings.png

Administrators

Administrators menu allows creation, editing and removal of SERVERware GUI Administrators.

sw3 network administrators.png

Adding administrator account

Follow this procedure to add administrator account:

  1. In the Administrators view, click Add.
  2. Add User dialog appears. Select User Role, Status and enter personal user information.

    sw3 system settings add user.png
  3. Click Add to add administrator.

Removing administrator account

Follow this procedure to remove administrator account:

  1.  Select Administrators menu.
  2.  Select Remove from the dropdown menu next to the administrator account you want to remove. A confirmation dialog appears.
  3.  Click Yes. Administrator account disappears from the list.

Demoting administrator account to user account

Follow this procedure to demote an administrator account to a user account:

  1.  In the Administrators view, select Downgrade from the dropdown menu next to the administrator you want to demote. A confirmation dialog appears.
  2.  Click Yes. Administrator disappears from the list and appears in the list of Domain Users.

Domain Users

Domain Users menu allows creation, editing and removal of SERVERware GUI users as well as assignment of various roles and permissions.

sw3 system settings user accounts.png

Adding user account

Follow this procedure to add a user account:

  1. In the Domain Users view, click Add User.
  2. Add User dialog appears. Select User Role, Status and enter personal user information.

    sw3 system settings add user.png
  3. Click Add to add user.

Removing user account

Follow this procedure to remove a user account:

  1.  In the Domain Users view, select Remove User from the dropdown menu next to the user you want to remove. A confirmation dialog appears.
  2.  Click Yes. User disappears from the list.

Promoting user account to administrator account

Follow this procedure to promote a user account to an administrator account:

  1.  In the Domain Users view, select Upgrade from the dropdown menu next to the user you want to promote. A confirmation dialog appears.
  2.  Click Yes. User disappears from the list and appears in the list of Administrators.

Role & Permissions

Use Role & Permissions view to add, edit or remove roles and permissions that can be assign to the SERVERware GUI users.

sw3 system settings role permissions.png

Administrator

    •  Can manage all options available in the SERVERware GUI.

Domain administrators

Similar to global administrators except that their administrative access is limited to domain they have been assigned to.

Domain administrator can manage:

    •  Domain dashboard
    • VPS management
      •  Create VPS
      •  Edit VPS
      •  Delete VPS
      •  Start,Stop and restart VPS actions
    • Statistics
      •  Statistics per VPS (CPU USAGE, MEMORY USAGE, CONCURRENT CALLS, DISK TRAFFIC, DISK IOPS, LAN)
    •  Domain Users management (Add, Edit, Remove) Domain Admin, VPS Admin VPS Owner.


VPS Administrators

    • Have permissions to manage all VPSs in their domain.
      •  Create VPS
      •  Edit VPS
      •  Delete VPS
      •  Start,Stop and restart VPS actions


VPS Owners

    • Have permissions to manage their own VPSs only.
      •  Create VPS
      •  Edit VPS
      •  Delete VPS
      •  Start,Stop and restart VPS actions


Adding role

To add a role, do the following:

  1. In the Role & Permissions view and click Add Role.
  2. Add Role dialog appears. Enter name, description and set permissions.

    sw3 system settings add role.png
  3. Click Add to add role.

Removing role

Follow this procedure to remove a role:

  1.  Select Role & Permissions view.
  2.  Select Remove Role from the dropdown menu next to the role you want to remove. A confirmation dialog appears.
  3.  Click Yes. Role disappears from the list.

Service Pools

Service Pools tab allows you to add and remove service pools.

sw3 network service pools.png

Adding service pool

To add a new service pool, do the following:

  1. In the Service Pools view and click Add Service Pool.
  2. Enter Name, select Service Type and click Save.

    sw3 network service pools add.png

Removing service pool

Follow this procedure to remove a service pool:

  1.  Select Service Pools view.
  2.  Click Remove Service Pool next to the service pool you want to remove. A confirmation dialog appears.
  3.  Click Yes. Service pool disappears from the list.

Alarms

Alarms view is used for setup and configuration of various SERVERware alarms. Alarms can be configured to send notifications when specific conditions are met.

sw3 alarms.png

Adding alarm

To add an alarm, do the following:

  1. In the Alarms view, click Add Alarm. Configure New Alarm dialog appears.
  2. Select alarm state, monitoring target, enter name, description and click next.
  3. In the Triggers tab, select trigger, operator, enter warning and critical conditions, click Save Trigger and then click next.

    sw3 add vps alarm.png
  4. In the Notifications tab, configure notifications for individual alarm state changes by selecting Notify and by checking on delivery methods. When all notifications are configured, click next.

    sw3 add vps alarm notifications.png
  5. In the Recipients tab, select groups that will receive notifications and click Save to add new alarm.

Removing alarm

Follow this procedure to remove an alarm:

  1.  In the Alarms view, select Remove Alarm from the dropdown menu next to the alarm configuration you want to remove. A confirmation dialog appears.
  2.  Click Yes. Alarm disappears from the list.

Flavors

Under the Flavors menu, it is possible to add, edit and remove Virtual Server Flavors. Flavors represent preconfigured set of hardware resources that can be assigned to a VPS upon creation.

sw3 flavors.png

Adding flavor

To add a flavor, do the following:

  1.  In the Flavors view, click Add Flavor. Add Flavor dialog appears.
  2.  Enter Name, select CPU Priority and amount of Memory, Storage and click Create to create a new flavor.

Removing flavor

Follow this procedure to remove a flavor:

  1.  In the Flavors view, select Remove Flavor from the dropdown menu next to the flavor you want to remove. A confirmation dialog appears.
  2.  Click Yes. Flavor disappears from the list.

Templates

Templates are software packages used to initialize and deploy new VPSes from. For example, if you want to deploy a PBXware VPS on your SERVERware setup, you will use PBXware template to create a VPS from.

Templates section in System Settings can be used to install and/or remove SERVERware VPS templates. There are 2 template types: Service Templates and System Templates.

sw3 templates.png

Select System Templates tab to view system templates.

sw3 templates2.png

Installing new templates

To install a new template from the catalog, select service or system templates tab, click on Template Catalog and then click Install. Template download starts right after the confirmation window.

In SERVERware 3.1 when downloading templates, if the user select multiple templates for download, SERVERware will start downloading first one, and put others into a queue.

sw3 templates install.png

Notifications

SMTP/XMPP notification delivery settings can be configured in the Notifications section of System Settings.

sw3 notifications.png

To properly configure SMTP settings, enter all the relevant SMTP data and then click Save. Configured settings can be tested by clicking Send test e-mail button. If there is a need to configure SMTP notification delivery using SMTP server that does not require user credentials for authentication, change the Authentication to "Open". If the SMTP server does not support SSL from the start, change the Encryption type to "None". When encryption is "None", SERVERware SMTP client will automatically switch to the encrypted mode if STARTTLS mode is supported by the SMTP server, otherwise connection will stay unencrypted. In case that sending of a test mail fails, the corresponding error message will be visible through the system logs view.

Updates

Updates section of System Settings is used to update the various SERVERware components. The list on the right side shows the Name, Current Version and the Latest Version of the component that can be updated.

sw3 updates.png

The SERVERware controller will check for available package updates on a daily basis. Once the update is available the notification pop up message will appear on the top of the GUI screen every time admin user logs in. The popup dialogue window disappears after 10 seconds and provides a link to open the package update view if the administrator wants to proceed with updates.

Email notifications for new available updates will be sent to the system administrators as well.

sw3 update.popup.png


To update a SERVERware component, click Update button for that component. Update process starts after the confirmation window.

NOTE: If there is more than one component update, SERVERware connector should be the first component to be updated.


Updating Host SW-Connector

The sw-connector service agent running on hosts is a crucial component for a proper functioning of the SERVERware environment, so it has to be updated if there are new features or bug fixes. A host should be moved to maintenance mode before updating the sw-connector.

Follow this procedure to update sw-connector:

  1.  In the Host view, select the host which sw-connector has to be updated.
  2.  Move the host into maintenance mode.
  3.  Click the Update SW-Connector button.
  4.  Open the System Logs view to track the progress of updating.
  5.  When the update is complete, click the Enable button to enable host.

License

License menu shows details about installed SERVERware license and gives you the ability to update or change the license.

sw3 license.png

If your license has changed, to update the license, click Update License, enter a valid license number in the text box and click Apply. This will refresh the feature list supported on your instance of SERVERware.