fabric-docker's Introduction

fabric-docker

Docker-engine command-line tool wrapper for Fabric.

Can be used both in local and remote modes (via subprocess or ssh).

Method names and options try to use the same names as related docker-engine commands and options.

So, it is mainly a helper to write:

docker.ps(all=True, size=True)

instead of:

run('docker ps --all --size')

With some nice use cases:

# remove dangling images "<none>:<none>"
docker.rmi(docker.none_images())

# remove images by some filter
images = [
    image['image id'] for image in docker.images()
    if image['tag'] != 'latest'
]
docker.rmi(images)

Requirements

Docker (local or remote - depending the mode you use)
Fabric
pyyaml

Supported commands

Only limited set of commands and options are supported now:

cli - run arbitrary Docker command. i.e. docker.cli('ps -a')
images
ps
restart
rm
rmi
run - limited set of options
start
stop
version
none_images - helper method to get "dangling" images

Install

pip install fabric-docker

Usage

Create instance to use locally with sudo:

import fabric_docker

docker = fabric_docker.DockerCli(local=True, use_sudo=True)
# any command can override this default settings by suppling
# "local" and "sudo" key-value arguments

List all local containers:

docker.ps(all=True)

Remove latest container:

docker.rm(docker.ps(latest=True))

List remote images (override default local flag):

docker.images(no_truncate=True, local=False)

Run remote container:

docker.run(
    detach=True,
    restart='always',
    publish={'8080':'80'},
    volume={'/host/dir': '/container/dir', '/host/dir2': '/container/dir2'},
    name='name_of_container',
    image='image_name:tag',
)

Recommend Projects