diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e06d208 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ +Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/README.md b/README.md index 51b6206..871ea1c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,43 @@ -# ansible-role_docker -# ansible-role_docker +docker +====== + +Installs Docker on Ubuntu. + +Well tested on 14.04. Has been known to work on 12.04. + +This role started from the *angstwad* *docker_ubuntu* role and has since forked a bit, primarily +to manage which version of Docker we install. Because of interdepencies between the Docker API +version and software that we install (especially `docker-py`), we have to be careful about +Docker versions. + + - Our initial deploys used a fixed version of LXC Docker, pinned at `1.5.0` + - Our newer deploy will still use a pinned version Docker Engine, but will be able to specify + their own versions (e.g. `1.8.1`) + + +Role Variables +-------------- + +The `docker_version` variable controls what version of Docker is installed. + + - The default `docker_version` is `1.5.0` (for historical reasons). If select, LXC Docker will be used. + - Otherwise, the stated version of Docker Engine will be used (if available). + + +Testing +------- + +There are known incompatibilities between some Docker versions and some versions of `docker-py`, +especially between LXC Docker `1.5.0` and `docker-py>1.1.0`. Using this combination will +result in Python errors along the lines of: + + client and server don't have same version (client : 1.19, server: 1.17) + +Fortunately, newer versions of Docker Engine with both newer and older versions of `docker-py` +appear to be compatible. A `testing.yml` playbook is provided for reference. + + +License +------- + +Apache v2.0 diff --git a/defaults/main.yml b/defaults/main.yml new file mode 100644 index 0000000..6bd5926 --- /dev/null +++ b/defaults/main.yml @@ -0,0 +1,5 @@ +--- +docker_version: 1.5.0 +kernel_pkg_state: latest +cgroup_lite_pkg_state: latest +ssh_port: 22 diff --git a/handlers/main.yml b/handlers/main.yml new file mode 100644 index 0000000..3a6c32e --- /dev/null +++ b/handlers/main.yml @@ -0,0 +1,2 @@ +--- +# handlers file for docker.ubuntu diff --git a/meta/main.yml b/meta/main.yml new file mode 100644 index 0000000..ba9d553 --- /dev/null +++ b/meta/main.yml @@ -0,0 +1,23 @@ +--- +galaxy_info: + author: Paul Durivage + description: Docker on Ubuntu greater than 12.04 + license: Apache v2.0 + min_ansible_version: 1.2 + platforms: + - name: Ubuntu + versions: + - precise + - raring + - saucy + - trusty + categories: + - development + - packaging + - system +dependencies: [] + # List your role dependencies here, one per line. Only + # dependencies available via galaxy should be listed here. + # Be sure to remove the '[]' above if you add dependencies + # to this list. + diff --git a/tasks/docker-engine.yml b/tasks/docker-engine.yml new file mode 100644 index 0000000..44d42f8 --- /dev/null +++ b/tasks/docker-engine.yml @@ -0,0 +1,27 @@ +--- +# Install docker engine. +# +# This is one of at least two mechanisms for installing Docker via apt (the other +# being the `lxc-docker` package). There is currently only one version of `docker-engine` +# available, so this mechanism will only work for the most recent `docker_version`, +# currently `1.8.1`. +# +# Installing this docker will remove the lxc-docker package. + + +- name: Add Docker Engine Repository Key + command: apt-key adv --keyserver hkp://p80.pool.sks-keyservers.net:80 --recv-keys 58118E89F3A912897C070ADBF76221572C52609D + +- name: Add Docker Engine Repository + apt_repository: + repo: 'deb https://apt.dockerproject.org/repo ubuntu-trusty main' + update_cache: yes + + +# While wildcarding the version is cute, in practice, there only seems to be one +# version of Docker available at a time. I'm not sure what will happen on the next +# release. Alternatively, we could install LXC Docker, which does have many more +# versions, but not the most recent versions. + +- name: Install Docker Engine + apt: name="docker-engine={{ docker_version }}-0~trusty" state=present diff --git a/tasks/lxc-docker.yml b/tasks/lxc-docker.yml new file mode 100644 index 0000000..35288a4 --- /dev/null +++ b/tasks/lxc-docker.yml @@ -0,0 +1,21 @@ +--- +# Install LXC docker. +# +# This is one of at least two mechanisms for installing Docker via apt (the other +# being the `docker-engine` package). There are multiple versions of `lxc-docker` +# available, but we currently only use this mechanism if `docker_version` is set +# to `1.5.0`. +# +# Installing this docker will remove the docker-engine package. + + +- name: Add LXC Docker Repository Key + command: apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 36A1D7869245C8950F966E92D8576A8BA88D21E9 + +- name: Add LXC Docker Repository + apt_repository: + repo: 'deb http://get.docker.io/ubuntu docker main' + update_cache: yes + +- name: Install LXC Docker + apt: pkg="lxc-docker-{{ docker_version }}" state=present diff --git a/tasks/main.yml b/tasks/main.yml new file mode 100644 index 0000000..e831c95 --- /dev/null +++ b/tasks/main.yml @@ -0,0 +1,77 @@ +--- +# tasks file for docker.ubuntu +- name: Fail if not a new release of Ubuntu + fail: msg="{{ ansible_distribution_version }} is not an acceptable version of Ubuntu for this role" + when: "ansible_distribution_version not in ['12.04', '13.04', '13.10', '14.04']" + +# https://docs.docker.com/installation/ubuntulinux/ +- name: Install trusty kernel onto 12.04 + apt: + pkg: "{{ item }}" + state: latest + update_cache: yes + cache_valid_time: 600 + with_items: + - linux-image-generic-lts-trusty + - linux-headers-generic-lts-trusty + register: kernel_result + when: "ansible_distribution_version == '12.04'" + +- name: Install latest kernel extras for Ubuntu 13.04+ + apt: + pkg: "linux-image-extra-{{ ansible_kernel }}" + state: "{{ kernel_pkg_state }}" + update_cache: yes + cache_valid_time: 600 + when: "ansible_distribution_version != '12.04'" + +# Fix for https://github.com/dotcloud/docker/issues/4568 +- name: Install cgroup-lite for Ubuntu 13.10 + apt: + pkg: cgroup-lite + state: "{{ cgroup_lite_pkg_state }}" + update_cache: yes + cache_valid_time: 600 + register: cgroup_lite_result + when: "ansible_distribution_version == '13.10'" + +- name: Reboot instance + command: /sbin/shutdown -r now + register: reboot_result + when: "(ansible_distribution_version == '12.04' and kernel_result|changed) + or (ansible_distribution_version == '13.10' and cgroup_lite_result|changed)" + +- name: Wait for instance to come online + local_action: + module: wait_for + host: "{{ ansible_ssh_host|default(inventory_hostname) }}" + port: "{{ ansible_ssh_port|default(ssh_port) }}" + delay: 30 + timeout: 600 + state: started + when: "(ansible_distribution_version == '12.04' and reboot_result|changed) + or (ansible_distribution_version == '13.10' and cgroup_lite_result|changed)" + +# Newer versions of Docker no longer require apparmor, but it seems like a good thing to have. +- name: Install apparmor + apt: pkg=apparmor state=present + +- name: Install LXC Docker + include: lxc-docker.yml + when: "{{ docker_version == '1.5.0' }}" + +- name: Install Docker Engine + include: docker-engine.yml + when: "{{ docker_version != '1.5.0' }}" + +- name: Ensure that Docker is running + service: name="docker" state=started + +- name: Check if /etc/default/ufw exists + stat: path=/etc/default/ufw + register: ufw_default_exists + +- name: Change ufw default forward policy from drop to accept + lineinfile: dest=/etc/default/ufw regexp="^DEFAULT_FORWARD_POLICY=" line="DEFAULT_FORWARD_POLICY=\"ACCEPT\"" + when: ufw_default_exists.stat.exists + diff --git a/testing.yml b/testing.yml new file mode 100644 index 0000000..0815676 --- /dev/null +++ b/testing.yml @@ -0,0 +1,24 @@ +--- +# Test docker-py compatibility + +- name: install python + hosts: all + tasks: + - apt: pkg={{ item }} state=present + with_items: + - python + - python-dev + - python-setuptools + - easy_install: name=pip + +- name: Test old docker-py + hosts: all + tasks: + - pip: name=docker-py version=1.1.0 + - command: python -c "from docker import Client; client=Client(base_url='unix://var/run/docker.sock'); print client.info()" + +- name: Install new docker-py + hosts: all + tasks: + - pip: name=docker-py state=latest + - command: python -c "from docker import Client; client=Client(base_url='unix://var/run/docker.sock'); print client.info()"