set up base for migrating infield locations from APM to CDM by erikangelsen-cognite · Pull Request #2159 · cognitedata/toolkit

erikangelsen-cognite · 2025-11-03T16:58:28Z

InField V2 Config Migration Architecture

https://cognitedata.atlassian.net/browse/FO-2086

Overview

This migration transforms the old APM Config structure into the new InField V2 configuration format, splitting location-specific and shared configuration into separate resources.

Architecture Diagram

┌─────────────────────────────────────────────────────────────┐
│                    Old APM Config                           │
│  ┌──────────────────────────────────────────────────────┐  │
│  │  APMConfig (externalId: "APP_CONFIG_V2" or           │  │
│  │              "default-config")                        │  │
│  │  ┌────────────────────────────────────────────────┐  │  │
│  │  │  FeatureConfiguration                           │  │  │
│  │  │  ├─ rootLocationConfigurations: [loc1, loc2...]│  │  │
│  │  │  ├─ observations                                │  │  │
│  │  │  ├─ activities                                  │  │  │
│  │  │  ├─ documents                                   │  │  │
│  │  │  ├─ notifications                               │  │  │
│  │  │  ├─ assetPageConfiguration                      │  │  │
│  │  │  └─ disciplines                                 │  │  │
│  │  └────────────────────────────────────────────────┘  │  │
│  └──────────────────────────────────────────────────────┘  │
└─────────────────────────────────────────────────────────────┘
                            │
                            │ Migration
                            ▼
┌─────────────────────────────────────────────────────────────┐
│                   New InField V2 Config                      │
│                                                              │
│  ┌────────────────────────────────────────────────────────┐ │
│  │  DataExplorationConfig (1 per config)                 │ │
│  │  ├─ observations                                      │ │
│  │  ├─ activities                                        │ │
│  │  ├─ documents                                         │ │
│  │  ├─ notifications                                    │ │
│  │  └─ assets                                           │ │
│  └────────────────────────────────────────────────────────┘ │
│                           ▲                                 │
│                           │ DirectRelationReference         │
│                           │                                 │
│  ┌────────────────────────────────────────────────────────┐ │
│  │  InFieldLocationConfig (1 per location)                │ │
│  │  ├─ rootLocationExternalId ───────────┐               │ │
│  │  ├─ featureToggles                     │               │ │
│  │  ├─ appInstanceSpace                   │               │ │
│  │  ├─ accessManagement                  │               │ │
│  │  ├─ disciplines                        │               │ │
│  │  ├─ dataFilters                        │               │ │
│  │  └─ dataExplorationConfig ─────────────┼───────────────┘ │
│  └────────────────────────────────────────────────────────┘ │
│                           │                                 │
│                           │ References via externalId       │
│                           ▼                                 │
│  ┌────────────────────────────────────────────────────────┐ │
│  │  LocationFilter (Fusion) (1 per location)                        │ │
│  │  ├─ name                                              │ │
│  │  ├─ description                                       │ │
│  │  ├─ instanceSpaces                                    │ │
│  │  └─ dataModels                                        │ │
│  └────────────────────────────────────────────────────────┘ │
└─────────────────────────────────────────────────────────────┘

Key Relationships

InFieldLocationConfig → LocationFilter (Fusion): Via rootLocationExternalId (string reference)
InFieldLocationConfig → DataExplorationConfig: Via dataExplorationConfig (DirectRelationReference)
All locations share: disciplines and dataExplorationConfig from the same FeatureConfiguration

Migration Selection Logic

Only one APM Config is migrated per run:

Priority 1: Config with externalId = "APP_CONFIG_V2"
Priority 2: Config with externalId = "default-config"
Otherwise: No migration is performed

APIs Used

Location Filters API: For creating/updating LocationFilter resources
Data Modeling Instances API: For creating/updating InFieldLocationConfig and DataExplorationConfig nodes

Test & implementation

All migrations have units tests.
Successfull migrations done in projects: aws-dub-dev and infield-dev project.

doctrino

Before I review this any further. Can you describe the overall flow. What is APMConfig in v1 of Infield turned into? From the code it looks like a location filter + a special new config. Is this so?

Furthermore, I think it is sensible that we instead of doing this ad-hoc introduction of InfieV2 config classes, we add support for it in Toolkit in the same way we did for the v1 config. What do you think?

doctrino · 2025-11-04T08:51:26Z

cognite_toolkit/_cdf_tk/commands/_migrate/creators.py

        for config in apm_config:
-            new_config = self._create_infield_v2_config(config)
-            new_config_nodes.append(new_config)
+            if not config.feature_configuration or not config.feature_configuration.root_location_configurations:


This should at least give a warning rather than silently skipping it.

doctrino · 2025-11-04T08:53:07Z

cognite_toolkit/_cdf_tk/commands/_migrate/command.py


+        results = DeployResults([], "deploy", dry_run=dry_run)
+
+        # Special handling for InfieldV2ConfigCreator which creates two different resource types


Is this true, do you expect APM_Config to turn into location filter(s) and a special Infield v2 configuration?

erikangelsen-cognite · 2025-11-04T10:21:26Z

cognite_toolkit/_cdf_tk/commands/_migrate/infield_config/location_filter/fields.py

+    location_filter.data_models = data_models
+
+    # TODO: Add more field migrations here as they are implemented
+    # - views


View selection.
If customer har created Asset or Maintenance order extentions, they must be listed here.
How do we migrate this? Or set it up at initial config creation when using toolkit?

# Description **Context** Cognite Toolkit have `pydantic` classes for all resources we support. This class is used to validate user input and give good error messages if they mistype. This PR add the `InfieldCDMv1YAML` class that will be used when supporting the new infield configuration format. I built the `InfieldLocationConfigYAML` based on the `InfeildLocationConfig` in the `InField` system model, and I used the #2159 for all the `JSONObjects`. <img width="1436" height="1004" alt="image" src="https://github.com/user-attachments/assets/0568b58c-9e91-45e5-9d7f-79fe6432bf81" /> ## Changelog - [ ] Patch - [x] Skip

erikangelsen-cognite added 6 commits November 3, 2025 17:55

set up base for migrating infield locations from APM to CDM

3f3ffdd

restucture files and do instanceSpace migration

97fca69

change type structure

d828d26

migrate data model to location filters

ca4d32f

feature toggle migration

708bd16

comment todo for the remaining fields to migrate

9a583fb

doctrino reviewed Nov 4, 2025

View reviewed changes

erikangelsen-cognite added 4 commits November 4, 2025 10:03

migrate asset

3b4e6d7

disciplines and access management migration

50bf33f

data filters migration

9a23117

migrate data exploration config

2563b6c

erikangelsen-cognite commented Nov 4, 2025

View reviewed changes

doctrino mentioned this pull request Nov 5, 2025

[CDF-26171] 👷 Infieldv2 yaml #2171

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

set up base for migrating infield locations from APM to CDM#2159

set up base for migrating infield locations from APM to CDM#2159
erikangelsen-cognite wants to merge 10 commits intomainfrom
infield/app-config-migration-base

erikangelsen-cognite commented Nov 3, 2025 •

edited

Loading

Uh oh!

doctrino left a comment

Uh oh!

doctrino Nov 4, 2025

Uh oh!

doctrino Nov 4, 2025

Uh oh!

erikangelsen-cognite Nov 4, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants


		results = DeployResults([], "deploy", dry_run=dry_run)

		# Special handling for InfieldV2ConfigCreator which creates two different resource types

Conversation

erikangelsen-cognite commented Nov 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

InField V2 Config Migration Architecture

Overview

Architecture Diagram

Key Relationships

Migration Selection Logic

APIs Used

Test & implementation

Uh oh!

doctrino left a comment

Choose a reason for hiding this comment

Uh oh!

doctrino Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

doctrino Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

erikangelsen-cognite Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

erikangelsen-cognite commented Nov 3, 2025 •

edited

Loading