.. _user/resources/container:

##########
Containers
##########

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. There are no limits on the range of
possible applications in Docker containers.

The Connectware imposes no constraints on the actual containers, but will ensure
security by running the containers in encapsulated networks. This way the
containerized applications can neither compromise the host system nor access any
other data except those explicitly granted access to within the commissioning
file (see :ref:`user/services/index`).

.. note:: |feature_not_on_kubernetes|

See also: :ref:`Cybus::Container resource <user/services/structure/resources/container>`

Containers can be added by :ref:`installing a Service <user/services/usage/install-service>`.

Overview
========

Once a service using one or more containers is enabled, respective rows
representing each container will be visible in the overview table.

.. figure:: ../../resources/containers/container_overview.png
     :width: 750px

Once the service is in the `enabled` state, basic manual interaction with the
container is possible by selecting the checkbox on the left side of the row in
the overview table. Activating this checkbox will show the toolbar, where
buttons for manually stopping and starting the container are available.

.. figure:: ../../resources/containers/container_overview_toolbar.png
     :width: 750px

Once stopped, containers can also be removed by clicking the delete icon in the
toolbar.

.. figure:: ../../resources/containers/container_degraded_toolbar_hover_delete.png
     :width: 750px

.. important::

  Manual stopping or deletion of containers will render the corresponding
  service to be :ref:`deviated <user/services/deviation>` (i.e. only partially
  functional). This is indicated by a yellow warning popup window at the bottom
  left of the screen. To restore the initial settings it is always possible to
  :ref:`disable <user/services/usage/disable-service>` and then again
  :ref:`enable the service <user/services/usage/enable-service>`.

Like every other resource, containers have a detail view. By clicking on one of
the listed containers you get redirected to the `Details View`_ of the selected
container.

Details View
============

Containers have multiple resources itself. These are grouped in `Config`_ and `Environmental Variables`_.

.. figure:: ../../resources/containers/container_details.png
     :width: 750px

Config
------

In the config section, all important configuration properties regarding the
specific container are listed.

.. figure:: ../../resources/containers/container_details_config.png
     :width: 750px

Environmental Variables
-----------------------

This section shows a listing of all specified environment variables for the
container.

.. figure:: ../../resources/containers/container_details_envs.png
     :width: 750px

API Definition
==============

:download:`Container Manager Swagger <../../swagger/containerManager.yaml>`