High Availability configuration operations

Important Note

Important

When initially configuring a high availability cluster, cluster members communicate using HTTPS over port 443. Caution should be exercised when configuring high availability where proxies are in use.  See Proxy configuration in the Network section of Command Line Management Console reference for information on configuring proxies and proxy bypass lists.

Add a worker node to an Access Gateway cluster

Info

Note

When adding a worker node, both the administration node and the worker node must:

To add a worker node to a cluster:

  1. On the Admin node,

    1. Connect to the instance Access Gateway Management console.
      ssh oag-mgmt@[admin.tld]
    2. Select 5 - System.
    3. Select 8- High Availability Configuration.
      The High Availability Configuration menu displays.
      Access Gateway High Availability Setup (role)
      1 - Reset Key
      2 - Prepare Admin
      3 - Prepare Worker
      4 - List Nodes
      5 - Remove Node
      6 - Check Status
      
      X- Exit
      Choice: 

      Info

      Note

      The High Availability menu displays the current role of a Access Gateway node.
      Roles can be:

      • Single - The node has not yet been configured as either a worker or an admin.
      • Admin - The node has been configured as an administrator for High Availability.
      • Worker - The node has been configured as a worker for High Availability.
    4. Select 2 - Prepare Admin
      Info

      Note

      When you configure an admin node for high availability for the first time, select and execute the 1 - Reset Keys option to reset the instance's SSH keys.
      You only need to reset keys once per instance. See Command Line Management Console reference.

      Important Note

      Important

      Access Gateway Replication uses the hostname setting from the command line console.
      Ensure that you update the hostname for both admin and worker nodes using the command line console System (5) > Change Hostname (1).

      . . .

    5. The admin node generates and displays an authorization code, which must be provided to the worker node.
      Copy the authorization code given:
      Authorization token required to initiate setup from worker nodes is given
      below. Copy the following text below this line and paste it on worker node when prompted.
      oag.okta.com:8ba1c123-715d-4b70-ab5d-0e41493bef73
      Worker nodes available so far:
      . . . 			
      					
      The admin node then waits for worker nodes.
    Important Note

    Important

    At this point, the admin node waits for connections from worker nodes. Leave the window open until all workers nodes have been added. Entering X prematurely will cause the admin node to assume the process is complete and stop listing for worker node additions.
    Enter X only after adding all worker nodes

    1. Return to the command prompt on the instance, which is being attached as a worker node.
  2. On each worker node,
    1. Connect to the instance Access Gateway Management console.
      ssh oag-mgmt@[worker.tld]
    2. Select 5 - System.
    3. Select 8- High Availability Configuration.
      The High Availability Configuration menu displays.
    4. Select 3 - Prepare Worker.
      Info

      Note

      When you configure a worker node for high availability for the first time, select and execute the 1 - Reset Keys option to reset the instance's SSH keys.
      You only need to reset keys once per instance. See Command Line Management Console reference..

    5. The worker displays:
      Checking HA readiness for host worker. . .   
      
      Note: Please ensure that admin node is ready for setup and you have the
      authorization token displayed on admin node.
      
      Enter the authorization token displayed on admin node: admin.. . . .com:927da506-7efb-4520-bd32-dd03b86f2a9b
      

      After it's entered, the worker node connects to the admin node and exchanges authorization and confirmation information similar to the following:
      Requesting admin  node admin. . . .com to allow connection  
      Node worker. . .com successfully added on admin node
      Synchronizing current configuration  
       
      Press enter to continue ....
      
    6. When prompted, press any key to continue.
    7. Enter X to exit or any other menu item to continue.

    The worker instance is now configured and ready for use.

On the admin node:

  1. Return to the admin instance Access Gateway Management console.
  2. Examine results of adding the new worker node similar to:
    Authorization token required to initiate setup from worker nodes is given
    below. Copy the text below this line and paste it on worker node when prompted.
    
    admin. . .com:927da506-7efb-4520-bd32-dd03b86f2a9b
    Worker nodes available so far:
    worker1. . .com
    worker2. . .com
    worker3. . .com
    Note the addition of the new worker node.
  3. Enter X to exit or any other menu item to continue.

 

List all worker nodes in an Access Gateway Cluster

To list all currently enabled worker nodes:

  1. Connect to the instance Access Gateway Management console.
    ssh oag-mgmt@[admin.tld]
  2. Select 8- HA Configuration
    The HA Configuration menu will display.
  3. Select 4 - List nodes
  4. A list of all currently enabled Worker nodes are displayed, which should resemble:
    Admin Node:
    admin. . .com
    
    Worker Nodes:
    worker1. . .com
    . . . 
    workern. . .com
    Press enter to continue ....
    
  5. Enter X to exit or any other menu item to continue.

 

Remove a worker node from an Access Gateway cluster

To remove an existing worker node from an Access Gateway cluster:

Info

Note

When a worker node is removed from an Access Gateway cluster is still exists but no longer receives updates from the Admin instance. In addition the Access Gateway UI continues to be disabled.

Nodes removed from the Access Gateway High availability cluster should be removed from any load balancer and otherwise decommissioned.
Once removed a worker node is no longer considered viable.

  1. Connect to the instance.
    ssh oag-mgmt@[admin.tld]
  2. Select 5 - System
  3. Select 8- High Availability Configuration
    The HA Configuration menu will display.
    Access Gateway Services...
    1 - Reset Key
    2 - Prepare Admin
    3 - Prepare Worker
    4 - List Nodes
    5 - Remove Node
    
    X- Exit
    Choice: 
  4. Select 5 - Remove node
  5. From the list of known nodes, enter the name of the worker node to be removed and press enter.
  6. Confirm the removal of the node.
  7. Enter X to exit or any other menu item to continue.

 

Reset the key associated with an Access Gateway node

Access Gateway nodes use various keys to intercommunicate. You must regenerate keys if you want to use an instance as a part of an Access Gateway High Availability cluster.
You only need to regenerate keys once per instance.

To reset a node's keys:

  1. Connect to the Access Gateway Management console.
    ssh oag-mgmt@[admin or worker]
  2. Select 5 - System.
  3. Select 8- High Availability Configuration.
    The High Availability Configuration menu displays.
  4. Select 1 - Reset Key node. The following Confirm the key reset message appears.
    This will reset keys being used by high availability sync process.
    If high availability is already setup, this option should not be used.
    Proceed with reset? [y/N]: 
  5. Enter y to reset or N to abort the reset process.
    The reset of either abort, or display a success message.
  6. Enter x to exit or any other menu item to continue.

 

Check the cluster configuration

To review or check the status of an Access Gateway High Availability Cluster:

  1. Connect to the Access Gateway Management console.
    ssh oag-mgmt@[admin or worker]
  2. Select 5 - System.
  3. Select 8- High Availability Configuration.
    The High Availability Configuration menu displays.
  4. Select 6 -Check Status.
  5. A list of cluster instances is displayed with their associated status.
    Use the Up/Down/Page Up/Page Down/Home/End keys to scroll through the list, which is similar to:
     
    HA Synch Status    Up/Down/Page Up/Page Down/Home/End - Scroll    x-exit
    worker1.yourdoman.tld:    Pass
    worker2.yourdoman.tld:    Pass
    . . . 
    workern.yourdoman.tld:    Fail										
    					
    Where:
    • Pass: Reachable, functioning worker node.
    • Fail: Non-functional worker. See the node log for details.
  6. Enter x to exit.