Versions Compared

Old Version 27

changes.mady.by.user Mitchell Saunders

Saved on

compared with

New Version Current

changes.mady.by.user Kenny King

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Replication Setup and Configuration Guide

...

Table of Contents
stylenone

...

opHA-MB 5.0 introduces the concept of a Primary & multiple Poller servers and a message bus (with replication):

...

Term

Meaning

Main Primary

server instance running opHA with role = 'primary_master'

Secondary Primary

server instance running opHA with role = 'master'. Also referred to as just 'primary'.

Peer

server instance running opHA with role = 'poller' or 'mirror'. It can optionally be of type 'streaming' which means that it is linked to an ophad instance.

Poller

server instance running opHA with role = 'poller'

Mirror

server instance running opHA with role = 'mirror'. It is paired with a poller and polls the same devices as that poller, however its data is not sync'd with primary unless the poller is offline.

Producer

an instance of the ophad process running in 'producer' mode (as per configuration). This will typically be running on the same server instances as the primary.

Consumer

an instance of the ophad process running in 'consumer' mode (as per configuration). This will typically be running on the same server instance as the poller (or mirror)

1. Software Installation

1.1 Download Software

Download the required software onto each server.

1.2 Install Software

IMPORTANT: All the servers should be setup with the following

a. opHA 4 needs to be currently installed

b. Pollers and mirrors discovered by the Main Primary

bc. Server names set

cd. Secondary Primary server setup as Primary

ce. One server needs to be an Arbiter. A poller can be used for this

cf. MongoDB 6 installed

We will be using the below example host names throughout this guide.

...

During the installation of the arbiter server you must answer 'n' at the following prompt

...

2. NATS Setup

This configuration should be applied to the Main Primary, Arbiter and Secondary Primary servers ONLY.

  1. Edit Configuration: Update the /etc/nats-server.conf file with the following settings:

    Code Block
    languagejson
    server_name: "opha-dev1.opmantek.net"  #The local server  
http_port: 8222 
listen: 4222 
jetstream: enabled 
accounts { 
  $SYS { 
    users = [ 
      { user: "admin",
        pass: "password" 
      } 
    ] 
  } 
  ophad: { 
    users: [ 
        { user: "omkadmin", password: "op42opha42" } 
    ] 
    jetstream: enabled 
  } 
} 

jetstream { 
  store_dir: "/opt/nats/storage" 
  max_memory_store: 1028M 
  max_file_store: 1028M 
} 
cluster { 
  name: "C1" 
  host: "opha-dev1.opmantek.net"  #The current host 
  # the current server 
  listen: "0.0.0.0:6222" 
  routes: [ 
    # secondary primary
    "nats://opha-dev6.opmantek.net:6222" 
    # server with the arbiter 
    "nats://opha-dev2.opmantek.net:6222" 
    # other servers 
  ] 
}

3. Common Configuration for All Servers

3.1 Update /usr/local/omk/conf/opCommon.json

  1. Backup Configuration: Make a backup copy of the opCommon.json file before making any changes.

  2. Add NATS Cluster Configuration: Ensure the following configuration is included in opCommon.json on all servers. In the below example we have added the Main Primary, arbiter and Secondary Primary FQDNs and port/s to be utilized in the nats_server cluster attribute, you can find this in the database section.

    Code Block
    languagejson
    "nats_cluster": [ "opha-dev1.opmantek.net:4222", "opha-dev2.opmantek.net:4222", "opha-dev6.opmantek.net:4222" ]

4. Server-Specific Configuration

4.1 Update /usr/local/omk/conf/opCommon.json for Main Primary and Secondary Primary only

Code Block
languagejson
"db_replica_set": "rs1", 
"db_mongo_cluster": [ "opha-dev1.opmantek.net", "opha-dev6.opmantek.net" ], 
"nats_num_replicas": 3, 
"nats_cluster": [ "opha-dev1.opmantek.net", "opha-dev2.opmantek.net", "opha-dev6.opmantek.net" ]

5. Update License

To obtain a license please contact FirstWave Sales.

...

  1. opHA-MB for NMIS & opCharts (This license is required for Message Bus to run)

    1. NMIS and opCharts data are synced from all poller/mirrors to the Main Primary using Message Bus. In replication mode, if the Main Primary were to go down the Secondary Primary will retain the NMIS and opCharts data.

      image-20241108-050221.png

  2. opHA-MB for opEvents (This license is an add-on for opEvents).

    1. With this add-on opEvents will use MessageBus to sync opEvents data from each poller/mirror to the Main Primary and in replication mode opEvents data is synced to the Secondary Primary. In replication mode, If the Main Primary were to go down the Secondary Primary will retain the opEvents data.

      image-20241107-234837.png

  3. You need to add your license to the opLicensing app as below on the main-primary and second-primary servers

    image-20241113-015434.pngImage Added

6. MongoDB Setup (Main Primary Only)

The following steps should be performed only on the Main Primary MongoDB instance.

6.1 Initialize MongoDB Replica Set

Connect to MongoDB using the mongosh command and configure the replica set:

...

Code Block
mongosh --username opUserRW --password op42flow42 admin

Run the following commandAdd the main-primary and secondary-primary to the below command and run it

Code Block
rs.initiate({ _id: "rs1", version: 1, members: [ { _id: 0, host : "opha-dev1.opmantek.net:27017" }, { _id: 1, host : "opha-dev6.opmantek.net:27017" } ] })

6.2 Set Default Write Concern

Run the following command to set the default write concern:

Code Block
db.adminCommand({ "setDefaultRWConcern": 1, "defaultWriteConcern": { "w": 1 } })

6.3 Add Arbiter

Run the following command to add an arbiter to the replica set:

Code Block
rs.addArb("opha-dev2.opmantek.net:27018")

6.4 Restart mongod on the Main Primary and Second Primary

Run the following command on the Main Primary, Secondary Primary, and Arbiter servers ONLY:

Code Block
sudo systemctl restart mongod

7. Starting Services

7.1 Start NATS

Start the NATS service on the Main Primary, Secondary Primary, and Arbiter servers ONLY:

Code Block
systemctl start nats-server

7.2 Restart mongod on Pollers and Mirrors only

After configuration changes, restart mongod on all Mirrors and Pollers servers ONLY:

Code Block
systemctl restart mongod

7.3 Restart services on all servers

After configuration changes have been made, you will need to restart the relevant FirstWave module daemons applicable to your server.

...

Code Block
systemctl restart nmis9d opchartsd opeventsd omkd ophad

7.4 Start the Poller and Mirrors

Execute the following command on the poller and mirror servers.

Code Block
cd /usr/local/omk/bin
./ophad cmd producer start

8. Final Steps

  1. Accept EULAs: Make sure when you login to each server to confirm that all End User License Agreements (EULAs) are accepted.

...