Skip to content

Management Server Config

After install and deploy MMBatch, you will have to use the API to configure the MMBatch Management Server in order to enable checkpoint capability for the first time.

Two levels of configurations are supported -

  • System level

    • Configured through RESTFUL API.

    • Configuration applies to all jobs.

    • Example:

      curl -X PUT http://localhost:8080/api/v1/ckptConfig \
           -H "Content-Type: application/json" \
           -d '{"ckptMode":"iterative", "ckptInterval":"15m", "diagnosisMode":false}'
      

  • Job level / Container level

    • Configured through environment variable.

    • Configuration applies only to the specific job / container.

    • Has higher priority than system level configuration. Will overwrite system level configuration if given.

Below is a table of system-level RESTFUL API keys, definitions, recommended default values, valid values, and corresponding job-level environment variable Key.

System Level - RESTFUL API Key Definition Recommended Default Value Valid Values Job Level - Environment Variable Key
ckptMode Enable / Disable checkpointing for spot reclaim protection iterative iterative or none MMC_CHECKPOINT_MODE
ckptInterval The interval between checkpointing. Recommended configuring more than 2 minutes, which is the spot reclaim window. 15m hms MMC_CHECKPOINT_INTERVAL
diagnosisMode Enable / Disable diagnosis mode for detailed logging false true or false MMC_CHECKPOINT_DIAGNOSIS