Difference between revisions of "Docs/Failover"

From Userful Support
Jump to: navigation, search
Line 9: Line 9:
 
==Introduction==
 
==Introduction==
  
'''Failover''' feature provides maximum possible uptime for the displays. Failover requires two Userful hosts to be located on the same subnet; if that is the case, then if one host fails, the "Backup" host "take over" the network zero-client devices of the "failed" host.<br>
+
'''Failover''' feature provides maximum possible uptime for the displays. Failover requires two Userful servers to be located on the same subnet; if that is the case, then if Primary server fails, the Secondary server takes over the network zero-client devices of the Primary i.e. failed server.<br>
  
 
This page outlines best practices and steps to take when preparing for and executing failover procedures using network zero clients.
 
This page outlines best practices and steps to take when preparing for and executing failover procedures using network zero clients.
  
'''Note:''' This feature is '''NOT''' applicable for USB zero clients, since USB zero clients will be connected to a specific Userful host only.
+
'''Note:''' This feature is '''NOT''' applicable for USB zero clients, since USB zero clients will be connected to a specific Userful server only.
  
 
===Requirements===
 
===Requirements===
 
Before configuring failover group, following requirements and caveats must be met:
 
Before configuring failover group, following requirements and caveats must be met:
* Primary-Backup relationship
+
* Primary-Secondary relationship
: Although all members in the failover group are equivalent; we still suggest that user should indicate one host as the "primary" and the other as the "backup"
+
: Although all members in the failover group are equivalent; we still suggest that user should indicate one server as the '''Primary''' and the other as the '''Secondary'''
 
   
 
   
: '''Primary''' is the host with assigned displays that is added first when a failover group is created
+
: '''Primary''' is the server with assigned displays that is added first when a failover group is created
: '''Backup''' is the host that should have only onboard display running (i.e., without any assigned display)
+
: '''Secondary''' is the server with only onboard display running (i.e., without any assigned display)
  
 
* Same hardware specifications
 
* Same hardware specifications
: Both Userful hosts should have similar hardware specifications
+
: Both Userful servers should have similar hardware specifications
  
 
* Same working environment
 
* Same working environment
: Both Userful hosts should have identical version of all the software packages (specially the "userful-control-center" package)<br>
+
: Both Userful servers should have identical version of all the software packages (specially the "userful-control-center" package)<br>
  
 
* Same media content
 
* Same media content
: Any local content must be added manually to both hosts and CMS subscription may be required for both hosts
+
: Any local content must be added manually to both servers and CMS subscription may be required for both hosts
  
 
* Same license
 
* Same license
: Both Userful hosts should have identical licenses, please contact Userful Sales Representative or send an email to [mailto:sales@userful.com  sales@userful.com] for more details
+
: Both Userful servers should have identical licenses, please contact Userful Sales Representative or send an email to [mailto:sales@userful.com  sales@userful.com] for more details
 
<br>
 
<br>
  
 
===Setting Failover Group===
 
===Setting Failover Group===
 
[[File:Enable_Failover.png|300px|right]]
 
[[File:Enable_Failover.png|300px|right]]
The first step in setting failover group is to ''Enable Failover'' on the Userful host to be configured as '''Primary''' host.
+
The first step in setting failover group is to ''Enable Failover'' on the '''Primary''' server.
  
# Open <tt>Control Center > Settings > Failover Group Settings</tt>
+
# Open <tt>Control Center > Settings > Failover Group Settings.</tt>
# Select "Enable Failover"
+
# Select "Enable Failover".
# Allow UCC to restart
+
# Allow Control Center to restart.
 
<br clear="all"/>
 
<br clear="all"/>
  
 
[[File:FG1.png|300px|right]]
 
[[File:FG1.png|300px|right]]
 
[[File:FG2.png|300px|right]]
 
[[File:FG2.png|300px|right]]
The next step is to define the failover group, i.e. the failover relation between two hosts.
+
The next step is to define the failover group, i.e. the failover relation among two servers.
 
: Follow the below mentioned steps to define failover group:
 
: Follow the below mentioned steps to define failover group:
# Open Control Center of the Userful host (to be configured as "Primary" host)
+
# Open Control Center of the "Primary" server.
 
# Go to <tt>Settings > Failover Group Settings</tt>
 
# Go to <tt>Settings > Failover Group Settings</tt>
# In the pop-up window, enter the Failover Group Name and click “Create Failover Group” to create a new group
+
# Enter the Group Name and click "Create Group" to create a new group.
# Once created, the hostname of the "Primary" host would be listed under “Failover Group Members”
+
 
 +
<br clear="all"/>
 +
[[File:Failover_Settings2.png|300px|right]]
 +
 
 +
# Once the failover group is created, the name of the "Primary" server will be listed under "Servers".<br>
 +
# Select the Failback Setting to be "Automatic" or "Manual" depending on the use case.
 +
 
 +
 
 +
: "Failback" occurs once the Primary server comes back online where the failed over displays from the Secondary server will be re-assigned back to the Primary server. This failback can happen automatically or manually as mentioned above.
 +
 
 
<br clear="all"/>
 
<br clear="all"/>
<br>
 
  
 
[[File:FG3.png|300px|right]]
 
[[File:FG3.png|300px|right]]
[[File:FG4.png|300px|right]]
+
 
Now login to the second host to be configured as '''Backup''' host'''<br>
+
:Next step is to log in to the Secondary server.
 
<ol start="1">
 
<ol start="1">
<li> Open <tt>Control Center > Settings > Failover Group Settings</tt></li>
+
<li> Open Control Center.</li>
<li> Select "Enable Failover" and allow UCC to restart </li>
+
<li> Go to <tt>Settings > Failover Group Settings</tt>.</li>
<li> Again open <tt> Control Center </tt>
+
<li> Select "Enable Failover" and allow Control Center to restart. </li>
<li> Go to <tt> Settings > Failover Group Settings </tt> to open "Failover Group Settings" dialog window, select “Join an Existing Group” option and click “Join Failover Group” button </li>
+
<li> Again open <tt> Control Center.</tt></li>
<li> The newly added Userful host is now listed under “Failover Group Members”</li>
+
<li> Go to <tt> Settings > Failover Group Settings. </tt></li>
 +
<li> Create a new group or Join an existing group from the drop-down menu as shown in the image.</li>
 +
<li> Click “Join Group” button. </li>
 +
'''Note:''' Joining an existing failover group will copy and overwrite current display mapping with the display mapping from the failover group's shared database.
 
</ol>
 
</ol>
  
 
<br clear="all"/>
 
<br clear="all"/>
'''Note:''' When a new host is added to an existing failover group, the sources and other settings of the "Primary" host gets copied to the newly added host automatically. Blackmagic Capture source and Video Capture source will not get copied on the "Backup" host as the capture card is directly connected to the "Primary" host.<!--VDI Phase-out 16207 and also Virtual Machine source will not work as VM is copied in the "primary" host managed through VirtualBox Manager.-->
+
 
 +
[[File:FG4.png|300px|right]]
 +
: The newly added Secondary server is now listed under the list of servers.
 +
 
 +
<br clear="all"/>
 +
'''Note:''' When a new server is added to an existing failover group, the sources and other settings of the "Primary" server gets copied to the newly added server automatically. Blackmagic Capture source and Video Capture source will not get copied on the "Secondary" server as the capture card is directly connected to the "Primary" server.<!--VDI Phase-out 16207 and also Virtual Machine source will not work as VM is copied in the "primary" host managed through VirtualBox Manager.-->
 
<br>
 
<br>
 
<br>
 
<br>
 
Follow the below mentioned steps to test the Failover process:
 
Follow the below mentioned steps to test the Failover process:
 +
[[File:FG_5.png|300px|right]]
 +
 +
[[File:FG6.png|300px|right]]
 
<ol start="1">
 
<ol start="1">
<li> Ensure that the “Primary” host and “Backup” host are both online under the same subnet</li>
+
<li> Ensure that the “Primary” server and “Secondary” server are both online under the same subnet.</li>
<li> Shutdown the "Primary" host or unplug the network cable from the Primary host</li>
+
<li> Shutdown or unplug the network cable from the "Primary" server</li>
<li> Within few seconds, the displays that were assigned to the Primary (failed) host should come back online. These displays are now running on the Backup host as failover displays<br>
+
<li> Within few seconds, the displays that were assigned to the Primary (failed) server should come back online, but these displays are now running on the "Secondary" server as failover displays<br>
 
Please note that the failover displays have orange display icon with display ID [[Image:Failover_Display.png|40px]]</li>
 
Please note that the failover displays have orange display icon with display ID [[Image:Failover_Display.png|40px]]</li>
<li> Reboot the "Primary" host or plug the network cable back to the Primary host </li>
+
<li> Reboot or plug the network cable back to the Primary host. </li>
<li> Within few seconds, all failover displays will unassign from the Backup host and restored back to the Primary host automatically</li>
+
<li> Within few seconds, all failover displays will unassign from the "Secondary" server and restored back to the "Primary" server automatically or manually depending on the Failback Setting selected.</li>
 
</ol>
 
</ol>
<br>
+
: Images shown in the right show the messages that will appear while displays failback from Secondary server to the Primary server.
 +
 
 +
 
 
{|{{Notes}}
 
{|{{Notes}}
 
|
 
|

Revision as of 17:36, 12 April 2018



Copyright © 2019 Userful Corporation. All rights reserved.
(Updated 2018.04.12)

To return to the main documentation page, Click Here.


Introduction

Failover feature provides maximum possible uptime for the displays. Failover requires two Userful servers to be located on the same subnet; if that is the case, then if Primary server fails, the Secondary server takes over the network zero-client devices of the Primary i.e. failed server.

This page outlines best practices and steps to take when preparing for and executing failover procedures using network zero clients.

Note: This feature is NOT applicable for USB zero clients, since USB zero clients will be connected to a specific Userful server only.

Requirements

Before configuring failover group, following requirements and caveats must be met:

  • Primary-Secondary relationship
Although all members in the failover group are equivalent; we still suggest that user should indicate one server as the Primary and the other as the Secondary
Primary is the server with assigned displays that is added first when a failover group is created
Secondary is the server with only onboard display running (i.e., without any assigned display)
  • Same hardware specifications
Both Userful servers should have similar hardware specifications
  • Same working environment
Both Userful servers should have identical version of all the software packages (specially the "userful-control-center" package)
  • Same media content
Any local content must be added manually to both servers and CMS subscription may be required for both hosts
  • Same license
Both Userful servers should have identical licenses, please contact Userful Sales Representative or send an email to sales@userful.com for more details


Setting Failover Group

Enable Failover.png

The first step in setting failover group is to Enable Failover on the Primary server.

  1. Open Control Center > Settings > Failover Group Settings.
  2. Select "Enable Failover".
  3. Allow Control Center to restart.


FG1.png
FG2.png

The next step is to define the failover group, i.e. the failover relation among two servers.

Follow the below mentioned steps to define failover group:
  1. Open Control Center of the "Primary" server.
  2. Go to Settings > Failover Group Settings
  3. Enter the Group Name and click "Create Group" to create a new group.


Failover Settings2.png
  1. Once the failover group is created, the name of the "Primary" server will be listed under "Servers".
  2. Select the Failback Setting to be "Automatic" or "Manual" depending on the use case.


"Failback" occurs once the Primary server comes back online where the failed over displays from the Secondary server will be re-assigned back to the Primary server. This failback can happen automatically or manually as mentioned above.


FG3.png
Next step is to log in to the Secondary server.
  1. Open Control Center.
  2. Go to Settings > Failover Group Settings.
  3. Select "Enable Failover" and allow Control Center to restart.
  4. Again open Control Center.
  5. Go to Settings > Failover Group Settings.
  6. Create a new group or Join an existing group from the drop-down menu as shown in the image.
  7. Click “Join Group” button.
  8. Note: Joining an existing failover group will copy and overwrite current display mapping with the display mapping from the failover group's shared database.


FG4.png
The newly added Secondary server is now listed under the list of servers.


Note: When a new server is added to an existing failover group, the sources and other settings of the "Primary" server gets copied to the newly added server automatically. Blackmagic Capture source and Video Capture source will not get copied on the "Secondary" server as the capture card is directly connected to the "Primary" server.

Follow the below mentioned steps to test the Failover process:

FG 5.png
FG6.png
  1. Ensure that the “Primary” server and “Secondary” server are both online under the same subnet.
  2. Shutdown or unplug the network cable from the "Primary" server
  3. Within few seconds, the displays that were assigned to the Primary (failed) server should come back online, but these displays are now running on the "Secondary" server as failover displays
    Please note that the failover displays have orange display icon with display ID Failover Display.png
  4. Reboot or plug the network cable back to the Primary host.
  5. Within few seconds, all failover displays will unassign from the "Secondary" server and restored back to the "Primary" server automatically or manually depending on the Failback Setting selected.
Images shown in the right show the messages that will appear while displays failback from Secondary server to the Primary server.


Please Note:

  • Failover is designed to automatically transition to the designated backup system in the event of an unrecoverable failure of the primary host system. Restoration from the backup state is currently manual and some care must be taken when restoring the host system to ensure that the failback process is smooth.
  • If you have a specialized failover need, please contact Userful Sales Representative or send an email to sales@userful.com with details of your use-case.


Related Links