Statuses of the product layer update process in all domains (product_layer_multi)

Table of Contents

Description

A virtual entity to manage the rollout of product layer updates across all domains.

Not stored in the database. Built every time based on product_layer polling in all domains.

Updates are installed sequentially across all domains. The log contains the console output of the process

Updates are only installed in domains where the product layer has been successfully deployed using the automatic installation process via an entity product_layer. Installing the upgrade preserves the deployment mode and package composition selected and installed in each domain.

Fields

Entity structure
{
  "prefix": str,
  "domain": str,
  "items": array<obj>
}
Table 1. Fields
Specification Description

Field: operation
Mode: in
Type: str
Default: 'update'

Requested operation. Value options:

  • update - upgrade order. Applies only in domains where the product layer was previously installed via API. The operation is placed in all domains by default, unless otherwise specified using masks in the 'domains' parameter. The default 'mode' is applied from the previous installation.

  • install - order for installation or reinstallation. It is mandatory to have the parameter 'domains'.

  • delete - order to delete the product layer (metadata). It is obligatory to have the parameter 'domains'.

  • clear - order of product layer removal with data cleaning. It is obligatory to have the parameter 'domains'.

Field: domains
Mode: in
Type: array<str>
Default: — 

List of masks for domain tree filtering. Special characters may be used: '*', '$', '?'.
If necessary, the master domain should also fall under the list of specified masks.
The parameter is mandatory for the 'install' operation, and no filtering is performed by default for the 'update' operation.

Field: prefix
Mode: in
Type: str
Default: required

The prefix of the name of the product layer archive file accessible via the /rest/v1/fs/targets/product.
Applies only when creating an entity (installation order) to discover a specific product layer archive file, and is not contained in the collection issue.

Field: mode
Mode: in
Type: str
Default: required

Setting mode applied to all domains selected for the operation. Possible options:

  • default - all microservices are collapsed into a single operating system process.

  • multi - each microservice in a separate operating system process with a separate connection to the platform.

The default mode for 'update' operation is the mode from a previously performed installation. For the 'install' operation, it is mandatory to specify the mode.

Field: domain
Mode: out
Type: str

Domain Name. Only at issuance.

Field: items
Mode: out
Type: array<str>

List of product_layer objects of a specific domain. Only at issuance.