i Prerequisites

Verify that your system meets the requirements in System requirements.

For security requirements, see Software Self-solve knowledge base article KM02707977.

Checklist

Use the following questions to make sure you are ready to install.

Category Tell us... Your answer...
On which machine will you be installing ALM Octane?  
Does the machine have a Quad Core AMD64 processor or equivalent x86-compatible processor?   

How much memory does the machine have? 

You need a minimum of 8 GB.

 
 
What Linux operating system is on the machine?  
What is the user name and password you will use for the installation user?   
Does the installation user have sudo permissions? See Permissions.  
Are your browsers and screen resolutions compatible with ALM Octane?  

On-premises installation of ALM Octane supports only English characters for the names of schemas, operating systems, users, and so on. Did you check?

 

 

Elasticsearch enables trend reporting and search functionality in ALM Octane.

What is the Elasticsearch version that matches ALM Octane requirements? 

 

Do you need to download Elasticsearch? 

You can download Elasticsearch from - https://www.elastic.co/downloads/past-releases/elasticsearch-5-6-5.

 
Did you check knowledge base article KM02494295?  
On which machine is Elasticsearch installed?  

What is the Elasticsearch port? Default: 9300

You can modify the port in setup.xml.

 

Did you make sure that the port for outbound communication to Elasticsearch is open? 

By default, outbound ports are open.

 

Did you make sure that the Elasticsearch ports (such as 9300 and 9200)  are accessible directly from the ALM Octane server, not just by checking the HTTP connection? 

 
What is the name of the Elasticsearch cluster you have configured?   
Was Elasticsearch configured according to ALM Octane requirements? For details, see System requirements.  
Is the Elasticsearch accessible from the ALM Octane server?   
Does your Oracle version match ALM Octane requirements? For details, see System requirements.  

On which machine is the database installed? 

 

What is the Oracle database port? Default: 1521

You can modify the port in the ConnectionString field in setup.xml.

 

Did you make sure that the port for outbound communication to Oracle is open? 

By default, outbound ports are open.

 
What is the URL for Java Database Connectivity (JDBC) for your database?  
What is the database admin's user name and password?  
Does the database admin power user have the necessary permissions? See Permissions.  
What table space and temporary table space can be used?  
Did the DBA add any objects to the schemas? If so, create an exception file before installing. For details, see Using exception files for manual database changes.  

Does your SQL Server version match ALM Octane requirements? For details, see Database and Elasticsearch.

 
On which machine is the database installed?   

Will you be using the SQL Server database port or instance name to connect to the database? 

  • What is the SQL Server database port? Default: 1433

  • What is the SQL Server instance name?

 
What is the database admin's user name and password?  
Does the database administrator (power user) have the necessary permissions? See Permissions.  

What MSSQL database login user, and password, can be used for ALM Octane

 
Did the DBA add any objects to the schemas? If so, create an exception file before installing. For details, see Using exception files for manual database changes.  

Do you need to install the JDK on the ALM Octane server and other servers, such as the ElasticSearch server? 

 

Does your Java version match ALM Octane requirements? For details, see JDK.

 

Did you make sure that the port for inbound communication with Jetty is open? 

By default, the port is 8080. For SSL, 8443.

You can define the port during initial installation, in octane.yml.

 

Did you make sure that  ALM Octane can communicate between the nodes in the cluster, using inbound and outbound communication for clusters? 

By default, the port is 5701.

You can define the port during initial installation, in hazelcast.xml.

 

Back to top

Permissions

ALM Octane requires the following permissions for the file system and for the database.

File system

Root or sudo user.

During deployment, ALM Octane creates a user and group named octane for running the octane service that starts the ALM Octane server. However, if your organization prefers to manage users in a centralized way, without enabling ad hoc creation of local users, create a user and group for this purpose, and define the following environment variables: OCTANE_USER and OCTANE_GROUP.

Make sure the user has write permissions to the /opt/octane/log directory.

Oracle database

These are the permissions user you will define for the user you will specify in the DBAdminUser setting in the setup.xml file. For details, see DBAdminUser.

Permissions vary depending how you work with ALM Octane and how you want to install.

Do you want ALM Octane to create schemas, objects, and tables during the installation? 

Yes

Provide ALM Octane with an Oracle power user with the following admin privileges, so that ALM Octane can create schemas and objects automatically during the installation.

  • CREATE USER

  • CREATE SESSION WITH ADMIN OPTION

  • CREATE TABLE WITH ADMIN OPTION

  • CREATE SEQUENCE WITH ADMIN OPTION

  • DROP USER (optional). If not provided, the DBA must take responsibility for cleaning up unnecessary schemas.

If the database at your site is managed by database administrators, and ALM Octane is not authorized to create its own schemas, this power user can be created temporarily, for installation purposes only. You can remove this user if: 

  • The installation is complete, and login to ALM Octane is successful.

  • The ALM Octane site admin intends to create spaces using an existing schema, which can be selected when creating a space in the ALM Octane Settings area for the site. For details, see the information about creating a space in the ALM Octane User Guide.

No

Provide ALM Octane with a regular Oracle user with the following permissions. Create the schemas before installation.

  • CREATE TABLE

  • CREATE SESSION

  • CREATE SEQUENCE

  • The QUOTA clause on the user's default tablespace should be unlimited.

SQL Server Database

These are the permissions user you will define for the user you will specify in the DBAdminUser setting in the setup.xml file. For details, see DBAdminUser.

Permissions vary depending how you work with ALM Octane and how you want to install.

Do you want ALM Octane to create databases and the login user during the installation? 

Yes

Use the sa user, or an ALM Octane database admin power user.

Install ALM Octane with a database admin power user if you cannot use the SQL sa user for security reasons. This user can be a temporary user, for installation purposes only.

Request that the SQL Server database admin create a temporary power user with the following privileges (roles), which are required to install ALM Octane:

  • Database Creators dbcreator role

  • Security Administrator securityadmin role

Note:  It is important that the ALM Octane database administrative user is not the same as the ALM Octane admin user.

The SQL Server database admin could name this power user octane_install_power_user, for example.

No

Create an ALM Octane database admin power user for installation purposes.

  1. Open the SQL Server Management Studio.

  2. In the Object Explorer pane, under the ALM Octane database server, expand the Security directory.

  3. Right-click the Logins directory, and select New Login.

  4. Type, for example, octane_install_power_user as the user name, and select the authentication type (enter the password if necessary).

  5. Click the Server Roles tab, and select the dbcreator and securityadmin options. Click OK.

Back to top

Next steps: