Public | Automated Build

Last pushed: 5 days ago
Short Description
Docker images for Ansible software, installed in Debian, Ubuntu, CentOS, and Alpine.
Full Description

Docker-Ansible base images

Summary

Repository name in Docker Hub: williamyeh/ansible

This repository contains Dockerized Ansible, published to the public Docker Hub via automated build mechanism.

Configuration

These are Docker images for Ansible software, installed in a selected Linux distributions.

Base OS

Debian (stretch, jessie), Ubuntu (xenial, trusty), CentOS (7), Alpine (3).

Supports for Wheezy, Precise, and CentOS6 have been ended since Sep 2017.

Ansible

Four versions are provided:

  1. provides the most recent stable version of Ansible; suitable for most people.
  2. same as stable version, but is designed for building (near-)minimal images out of playbooks; i.e., the Ansible body will be removed when mission completed. Refer to “Build Docker images with Ansible: A half-blood approach” for working examples and slides.
  3. provides the old 1.9 version of Ansible (but will be retired someday).
  4. provides the experimental version of Ansible; i.e., the master branch of official Ansible's git repo.

Each version is further divided into two variants:

  • Normal variant: intended to be used as Ansible control machines, or in cases that is inadequate in the onbuild variants.
  • Onbuild variant: intended to be used to build Docker images.

Images and tags

Stable version (installed from official PyPI repo):

  • Normal variants:

    • williamyeh/ansible:debian9
    • williamyeh/ansible:debian8
    • williamyeh/ansible:ubuntu16.04
    • williamyeh/ansible:ubuntu14.04
    • williamyeh/ansible:centos7
    • williamyeh/ansible:alpine3
  • Onbuild variants (recommended for common cases):

    • williamyeh/ansible:debian9-onbuild
    • williamyeh/ansible:debian8-onbuild
    • williamyeh/ansible:ubuntu16.04-onbuild
    • williamyeh/ansible:ubuntu14.04-onbuild
    • williamyeh/ansible:centos7-onbuild
    • williamyeh/ansible:alpine3-onbuild

Minimal configuration (the Ansible body will be removed when mission completed):

Refer to “Build Docker images with Ansible: A half-blood approach” for working examples and slides.

  • Onbuild variants:

    • williamyeh/ansible:mini-alpine3
    • williamyeh/ansible:mini-debian9
    • williamyeh/ansible:mini-debian8

Old 1.9 version (will be retired someday):

Note: Ansible 1.9 was not supported in CentOS EPEL since January 2017, according to this announcement.

  • Normal variants:

    • williamyeh/ansible:1.9-debian8
    • williamyeh/ansible:1.9-ubuntu14.04
    • williamyeh/ansible:1.9-alpine3
  • Onbuild variants (recommended for common cases):

    • williamyeh/ansible:1.9-debian8-onbuild
    • williamyeh/ansible:1.9-ubuntu14.04-onbuild
    • williamyeh/ansible:1.9-alpine3-onbuild

Experimental version (building directly from the git master source tree; use at your own risk!):

  • Normal variants:

    • williamyeh/ansible:master-debian9
    • williamyeh/ansible:master-debian8
    • williamyeh/ansible:master-ubuntu16.04
    • williamyeh/ansible:master-ubuntu14.04
    • williamyeh/ansible:master-centos7
  • Onbuild variants (recommended for common cases):

    • williamyeh/ansible:master-debian9-onbuild
    • williamyeh/ansible:master-debian8-onbuild
    • williamyeh/ansible:master-ubuntu16.04-onbuild
    • williamyeh/ansible:master-ubuntu14.04-onbuild
    • williamyeh/ansible:master-centos7-onbuild

For the impatient

Here comes a simplest working example for the impatient.

First, choose a base image you'd like to begin with. For example, williamyeh/ansible:ubuntu14.04-onbuild.

Second, put the following Dockerfile along with your playbook directory:

FROM williamyeh/ansible:ubuntu14.04-onbuild

# ==> Specify requirements filename;  default = "requirements.yml"
#ENV REQUIREMENTS  requirements.yml

# ==> Specify playbook filename;      default = "playbook.yml"
#ENV PLAYBOOK      playbook.yml

# ==> Specify inventory filename;     default = "/etc/ansible/hosts"
#ENV INVENTORY     inventory.ini

# ==> Executing Ansible (with a simple wrapper)...
RUN ansible-playbook-wrapper

Third, docker build .

Done!

For more advanced usage, the role in Ansible Galaxy williamyeh/nginx demonstrates how to perform a simple smoke test (configuration needs test, too!) on a variety of (containerized) Linux distributions on CircleCI's Ubuntu 12.04 and Travis CI’s Ubuntu 14.04 worker instances.

Why yet another Ansible image for Docker?

There has been quite a few Ansible images for Docker (e.g., search in the Docker Hub), so why reinvent the wheel?

In the beginning I used the ansible/ansible-docker-base created by Ansible Inc. It worked well, but left some room for improvement:

  • Base OS image - It provides only centos:centos7 and ubuntu:14.04. Insufficent for me.

  • Unnecessary dependencies - It installed, at the very beginning of its Dockerfile, the software-properties-common package, which in turns installed some Python packages. I prefered to incorporate these stuff only when absolutely needed.

Therefore, I built these Docker images on my own.

NOTE: ansible/ansible-docker-base announced in September 2015: “Ansible no longer maintains images in Dockerhub directly.”

Comparison: image size

REPOSITORY                    TAG                   VIRTUAL SIZE
---------------------------   -------------------   ------------
ansible/centos7-ansible       stable                367.5 MB
ansible/ubuntu14.04-ansible   stable                286.6 MB

williamyeh/ansible            alpine3-onbuild        66.4 MB
williamyeh/ansible            centos6-onbuild       264.2 MB
williamyeh/ansible            centos7-onbuild       275.3 MB
williamyeh/ansible            debian7-onbuild       134.4 MB
williamyeh/ansible            debian8-onbuild       178.3 MB
williamyeh/ansible            ubuntu12.04-onbuild   181.9 MB
williamyeh/ansible            ubuntu14.04-onbuild   238.3 MB

Usage

Used mostly as a base image for configuring other software stack on some specified Linux distribution(s).

Take Debian/Ubuntu/CentOS for example. To test an Ansible playbook.yml against a variety of Linux distributions, we may use Vagrant as follows:

# Vagrantfile

Vagrant.configure(2) do |config|

    # ==> Choose a Vagrant box to emulate Linux distribution...
    config.vm.box = "ubuntu/xenial64"
    #config.vm.box = "ubuntu/trusty64"
    #config.vm.box = "debian/stretch64"
    #config.vm.box = "debian/jessie64"
    #config.vm.box = "bento/centos-7.2"
    #config.vm.box = "maier/alpine-3.3.1-x86_64"


    # ==> Executing Ansible...
    config.vm.provision "ansible" do |ansible|
        ansible.playbook = "playbook.yml"
    end

end

Virtual machines can emulate a variety of Linux distributions with good quality, at the cost of runtime overhead.

Docker to be a rescue. Now, with these williamyeh/ansible series, we may test an Ansible playbook.yml against a variety of Linux distributions as follows:

# Dockerfile

# ==> Choose a base image to emulate Linux distribution...
FROM williamyeh/ansible:ubuntu16.04
#FROM williamyeh/ansible:ubuntu14.04
#FROM williamyeh/ansible:debian9
#FROM williamyeh/ansible:debian8
#FROM williamyeh/ansible:centos7
#FROM williamyeh/ansible:alpine3


# ==> Copying Ansible playbook...
WORKDIR /tmp
COPY  .  /tmp

# ==> Creating inventory file...
RUN echo localhost > inventory

# ==> Executing Ansible...
RUN ansible-playbook -i inventory playbook.yml \
      --connection=local --sudo

You may also work with onbuild variants, which take care of many routine steps for you:

# Dockerfile

# ==> Choose a base image to emulate Linux distribution...
FROM williamyeh/ansible:ubuntu16.04-onbuild
#FROM williamyeh/ansible:ubuntu14.04-onbuild
#FROM williamyeh/ansible:debian9-onbuild
#FROM williamyeh/ansible:debian8-onbuild
#FROM williamyeh/ansible:centos7-onbuild
#FROM williamyeh/ansible:alpine3-onbuild


# ==> Specify requirements filename;  default = "requirements.yml"
#ENV REQUIREMENTS  requirements.yml

# ==> Specify playbook filename;      default = "playbook.yml"
#ENV PLAYBOOK      playbook.yml

# ==> Specify inventory filename;     default = "/etc/ansible/hosts"
#ENV INVENTORY     inventory.ini

# ==> Executing Ansible (with a simple wrapper)...
RUN ansible-playbook-wrapper

With Docker, we can test any Ansible playbook against any version of any Linux distribution without the help of Vagrant. More lightweight, and more portable across IaaS, PaaS, and even CaaS (Container as a Service) providers!

If better OS emulation (virtualization) isn't required, the Docker approach (containerization) should give you a more efficient Ansible experience.

License

Author: William Yeh william.pjyeh@gmail.com

Licensed under the Apache License V2.0. See the LICENSE file for details.

Docker Pull Command
Owner
williamyeh
Source Repository

Comments (8)
korsar
3 months ago

Got the following error, while it works as a charm with ansible w/o docker:

fatal: [localhost]: FAILED! => {"changed": false, "failed": true, "msg": "boto required for this module, install via pip or your package manager"}

bartoszbilicki
a year ago

this image works great, thanks!
My workstation is windows. This image allows me to control unix hosts with ansible (I have mounted my playbooks, inventory and ssh key in this image).

One request: could base image contain python-keyczar module? (sudo apt-get install python-keyczar)

This module (when installed on control and target machine) allows to use accelerated mode http://docs.ansible.com/ansible/playbooks_acceleration.html

That mode makes ansible much faster (no need for SSH handshake before each command). That really speeds up development!

williamyeh
2 years ago

Hi emiliorodo,

In most cases, you don't need to specify any inventory file for these "-onbuild" images. The ansible-playbook-wrapper simply reads such information from "/etc/ansible/hosts".

In case you need to customize the inventory file, just define the "INVENTORY" environment variable, as shown in the README document.

emiliorodo
2 years ago

Hi William,
A question regarding the onbuild images:

I see you specify the inventory to be inventory.ini in the Dockerfile, does that mean that we expect that there is such a file in the same directory as the Dockerfile, or is it generated by the ansible-playbook-wrapper?

If I do need to put it there myself, what should I include in it? If I understand correctly, the only host I should have there is localhost.

Thanks in advance:)

williamyeh
2 years ago

Hi oveits,

I've made a series of Ansible2 images directly from git source tree with the tags master-*. Have a try!

oveits
2 years ago

Hi William-Yeh,
thanks a lot. I did not known that there are no notifications from Docker Hub. I have sent a copy vie email.

Installing the latest development version of Ansible is not hard. I have described it here (Appendix E): https://oliverveits.wordpress.com/2015/11/09/it-automation-a-hello-world-example-using-ansible-on-docker/#appendixe
Best Regards,
Oliver

williamyeh
2 years ago

Hi oveits,

Thanks for your suggestions. I'll think about how to incorporate and name these Ansible 2.x images.

PS. Docker Hub neither notify nor forward these comments to me...

oveits
2 years ago

Hi William-Yeh,
I am one of your fans of your Docker and Vagrant images. Great job!
For this Docker image, I have stumbled over the problem that the Ansible documentation seems to be based on the latest development build >2.0.0, while your Ansible Docker image is based on the latest stable build (currently v1.9.4). New features like variable specifications in the inventory file are not supported (and the Ansible documentation is not telling you, that it is a new feature). See e.g. the example “jumper ansible_port=5555 ansible_host=192.168.1.50″ on http://docs.ansible.com/ansible/intro_inventory.html; in your image, the ansible_host information is ignored and leads to a “Could not resolve hostname” error; see also the stackoverflow post http://stackoverflow.com/questions/33386890/why-giving-a-host-alias-does-not-workwith-an-ansible-inventory-file/33387754#33387754.

How easy would it be to also offer a Docker image based on the latest development build?
Best Regards,
Oliver

P.S.: for the case you are interested, I have used your image for a little proof of concept described on https://oliverveits.wordpress.com/2015/11/09/it-automation-a-hello-world-example-using-ansible-on-docker/.
Best Regards,
Oliver