Cedana Controller REST API

Cluster Management APIs

List checkpointable containers on all nodes

Returns a list of containers across cedana-managed nodes that can be checkpointed given a specific namespace.

GET/list/{namespace}

Path parameters

namespace*string

Namespace to list containers from

Body

application/json

Variables required for fetching list requests

root*string

Response

200400404500

OK

Request

JavaScriptCurlPython

const response = await fetch('/list/{namespace}', {
    method: 'GET',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "root": "text"
    }),
});
const data = await response.json();

Checkpoint APIs

Start checkpoint of a runc container

Start a synchronous checkpoint of a runc container. Use /list/:namespace to get the required CheckpointData.

POST/checkpoint

Body

application/json

Container information required for checkpoint

checkpoint_datacrservice.CheckpointData (object)

Response

200400404500

OK

Request

JavaScriptCurlPython

const response = await fetch('/checkpoint', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

start a checkpoint of a containerd container's rootfs

rootfs checkpoint endpoint for containerd

POST/checkpoint/rootfs

Body

application/json

Container information required for checkpoint

address*string

container_name*string

image_ref*string

namespace*string

rootstring

sandbox_name*string

Response

200400404500

OK

Request

JavaScriptCurlPython

const response = await fetch('/checkpoint/rootfs', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "address": "text",
      "container_name": "text",
      "image_ref": "text",
      "namespace": "text",
      "sandbox_name": "text"
    }),
});
const data = await response.json();

start a checkpoint of a crio container's rootfs

rootfs checkpoint endpoint for crio

POST/checkpoint/rootfs/crio

Body

application/json

Container information required for checkpoint

container_name*string

image_ref*string

namespace*string

new_image_ref*string

registry_auth_datacrservice.RegistryAuthData (object)

rootstring

sandbox_name*string

Response

200400404500

OK

Request

JavaScriptCurlPython

const response = await fetch('/checkpoint/rootfs/crio', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "container_name": "text",
      "image_ref": "text",
      "namespace": "text",
      "new_image_ref": "text",
      "sandbox_name": "text"
    }),
});
const data = await response.json();

Full containerd checkpoint request

Start a synchronous containerd checkpoint, which includes the rootfs.

POST/containerd/checkpoint

Body

application/json

Container information required for containerd checkpoint

checkpoint_datacrservice.CheckpointData (object)

leave_runningboolean

rootstring

Root is the path to the runc storage for the host

rootfs_checkpoint_datacrservice.RootfsCheckpointData (object)

Response

200400404500

OK

Request

JavaScriptCurlPython

const response = await fetch('/containerd/checkpoint', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Restore APIs

start a restore of a containerd container's rootfs

rootfs restore endpoint for containerd

POST/restore/rootfs

Body

application/json

Container information required for rootfs restore

address*string

container_name*string

image_ref*string

namespace*string

rootstring

sandbox_name*string

Response

200400404500

OK

Request

JavaScriptCurlPython

const response = await fetch('/restore/rootfs', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "address": "text",
      "container_name": "text",
      "image_ref": "text",
      "namespace": "text",
      "sandbox_name": "text"
    }),
});
const data = await response.json();

start restore of a runc container

Start a restore of a previously checkpointed runc container. Use /list/:namespace to get the required CheckpointData. Requires a target sleeping container to restore into. See documentation for more info.

POST/restore

Body

application/json

Container information required for restore

checkpoint_datacrservice.CheckpointData (object)

checkpoint_idstring

Response

200400404500

OK

Request

JavaScriptCurlPython

const response = await fetch('/restore', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();