edgehog-astarte-interfaces/io.edgehog.devicemanager.apps.CreateImageRequest.json at main · edgehog-device-manager/edgehog-astarte-interfaces · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
{
  "interface_name": "io.edgehog.devicemanager.apps.CreateImageRequest",
  "version_major": 0,
  "version_minor": 1,
  "type": "datastream",
  "ownership": "server",
  "aggregation": "object",
  "description": "Request to pull and create a container image.",
  "doc": "The ttl of this datastream is short to keep the sensitive fields private.",
  "mappings": [
    {
      "endpoint": "/image/id",
      "type": "string",
      "database_retention_policy": "use_ttl",
      "database_retention_ttl": 600,
      "reliability": "guaranteed",
      "description": "Create Image Request id",
      "doc": "Unique id for the container image."
    },
    {
      "endpoint": "/image/deploymentId",
      "type": "string",
      "database_retention_policy": "use_ttl",
      "database_retention_ttl": 600,
      "reliability": "guaranteed",
      "description": "Reference to a Deployment using the image",
      "doc": "The deployment in which the image is used, so the device can send deployment events to Astarte for the create request"
    },
    {
      "endpoint": "/image/reference",
      "type": "string",
      "database_retention_policy": "use_ttl",
      "database_retention_ttl": 600,
      "reliability": "guaranteed",
      "description": "Image reference to be pulled",
      "doc": "Name of the image to pull. It should be in the form [regitry-host[:port]/][image-repo/]image-name[:(tag|digest)]"
    },
    {
      "endpoint": "/image/registryAuth",
      "type": "string",
      "database_retention_policy": "use_ttl",
      "database_retention_ttl": 600,
      "reliability": "guaranteed",
      "description": "Image registry authentication header",
      "doc": "Optional base64url-encoded JSON for the auth configuration to the registry. An empty string means the image is public and doesn't require authentication. See https://docs.docker.com/reference/api/engine/version/v1.43/#section/Authentication for more information."
    }
  ]
}