Installation with preconfigured BPC

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

Import module and module instance settings

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

Prerequisites and preparation

An existing BPC installation is required, the configuration of which is to be used as the basis for the new system. To do this, export the required configurations from this to a JSON file (deployment target) via Deployment.

Application

Rename the JSON file previously created via deployment. It must have the file extension .bpc-deployment-export. Now copy this to the [KARAF]/deploy directory in the newly set up system. The configurations contained therein are imported automatically.

Notes:

The system checks every 3 seconds whether a file with this file extension exists in the [KARAF]/deploy directory
Only deployment exports in which ALL modules used are loaded can be imported. For example, if the Karaf is just starting up, it will try again in 3 seconds, etc.

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 again and again. It will have one of the following file extensions:

.processed - after successful processing
.empty - if the import file does not contain any module information
.invalid_json - if the import file does not contain any valid JSON
.error - if an error occurred while checking whether all relevant modules have been loaded, an error occurred
.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. In the following, 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. An export is possible under the administration interface under Administration -&gt Core Services -&gt Indices where an export file can be downloaded for the desired index (see also OpenSearch indices view).

Application

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 of the index to be created, in this example my-index.

This file can now be copied to the [KARAF]/deploy directory in the newly set up system. The index is created and filled with the respective data if no index with this name already exists.

Notes:

A check is made every 3 seconds to see whether there is a file with this file extension in the [KARAF]/deploy directory

File extensions

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

After processing, this import file is renamed so that the same file is not processed again and again. It will have one of the following file extensions:

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

Keywords: