You are currently browsing legacy 2.5 version of documentation. Click here to switch to the newest 5.0 version.

We can help you with migration to the latest RavenDB

Contact Us Now
see on GitHub

Windows Clustering

Information

Windows Clustering feature is only available in the Enterprise Edition.

In order to ensure RavenDB high availability you can run it on a failover cluster.

Requirements

  • Windows Server 2008
  • Failover Cluster Manager snap-in installed
  • Storage Area Network (SAN) configured

Configuring RavenDB service

Execute the following steps on every cluster node:

  1. If RavenDB isn't installed as a service follow this link in order to do it
  2. Stop RavenDB service by executing the following command on the command line: Raven.Server.exe /stop
  3. In the Raven.Server.exe.config file set up Raven/DataDir to the SAN

Note: A failover cluster will take care of working RavenDB. If the failure take place on one of the cluster nodes then a failover cluster will start RavenDB service immediately. So it's important that RavenDB instance on every node should use the same data directory placed on the SAN.

Creating failover cluster

  1. Go to Start -> Administrative Tool -> Failover Cluster Manager
  2. Select Create a cluster option from context menu
    Figure 1.1: FMC Configuration
  3. Go through the wizard
    Figure 1.2: FMC Configuration
  4. Add cluster nodes
    Figure 1.3: FMC Configuration
  5. Validate a cluster configuration
    Figure 1.4: FMC Configuration
  6. Validation Wizard will be shown
    Figure 1.5: FMC Configuration
  7. Run all test to make sure that nodes are configured properly
    Figure 1.6: FMC Configuration
  8. Click Next
    Figure 1.7: FMC Configuration
  9. Wait for validation finish
    Figure 1.8: FMC Configuration
  10. Name a cluster and assign IP address for it
    Figure 1.9: FMC Configuration
  11. Confirm and finish next steps
    Figure 1.10: FMC Configuration

Adding RavenDB as a Generic Service resource

  1. Right click on Services and applications of newly created cluster and choose Configure a Service or Application... option from context menu
    Figure 2.1: FMC Configuration
  2. Go through the High Availability Wizard
    Figure 2.2: FMC Configuration
  3. Choose Generic Service
    Figure 2.3: FMC Configuration
  4. Select RavenDB service
    Figure 2.4: FMC Configuration
  5. Type the cluster service name and assign the IP address under which RavenDB will be available
    Figure 2.5: FMC Configuration
  6. RavenDB has been already configured on every node to keep data in SAN, so no storage is needed here. Click Next
    Figure 2.6: FMC Configuration
  7. Click Next
    Figure 2.7: FMC Configuration
  8. Summary screen. Click Finish
    Figure 2.8: FMC Configuration

Windows Authentication usage

In a clustered environment a host can have more than one name associated. That can cause problems for Kerberos. If you are going to use Windows Authentication then use static IP addresses and add a DNS A record for RavenDB.

Summary

  • After click on a service name in a cluster tree you will see RavenDB service information
    Figure 3: FMC Configuration
  • Service properties
    Figure 4.1: FMC Configuration
    • General options
      Figure 4.2: FMC Configuration
    • Failover options
      Figure 4.3: FMC Configuration
  • Failure simulation
    1. Right click on RavenDB resource and choose Simulate failure of this resource Figure 5.1: FMC Configuration
    2. During failover the resource has been moved to a different node and is in pending mode
      Figure 5.2: FMC Configuration
    3. Failover succeeded
      Figure 5.3: FMC Configuration