Metadata-Version: 2.0
Name: sloth-ci.ext.docker-exec
Version: 1.1.3
Summary: Docker executor for Sloth CI
Home-page: https://bitbucket.org/moigagoo/sloth-ci-extensions
Author: Konstantin Molchanov
Author-email: moigagoo@live.com
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Dist: awesome-slugify
Requires-Dist: docker-py
Requires-Dist: sloth-ci (>=2.0.1)

Run actions inside a `Docker <https://www.docker.com/>`__ image.

By default, Sloth CI apps run actions in a subprocess on the same machine they're running on. This extension overrides this and makes the app execute each action as a container inside a given Docker image.


Installation
------------

.. code-block:: bash

    $ pip install sloth-ci.ext.docker_exec


Usage
-----

.. code-block:: yaml
    :caption: docker_exec.yml

    extensions:
        run_in_docker:
            # Use the module sloth_ci.ext.docker_exec.
            module: docker_exec

            # Image name. If missing, slug of the Sloth app listen point is used.
            # image: foo

            # Path to the Docker daemon to connect to. Can point to either a tcp URL or a unix socket. If missing, the client connects to /var/run/docker.sock.
            # base_url: tcp://555.55.55.55:5555 *.

            # Docker API version used on the server. If missing, the latest version is used.
            # version: 1.10

            # Path to the Dockerfile used to build an image if it doesn't exist. If missing, current directory is used.
            # path_to_dockerfile: docker/files

            # Memory limit in MB.
            # memory_limit: 10

            # CPU share in per cent.
            # cpu_share: 5


