Docker Runner is a core Keboola Connection (KBC) component which provides an interface for running other KBC components. Every component in KBC is represented by a Docker image. Running a component means creating and executing an asynchronous job.
Developing functionality in Docker allows you to focus only on the application logic; all communication with the Storage API will be handled by Docker Runner. You can encapsulate any application into a Docker image following a set of rules that will allow you to integrate the application into KBC.
There is a predefined interface with Docker Runner, consisting mainly of a folder structure and a serialized configuration file. All components, including our internal R and Python Transformations, are run using Docker Runner.
The Docker Runner functionality can be described in the following steps:
When the component execution is finished, Docker Runner automatically collects the exit code and the content of STDOUT and STDERR. The following schema illustrates the workflow of running a dockerized component.
The component is responsible for these processes:
Docker Runner is responsible for the following processes:
The Docker Runner API is described on Apiary.io. Docker Runner has API calls to
Components executed by Docker Runner store their configurations in Storage API components configurations.
When creating the configuration, use this JSON schema to validate the configuration before storing it. The configuration contains the following nodes, all of them are optional:
parameters— an arbitrary object passed to the dockerized application itself
storage— configuration of input and output mapping; specific options correspond to the options of the unload data and load data API calls.
runtime— configuration for modifying some image parameters at run time
processors— configuration of Processors
authorization— OAuth authorization injected to the configuration; not stored in the component configuration
image_parameters— an arbitrary object passed from the component; not stored in the component configuration
action— an action being executed; not stored in the component configuration