Skip to content

Quickstart: ZFS Cluster

This page goes through a basic setup for a RSF-1 High Availability cluster. After completion you should have a working Active-Active cluster with a service sharing out your storage/data via a Virtual Hostname ready for failover when the situation arises.

Please make sure that any firewalls on your cluster have the following ports open before attempting configuration:

- 1195 (TCP & UDP)
- 4330 (TCP)

Configuring with the GUI

To connect to the RSF-1 GUI, direct your web browser to:

https://<hostname>:4330

First, create the admin user account for the GUI. Provide a non-empty password in the provided fields and click the Submit button when ready.

QS image 1

Once you click the Submit button, the admin user account will be created and you will be taken to the login screen. Login with the username admin + the password you have just created.

QS image 2

The first page you see after login is the dashboard page. It will look like this after a fresh install:

QS image 3

RSF-1 Configuration & Licensing through the GUI

Note: Before doing the following steps, make sure your /etc/hosts file is configured correctly on both nodes. Your hostname can't be directed to 127.0.0.1, and both of your nodes should be resolvable. Below is a correctly configured example:

127.0.0.1 localhost localhost.localdomain
::1 localhost localhost.localdomain
10.10.6.2 nodo1
10.10.6.3 nodo2

To begin the cluster creation process, click on Create/Destroy option either in the side-menu or in the panel on the Dashboard page. Upon visiting the Cluster Create page, a scan will be performed to locate any nodes that are ready for clustering.

QS image 4

When the scan is complete, a list of nodes that can be clustered will be displayed:

QS image 5

Select the nodes you want to cluster by clicking the Add to Cluster toggle.

If any of the selected nodes are unlicensed for use with RSF-1, a licensing panel will be shown:

QS image 6

If you want to automatically obtain a temporary evaluation license, enter a valid email address and click the Licence button.

At this point, the RSF-1 End User License Agreement (EULA) will be displayed. Click accept to proceed.

QS image 7

Once the license keys have been successfully installed, click the Create Cluster button to initialize the cluster. When the cluster has been created, you will be able to choose between being taken to the dashboard or to start adding services to the cluster.

QS image 8

Managing Pools

Before being able to create a service for your pool, you will need to have your pools imported on one of your nodes. Click the Pools option on the side menu to check the status:

QS image Pools 1

To import the pools to create your service with, find your pool by filtering by Cluster State, and/or searching by the pool GUID using the search box.

Once located, you can view more information on the pool by clicking the details button:

QS image Pools 2

Click the Import button to import the pool on to the node that you are currently logged into. The Cluster Status of the pool should now change to CLUSTERABLE. If there are any problems with the pool (for example it can't be imported/exported on both nodes), the status will show UNCLUSTERABLE.

QS image Pools 3

You should now be able to create a service with your imported pools.

Creating Services and Adding Volumes

Before proceeding, make sure you are able to export and import your pools on both nodes using the "zpool import/export" command.

Click the Services option on the side-menu to go to the services page. You will be presented with a panel like the one shown below:

QS image 9

Click on the Add Services button to search for pools that are suitable for clustering.

In this example we have four ZFS pools, pool1, pool2, pool3 and pool4 that have already been created and imported using the zpool create command. To begin configuration, select a pool from the list and click the Create button.

QS image 10

Here we are going to configure a service for pool1 on nodes mgc71 and mgc72. You are now shown the configuration options for the service:

QS image 11

Add a Virtual hostname to the service by clicking on the Add button in the Virtual Hostname panel.

QS image 12

Enter the Virtual Hostname you want to use into the field as well as an IP Address this hostname will resolve to along with the associated netmask.

If the nodes have multiple network interfaces, you can select the interface you want to use for cluster traffic on each node by selecting it from the corresponding drop-down list.

You can confirm that the Virtual Hostname configuration has been added by observing its entry in the Virtual Hostname panel:

QS image 13

You can click the Modify button to modify the configuration if you need to, or click the Remove button to drop the hostname from the service config.

Click the Create button at the bottom of the page to continue. You are now presented with a configuration summary for the service you are about to add to the cluster.

QS image 14

Confirm the details are correct and click Confirm to add the service to the cluster.

RSF-1 Status with the GUI

To view the current cluster status, click on the Cluster Control option in the side-menu to access the Cluster Control page.

QS image 15

This screen shows the location of each service and the respective Pool States and Failover Modes. It also allows the operator to stop, start and move services throughout the cluster. Click on the Actions button of the pool you want to operate on to see what actions are possible. The following screenshot shows the operations available on mgc71 for pool1.

QS image 16

Moving Services between Cluster Nodes

In this example, we want to move the service pool1 from mgc71 to mgc72.

QS image 17

During this process, pool1 will be stopped on mgc71 and then restarted on mgc72.

QS image 18

Once this move has completed, mgc72 is now running pool1.

QS image 19

Viewing Cluster Heartbeats with the GUI

In addition to the cluster control page, you can also view the cluster heartbeat information by clicking the Heartbeats option on the left side-menu. The status of the current heartbeats in the cluster are displayed.

QS image 20

Adding Additional Network Heartbeats with the GUI

Additional network heartbeats can be added from teh Heartbeats page. In the worked example, we also have a private network connection between the two servers, named mgc71-priv and mgc72-priv respectively. To add network heartbeats using these private addresses, click on the Add Network Heartbeat button.

In this example, we are going to add a heartbeat connection between mgc71 and mgc72-priv and between mgc72 and mgc71-priv :

QS image 21

Click Submit to submit the new heartbeat link addition. Review that the actions about to be taken are correct. Click Confirm to confirm the addition.

The new heartbeat is now displayed on the Heartbeats status page.

QS image 22

This completes basic cluster configuration.