Werk #14821: Custom extensions might need adjustment due to refactorings in GUI code (Transform)

Component Setup
Title Custom extensions might need adjustment due to refactorings in GUI code (Transform)
Date Sep 6, 2022
Level Trivial Change
Class New Feature
Compatibility Incompatible - Manual interaction might be required
Checkmk versions & editions
2.2.0b1
Not yet released
Checkmk Raw (CRE), Checkmk Enterprise (CEE), Checkmk Cloud (CCE), Checkmk MSP (CME)
2.2.0b1
Not yet released
Checkmk Raw (CRE), Checkmk Enterprise (CEE), Checkmk Cloud (CCE), Checkmk MSP (CME)
2.2.0b1 Checkmk Raw (CRE), Checkmk Enterprise (CEE), Checkmk Cloud (CCE), Checkmk MSP (CME)

This werk only affects users of non-Checkmk custom extensions (single files and MKPs from non- Checkmk sources such as the Checkmk exchange).

Before this werk, the Checkmk codebase offered the ValueSpec subclass Transform, which was used for two things:

  • Changing the format in which configured values are stored (back and forth specified).
  • Updating legacy configurations to the current format (forth only specified).

As of this werk, the Transform class should only be used for the first point above (changing the storage format). It now expects two arguments to_valuespec (previously forth) and from_valuespec (previously back). back and forth are still accepted as arguments and work as before. However, back and forth will be removed in a future version and to/from_valuespec will become mandatory.

For updating legacy configurations, use the new Migrate class, which requires a mandatory migrate argument. This is the equivalent of specifying forth only in the Transform class.

To the list of all Werks