Skip to content

add engine/admin/ansible/ #281

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 20, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions _data/toc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,8 @@ toc:
title: Splunk logging driver
- path: /engine/admin/dsc/
title: PowerShell DSC Usage
- path: /engine/admin/ansible/
title: Using Ansible
- path: /engine/admin/chef/
title: Using Chef
- path: /engine/admin/puppet/
Expand Down
67 changes: 67 additions & 0 deletions engine/admin/ansible.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
description: Installation and using Docker via Ansible
keywords:
- ansible, installation, usage, docker, documentation
title: Using Ansible
---

# Using Ansible

> **Note**:
> Please note this is a community contributed installation path.

## Requirements

To use this guide you'll need a working installation of
[Ansible](https://www.ansible.com/) version 2.1.0 or later.

Requirements on the host that will execute the module:

```
python >= 2.6
docker-py >= 1.7.0
Docker API >= 1.20
```

## Installation

The `docker_container` module is a core module, and will ship with
Ansible by default.

## Usage

Task example that pulls the latest version of the `nginx` image and
runs a container. Bind address and ports are in the example defined
as [a variable](https://docs.ansible.com/ansible/playbooks_variables.html).

```
---
- name: nginx container
docker:
name: nginx
image: nginx
state: reloaded
ports:
- "{{ nginx_bind_address }}:{{ nginx_port }}:{{ nginx_port }}"
cap_drop: all
cap_add:
- setgid
- setuid
pull: always
restart_policy: on-failure
restart_policy_retry: 3
volumes:
- /some/nginx.conf:/etc/nginx/nginx.conf:ro
tags:
- docker_container
- nginx
...
```

## Documentation

The documentation for the `ansible_container` module is present at
[docs.ansible.com](https://docs.ansible.com/ansible/docker_container_module.html).

Documentation covering Docker images, networks and services is also present
at [docs.ansible.com](https://docs.ansible.com/ansible/list_of_cloud_modules.html#docker).