Installation with a preconfigured BPC

A preconfigured BPC can be started directly using the Installation. Both module and module instance settings, as well as preconfigured OpenSearch indices, can be imported. This is particularly useful in a Kubernetes/container environment.

Importing Module and Module Instance Settings

Module and module instance settings can be exported as a JSON file via the deployment and imported after installation. The following section explains the preparation and implementation.

Prerequisites and Preparation

An existing BPC installation is required, whose configuration will serve as the basis for the new system. To do this, export the necessary configurations from that installation via Deployment into a JSON file (Deployment Target).

Application

Rename the JSON file previously generated via Deployment. It must have the file extension .bpc-deployment-export. Now copy this file to the <KARAF-INSTALL-DIR>/deploy directory in the newly set up system. The configurations it contains will be imported automatically.

Notes:

The system checks every 3 seconds to see if a file with these extensions exists in the directory <KARAF-INSTALL-DIR>/deploy
Only deployment exports in which ALL used modules are loaded can be imported. For example, if Karaf is currently booting up, the system will try again in 3 seconds, and so on.

File Extensions

As mentioned above, the file to be imported must initially have the file extension .bpc-deployment-export.

After processing, this import file is renamed so that the same file is not processed repeatedly. It will be given one of the following file extensions:

.processed - after successful processing
.empty - if the import file does not contain module information
.invalid_json - if the import file does not contain valid JSON
.error - if an error occurred while checking whether all relevant modules were loaded
.error_on_import - if a problem occurred during the import

Importing OpenSearch Indices

In addition to module and instance settings, OpenSearch indices can also be imported. Below, we describe the preparation and Durchführung.

Prerequisites and Preparation

To import an OpenSearch index, the index must first be exported as a ZIP file. You can export the index from the administration interface under Administration → Core Services → Indexes is possible; there, you can download an export file for the desired index (see also OpenSearch Index View).

Usage

The index ZIP file must be renamed with the file extension .bpc-index-export, for example my-index.bpc-index-export. The name without the extension is the desired index alias for the index to be created; in the example given, this is my-index.

This file can now be copied to the <KARAF-INSTALL-DIR>/deploy directory in the newly set up system. The index will be created and populated with the relevant data, provided no index with this name already exists.

Notes:

The system checks every 3 seconds to see if a file with this file extension exists in the directory <KARAF-INSTALL-DIR>/deploy

File Extensions

As mentioned above, the file to be imported must initially have the file extensions .bpc-index-export.

After processing, this import file is renamed so that the same file isn’t processed repeatedly. It will be given one of the following file extensions:

.processed - after successful processing
.error - if an error occurs during import
.index_already_exists - if the specified index already exists

Keywords: