Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
devel:documentation:adm:export_import [2021/05/26 08:21] 127.0.0.1 external edit |
devel:documentation:adm:export_import [2021/09/17 15:25] (current) apeterova formatting |
||
---|---|---|---|
Line 5: | Line 5: | ||
This agenda is used to transfer configuration data from one IdM to another. A typical use scenario is when you already have IdM configured on a test environment and now you need to migrate the tested configuration to a production environment. | This agenda is used to transfer configuration data from one IdM to another. A typical use scenario is when you already have IdM configured on a test environment and now you need to migrate the tested configuration to a production environment. | ||
- | Without this tool, you must manually transfer the settings. Ie. you must create roles, system definitions, | + | Without this tool, you must manually transfer the settings. Ie. you must create roles, system definitions, |
- | So the main goal is to facilitate configuration transfer between individual IdM systems. | + | |
This transmission is divided into two basic parts **Export** and **Import**: | This transmission is divided into two basic parts **Export** and **Import**: | ||
- | {{ : | + | {{ ..: |
===== Export ===== | ===== Export ===== | ||
+ | |||
You can export data from the source IdM by using bulk operations over the appropriate agendas. | You can export data from the source IdM by using bulk operations over the appropriate agendas. | ||
- | For example, if you want to export roles, then first select the appropriate roles in the role agenda and then run the **Export Roles** bulk operation. | + | For example, if you want to export roles, then first select the appropriate roles in the role agenda and then run the **Export Roles** bulk operation. The result of this operation will be to create a new export batch in the **Menu |
- | The result of this operation will be to create a new export batch in the **Menu | + | |
- | {{ : | + | {{ ..: |
===== Import ===== | ===== Import ===== | ||
- | Import is performed in the target IdM, when in the same agenda **Menu -> Settings -> Export/ | ||
+ | Import is performed in the target IdM, when in the same agenda **Menu → Settings → Export/ | ||
The import batch can then be run in the so-called **demo mode**. This mode serves to test what the given batch will actually change in the target IdM. | The import batch can then be run in the so-called **demo mode**. This mode serves to test what the given batch will actually change in the target IdM. | ||
Line 28: | Line 27: | ||
When we are sure that we really want to make the changes that the batch makes, we can proceed to the launch of the import itself. | When we are sure that we really want to make the changes that the batch makes, we can proceed to the launch of the import itself. | ||
- | {{ : | + | {{ .: |
===== Dry run mode ===== | ===== Dry run mode ===== | ||
+ | |||
**Dry run** is a mode where we first want to check what changes will be made to the target IdM. For example, due to **authoritative mode**, some objects that are not part of the imported batch may be deleted during import. Starting dry run mode allows us to find out what **data will be deleted**. | **Dry run** is a mode where we first want to check what changes will be made to the target IdM. For example, due to **authoritative mode**, some objects that are not part of the imported batch may be deleted during import. Starting dry run mode allows us to find out what **data will be deleted**. | ||
Line 37: | Line 37: | ||
< | < | ||
- | {{ : | + | {{ .: |
===== How it works? ===== | ===== How it works? ===== | ||
+ | |||
Each export of a given type of object is implemented as a separate bulk action, which ensures correct data export. The export action must also ensure that the export metadata is correctly created. Export metadata is the file **export-batch.json**, | Each export of a given type of object is implemented as a separate bulk action, which ensures correct data export. The export action must also ensure that the export metadata is correctly created. Export metadata is the file **export-batch.json**, | ||
+ | ==== Export descriptors ==== | ||
- | ==== Export descriptors ==== | ||
Export descriptors primarily define the order in which data is exported (the same order is used during import). In addition, each descriptor contains additional metadata that defines how the import should handle that type of object. The descriptor metadata also defines: | Export descriptors primarily define the order in which data is exported (the same order is used during import). In addition, each descriptor contains additional metadata that defines how the import should handle that type of object. The descriptor metadata also defines: | ||
- | * **Supports authoritative mode** - Defines whether authoritative mode is enabled for this object type. If so, then the import removes other / redundant entities from the target IdM (for example, if the role contains additional guarantors that do not exist in the batch, they will be deleted).Parent fields are uses for find ID of super parents for this batch (system, role, ..). | + | |
- | * **Parent fields** - Defines name of parent fields. This contains UUID of entity for which was DTO exported. This is important for authoritative import, because we need to delete others entity from target IdM. Parent fields are uses for find ID of super parents for this batch (system, role, ..). | + | * **Parent fields** |
- | * **Super parent filter property** - Defines name of filter for find all DTOs existing under same super parent on target system. Super parent DTO ia typically system or role. This field is mandatory for authoritative mode. This property is uses for find specific setter in Filter POJO. It means setter must exists in filter! | + | * **Super parent filter property** |
- | * **Advanced paring fields** | + | * **Advanced paring fields** |
- | * **Optional** - If is true and DTO will cannot be persisted, because some relation was not found, then only warning will be logged, but batch can continue. | + | * **Optional** |
- | * **Excluded fields** | + | * **Excluded fields** |
+ | <note important> | ||
- | <note important> | + | ===== What can be exported ===== |
+ | Version **10.2.0** | ||
- | ===== What can be exported ===== | + | <note important> |
- | Version **10.2.0** implements export of **roles**, **systems**, | + | |
- | + | ||
- | <note important> | + | |
==== Roles ==== | ==== Roles ==== | ||
Line 64: | Line 64: | ||
Roles are exports with this related objects: | Roles are exports with this related objects: | ||
- | * **More information (EAV)** (authoritative mode = **off**) | + | |
- | * **Definition of assigned attributes** (authoritative mode = **on**) | + | * **Definition of assigned attributes** |
- | * **Business roles** (authoritative mode = **on**) | + | * **Business roles** |
- | * **Incompatible roles** (authoritative mode = **on**) | + | * **Role authorizer - defined by role** |
- | * **Role authorizer - defined by role** (authoritative mode = **on**) | + | * **Role authorizer - defined by identity** |
- | * **Role authorizer - defined by identity** (authoritative mode = **on**) | + | * **Role catalogue** |
- | * **Role catalogue** (authoritative mode = **on**). Besides a role catalog relation, the catalog definition itself is also exported. Only the catalog to which the role is linked is always exported and all catalogs defining the path to the root of the catalog tree. The catalogs themselves are not exported in authoritative mode (authoritative mode = **off**) | + | * **Permissions** |
- | * **Permissions** (authoritative mode = **on**) | + | * **Automatic roles** |
- | * **Automatic roles** - Version **10.2.0** doesn' | + | * **Systems** |
- | * **Systems** - Relation between role and system is not exported within role export. **This relations are exported within export of systems**. | + | ==== Systems ==== |
- | ==== Systems ==== | ||
<note tip> | <note tip> | ||
Systems are exports with this related objects: | Systems are exports with this related objects: | ||
- | * **Connector configuration** (authoritative mode = **off**) | + | |
- | * **Connector pooling configuration** (authoritative mode = **on**) | + | * **Connector pooling configuration** |
- | * **Provisioning brake** (authoritative mode = **on**) - Relations to a receivers are mandatory. It means a identities or roles using as receivers must exists in target IdM. | + | * **Provisioning brake** |
- | * **System scheme** (authoritative mode = **on**) | + | * **System scheme** |
- | * **System scheme attributes** (authoritative mode = **on**) | + | * **System scheme attributes** |
- | * **Mapping** (authoritative mode = **on**) | + | * **Mapping** |
- | * **Attributes mapping** (authoritative mode = **on**) - If a particular attribute maps an EAV attribute to an entity (such as identity), then **the attribute definition is also added to the export**. | + | * **Attributes mapping** |
- | * **Role assigns account in systems** (authoritative mode = **on**, optional = **on**) - Relations between system and roles are exports as optional. It means if some of a role isn't found on target IdM, then is that relation skipped (import will be continue). Within exporting of this relations are role-defined attributes also exported (authoritative mode = **on**, optional = **on**). | + | * **Role assigns account in systems** |
- | * **Sync configuration** (authoritative mode = **on**, optional=**on**) - Sync contract/ | + | * **Sync configuration** |
- | + | <note important> | |
- | <note important> | + | |
<note tip> | <note tip> | ||
Line 102: | Line 100: | ||
**For execute an export action you will need to have:** | **For execute an export action you will need to have:** | ||
- | * Permission to autocomplete and read, update and create export batch: **Export/ | + | * Permission to autocomplete and read, update and create export batch: **Export/ |
- | * Permission to see a progress bar: **Scheduler (IdmLongRunningTask)** | Autocomplete| BasePermissionEvaluator. | + | * Permission to see a progress bar: **Scheduler (IdmLongRunningTask)** |
- | * Permission for read exported object. For example: To export a application configurations you need: **Configuration (app) (IdmConfiguration)** | Read | BasePermissionEvaluator. | + | * Permission for read exported object. For example: To export a application configurations you need: **Configuration (app) (IdmConfiguration)** |
<note important> | <note important> | ||
Line 110: | Line 108: | ||
**For execute an import action in dry-run mode you will need to have:** | **For execute an import action in dry-run mode you will need to have:** | ||
- | * Permission to autocomplete and read, update and create export batch: **Export/ | + | * Permission to autocomplete and read, update and create export batch: **Export/ |
- | * Permission to see a progress bar: **Scheduler (IdmLongRunningTask)** | Read | BasePermissionEvaluator. | + | * Permission to see a progress bar: **Scheduler (IdmLongRunningTask)** |
- | * Permission to read import log: **Export/ | + | * Permission to read import log: **Export/ |
**For execute an import action you will need to have:** | **For execute an import action you will need to have:** | ||
- | * Permission to admin export batch: **Export/ | + | * Permission to admin export batch: **Export/ |
- | + | ||
- | <note important> | + | |
+ | <note important> | ||
===== Performance tests ===== | ===== Performance tests ===== | ||
- | Performance testing took place with using numbers of Systems (specifically CSVDir system) with assigned several roles, set mapping etc. to increase overall number of entities to export. | + | Performance testing took place with using numbers of Systems (specifically CSVDir system) with assigned several roles, set mapping etc. to increase overall number of entities to export. The goal was to find both particular time of duration and estimation of the export/ |
- | The goal was to find both particular time of duration and estimation of the export/ | + | |
* Testing was performed on NB (i7, 16GB RAM, SSD). | * Testing was performed on NB (i7, 16GB RAM, SSD). | ||
Line 133: | Line 128: | ||
Following table shows number of testing systems and measured times of their export and import. The growth of the operation time is roughly linearly proportional to number of testing systems and by extension overall processed entities. | Following table shows number of testing systems and measured times of their export and import. The growth of the operation time is roughly linearly proportional to number of testing systems and by extension overall processed entities. | ||
- | + | ^System num^Overall entity num ^Export time [min]^Import time - Dry run [min]^Import time - Apply changes [min]^Zip size [MB]| | |
- | ^System num ^ Overall entity num ^ Export time [min] ^ Import time - Dry run [min] ^ Import time - Apply changes [min]^ Zip size [MB] ^ | + | |111|2691|1|1|3|2, |
- | | 111 | 2691 | 1 | 1 | 3 | 2,18 | | + | |201|4851|1|3|10|3, |
- | | 201 | 4851 | 1 | 3 | 10 | 3,93 | | + | |415|9982|2|10|35|8, |
- | | 415 | 9982 | 2 | 10 | 35 | 8,08 | | + | |815|19582|4|38|130|15, |
- | | 815 | 19582 | 4 | 38 | 130 | 15,8 | | + | |
===== Limitations ===== | ===== Limitations ===== | ||
==== Cannot be used to update systems / roles that have not been created by the import function ==== | ==== Cannot be used to update systems / roles that have not been created by the import function ==== | ||
- | <note important> | ||
- | In addition to the basic match of identifiers, | + | <note important> |
- | **systems**, | + | |
+ | In addition to the basic match of identifiers, | ||
- | However, there are a number of objects that require unique attributes based on two or more attributes. For example, a **scheme of a system** that requires its **name to be unique within the system**. | + | However, there are a number of objects that require unique attributes based on two or more attributes. For example, a **scheme of a system** |
- | Pairing of these objects is not supported in version **10.2.0**. Trying to update such an object will result in the import attempting to create a **system schema with a duplicate name**, which will result in the entire **import failing**. | + | |
</ | </ | ||
- | ==== No skip implemented | + | ==== No skip implemented ==== |
<note important> | <note important> | ||
- | ==== Virtual systems | + | ==== Virtual systems ==== |
<note tip > Full support of the virtual system export and import has been available since version 11.1. Following workaround should not be necessary anymore. </ | <note tip > Full support of the virtual system export and import has been available since version 11.1. Following workaround should not be necessary anymore. </ | ||
- | When importing a virtual system, you must make some further adjustments so the imported system behaves in the same way as the exported system. Especially if you use the " | + | When importing a virtual system, you must make some further adjustments so the imported system behaves in the same way as the exported system. Especially if you use the " |
- | * Go to **Settings | + | |
+ | * Go to **Settings | ||
* Go to **Form attributes**, | * Go to **Form attributes**, | ||
More info [[https:// | More info [[https:// | ||
- | |||
- | |||
- | |||