Skip to main content

Managing Catalog Content and Configuration Data

Overview​

Standard Qarbine installations include an internal MongoDB database server running on the primary host. That server includes several databases including one for catalog component content and another for configuration. There are also several database accounts created for Qarbine operations.

Catalog components are generally independent of an installation. You can export and import them across installations. Components like Data Sources reference a data service by name so there is some soft coupling to an installation’s configuration. As long as each installation has a matching data service name with similar data driver and other settings, the queries will likely run as-is.

By default the following configuration settings are different across installations:

  • internal database connection account and passwords,
  • password secret, and
  • JWT secret.

These values are generally contained in the primary host’s ./config/env.main.txt file.

JWT_SECRET=...
PWD_SECRET = ...
COMPUTE_CONNECTION=...
CONFIG_CONNECTION=...
CATALOG_CONNECTION=...
LOG_CONNECTION=...

At primary host installation time passwords are generated for the internal database connection accounts and new password and JWT secrets are also generated. For security purposes a Qarbine installation’s Principal passwords and API keys are dependent on the password and JWT secret values. Catalog components do not have this dependency.

Administration Tools Utilities​

Overview​

The administration tool includes an option to perform various catalog and configuration data activities. Oen the Administration Tool and activate the Utilities tab.

  

In the Utilities tab choose the option noted below.

  

A drop down appears as shown below for action selection.

  

Downloading Catalog and Configuration Data​

Choose the option shown below.

  

Click the desired button.

  

Copying Qarbine Data to Another Database Server​

Choose the option shown below.

  

This option enables the catalog and configuration information to be stored in another database. Internally Qarbine uses a MongoDB database. Thus the other database must be MongoDB API compatible as well. That database may be part of existing operations which includes periodic backups for example. Provide the URI for a target MongoDB database. The URI includes the user name and password for an account which has write permissions.

The account does not require administrative permissions on the target database because the internal Qarbine database accounts and roles are not being copied.

For a MongoDB Atlas target fill out the fields below.

  

For remote MongoDB target (MongoDB Extended Edition or otherwise) fill out the fields below.

  

Test connectivity by clicking   .

To perform the task click   .

Migrate All Qarbine Data to Another Database Server​

Choose the option shown below.

  

This option is similar to the copy one above except that Qarbine database accounts and roles are also defined in the target database. This option would be appropriate when you want to use an external MongoDB Atlas or MongoDB Extended Edition database. For this to succeed the target connection string must reference an account which has administrative privileges. This target database account is only used to perform the Qarbine internal account and role definition steps and is not stored.

Select the target type of database and fill in the details as described above.
Test connectivity by clicking   .

To perform the task click   .

After the data will be copied and the accounts and roles will be defined. The env.main.txt file on the primary host will then be updated with the new host reference in each of the connection strings. For example, if the target database server connection string was

mongodb+srv://johny:hello@cluster0.v8vlh.mongodb.net/cluster0

then the env.main.txt line

COMPUTE_CONNECTION = mongodb://q_compute:Wyb12345@%MAIN_COMPUTE_HOST%:%MONGO_DB_PORT%

will become

COMPUTE_CONNECTION = mongodb+srv://q_compute:Wyb12345@cluster0.v8vlh.mongodb.net/cluster0

All Qarbine compute nodes for this installation must then be restarted so that the new database location takes effect. This can be done from the Administration Tool’s Utilities tab.