Container

By means of Containers the basic functionality of the Connectware can be extended.

A Container represents any (third-party) application made available using the docker (https://www.docker.com) technology. Indeed, the Connectware exposes zero constraints on the containerized applications. Moreover, will the Connectware ensure security by running the Containers in encapsulated networks, such that the containerized applications can not compromise the host system nor access any other data except those explicitly granted access to within the commissioning file (see Services V1).

Note

Containers may only be added through Services

Once a Service using one ore more Container is enabled, respective cards representing the Container will be visible.

../_images/running-container.png

While the Service stays enabled, manual interaction with the Container is possible through the bottom-right slider of each card. Use this slider to manually stop and start the Container if needed. Once stopped, Containers can also be removed by clicking the delete icon at the bottom-left of the Card.

../_images/degraded.png

Important

Manual stopping or deletion of Containers will render the corresponding Service to be degraded (i.e. only partially functional). This is indicated by a red error icon at the bottom of the respective Service card. To restore the initial settings its always possible to disable and again enable the Service.

API Definition

GET /api/containers

Return all containers.

Return all containers managed by the Cybus Platform.

Status Codes
POST /api/containers

Creates and runs a new docker container.

This endpoint will try to pull the specified image from dockerhub and if successful create & run the container. Containers are labeled with io.cybus.# for tracking/filtering purposes.

Status Codes
GET /api/containers/status

List all Containers and their current state

Status Codes
GET /api/containers/{id}

Find container by Id

Returns information on the given container.

Parameters
  • id (string) – Container Id

Status Codes
DELETE /api/containers/{id}

Delete container by Id

Delete a given container. This won’t delete the container’s base image

Parameters
  • id (string) – Container Id

Status Codes
GET /api/containers/{id}/status

Get container status by Id

Returns status on the given container.

Parameters
  • id (string) – Container Id

Status Codes
POST /api/containers/{id}/operation

Perform an operation on a container

Allows to start or stop a container. If the Container is already running/stopped nothing happens.

Parameters
  • id (string) – Container Id

Status Codes