Cluster Manager Setup #

I. Initialize Cluster Manager #

1. Initialize Cluster Manager with the following command:

   ./bin/replicant-cluster-manager init –metadata conf/metadata/oracle.yaml
   

Note: Run this command only once to clear all existing statistics

II. Start Cluster Manager #

1. Run the following command in every host you want to run Cluster Manager in:

   ./bin/replicant-cluster-manager start-cluster --host-id host1 --cluster conf/cluster/cluster.yaml --metadata conf/metadata/oracle.yaml
   

III. Add Jobs #

1. Navigate to the sample job configuration file

   vi $CM_HOME_DIR/conf/jobs/jobs.yaml
   

2. Edit the following job configuration as necessary:

   add-jobs:
     job-command: "/home/replicate/core/bin/replicate full /home/replicate/core/conf/conn/oracle_src.yaml /home/replicate/core/conf/conn/memsql_dst.yaml --extractor /home/replicate/core/conf/src/oracle.yaml --applier /home/replicate/core/conf/dst/memsql.yaml --replace-existing --filter /home/replicate/core/filter/oracle_filter.yaml --metadata /home/replicate/core/conf/metadata/memsql.yaml --general /home/replicate/core/conf/general/general.yaml --distribute /home/replicate/core/conf/distribution/distribution.yaml --id repl1 --overwrite"
     replicant-id: "repl1" #Replace repl1 with the value of ```--id``` from the job command
     replicant-group: "test_group" #Only applicable if using distributed replication
     host-affinity: "host1" #Replace host1 with the host-id of the intended host in the cluster
   

3. Add the job:

   ./bin/replicant-cluster-manager alter-cluster --metadata conf/metadata/oracle.yaml --jobs conf/jobs/jobs.yaml
   

Managing Jobs #

Using the job configuration file, the following operations can be performed on a previously added job in Cluster Manager

• Stop a job

  stop-jobs:
    replicant-id: "repl1" #Replace repl1 the replicant ID of the job you want to stop
    #replicant-group: "test_group" #If applicable, replace test_group with the replicant group of the job you want to stop
  

• Restart a job

  restart-jobs:
    replicant-id: "repl1" #Replace repl1 the replicant ID of the job you want to restart
    #replicant-group: "test_group" #If applicable, replace test_group with the replicant group of the job you want to restart
  

• Resume a job

  resume-jobs:
    replicant-id:  "repl1" #Replace repl1 the replicant ID of the job you want to resume
    #replicant-group:  "test_group" #If applicable, replace test_group with the replicant group of the job you want to resume
  

• Remove a job

  remove-jobs:
    replicant-id: "repl1" #Replace repl1 the replicant ID of the job you want to remove
    #replicant-group: #If applicable, replace test_group with the replicant group of the job you want to remove
  

• Change host affinity for a job

  alter-host-affinity-for-jobs:
    replicant-id: "repl1" #Replace repl1 the replicant ID of the job you want to alter hosts for
    #replicant-group: "test_group" #If applicable, replace test_group with the replicant group of the job you want to alter hosts for
    host-affinity: "host1" #Replace host1 with the new host-id
  

Cluster Manager as a System Service Setup #

Setting up CM as a service system is optional but if you wish to do so, follow the proceeding steps.

I. Create a Service #

1. Enter the following command to start a service:

   vim /etc/systemd/system/replicant-cluster-manager.service
   

2. Copy-paste the following example content in the file and change it accordingly:

   [Unit]
   Description=Replicant Cluster Manager
   After=network.target
   
   [Service]
   ExecStart=/home/repo/cm2/replicant-cluster-manager/bin/replicant-cluster-manager start-cluster --metadata /home/repo/cm2/replicant-cluster-manager/conf/metadata/oracle.yaml --host-id "host1"
   
   SuccessExitStatus=0 2
   Restart=on-failure
   RestartSec=10
   
   [Install]
   WantedBy=multi-user.target
   

Note: In the ExecStart field, please write the start-cluster command with absolute path for every file. You can keep the other configurations as it is.

II. Start the Service #

1. Enter the following commands to start the service:

   systemctl daemon-reload
   systemctl enable replicant-cluster-manager.service
   systemctl start replicant-cluster-manager
   

III. Managing the Service #

To check the status of your service: systemctl status replicant-cluster-manager

To stop you service: systemctl stop replicant-cluster-manager

To view real-time CM output: journalctl -f -u replicant-cluster-manager