SafeKit quick installation guide with Oracle (oracle.safe mirror module)

SafeKit quick installation guide for Oracle on Windows and Linux

Package installation on Windows

Download 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.
To open the Windows firewall, on both nodes start a powershell as administrator, and type
```
c:/safekit/private/bin/firewallcfg add
```
To initialize the password for the default admin user of the web console, on both nodes start a powershell as administrator, and type
```
c:/safekit/private/bin/webservercfg.ps1 -passwd pwd
```
1. Use aphanumeric characters for the password (no special characters).
2. pwd must be the same on both 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.
1. Use aphanumeric characters for the password (no special characters).
2. The password must be the same on both nodes.

Step by step configuration

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.

If you want, you can add a new LAN for a second heartbeat and for a dedicated replication network.

This operation will place the IP addresses in the cluster.xml file on both nodes (more information in the training with the command line).

4. Configure the module

Choose an Automatic start of the module at boot without delay.
Normally, you have a single Heartbeat network on which the replication is made. But, you can define a private network if necessary (by adding a LAN at step 2).
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).
The virtual IP address is automatically switched in the event of a failure.
Check that the Replicated directories are installed on both nodes and contain the application data.
Data and log replication are essential for a database..
You can create additional replicated directories as required.
Note that 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 (example with Microsoft SQL Server).

5. Edit scripts (optional)

start_prim and stop_prim must contain starting and stopping of the Oracle application (example provided for Microsoft SQL Server on the right).
You can add new services in these scripts.
Check that the names of the services started in these scripts are those installed on both nodes, otherwise modify them in the scripts.
On Windows and on both nodes, with the Windows services manager, set Boot Startup Type = Manual for all the services registered in start_prim (SafeKit controls the start of services in start_prim).

9. Start the node with up-to-date data

If node 1 has the up-to-date replicated directories, select it and start it As primary.

When node 2 will be started, all data will be copied from node 1 to node 2.

If you make the wrong choice, you run the risk of synchronizing outdated data on both nodes.

It is also assumed that the Oracle application is stopped on node 1 so that SafeKit installs the replication mechanisms and then starts the application in the start_prim script.

Use Start for subsequent starts: SafeKit retains the most up-to-date server. Starting As primary is a special start-up the first time or during exceptional operations.

10. Wait for the transition to ALONE (green)

Node 1 should reach the ALONE (green) state, which means that the virtual IP is set and that the start_prim script has been executed on node 1.

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

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

If the cluster is in WAIT (red) not uptodate, STOP (red) not uptodate state, stop the WAIT node and force its start as primary.

13. Testing

Stop the PRIM node by scrolling down its contextual menu and clicking Stop.
Verify that there is a failover on the SECOND node which should become ALONE (green).
And with Microsoft Management Console (MMC) on Windows or with command lines on Linux, check the failover of Oracle services (stopped on node 1 in the stop_prim script and started on node 2 in the start_prim script).

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

click the "log" icon of 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_prim in the log: output messages of the script are displayed on the right and errors can be detected such as a service incorrectly started.

If everything is okay, initiate a start on node1, which will resynchronize the replicated directories from node2.

If things go wrong, stop node2 and force the start as primary of node1, which will restart with its locally healthy data at the time of the stop.

More information on tests in the User's Guide.

15. If necessary, configure a splitbrain checker

See below "What are the different scenarios in case of network isolation in a cluster?" to know if you need to configure a splitbrain checker.
Go to the module configuration and click on Checkers / Splitbrain (see image) to edit the splitbrain parameters.
Save and apply the new configuration to redeploy it on both nodes (module must be stopped on both nodes to save and apply).

Parameters:

Resource name identifies the witness with a resource name: splitbrain.witness. You can change this value to identify the witness.
Witness address is the argument for a ping when a node goes from PRIM to ALONE or from SECOND to ALONE. Change this value with the IP of the witness (a robust element, typically a router).
Note: you can set several IPs separated by white spaces. Pay attention that the IP addresses must be accessible from one node but not from the other in the event of network isolation.

When there is a network isolation, the behavior with a split-brain checker is:

a split-brain checker has been configured with the IP address of a witness (typically a router),
the split-brain checker operates when a server goes from PRIM to ALONE or from SECOND to ALONE,
in case of network isolation, before going to ALONE, both nodes test the IP address,
the node which can access the IP address goes to ALONE, the other one goes to WAIT,
when the isolation is repaired, the WAIT node resynchronizes its data and becomes SECOND.

Note: If the witness is down or disconnected, both nodes go to WAIT and the application is no more running. That's why you must choose a robust witness like a router.

Internals

Internals of a SafeKit / Oracle high availability cluster with synchronous replication and failover

Go to the Advanced Configuration tab in the console, for editing these files

Internal files of the Windows oracle.safe module

userconfig.xml on Windows (description in the User's Guide)

<!DOCTYPE safe>
<safe>
<macro name="ORACLE_SID" value="ORACLE_SID_TO_BE_DEFINED" />
<macro name="ORACLE_HOME_NAME" value="ORACLE_HOME_NAME_TO_BE_DEFINED" />
<service mode="mirror" defaultprim="alone" maxloop="3" loop_interval="24" failover="on">
  <!-- Heartbeat Configuration -->
  <!-- Names or IP addresses on the default network are set during initialization in the console -->
  <heart pulse="700" timeout="30000">
    <heartbeat name="default" ident="flow">
    </heartbeat>
  </heart>
  <!-- Virtual IP Configuration (used by Oracle SQL*Net Listener) -->
  <!-- Replace
     * VIRTUAL_TO_BE_DEFINED by the IP address of your virtual server 
  --> 
  <vip>
    <interface_list>
        <interface check="on" arpreroute="on">
           <real_interface>
               <virtual_addr addr="VIRTUAL_TO_BE_DEFINED" where="one_side_alias" />
          </real_interface>
        </interface>
    </interface_list>
  </vip>
  <!-- Software Error Detection Configuration -->
  <errd polltimer="10">
    <!-- Oracle databases 
    For monitoring one specific oracle instance, insert the attribute
    argregex="{.*SID.*}" where SID is the name of the DataBase
    -->
    <proc name="oracle.exe" atleast="1" action="restart" class="prim" />
    <proc name="tnslsnr.exe" atleast="1" action="restart" class="prim" />
  </errd>
  <!-- File Replication Configuration -->
  <!-- Replace
     * ORACLE_DATA_TO_BE_DEFINED by the path of your Oracle database directory and transaction logs
  -->
  <rfs async="second" acl="off" nbrei="3">
    <replicated dir="ORACLE_DATA_TO_BE_DEFINED" mode="read_only" />
  </rfs>
  <!-- User scripts Configuration / Environment variables -->
  <user nicestoptimeout="300" forcestoptimeout="300" logging="userlog">
    <var name="ORACLE_SID" value="%ORACLE_SID%" /> <!-- values defined in macro above -->
    <var name="ORACLE_HOME_NAME" value="%ORACLE_HOME_NAME%" />
  </user>
</service>
</safe>

start_prim.cmd on Windows

@echo off
rem Script called on the primary server for starting application services 

rem For logging into SafeKit log use:
rem "%SAFE%safekit" printi | printe "message"

rem stdout goes into Application log
echo "Running start_prim %*" 

set res=0

net start "OracleDbConsole%ORACLE_SID%" > nul
if not %errorlevel% == 0 goto stop
%SAFE%safekit printi "OracleDbConsole%ORACLE_SID% started"

net start "OracleService%ORACLE_SID%" > nul
if not %errorlevel% == 0 goto stop
%SAFE%safekit printi "OracleService%ORACLE_SID% started"

net start "Oracle%ORACLE_HOME_NAME%TNSListener" > nul
if not %errorlevel% == 0 goto stop
%SAFE%safekit printi "Oracle%ORACLE_HOME_NAME%TNSListener started"

if %res% == 0 goto end

:stop
set res=%errorlevel%
%SAFE%safekit printi "Oracle start failed"

rem uncomment to stop SafeKit when critical
rem %SAFE%safekit stop -i "start_prim"

:end

stop_prim.cmd on Windows

@echo off
rem Script called on the primary server for stopping application services 

rem ----------------------------------------------------------
rem
rem 2 stop modes:
rem
rem - graceful stop
rem   call standard application stop with net stop
rem
rem - force stop (%1=force)
rem   kill application's processes
rem
rem ----------------------------------------------------------

rem For logging into SafeKit log use:
rem "%SAFE%safekit" printi | printe "message"

rem stdout goes into Application log
echo "Running stop_prim %*" 

set res=0

rem default: no action on forcestop
if "%1" == "force" goto end

net stop OracleService%ORACLE_SID% > nul
%SAFE%safekit printi "OracleService%ORACLE_SID% stopped"

net stop  OracleDBConsole%ORACLE_SID% > nul
%SAFE%safekit printi "OracleDBConsole%ORACLE_SID% stopped"

net stop  Oracle%ORACLE_HOME_NAME%TNSListener > nul
%SAFE%safekit printi "Oracle%ORACLE_HOME_NAME%TNSListener stopped"

rem wait a little for a real stop of services
%SAFEBIN%sleep 10

:end

Internal files of the Linux oracle.safe module

userconfig.xml on Linux (description in the User's Guide)

<!DOCTYPE safe>
<safe>
<macro name="ORACLE_HOME" value="PATH_TO_BE_DEFINED" />
<macro name="ORACLE_DBA" value="USER_TO_BE_DEFINED" />
<service mode="mirror" defaultprim="alone" maxloop="3" loop_interval="24" failover="on">
  <!-- Heartbeat Configuration -->
  <!-- Names or IP addresses on the default network are set during initialization in the console -->
  <heart pulse="700" timeout="30000">
    <heartbeat name="default" ident="flow">
    </heartbeat>
  </heart>
  <!-- Virtual IP Configuration (used by Oracle SQL*Net Listener) -->
  <!-- Replace
  * VIRTUAL_TO_BE_DEFINED by the IP address of your virtual server
  -->
  <vip>
    <interface_list>
      <interface check="on" arpreroute="on">
        <real_interface>
          <virtual_addr addr="VIRTUAL_TO_BE_DEFINED" where="one_side_alias" />
        </real_interface>
      </interface>
    </interface_list>
  </vip>
  <!-- Software Error Detection Configuration -->
  <errd polltimer="10">
    <!-- Oracle databases
    For monitoring one specific oracle instance, insert the attribute
    argregex=".*SID$" where SID is the name of the DataBase
    -->
    <proc name="oracle" nameregex="ora_.*" atleast="1" action="restart" class="prim" />
    <proc name="tnslsnr" atleast="1" action="restart" class="prim" />
  </errd>
  <!-- File Replication Configuration -->
  <!-- Replace
  * ORACLE_DATA_TO_BE_DEFINED by the path of your Oracle database directory and transaction logs
  -->
  <rfs mountover="off" packetsize="32768" async="second" acl="off" nbrei="3">
    <replicated dir="ORACLE_DATA_TO_BE_DEFINED" mode="read_only" />
  </rfs>
  <!-- User scripts Configuration / Environment variables -->
  <user nicestoptimeout="300" forcestoptimeout="300" logging="userlog">
    <var name="ORACLE_HOME" value="%ORACLE_HOME%" /> <!-- values defined in macro above -->
    <var name="ORACLE_DBA" value="%ORACLE_DBA%" />
  </user>
</service>
</safe>

start_prim on Linux

#!/bin/sh
# Script called on the primary server for starting applications

# For logging into SafeKit log use:
# $SAFE/safekit printi | printe "message" 

#---------- Clean Oracle residual processes and shared memory
# Call this function before starting any Oracle databases 
# to clean eventual resual Oracle processes and IPC
clean_oracle()
{
  retval=0

  $SAFE/safekit printw "Cleaning Oracle processes and shared memory"

  # kill started Oracle databases
  ps -e -o pid,comm |grep ora | $AWK '{print "kill " $1}'| sh >/dev/null 2>&1

  # delete oracle shared memory to start in a clean state
  case $OSNAME in
 	   Linux)
	        ipcs -m |grep oracle |$AWK '{print "shm "$2 | "xargs ipcrm"}' >/dev/null 2>&1
		ipcs -s |grep oracle |$AWK '{print "sem "$2 | "xargs ipcrm"}' >/dev/null 2>&1
		;;
 	   *)
	        ipcs -m |grep oracle |$AWK '{print "-m "$2 | "xargs ipcrm"}' >/dev/null 2>&1
		ipcs -s |grep oracle |$AWK '{print "-s "$2 | "xargs ipcrm"}' >/dev/null 2>&1
		;;
  esac

  if [ -f $ORACLE_HOME/dbs/sgadef*.dbf ]; then          
    rm $ORACLE_HOME/dbs/sgadef*.dbf                   
  fi                                               

  return $retval
}

#---------- Oracle Databases
# Call this function for starting Oracle Databases        
start_oracle()
{
  retval=0

  $SAFE/safekit printw "Starting Oracle databases"

  # Oracle - Database Starting 
  /bin/su - $ORACLE_DBA -c "$ORACLE_HOME/bin/dbstart $ORACLE_HOME" #> /dev/console 2>&1   
  if [ $? -ne 0 ] ; then 
    $SAFE/safekit printw "Oracle databases start failed"
#    retval=1
  else
    $SAFE/safekit printw "Oracle databases started"
  fi

  return $retval
}

#---------- Oracle SQL*Net Listener
# Call this function for starting Oracle Listener
start_listener()
{
  retval=0

  # Oracle - Listener Starting
  LISTENER_STATE=`$SAFEBIN/killit list tnslsnr`     
  if [ "$LISTENER_STATE" != "" ]; then              
    $SAFE/safekit printw "Oracle Listener already started"         
    return $retval                                  
  fi                                                

  $SAFE/safekit printw "Starting Oracle Listener"
  /bin/su - $ORACLE_DBA -c "$ORACLE_HOME/bin/lsnrctl start" #> /dev/console 2>&1
  if [ $? -ne 0 ] ; then
    $SAFE/safekit printw "Oracle Listener start failed"
  else
    $SAFE/safekit printw "Oracle Listener started"
  fi

  return $retval
}

# stdout goes into Application log
echo "Running start_prim $*" 

res=0

[ -z "$OSNAME" ] && OSNAME=`uname -s`
OSNAME=`uname -s`
case "$OSNAME" in
    Linux)
	AWK=/bin/awk
	;;
    *)
	AWK=/usr/bin/awk
	;;
esac

# stdout goes into Application log
echo "Running start_prim $*" 

# TODO
# remove oracle boot start  

# WARNING: all databases defined in /etc/oratab are started
#

# Clean Oracle residual processes and shared memory to start Oracle databases in a clean state
clean_oracle || res=$?

# Start Oracle databases
start_oracle || res=$?

# Start SQL*Net Listener Oracle
start_listener || res=$?

if [ $res -ne 0 ] ; then
  $SAFE/safekit printi "start_prim failed"

  # uncomment to stop SafeKit when critical
  # $SAFE/safekit stop -i "start_prim"
fi

exit 0

stop_prim on Linux

#!/bin/sh
# Script called on the primary server for stopping applications

# For logging into SafeKit log use:
# $SAFE/safekit printi | printe "message" 

#----------------------------------------------------------
#
# 2 stop modes:
#
# - graceful stop
#   call standard application stop
#
# - force stop ($1=force)
#   kill application's processes
#
#----------------------------------------------------------

#---------- Clean Oracle residual processes and shared memory
# Call this function on force stop 
# to clean eventual resual Oracle processes and IPC
clean_oracle()
{
  retval=0

  $SAFE/safekit printw "Cleaning Oracle processes and shared memory"

  # kill started Oracle databases
  ps -e -o pid,comm |grep ora | $AWK '{print "kill -9 " $1}'| sh >/dev/null 2>&1

  # delete oracle shared memory to start in a clean state
  case $OSNAME in
 	   Linux)
	        ipcs -m |grep oracle |$AWK '{print "shm "$2 | "xargs ipcrm"}' >/dev/null 2>&1
		ipcs -s |grep oracle |$AWK '{print "sem "$2 | "xargs ipcrm"}' >/dev/null 2>&1
		;;
 	   *)
	        ipcs -m |grep oracle |$AWK '{print "-m "$2 | "xargs ipcrm"}' >/dev/null 2>&1
		ipcs -s |grep oracle |$AWK '{print "-s "$2 | "xargs ipcrm"}' >/dev/null 2>&1
		;;
  esac

  if [ -f $ORACLE_HOME/dbs/sgadef*.dbf ]; then          
    rm $ORACLE_HOME/dbs/sgadef*.dbf                   
  fi                                               

  return $retval
}

#---------- Oracle SQL*Net Listener
# Call this function for stopping Oracle Listener
stop_listener()
{
  retval=0

  if [ "$1" = "force" ] ; then
    # Oracle Listener force stop
    $SAFEBIN/killit +KILL tnslsnr 1>/dev/null 2>&1
    return $retval
  fi

  # Oracle - Listener stopping
  LISTENER_STATE=`$SAFEBIN/killit list tnslsnr`            
  if [ "$LISTENER_STATE" = "" ]; then                      
    $SAFE/safekit printw "Oracle Listener already stoppped"               
    return $retval                                         
  fi            

  $SAFE/safekit printw "Stopping Oracle Listener"
  /bin/su - $ORACLE_DBA -c "$ORACLE_HOME/bin/lsnrctl stop" #> /dev/console 2>&1
  if [ $? -ne 0 ] ; then
    $SAFE/safekit printw "Oracle Listener stop failed"
  else
    $SAFE/safekit printw "Oracle Listener stopped"
  fi

  return $retval
}

#---------- Oracle databases
# Call this function for stopping Oracle databases
stop_oracle()
{
  retval=0

  if [ "$1" = "force" ] ; then
    # Oracle databases force stop
    clean_oracle
    return $retval
  fi

  # Oracle databases gracefull stop

  # First stop the startup - shutdown command if it is running
  $SAFEBIN/killit +TERM dbstart dbshut> /dev/null 2>&1 

  # Kill oracle connections that prevent Oracle from stopping gracefully   
  ps -e -o pid,args |grep LOCAL=NO |$AWK '{print "kill " $1}'| sh > /dev/null 2>&1        
  ps -e -o pid,args |grep LOCAL=YES |$AWK '{print "kill " $1}'| sh > /dev/null 2>&1        

  $SAFE/safekit printw "Stopping Oracle databases"  
  /bin/su - $ORACLE_DBA -c "$ORACLE_HOME/bin/dbshut $ORACLE_HOME " #> /dev/console 2>&1
  if [ $? -ne 0 ] ; then 
    $SAFE/safekit printw "Oracle databases stop failed"
  else
    $SAFE/safekit printw "Oracle databases stopped"  
  fi

  return $retval
}

# stdout goes into Application log
echo "Running stop_prim $*" 

res=0

[ -z "$OSNAME" ] && OSNAME=`uname -s`
case "$OSNAME" in
    Linux)
	AWK=/bin/awk
	;;
    *)
	AWK=/usr/bin/awk
	;;
esac

mode=
if [ "$1" = "force" ] ; then
  mode=force
  shift
fi

# WARNING: all databases defined in /etc/oratab are stopped                    

# Stop Oracle SQL*Net Listener
stop_listener $mode || res=$?

# Stop Oracle databases 
stop_oracle $mode || res=$?

[ $res -ne 0 ] && $SAFE/safekit printi "stop_prim failed"

exit 0