Metadata for Custom ML Runtimes

This topic addresses the metadata for custom Runtimes.

All new custom Runtimes must override the Edition metadata of existing Runtimes. The rest of the metadata can be overriden to communicate the expectations for the consumers of the image. Both the Docker label and the environment variable match in a custom Runtime image. In order to add or register a custom Runtime to a deployment, the user facing metadata combination should be unique in that deployment. For example, of the following, Editor, Edition, Kernel, Version, and Maintenance Version, at least the later should be incremented for adding a next iteration of the same image.

See the following reference table for more details on ML Runtime metadata.


Environment variable	Docker Label	Description	Override in custom non-PBJ runtime	Value in PBJ Runtimes
`ML_RUNTIME_METADATA_VERSION`	`com.cloudera.ml.runtime.runtime-metadata-version`	Metadata version	Not allowed	Must be set to 2
`ML_RUNTIME_EDITOR`	`com.cloudera.ml.runtime.editor`	CDSW/CML Editor installed in the image.	Allowed	Required
`ML_RUNTIME_EDITION`	`com.cloudera.ml.runtime.edition`	Edition of the image, a notion of the Runtime capabilities.	Required	Required
`ML_RUNTIME_DESCRIPTION`	`com.cloudera.ml.runtime.description`	Longer description of the Runtime image capabilities.	Recommended	Required
`ML_RUNTIME_KERNEL`	`com.cloudera.ml.runtime.kernel`	Main kernel included in the image, e.g., Python 3.8	Not allowed	Required
`ML_RUNTIME_SHORT_VERSION`	`com.cloudera.ml.runtime.short-version`	Main version of the image, e.g., 1.0. This shows up as Version in the selection screen.	Recommended	Required
`ML_RUNTIME_FULL_VERSION`	`com.cloudera.ml.runtime.full-version`	Full version consists of the short version + maintenance version, e.g., 1.0.1	Optional	Optional
`ML_RUNTIME_MAINTENANCE_VERSION`	`com.cloudera.ml.runtime.maintenance-version`	Maintenance version must be an integer, e.g., 1. Only the largest maintenance version of the set of the same short version images are visible for users to select. Increment this number if you create a drop in replacement of an existing Runtime. Start with 1 with a new version or edition.	Recommended	Required
`ML_RUNTIME_CUDA_VERSION`	`com.cloudera.ml.runtime.cuda-version`	CUDA version installed in the image.	Not allowed	Do not set
`ML_RUNTIME_GIT_HASH`	`com.cloudera.ml.runtime.git-hash`	Git hash of runtime source	Not allowed	Do not set
`ML_RUNTIME_GBN`	`com.cloudera.ml.runtime.gbn`	Cloudera internal build number	Not allowed	Do not set