API for custom checkpoint meta-data¶

Problem description¶

Currently when creating a checkpoint. The only place to add custom information apart from the name is in the description field. This means that tools that create checkpoints needs to use this user visible space for their own metadata.

User data can only be set during creation and is read-only from that point on.

Use Cases¶

A tool creates a checkpoint and want’s to add information related to the tools functions. For example a tool that creates checkpoints due to specific external events would like to add the event_id of the event that triggered the checkpoint creation.

Proposed change¶

When creating a checkpoint a new field would be available called extra-info. This field must be a map in the format of:

{
    "key": "value",
}

Keys and values must both be strings. Keys that are officially recognized will be in the format of karbor-<key-name> for example karbor-created-by.

Anything that is not officially defined should use the prefix: x-<application>--<key-name>. For example, x-trigger-master--trigger-id

POST/v1/{tenant_id}/checkpoint

{
    ...
    "extra-info": {
            "karbor-created-by": "operation-engine"
    }
}

Implementation¶

Dependencies¶

None

Testing¶

Unit tests in Karbor and the python-karborclient.

Documentation Impact¶

New docs to explain how to use the API.

References¶

None