Scenario Image Contract

Mon, 01 Jan 0001 00:00:00 +0000

Krknctl and Krkn Operator discover scenario definitions from container image metadata. To add a custom scenario, publish an image with the expected labels and configure its registry in the client. You do not need to add the scenario to krknctl’s source code when the existing input types cover its parameters.

The packaging lab builds this contract without rebuilding krkn-hub. The definitions are implemented in krknctl’s input field parser and type validators.

Image labels

krknctl.is_a_scenario identifies scenario images when set to "true".
krknctl.title and krknctl.description describe the scenario.
krknctl.input_fields contains a JSON array of field descriptors.
krknctl.kubeconfig_path appears in the companion image as metadata. The clients used in this lab do not read it to configure the kubeconfig mount. Set the runtime mount path independently.
krknctl.privileged declares a privilege requirement. It is not an RBAC grant; actual permissions depend on the client, runtime, and target credentials.
krknctl.has_rollback describes rollback capability. Set it to match implemented behavior, not to indicate an intended future feature.

The base image can also supply global input labels such as krknctl.input_fields.global. Keep scenario-specific fields in the scenario label rather than copying every framework setting into it.

Metadata on Krkn

Scenario Image Contract

Image labels