Cluster installation (optional)

This section provides end-to-end instructions for installing an on-premises ALM Octane server in a cluster configuration on Linux.

Overview

A cluster is a group of application servers that run as a single system. Each application server in a cluster is referred to as a "node."

We install ALM Octane in a cluster configuration by: 

  1. Verifying all requirements and prerequisites for every node in the configuration.

  2. After you configured the setup.xml and octane.yml configuration files in the first node, copy these file to all other cluster nodes.

  3. Start ALM Octane on all servers.

See also Installation flow.

Back to top

Install ALM Octane in a cluster configuration

  1. For each node in the cluster, check requirements and access

    Check requirements Verify that the all cluster nodes, including the first, meet all requirements and prerequisites. For details, see System requirements and Prerequisites.
    Check database server access All cluster nodes, including the first, must have access to the database server on which the site database schema resides.
    Check repository access

    The repository directory has to be a shared directory visible to all cluster nodes. All nodes must have read and write access to the repository.

    Generally, the repository is located on an NFS or SAN server.

    If the repository is not located on a remote, dedicated machine, the repository location cannot be /opt/octane.

    The repository must be configured to use the same mount point (path) on all nodes.

    It is important that you enter the repository path using the same path name on all nodes. For example, you cannot have the path on the first server node defined as /opt/octane/repo and on additional nodes defined as /server1/opt/octane/repo.

    Check access between nodes

    All nodes must have access to each other. Verify ports are open in your firewall.

    ALM Octane needs to communicate between the nodes in the cluster on port 5701. Therefore, make sure that your firewall enables communication between the nodes of the cluster on the specified port..

    By default, outbound ports are open. Check inbound ports. For details, see Prerequisites.

  2. Install ALM Octane on the first cluster node

    Install ALM Octane on the first cluster node, as described under Installation.

    1. Deploy ALM Octane

      Here we deploy the ALM Octane installation files onto the first node.

    2. Configure initial site settings

      We configure ALM Octane by modifying the setup.xml configuration file.

      Make sure to set the following settings to values that all cluster nodes can access.

      DBServerName

      The database server on which the site database schema resides.

      For cluster environments only.

      RepositoryFolder The shared repository that all cluster nodes can access (read and write).
    3. Configure other settings

      We configure other ALM Octane cluster settings by modifying the octane.yml configuration file.

      ALM Octane validates these settings when starting. If they are not valid, the ALM Octane server does not start.

      cluster: 

      Section header. Do not edit.

      cluster:
         isCluster: true
         nodes:

      isCluster

      Available with 12.60 CP8 and later.

      Whether your server is standalone or in a cluster configuration.

      Mandatory.

      For a cluster configuration, set this value to true. You must enter node host names in the nodes setting.

      For a standalone server, set this value to false and do not enter any host names using the nodes setting.

      Default: true

      nodes:

      Configure the IP addresses or fully qualified domain names for each cluster node.

      Enter a comma-separated list of node host names, or IPs, in the cluster.

      Examples

      • server1.domain.com,server2.domain.com,server3.domain.com
      • 120.150.12.12,120.150.80.13,120.150.32.14

      Make sure isCluster is set to true.

    4. Start the ALM Octane server

      On the first node only, start the ALM Octane server by running service octane start.

  3. Set up a secure configuration on the first cluster node

    If you want to set up a secure configuration for ALM Octane, follow the instructions in knowledge base article KM02707977.

  4. Make sure ALM Octane is running on the first node in the cluster

    Before installing on remaining cluster nodes, log in to ALM Octane.

    For details, see Log in to ALM Octane.

  5. Only after you successfully log in, deploy ALM Octane installation files on each additional cluster node

    Download and deploy the ALM Octane package on each cluster node. For details, see Deploy ALM Octane and Deploy in cluster environment.

    Caution: Do not do the following:

    • Do not configure the setup.xml and octane.yml files. You will be copying these files from the first node in the cluster during the next step.

    • Do not run connectnode.sh scripts.

  6. Configure each additional cluster node

    Copy the /opt/octane/conf/setup.xml and /opt/octane/conf/octane.yml files from the first cluster node to the /opt/octane/conf folder on the cluster node.

  7. Start ALM Octane on each additional cluster node

    Run service octane start on each additional node.

  8. Set up a secure configuration on each additional cluster node

    If you want to set up a secure configuration for ALM Octane in a cluster configuration, follow these instructions on each additional cluster node: Software Self-solve knowledge base article KM02707977.

  9. Log in to make sure ALM Octane is running on each additional node in the cluster

    For details, see Log in to ALM Octane. Use the load balancer URL when you log in.

Back to top