Handle database-related issues

This topic provides instructions for handling database-related management tasks.

Change site schema settings and reinitialize

If you need to make changes to the site schema settings, make the changes in the octane.conf file.

To change site schema settings and reinitialize:

  1. Obtain the names of the indexes related to your instance of ALM Octane in the sharedspace_logical_name.txt in the /opt/octane/server/conf/ directory.

  2. Delete the database site schema.

  3. Delete the repository.

  4. Delete the mqm_<sp_logical_name> index from Elasticsearch. From the shell on the ALM Octane server, run: 

    curl -XDELETE 'http://<server address>:9200/mqm_<sp_logical_name>/'

  5. Start the ALM Octane server.

    systemctl start octane

Back to top

Update database password in ALM Octane site schema and configuration files

If you change your database password, you can use the database password update tool to update the database password in ALM Octane’s site schema, and in the octane.conf configuration files. Note that this does not update the database user’s password, but only ALM Octane's configuration.

Note: The tool operates offline. Credential outputs are disabled for security.

  1. Stop the ALM Octane server.

    After stopping the server, wait 30 seconds before running the tool. The cluster is considered offline when there is no activity from any node for 30 seconds.

  2. Run the following command on your ALM Octane server:

    /opt/octane/install/updatedbcreds.sh

  3. Enter values as described in the sections below.

  4. When you are done, start the ALM Octane server.

Usage

The tool can operate in 2 modes: file, or interactive. 

updatedbcreds.sh <-m mode> <-f path | -t target>

Where:

  • mode = {file | interactive}

  • target = {admin | user}

  • path = valid absolute or relative path to file

File. If mode is set to file, use -f to specify the path to the password definition file. Credentials will be taken from the provided file.

Interactive. If mode is set to interactive, use -t to specify the target whose password you want to change - either admin or user. You will enter credentials interactively.

Example: If you want to update the db.admin-user in the config file, the target should be admin (in Interactive mode).

If you want to update the db.<db-vendor>.app-user-name in the config file, the target should be user (in Interactive mode).

You can use the CLI in file mode, which allows granular definitions for admin, user, or space passwords.

Using a tool in file mode looks like this:

./updatedbcreds.sh -m file -f /path/to/definition.json

This is done using a JSON password definition file, in the following format:

```json
{
  "admin" : {
    "password" : "PasswordForAdminUser"
  },
  "appUser" : {
    "password" : "PasswordForAppUser"
  },
  "spaces": {
    "default_shared_space": {
      "password": "PasswordForSpecificSpace"
    }
  }
}

You can delete the spaces section. In this case all spaces will get the appUser password.

Caution: Before the tool runs, your file contains passwords in clear text. It is your responsibility as administrator to secure the file according to your organization's policies. The tool encrypts the file when running. The tool can read the encrypted password if you want to rerun the tool.

For improved security, use interactive mode.

In interactive mode you update only the admin or user password. This is useful when you do not need extensive password definition and just want to change a password for a single user.

Using a tool in interactive mode looks like this:

$ ./updatedbcreds.sh -m interactive -t admin

Enter the following:

  • New password for ADMIN: Enter a new password for admin user. Output is disabled.

  • DB authentication username: Enter a user for CLI database connection. Output is disabled.

  • DB authentication password: Enter a password for CLI database connection. Output is disabled.

Back to top

See also: