.. _index:

Quickstart
==========
container-transform is a small utility to transform various docker container
formats to one another.

Currently, container-transform can parse and convert:

* Kubernetes Pod specs
* ECS task definitions
* Docker-compose configuration files
* Marathon Application Definitions or Groups of Applications
* Chronos Task Definitions

and it can output to:

* Systemd unit files

Any missing required parameters are printed to STDERR.

Example usage:

.. code-block:: bash

    $ cat docker-compose.yml | container-transform  -v
    {
        "family": "python-app",
        "volumes": [
            {
                "name": "host_logs",
                "host": {
                    "sourcePath": "/var/log/myapp"
                }
            }
        ],
        "containerDefinitions": [
            {
                "memory": 1024,
                "image": "postgres:9.3",
                "name": "db",
                "essential": true
            },
            {
                "memory": 128,
                "image": "redis:latest",
                "name": "redis",
                "essential": true
            },
            {
                "name": "web",
                "memory": 64,
                "command": [
                    "uwsgi",
                    "--json",
                    "uwsgi.json"
                ],
                "mountPoints": [
                    {
                        "sourceVolume": "host_logs",
                        "containerPath": "/var/log/uwsgi/"
                    }
                ],
                "environment": [
                    {
                        "name": "AWS_ACCESS_KEY_ID",
                        "value": "AAAAAAAAAAAAAAAAAAAA"
                    },
                    {
                        "name": "AWS_SECRET_ACCESS_KEY",
                        "value": "1111111111111111111111111111111111111111"
                    }
                ],
                "essential": true
            }
        ]
    }
    Container web is missing required parameter "image".

or:

.. code-block:: bash

    $ container-transform  --input-type ecs --output-type compose task.json
    db:
      image: postgres:9.3
      mem_limit: 1073741824b
    redis:
      image: redis:latest
      mem_limit: 134217728b
    web:
      command: uwsgi --json uwsgi.json
      environment:
        AWS_ACCESS_KEY_ID: AAAAAAAAAAAAAAAAAAAA
        AWS_SECRET_ACCESS_KEY: '1111111111111111111111111111111111111111'
      mem_limit: 67108864b

    Container web is missing required parameter "image".


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

To install the latest release (Python 3 only), type::

    pip install container-transform

To install the latest code directly from source, type::

    pip install git+git://github.com/micahhausler/container-transform.git