Product layer update states across all domains (product_layer_multi)

Description

Virtual entity for managing the rollout of product layer updates across all domains.

Not stored in the DB. Built each time by polling product_layer in all domains.

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

Updates are installed only in domains where the product layer was successfully deployed via the automatic installation process through the product_layer entity. Installing an update preserves the deployment mode and the composition of packages 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 variants:

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

  • install - installation or reinstallation order. The 'domains' parameter is required.

  • delete - product layer (metadata) deletion order. The 'domains' parameter is required.

  • clear - product layer deletion order with data cleanup. The 'domains' parameter is required.

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

List of masks for filtering the domain tree. Special characters may be used: '*', '$', '?'.
If necessary, the master domain must also match the specified masks.
The parameter is required for the 'install' operation; for 'update' no filtering is performed by default.

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

Name prefix of the product layer archive file available via /rest/v1/fs/targets/product.
Applied only when creating the entity (installation order) to discover a specific product layer archive file, and is not included in the collection output.

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

Installation mode applied to all domains selected for the operation. Possible values:

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

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

By default for the 'update' operation, the mode from the previous installation is applied. For the 'install' operation, specifying the mode is mandatory.

Field: domain
Mode: out
Type: str

Domain name. Output only.

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

List of product_layer objects of a specific domain. Output only.