Complete List of Labels¶
The following table describes the labels supported by the MemVerge Transparent Checkpoint Operator:
| Label | Description |
|---|---|
memverge.ai/checkpoint-mode |
Set to true to enable MemVerge transparent checkpoint/restore service. |
memverge.ai/checkpoint-containers |
List of container names to be checkpointed, delimited by comma. If not set, all containers except istio-proxy and nginx-proxy are checkpointed. |
memverge.ai/checkpoint-storage-volume |
An existing volume in the pod used for checkpoint storage. If not set, a dynamically provisioned PV is used for checkpoint storage. The PV's lifecycle is controlled by the operator, which requires that the pod has a controller. This option is required for plain pods (no workload controller, i.e., StatefulSet, Job, CronJob, etc.). The user must manage the lifecycle of the volume. |
memverge.ai/checkpoint-storage-class |
The StorageClass name used to dynamically provision the Persistent Volume for checkpoint storage. If not set, the default StorageClass is used. It is ignored if memverge.ai/checkpoint-storage-volume is set. |
memverge.ai/checkpoint-volume-size |
The size of the Persistent Volume for checkpoint storage. If not set, it is computed by summation of the memory limits of all containers in the pod. It is ignored if memverge.ai/checkpoint-storage-volume is set. |
memverge.ai/checkpoint-diagnosis |
Set to true to preserve checkpoint images and logs for diagnostic purposes. |
Certain configurations can't be set in label because of label's syntax limitation. Besides, each container in a pod might want different configurations for file saving and advanced options. These configurations can be set in the environment variables of each container.
The following table describes the container environment variables supported by the MemVerge Transparent Checkpoint Operator:
| Environment Variable | Description |
|---|---|
MMC_CHECKPOINT_FILES |
List of files/directories to be checkpointed, delimited by comma. |
MMC_CHECKPOINT_ADVANCED_OPTIONS |
List of advanced options for checkpointing containers. |
MMC_RESTORE_ADVANCED_OPTIONS |
List of advanced options for restoring containers. |
By understanding and applying these labels and environment variables, you can effectively manage the checkpointing behavior of your Kubernetes applications using the MemVerge Transparent Checkpoint Operator. Remember to consult the operator's logs and Kubernetes events for detailed information.