io.edgehog.devicemanager.apps.CreateContainerRequest.json

{
  "interface_name": "io.edgehog.devicemanager.apps.CreateContainerRequest",
  "version_major": 0,
  "version_minor": 1,
  "type": "datastream",
  "ownership": "server",
  "aggregation": "object",
  "mappings": [
    {
      "endpoint": "/container/id",
      "type": "string",
      "database_retention_policy": "use_ttl",
      "database_retention_ttl": 31556952,
      "reliability": "guaranteed",
      "description": "Create Container Request id",
      "doc": "Unique id for the container."
    },
    {
      "endpoint": "/container/imageId",
      "type": "string",
      "database_retention_policy": "use_ttl",
      "database_retention_ttl": 31556952,
      "reliability": "guaranteed",
      "description": "Container image id",
      "doc": "The id of the image to use when creating the container."
    },
    {
      "endpoint": "/container/networkIds",
      "type": "stringarray",
      "database_retention_policy": "use_ttl",
      "database_retention_ttl": 31556952,
      "reliability": "guaranteed",
      "description": "Container network ids",
      "doc": "The ids of the network to connect with the container."
    },
    {
      "endpoint": "/container/volumeIds",
      "type": "stringarray",
      "database_retention_policy": "use_ttl",
      "database_retention_ttl": 31556952,
      "reliability": "guaranteed",
      "description": "Container volume ids",
      "doc": "The ids of the volumes to mount on the container."
    },
    {
      "endpoint": "/container/image",
      "type": "string",
      "database_retention_policy": "use_ttl",
      "database_retention_ttl": 31556952,
      "reliability": "guaranteed",
      "description": "Container image",
      "doc": "TODO: this will be remove (by only sending the image_id), when it will be supported on the device."
    },
    {
      "endpoint": "/container/hostname",
      "type": "string",
      "database_retention_policy": "use_ttl",
      "database_retention_ttl": 31556952,
      "reliability": "guaranteed",
      "description": "Container hostname",
      "doc": "The hostname to use for the container, as a valid RFC 1123 hostname."
    },
    {
      "endpoint": "/container/restartPolicy",
      "type": "string",
      "database_retention_policy": "use_ttl",
      "database_retention_ttl": 31556952,
      "reliability": "guaranteed",
      "description": "Container restart policy",
      "doc": "The behavior to apply when the container exits. Possible values are: ['', 'no', 'always' 'unless-stopped', 'on-failure']"
    },
    {
      "endpoint": "/container/env",
      "type": "stringarray",
      "database_retention_policy": "use_ttl",
      "database_retention_ttl": 31556952,
      "reliability": "guaranteed",
      "description": "Container environment",
      "doc": "Array of KEY=value environment variables"
    },
    {
      "endpoint": "/container/binds",
      "type": "stringarray",
      "database_retention_policy": "use_ttl",
      "database_retention_ttl": 31556952,
      "reliability": "guaranteed",
      "description": "Container binds",
      "doc": "A list of volume bindings for this container. Each volume binding is a string in one of these forms: host-src:container-dest[:options], or volume-name:container-dest[:options]. The container-dest must be an absolute path."
    },
    {
      "endpoint": "/container/networkMode",
      "type": "string",
      "database_retention_policy": "use_ttl",
      "database_retention_ttl": 31556952,
      "reliability": "guaranteed",
      "description": "Network mode used for this container.",
      "doc": "Supported standard values are: bridge, host, none, and container:<name|id>. Any other value is taken as a custom network's name to which this container should connect to. If you are using a different container engine than docker, there could be other values."
    },
    {
      "endpoint": "/container/portBindings",
      "type": "stringarray",
      "database_retention_policy": "use_ttl",
      "database_retention_ttl": 31556952,
      "reliability": "guaranteed",
      "description": "Container port bindings",
      "doc": "Array of ip:[host_port:]container_port[/protocol] | [hostPort:]containerPort[/protocol]. Protocol is TCP by default"
    },
    {
      "endpoint": "/container/privileged",
      "type": "boolean",
      "database_retention_policy": "use_ttl",
      "database_retention_ttl": 31556952,
      "reliability": "guaranteed",
      "description": "Run privileged",
      "doc": "Runs the exec process with extended privileges."
    }
  ]
}