Architecture

You can set up 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 gray are products.

Basic system architecture of a single-node configuration.

Enterprise configuration

The following diagram illustrates the system architecture of an enterprise, cluster configuration. Components in gray are products.

System architecture of an enterprise, cluster configuration.

Components

Components Description
clients The clients communicate with the server over HTTP/S.
Server application nodes

Client requests from are dispatched to the deployed application.
application additional cluster (sync) nodes

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 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 (Linux) or C:\Program Files\octane (Windows).

  • All nodes must have access to each other.
Repository / File system

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

When working in a clustered configuration, the repository must be accessible by all nodes. Also, the repository must be configured to use the same mount point (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:

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

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

The schemas can reside on an Oracle server (Oracle RAC is supported).

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 might require a database upgrade. This may necessitate migration of data if other applications sharing the same database do not support the database version that requires.
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 Elasticsearch engine must be able to sustain the load of all the applications.

  • Future versions of might require an Elasticsearch upgrade. This may necessitate migration of data if other applications sharing the same Elasticsearch do not support the Elasticsearch version that requires.

A working Elasticsearch server is a requirement for working with . For the supported version, refer to the Support Matrix.
Load balancer

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 These can be "VIPs" (virtual IP addresses) of one physical load balancer.
DMZ An optional, demilitarized zone.
High availability reverse proxies and SSL offloading Optional configuration for load balancing using a software solution (for example, NGINX).
SMTP A mail server.
Jenkins (with plugin)

You can integrate with a Jenkins CI server using the  Plugin on your CI server.

TFS, TeamCity, or Bamboo server (with plugin)

You can integrate with a TFS, TeamCity, or Bamboo CI server using the  plugin on your CI server.

Slack

 Integration with Slack, which enables all stakeholders of a backlog item to collaborate and communicate. You can integrate with Slack by adding it as a collaboration tool associating it with a workspace.
Open Text testing tools: , ,,

You can integrate with Open Text testing tools. For details, see Integrations.
  • Installation types
  • Installation flow
  • Prerequisites
  • Install
  • Deploy