Architecture

You can set up ALM Octane as a single node, or in a cluster configuration. The following diagrams illustrate the system architecture for both options. These are followed by descriptions of each of the components.

Basic configuration

The following diagram illustrates the system architecture of a single-node configuration.

Components in grey are Micro Focus products.

Note: The ALM Octane, database, and Elasticsearch servers should each reside on separate machines.

Back to top

Enterprise configuration

The following diagram illustrates the system architecture of an enterprise, cluster configuration: 

Components in grey are Micro Focus products.

Back to top

Components

Components Description
ALM Octane clients The clients communicate with the ALM Octane server over HTTP/S.
Integration bridge and external sources

Enterprise configuration: The integration bridge enables ALM Octane to integrate with external applications ("off-organization" communication).

This is generally optional, but required for synchronization. Also used for Trigger Webhook rules to an endpoint URL, SaaS deployments, and for communication between Micro Focus SaaS and an on-premises deployment.

ALM Octane Server application nodes

Client requests from ALM Octane are dispatched to the deployed application.

Note: The ALM Octane, database, and Elasticsearch servers should each reside on separate machines.

ALM Octane application additional cluster (sync) nodes

Cluster configuration: 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."

  • All nodes must have access to the database server on which the site database schema resides.

  • All nodes must have access to the repository.

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

  • All nodes must have access to each other.

Integration bridge service nodes

The service handles communication between the Integration Bridge and Synchronizer.

Synchronizer service nodes

The service nodes handle synchronization between ALM Octane and ALM or JIRA.

Repository / File system

Stores all files to be used by all the projects in the system, such as templates and attachments.

Cluster configuration: When working in a clustered configuration, the repository must be accessible by all nodes. Also, the repository must be configured to use the same path on all nodes.

Database server

A relational database management system, either Oracle RAC or Microsoft SQL Server.

The database server stores the following schemas:

  • Space schema. All space information, such as workspaces, users, and roles..

  • Site schema. Stores all site-related information, such as database servers, cluster nodes, the SMTP servers, and configuration.

This server can be shared with other applications with the following constraints:

  • The database must be able to sustain the load of all the applications.

  • Future versions of ALM Octane might require a database upgrade. This may necessitate migration of data if other applications sharing the same database will not support the database version that ALM Octane requires.

Note: The ALM Octane, database, and Elasticsearch servers should each reside on separate machines.

Elasticsearch server (or cluster)

A Java-based, open-source search engine. This component is used for various aspects of the application, such as global search and trends.

This server can be shared with other applications with the following constraints:

  • The database must be able to sustain the load of all the applications.

  • Future versions of ALM Octane might require a database upgrade. This may necessitate migration of data if other applications sharing the same database will not support the database version that ALM Octane requires.

Note: The ALM Octane, database, and Elasticsearch servers should each reside on separate machines.

A working Elasticsearch server is a requirement for working with ALM Octane. Make sure you are using a version supported by ALM Octane:

  • For the supported version, see the requirements for Database and Elasticsearch.

  • For details on installing Elasticsearch, see knowledge base article KM02494295.

  • For details on upgrading to a new Elasticsearch version, see knowledge base article KM03207448.

Load balancer

Cluster configuration: When working with a load balancer, client requests are transmitted to the load balancer and distributed according to server availability within the cluster.

If you are using a load balancer, we recommend you utilize SSL offloading.

High availability load balancers Cluster configuration: These can be "VIPs" (virtual IP addresses) of one physical load balancer.
DMZ An optional, demilitarized zone.
High availability reverse proxies and SSL offloading Cluster configuration: Optional configuration for load balancing using a software solution (for example, NGINX).
SMTP A mail server.
Jenkins (with ALM Octane plugin)

Enterprise configuration: You can integrate ALM Octane with a Jenkins CI server using the Application Automation Tools Plugin on your CI server.

TeamCity, Bamboo, or TFS server (with ALM Octane plugin)

Enterprise configuration: You can integrate ALM Octane with a TeamCity, Bamboo, or TFS CI server using the ALM Octane CI Plugin on your CI server.

Slack

Integration with Slack, which enables all stakeholders of a backlog item or pipeline run failure to collaborate and communicate. You can integrate with Slack by adding it as a collaboration tool associating it with a workspace.
Micro Focus testing tools: LeanFT, UFT, LoadRunner, StormRunner Functional, StormRunner Load, Performance Center You can integrate ALM Octane with Micro Focus testing tools. For details, see ALM Octane DevOps integrations in the ALM Octane DevOps integrations.

Back to top

See also: