SafeKit quick installation guide in GCP (farm.safe module for network load balancing and failover)

Overview of the SafeKit / GCP solution

Installation of the SafeKit / GCP solution on Windows and Linux (farm.safe)

Configuration of the Google GCP load balancer

The load balancer must be configured with a virtual IP address.
And the load balancer must be configured to periodically send health packets to nodes.
For that, SafeKit provides a health check which runs inside the nodes and which

returns OK when the farm module state is UP (green)
returns NOT FOUND in all other states

You must configure the Google GCP load balancer with:

HTTP protocol
port 9010, the SafeKit web server port
URL /var/modules/farm/ready.txt (if farm is the module name that you will deploy later)

For more information, see the configuration of the Google GCP load balancer.

Do not configure a virtual IP address and load balancing rules at step 4 in the step by step configuration below. The virtual IP address and load balancing rules are already set in the Google GCP load balancer. Setting a virtual IP and load balancing rules at step 4 is useful for on-premise configuration only.

Configuration of the Google GCP network security

The network security must be configured to enable communications for the following protocols and ports:

UDP - 4800 for the safeadmin service (between SafeKit nodes)
UDP - 4803 for the heartbeats inside the farm module (between SafeKit nodes)
TCP – 9010 for the load-balancer health check and for the SafeKit web console running in the http mode
TCP – 9001 to configure the https mode for the console
TCP – 9453 for the SafeKit web console running in https mode

Package installation on Windows

Download and install the free version of SafeKit on 2 Windows nodes.

Note: the free version includes all SafeKit features. At the end of the trial, you can activate permanent license keys without uninstalling the package.
Upon completing the package installation, select Set console credentials and firewall rules now and configure a password for the admin user of the SafeKit console.

Set the same password on all nodes.
Exclude from antivirus scans C:\safekit\ (the default installation directory) and all replicated folders that you are going to define.

Antiviruses may face detection challenges with SafeKit due to its close integration with the OS, virtual IP mechanisms, real-time replication and restart of critical services.

Package installation on Linux

Install the free version of SafeKit on 2 Linux nodes.

Note: the free trial includes all SafeKit features. At the end of the trial, you can activate permanent license keys without uninstalling the package.
After the download of safekit_xx.bin package, execute it to extract the rpm and the safekitinstall script and then execute the safekitinstall script
Answer yes to firewall automatic configuration
Set the password for the web console and the default user admin.

Set the same password on all nodes.

Step by step configuration of the SafeKit / GCP solution

2. Configure node addresses

Enter the node IP addresses, press the Tab key to check connectivity and fill node names.
Then, click on Save and apply to save the configuration.

If either node1 or node2 has a red color, check connectivity of the browser to both nodes and check firewall on both nodes for troubleshooting.

In a farm architecture, you can define more than 2 nodes.

If you want, you can add a new LAN for a second heartbeat.

If you click on Advanced configuration, the cluster.xml file is displayed. This file, automatically populated by the console, is the one that will be deployed on the nodes.

4. Configure the module

In Module startup at boot, choose an automatic start of the module at boot without delay.
In Macros / SERVICES, enter the service names of your application, in the startup order, separated by commas.
In Heartbeat networks, you should have a single heartbeat network except if you have added a LAN at step 2.
In Virtual IP addresses, enter a virtual IP address. A virtual IP address is a standard IP address in the same IP network (same subnet) as the IP addresses of both nodes.
Application clients must be configured with the virtual IP address (or the DNS name associated with the virtual IP address).
In Load balancing rules, set the service port to load balance (ex.: TCP 80 for HTTP, TCP 443 for HTTPS, TCP 9010 in the example).
In Load balancing rules, set the load balancing rule, Source address or Source port:
- with the source IP address of the client, the same client will be connected to the same node in the farm on multiple TCP sessions and retrieve its context on the node.
- with the source TCP port of the client, the same client will be connected to different nodes in the farm on multiple TCP sessions (without retrieving a context).
In Checkers, you will be able to configure checkers if needed, such as process monitoring, custom checkers, TCP, ping, or split-brain checkers.
For example, if a process name is displayed in Monitored processes/services, it will be monitored with a restart action in case of failure. Configuring a wrong process name will cause the module to stop right after its start.

If you click on Advanced configuration, the userconfig.xml file is displayed. This file, automatically populated by the console, is the one that will be deployed on the nodes along with the restart scripts.

5. Edit scripts (optional)

This step is optional and can be skipped in most cases, as the restart scripts are already pre-configured to restart services defined in the previous step.
So, click directly on Next step.
start_both.ps1 starts all services in the order specified in the SERVICES list, while stop_both.ps1 stops all services in the reverse order.
Additionally, start_both.ps1 checks the startup of each service and stops the module if any service fails to start correctly.
During module configuration, the boot startup of services will automatically be set to ‘Manual’. This ensures that services do not start automatically upon system boot, but instead, they will be initiated only when the module itself is started.

10. Wait for the transition to UP (green) / UP (green)

Node 1 and node 2 should reach the UP (green) state, which means that the start_both script has been executed on node 1 and node 2.

If UP (green) is not reached or if the application is not started, analyze why with the module log of node 1 or node 2.

click the "log" icon of node1 or node2 to open the module log and look for error messages such as a checker detecting an error and stopping the module.
click on start_both in the log: output messages of the script are displayed on the right and errors can be detected such as a service incorrectly started.

11. Testing

SafeKit brings a built-in test in the product:

- Configure a rule for TCP port 9010 with a load balancing on source TCP port.
- Connect an external workstation outside the farm nodes.
- Start a browser on http://virtual-ip:9010/safekit/mosaic.html.

You should see a mosaic of colors depending on nodes answering to HTTP requests.

Stop one UP (green) node by scrolling down its contextual menu and clicking Stop.
Check that there is no more TCP connections on the stopped node and on the virtual IP address.

Find more details, along with videos, in the SafeKit Online Training.

🔍 SafeKit High Availability Navigation Hub

Explore SafeKit: Features, technical videos, documentation, and free trial
Resource Type	Description	Direct Link
Key Features	Why Choose SafeKit for Simple and Cost-Effective High Availability?	See Why Choose SafeKit for High Availability
Deployment Model	All-in-One SANless HA: Shared-Nothing Software Clustering	See SafeKit All-in-One SANless HA
Partners	SafeKit: The Benchmark in High Availability for Partners	See Why SafeKit Is the HA Benchmark for Partners
HA Strategies	SafeKit: Infrastructure (VM) vs. Application-Level High Availability	See SafeKit HA & Redundancy: VM vs. Application Level
Technical Specifications	Technical Limitations for SafeKit Clustering	See SafeKit High Availability Limitations
Proof of Concept	SafeKit: High Availability Configuration & Failover Demos	See SafeKit Failover Tutorials
Architecture	How the SafeKit Mirror Cluster works (Real-Time Replication & Failover)	See SafeKit Mirror Cluster: Real-Time Replication & Failover
Architecture	How the SafeKit Farm Cluster works (Network Load Balancing & Failover)	See SafeKit Farm Cluster: Network Load Balancing & Failover
Competitive Advantages	Comparison: SafeKit vs. Traditional High Availability (HA) Clusters	See SafeKit vs. Traditional HA Cluster Comparison
Technical Resources	SafeKit High Availability: Documentation, Downloads & Trial	See SafeKit HA Free Trial & Technical Documentation
Pre-configured Solutions	SafeKit Application Module Library: Ready-to-Use HA Solutions	See SafeKit High Availability Application Modules
FAQ	Frequently Asked Questions on Architecture, Technical specs, Features	See SafeKit HA FAQ

SafeKit Quick Installation Guide for GCP (farm.safe Module)

With the Network Load Balancing and Automatic Failover Provided by Evidian SafeKit

High Availability Quick Installation Guide for GCP

1. Overview

2. Installation

3. Configuration

Overview of the SafeKit / GCP solution

Installation of the SafeKit / GCP solution on Windows and Linux (farm.safe)

Configuration of the Google GCP load balancer

Configuration of the Google GCP network security

Package installation on Windows

Package installation on Linux

Step by step configuration of the SafeKit / GCP solution

1. Launch the SafeKit console

2. Configure node addresses

3. Select a module

4. Configure the module

5. Edit scripts (optional)

6. Communication encryption (optional)

7. Save and apply

8. Verify successful configuration

9. Start the farm cluster on node 1 and node 2

10. Wait for the transition to UP (green) / UP (green)

11. Testing

12. Support

🔍 SafeKit High Availability Navigation Hub