Deployment

An administrator can use the deployment function within the BPC to transfer individual module components and BPC configurations from one BPC installation to another.

It is also possible to deploy modules and themes, see Deployment of BPC modules and themes.

Configuration of deployment targets

The BPC instances from and to which a configuration is to be deployed must be created as Backend Connections of type deployment_system (see Backend Connections).

A deployment system with the name Local BPC and the ID ds_local is automatically created for the local BPC server (can be used as source and target). A valid API key must be stored there.

Call deployment wizard (1st option)

The deployment wizard can be started in the administration area in the function bar. This enables the selection of the deployment source and target systems, automatically starts the synchronization of the selected BPC instances and lists all deviations.

deployment open wizard

Call deployment wizard (2nd option) The deployment wizard can be started in the administration area in the function bar. Option)

At Core Services and Backups, a backup can be selected as the source for the deployment at the bpc-configuration indices (these contain the configuration settings). To do this, click on the symbol with the two arrows (see screenshot).

deployment backup as source

Calling up the deployment wizard (3. Possibility)

The deployment wizard can be deployed as a plugin to various hooks at Core Services and Plugins.

deployment wizard from plugin

Deployment wizard

After selecting the deployment source and target system, a tree view is generated that is grouped by module type.

If there is no direct connection between the two systems, you can take a detour via a JSON file. To do this, first select the source system and JSON as the target system. On the target system, load this JSON file as the source system ( select`JSON` ) and deploy to the target system.

deployment overview 1
deployment overview 2

The colored circles in the source system help to identify the module differences compared to the target system. The circles in the first column refer to the components of a module, those in the second column to the module itself.

Color code Meaning

Green

The green circle indicates that the module or module component is present on both the source system and the target system and has the same configuration.

Orange

The orange circle indicates that the module or module component is present on both the source system and the target system, but with different settings or setting values.

Red

The red circle indicates that the module or module component is missing on the target system.

A tooltip with the meaning is available on the colored circles.

Source system selection filters

Filters can be defined in the source tree using the tools in the tree header. The filters show missing, modified and identical modules compared to the target system.

deployment filter sourcesystem

Target system selection filter

The target filter shows the list of modules or module components that are to be deployed.

deployment filter targetsystem

Deployment of modules and components

To deploy modules and components, click on the arrow in the source tree. If the module is not yet present in the target system, it is added to it. If the module already exists on the target system, the settings of the source system overwrite the settings on the target system as soon as the "Deploy" button is pressed.

deployment sourcesystem

When deploying to the target system, only different and missing settings are transferred.

Deployment of individual settings

Individual settings of modules and components can also be deployed. Open the context menu in the source tree for the selected module or module component and select Einstellungen vergleichen or click on the icon with the "≠" symbol.

deployment compare settings open dialog

In the settings comparison window, the settings are marked with the same color coding as described above (except for settings that do not differ).

deployment compare settings 1

Use the arrow in the source tree to add individual settings to the deployment. You can undo this again using the arrow in the target system.

deployment compare settings 2

If settings differ with a JSON value, a comparison window can be opened by clicking on the value in the source system. The differences are then visually highlighted in this window.

deployment compare settings json diff

The JSON on the source system (left-hand side) can be edited. These changes can be applied by clicking on the "Adjust source setting" button.

Deployment of bundles

To deploy bundles, click on the arrow in the source tree. If the bundle does not yet exist in the target system, it is added to it and is available shortly after the deployment has been carried out. If the bundle already exists on the target system, it is replaced by this version.

Deployment of OpenSearch indices

To deploy OpenSearch indices, click on the arrow in the source tree. If the index does not yet exist on the target system, it is created there with the same settings and mappings and the documents are copied block by block. If the index already exists on the target system, it is first deleted, recreated and the documents are copied.

The process can take some time depending on the size of the indices to be copied. It is intended for smaller indices or if an index is required on another system for test or adjustment purposes. If the data can be created via replication, select this method.

Activate maintenance mode of the target system

The target system maintenance mode can be activated from the deployment window, but can only be deactivated again directly on the target system.

deployment enable maintenance mode

Validation of the module settings

If Validierung is active, the module settings are validated on the target system during deployment.

deployment validation

Comparison of navigation settings

You can also compare the navigation settings and deploy them individually.

deployment compare navigation 1

The assignment is then carried out using drag & drop.

deployment compare navigation 2

Warning for critical settings

Some settings can cause unwanted behavior on the deployment target. To make it easier to recognize such critical settings during deployment, they are marked with an exclamation mark and a short tooltip text. A few settings are already defined as critical via the 'Core Services' setting 'Core_Deployment' and can be extended there for the respective system.

deployment critical settings

Deployment between BPC with different versions

It is not possible to carry out a Deployment from a BPC with a higher model_version to a BPC with a lower model_version.

However, it is possible to deploy from a BPC with a lower model_version to a BPC with a higher model_version. If necessary, adjustments to the configuration are carried out automatically.


Keywords: