OpenText Analytics Database 26.2.x – Configuring Management Console

Mc: Changing MC or agent ports

Mon, 01 Jan 0001 00:00:00 +0000

When you configure MC, the Configuration Wizard sets up the following default ports:

5450—Used to connect a web browser session to MC and allows communication from the database cluster nodes to the MC application/web server
5444—Provides MC-to-node and node-to-node (agent) communications for database create/import and monitoring activities

If you need to change the MC default ports

A scenario might arise where you need to change the default port assignments for MC or its agents. For example, perhaps one of the default ports is not available on your database cluster, or you encounter connection problems between MC and the agents. The following topics describe how to change port assignments for MC or its agents.

Changing the MC port

Use this procedure to change the default port for MC's application server from 5450 to a different value.

Open a web browser and connect to MC as a user with MC ADMIN privileges.
On the MC Home page, navigate to MC Settings > Configuration and change the Application server running port value from 5450 to a new value.
In the change-port dialog, click OK.
Restart MC.
Reconnect your browser session using the new port. For example, if you changed the port from 5450 to 5555, use one of the following formats:
```
https://00.00.00.00:5555/
```
OR
```
https://hostname:5555/
```

Changing the agent port

Changing the agent port takes place in two steps: at the command line, where you modify the config.py file and through a browser, where you modify MC settings.

Change the agent port in config.py

$ cd /opt/vertica/oss/python3/lib/python3.9/site-packages/vertica/agent/

Use any text editor to open config.py.
Scroll down to the agent_port = 5444 entry and replace 5444 with a different port number.
Save and close the file.
Copy config.py to the /opt/vertica/oss/python3/lib/python3.9/site-packages/vertica/agent/ directory on all nodes in the cluster.
Restart the agent process by running the following command:
```
$ /etc/init.d/vertica_agent restart
```
Note
If you are using Red Hat Enterprise Linux/CentOS 7, use the following command instead:
```
$ /opt/vertica/sbin/vertica_agent restart
```
Repeat (as root) Step 6 on each cluster node where you copied the config.py file.

Change the agent port on MC

Open a web browser and connect to MC as a user with MC ADMIN privileges.
Navigate to MC Settings > Configuration.
Change Default database agent port from 5444 to the new value you specified in the config.py file.
Click Apply and click Done.
Restart MC so MC can connect to the agent at its new port. See Restarting MC.

Mc: Management Console settings

Mon, 01 Jan 0001 00:00:00 +0000

The MC Settings page allows you to configure properties specific to Management Console. To access MC Settings, go to the Management Console home page > MC Tools > MC Settings.

Configuration settings

The Configuration tab contains the following sections:

System User configurations

View the user name, user group, and user home path for the MC user.

Database configurations

Edit the following database paths:

License path
Catalog path
Data path

MC and Agent Port settings

Configure the server port and the default port the database agent uses.

Application Server JVM settings

Set the initial and maximum heap size for the JVM.

Browser connections settings

Enable and disable username and password auto-complete at Management Console login. After disabling, clear your browser's cache.

MC Password configuration settings

Set password requirements to log into the Management Console. This includes length, expiration, and login attempt settings.

User Analytics and Tracking

Choose if you want to provide the database with analytic information about your MC usage. OpenText™ Analytics Database uses this information to improve the MC in future releases.

Note

When you accept the End-User License Agreement Terms for the MC, you are given the option to provide the database with your anonymous user data. If you want to stop providing data, clear the checkbox in User Analytics and Tracking.

The database collects the following information:

Database type (Eon Mode or Enterprise Mode)
License type
Cloud provider name
Database version
MC version
Current page
Interactions with MC page components, including buttons, drop-down lists, checkboxes, and radio buttons.

To protect your privacy, all collected information is stored and processed anonymously, and in compliance with GDPR regulations. It is stored securely on database servers, and never shared with third-party organizations.

Monitoring settings

Control the following monitoring settings in Management Console:

Enable checks and set alert thresholds for spread retransmit rate. This setting is disabled by default. The recommended alert threshold for spread retransmit rate is 10%.
Set alert thresholds for free Management Console disk space checks. The recommended alert threshold is 500 MB.
Exclude MC queries from activity charts.
Set refresh intervals for MC charts and pages.

Security and authentication settings

On the SSL/TLS Certificates tab, upload a new SSL certificate or view the current certificate.

Note
LDAPS authentication requires a certificate. For details, see User administration in MC.
Use LDAP for user authentication (Authentication tab).

User Federation

You can authenticate users to MC with the following federated servers:

Kerberos
LDAP
LDAPS

For implementation details, see User administration in MC.

Identity Providers

You can authenticate users to MC with an identity provider (IDP). You can configure the MC to use a user-defined authentication protocol for your corporate IDP, or you can select a list of social IDPs, such as GitHub, Facebook, or Google.

For implementation details, see User administration in MC.

User management settings

Create new Management Console users and, with their user credentials, map them to an database managed by Management Console on the database server. See User administration in MC and /en/mc/users-roles-and-privileges/.

Extended monitoring settings

Configure Extended monitoring, which allows you to monitor more long-term data in Management Console:

Set up an external storage database for Extended Monitoring. See Managing the storage database.
Enable or disable Extended Monitoring on your databases. See Managing extended monitoring on a database.

Email Gateway

Local users require an email so they can manage their passwords. Local user profiles require that you complete the following fields:

Host
Port
From Display Name
From
EnableSSL

After the administrator completes the email gateway configuration, the user receives an email to reset their password.

Other MC settings

View your version of OpenText™ Analytics Database or upload a new OpenText™ Analytics Database binary file.
Customize the look and feel of Management Console on the Themes tab.
Configure Management Console to use an alternative data source to monitor your database. See Monitoring external data sources with MC.
Enable Management Console to send email alerts. See Setting up SMTP for email alerts.

Modifying database-specific settings

To inspect or modify settings related to a database managed by Management Console, go to the Existing Infrastructure page. On this page, select a running database to see its Overview page. From the bottom of the Overview page, click the Settings tab to make modifications to database-specific settings.

Mc: Backing up MC

Mon, 01 Jan 0001 00:00:00 +0000

Before you upgrade MC, it is recommended that you back up your MC metadata (configuration and user settings). Use a storage location external to the server on which you installed MC.

On the target server (where you want to store MC metadata), log in as root or a user with sudo privileges.
Create a backup directory:
```
# mkdir /backups/mc/mc-backup-20130425
```

Copy the /opt/vconsole directory to the new backup folder:

# cp –ar /opt/vconsole /backups/mc/mc-backup-20130425

Mc: Connecting securely from MC to the database

Mon, 01 Jan 0001 00:00:00 +0000

When you use MC to monitor and manage a database, MC (running in a browser) connects as the client to the database server.

MC uses JDBC for most database connections

MC uses Java Database Connectivity (JDBC) for most connections to a database, including:

Retrieving database information to display in charts
Running SQL queries through JDBC
Configuring and updating database properties
Configuring the database for extended monitoring

Exception

When MC uses Agents to perform AdminTools tasks, MC does not use JDBC to connect to the database.

OpenText™ Analytics Database supports TLS

OpenText™ Analytics Database and MC support TLS up to version 1.2. This topic and its subtopics describe configuring TLS in MC for JDBC connections to a database.

About certificate file formats

MC requires that all certificate and key files for upload to MC must be in PEM (Privacy-enhanced Electronic Mail) format.

Database security dictates how MC connects

The TLS/SSL security you configure for a database in MC must be consistent with the security configured on the database itself.

Whether the database has TLS/SSL configured in server mode or mutual mode, you should configure TLS/SSL for that database in MC to match.

To find out how the database is configured, see Determining the TLS mode of the database.

You can configure TLS/SSL in either server mode or mutual mode in MC.

The rest of this topic and related topics use the term TLS, TLS/SSL, and SSL interchangeably.

TLS server mode

When the MC client connects to a database configured in server mode:

The client requests and verifies the server's credentials.
The client does not need to present a client certificate and private key file to the server.
The MC administrator must configure the CA certificate that can verify server's certificate on MC when MC connects to the database over JDBC.

TLS mutual mode

When the MC client connects to a database configured in mutual mode:

The MC client requests and verifies the database server's credentials.
The server also requests and verifies the MC client's credentials.
Each MC user is a separate client, and must present a valid client certificate file and private key file pair (keypair), namely a certificate signed by a CA recognized by the database server as valid.
The MC administrator must configure:
- The CA certificate to verify the database server certificate.
- A client certificate and private key file (keypair) for each MC user. The keypair can be unique for each user, or shared by multiple users, depending on how client authentication is configured on the database. See Configuring client authentication.
Each MC user must be configured to map correctly to a user who is configured on the database server.

For more information about how the database supports TLS/SSL security, see TLS protocol.

MC administrator configures MC security

Only MC users having Admin or Super privileges on a database are able to configure TLS certificates and keys on MC for database connections. The topics in this section use "MC administrator" to refer to both of these roles. For more information about MC user roles and privileges, see User administration in MC.

As the MC administrator, when you first configure security in MC for a database that requires mutual mode, you configure these certificates for the database:

The server certificate and public key of the database.
Your own client certificate and private key, as the first configured MC user mapped to a database user.

Configuring TLS/SSL on MC

MC provides the Certificates wizard for configuring TLS certificates for all JDBC connections to the database, to ensure those connections are secure.

In MC, there are three scenarios in which you need to configure TLS security for a database:

While you are importing a database to monitor in MC. See Configuring TLS while importing a database on MC.
When you want to add security for a database that is already monitored by MC. See Configuring TLS for a monitored database in MC.
When you need to configure client security for an individual MC user who is mapped to a user who has privileges on the database server, because the database requires mutual authentication. See Configuring mutual TLS for MC users.

Adding certificates to MC for later use

You may want to add multiple CA certificates or client certificates to MC all at one time, to streamline the configuration of security when you are importing databases to MC or creating MC users. For details, see and .

To connect successfully, MC and database security must match

MC Security	Database Security	Does the connection succeed?
None	None	Connection succeeds, and it is open and therefore unsecured.
TLS server mode	TLS server mode	Connection succeeds provided MC can verify the server's certificate using the CA certificate configured on MC.
TLS mutual mode	TLS mutual mode	Connection succeeds provided: MC can verify the server's certificate using the CA certificate configured on MC. The server can verify the client certificate and private key that MC presents as belonging to a mapped user on the database.
None	TLS server mode	MC attempts to establish an open connection. The connection fails if the database requires TLS for client connections. For more information, see: Client authentication with TLS CREATE AUTHENTICATION
None	TLS mutual mode	MC attempts to establish an open connection. The connection fails if the database requires TLS for client connections. The connection fails because MC does not present what the database requires: a valid client certificate and private key that the database can verify as belonging to a mapped database user.
TLS server mode	None	MC attempts to connect to the database securely, however the connection fails as the database is not configured with TLS certificates.
TLS mutual mode	None	MC attempts to connect to the database securely, however the connection fails as the database is not configured with TLS certificates.

Mc: Upgrading Management Console manually

Mon, 01 Jan 0001 00:00:00 +0000

If you installed MC manually, follow the procedure below to upgrade MC.

If you installed MC automatically on AWS resources, see Upgrading MC automatically on AWS.

Backing up MC before you upgrade

Log in as root or a user with sudo privileges on the server where MC is already installed.
Open a terminal window and shut down the MC process:
```
# /etc/init.d/vertica-consoled stop
```
For versions of Red Hat 7/CentOS 7 and above, use:
```
# systemctl stop vertica-consoled
```
Back up MC to preserve configuration metadata.

Important
A full backup is required in order to restore MC to its previous state. Restoring MC is essential if the upgrade fails, or you decide to revert to the previous version of OpenText™ Analytics Database. For details, see Backing up MC.
Stop the database if MC was installed on an Ubuntu or Debian platform.

Extended monitoring upgrade recommendations

If you use Extended monitoring to monitor a database with MC, it is recommended to follow this upgrade procedure to avoid data loss.

Log in to MC as an administrator.
To stop the monitored database, navigate to the Existing Infrastructure > Databases and Clusters page, select the monitored database and click Stop.
On MC Settings > MC Storage DB Setup, click Disable Streaming to stop the storage database's collection of monitoring data.
To stop the storage database, navigate to the Existing Infrastructure > Databases and Clusters page, select the monitored database and click Stop.
Upgrade MC and OpenText™ Analytics Database according to Upgrade MC and Upgrading Vertica instructions.
To start the storage database, navigate to the Existing Infrastructure > Databases and Clusters page, select the monitored database and click Start.
Start the monitored database.
On MC Settings > MC Storage DB Setup, click Enable Streaming to enable collection of monitoring data.

Important
To avoid data loss, enable streaming soon after starting your monitored database. While your storage database is down and streaming is disabled, the Kafka server can retain data from your running monitored database for a limited amount of time. Data loss occurs when the data exceeds the Kafka retention policy's log size or retention time limits.

Upgrading MC

Note

After you upgrade, you can authenticate users to the MC with a federated server or your corporate identity provider. In addition, you are prompted to provide the following information:

A new password.
If your user profile does not have an email address, you must enter one immediately after accepting the end-user license agreement (EULA).

Download the MC package from the OpenText™ Analytics Database Website:
```
vertica-console-current-version.Linux-distro)
```
Save the package to a location on the target server, such as /tmp.
On the target server, log in as root or a user with sudo privileges.
Change to the directory where you saved the MC package.
Install MC using your local Linux distribution package management system—rpm, yum, zypper, apt, dpkg. For example:

Red Hat 8
```
# rpm -Uvh vertica-console-current-version.x86_64.rpm
```
Debian and Ubuntu
```
# dpkg -i vertica-console-current-version.deb
```
If you stopped the database before upgrading MC, restart the database.

As the root user, use the following command:
```
/etc/init.d/verticad start
```
For versions of Red Hat 8/CentOS 8 and above, run:
```
# systemctl start verticad
```
Open a browser and enter the URL of the MC installation, one of the following:
- IP address:
```
https://ip-address:mc-port/
```
- Server host name:
```
https://hostname:mc-port/
```
By default, mc-port is 5450.

If MC was not previously configured, the Configuration Wizard dialog box appears. Configuration steps are described in Configuring MC.

If MC was previously configured, OpenText™ Analytics Database prompts you to accept the end-user license agreement (EULA) when you first log in to MC after the upgrade.

Additionally, you can choose to provide the database with analytic information about your MC usage. For details, see Management Console settings.

Mc: Upgrading MC automatically on AWS

Mon, 01 Jan 0001 00:00:00 +0000

If you automatically installed Management Console (MC) version 9.1.1 or later on AWS resources, you can automatically upgrade it from the MC interface using the Upgrade wizard.

This process provisions a new Management Console instance and copies any current MC configuration data to the new MC. All MC settings, users, and monitored clusters will be transferred.

After upgrading, you can terminate the previous Management Console instance.

In addition, when you revive an Eon Mode database through the upgraded Management Console, that database will also be automatically upgraded to the same database version as MC.

Upgrade MC automatically

Automatic upgrade is only available if the existing MC has been installed automatically through the AWS Marketplace.

From the MC home page, select MC Settings.
From the menu on the left side of the page, select Upgrade MC. The Upgrade MC page displays current Management Console information and indicates whether you are using the latest version of MC, or if a newer version is available.
Click Start MC Upgrade at the bottom of the page (this button is only displayed if a newer version of MC is available). The Upgrade wizard appears.
Go through the wizard and enter the following information when prompted:
- AWS access key ID and AWS secret key (only required if existing MC was not installed using an IAM role)
- AWS key pair
- MC version to upgrade to
- EC2 instance type for new MC host
- EC2 instance tags (optional)
When upgrade is successful, the wizard displays the URL for the upgraded Management Console. Save this URL; this how to access your new MC. It is important to save this URL for future use; after you terminate your previous MC, the new MC URL will not be available elsewhere. (The MC URL referenced from the original stack when you created MC will continue to reference the previous MC, not the new MC.)
Follow the URL and log into your new MC.
To terminate the previous version of MC:
1. If necessary, disable termination protection for the previous MC instance. You can do so from the AWS console. See the AWS guide for enabling and disabling instance termination protection.
2. From the AWS console, terminate the instance on which the previous MC resides. See the AWS guide for how to terminate instances.
Note
Do not delete other associated resources for the previous MC. Some of these resources may still be in use by the new MC, or by any clusters that were created using the previous MC.

Next steps

If you plan to upgrade an Eon Mode database from Vertica version 9.1.0 or above to a later version, you can do so automatically by reviving it through a newer version of Management Console. As MC revives the database, it will also upgrade the Eon Mode database to the same database version as the upgraded MC. See Reviving an Eon Mode database on AWS in MC.

Mc: Localizing user interface text

Mon, 01 Jan 0001 00:00:00 +0000

You can translate Management Console (MC) user interface (UI) text with language files in the database server. After you translate the UI text, users can select the language from the language selector, a dropdown located to the right of the Message Center bell icon in the MC toolbar.

The required language files include the locales.json file and the resource bundle, a directory of JSON-formatted files that contain the text strings translated into the target language.

Language files are located in the /opt/vconsole/temp/webapp/resources/i18n/lang directory.

locales.json

The locales.json file contains an array of JSON objects with a name key and properties, where each object represents a language that the MC supports. For example, the following object represents Mexican Spanish:

"es_MX": {
    "code": "es_MX",
    "name": "Spanish - Mexico",
    "country_code": "MX"
}

The preceding object provides the following information that you use to translate UI text:

The object name key is a two- or four-letter country code. In the preceding example, the name key is es_MX. The resource bundle name must match this country code, or the MC cannot detect the translation files.
The MC lists the name value in the language selector. If you translated the UI text into Mexican Spanish, the language selector would list Spanish - Mexico.

Resource bundle

The resource bundle is a directory in /opt/vconsole/temp/webapp/resources/i18n/lang that stores a collection of JSON-formatted files that contain the UI text strings that you can translate. By default, OpenText™ Analytics Database provides the following resource bundles:

en_US (American English)
zh_CN (Simplified Chinese)

Creating a custom resource bundle

Important

Custom resource bundles are not preserved when you upgrade Management Console versions. Before you upgrade, you must back up your resource files when you back up your Management Console configuration.

For details, see Upgrading Management Console manually.

To create a resource bundle, you must manually create a new directory and copy files from one of the default resource bundles. For example, to create a resource bundle for Mexican Spanish:

Navigate to the directory that contains the language files:
```
$ cd /opt/vconsole/temp/webapp/resources/i18n/lang
```
Create a new directory named es_MX:
```
$ mkdir es_MX
```
Note
If the name of a resource bundle does not exactly match a name key in locales.json, the MC cannot detect the translation, and the translated language is not available in the language selector.
Copy all files from the default en_US resource bundle into the new es_MX resource bundle:
```
$ cp en_US/* es_MX
```

Text string file structure

Each JSON file in the resource bundle contains text strings for a specific section of the MC interface. For example, the homepage.json file stores text strings for the Management Console home page. Each JSON file represents MC pages and any child UI components that contain text—including subsections, tabs, and buttons—as individual objects. The file nests these pages and child components hierarchically to convey the page structure. For example, the homepage.json file uses the following structure:

{
    "homepage": {
        ...
      },
      "recentDatabase": {
        ...
      },
      "copyright": {
        ...
      },
      ...

The object properties represent the UI text as key/value pairs, where the key is the component with UI text, and the value is the text string that the MC displays in the UI.

Translating text

To translate a text string, edit the text string value. For example, to translate the title of the Recent Databases section into Spanish, open the homepage.json file in a text editor and update homepage.recentDatabase.title value:

{
    "homepage": {
        ...
        },
        "recentDatabase": {
          "title": "Bases de Datos Recientes",
          ...
}

OpenText Analytics Database 26.2.x – Configuring Management Console

Mc: Changing MC or agent ports

If you need to change the MC default ports

Changing the MC port

Changing the agent port

Change the agent port in config.py

Note

Change the agent port on MC

See also

Mc: Management Console settings

Configuration settings

System User configurations

Database configurations

MC and Agent Port settings

Application Server JVM settings

Browser connections settings

MC Password configuration settings

User Analytics and Tracking

Note

Monitoring settings

Security and authentication settings

Note

User Federation

Identity Providers

User management settings

Extended monitoring settings

Email Gateway

Other MC settings

Modifying database-specific settings

Mc: Backing up MC

Mc: Connecting securely from MC to the database

MC uses JDBC for most database connections

Exception

OpenText™ Analytics Database supports TLS

About certificate file formats

Database security dictates how MC connects

TLS server mode

TLS mutual mode

MC administrator configures MC security

Configuring TLS/SSL on MC

Adding certificates to MC for later use

To connect successfully, MC and database security must match

Mc: Upgrading Management Console manually

Backing up MC before you upgrade

Important

Extended monitoring upgrade recommendations

Important

Upgrading MC

Note

Mc: Upgrading MC automatically on AWS

Upgrade MC automatically

Note

Next steps

Mc: Localizing user interface text

locales.json

Resource bundle

Creating a custom resource bundle

Important

Note

Text string file structure

Translating text