From 24357b016d148efa7d3a914801a5d51925fad347 Mon Sep 17 00:00:00 2001 From: Jeff Geerling Date: Tue, 9 May 2017 22:29:25 -0500 Subject: [PATCH] Issue #5: Update documentation in README. --- README.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 13af257..28be7f5 100644 --- a/README.md +++ b/README.md @@ -12,23 +12,28 @@ None. Available variables are listed below, along with default values (see `defaults/main.yml`): - docker_package: "docker-engine" + # Edition can be one of: 'ce' (Community Edition) or 'ee' (Enterprise Edition). + docker_edition: 'ce' + docker_package: "docker-{{ docker_edition }}" -The Docker package to install. +The `docker_edition` should be either `ce` (Community Edition) or `ee` (Enterprise Edition). You can also specify a specific version of Docker to install using a format like `docker-{{ docker_edition }}-`. docker_install_compose: true - docker_compose_version: "1.11.2" + docker_compose_version: "1.13.0" docker_compose_path: /usr/local/bin/docker-compose Docker Compose installation options. - docker_apt_repository: "deb https://apt.dockerproject.org/repo {{ ansible_distribution|lower }}-{{ ansible_distribution_release }} main" + docker_apt_release_channel: stable + docker_apt_repository: "deb [arch=amd64] https://download.docker.com/linux/{{ ansible_distribution|lower }} {{ ansible_distribution_release }} {{ docker_apt_release_channel }}" -(Used only for Debian/Ubuntu.) Add 'testing' if you don't want stable. +(Used only for Debian/Ubuntu.) You can switch the channel to `edge` if you want to use the Edge release. - docker_yum_repo_version: 'main' # 'testing', 'beta', 'nightly' + docker_yum_repo_url: https://download.docker.com/linux/centos/docker-{{ docker_edition }}.repo + docker_yum_repo_enable_edge: 0 + docker_yum_repo_enable_test: 0 -(Used only for RedHat/CentOS.) +(Used only for RedHat/CentOS.) You can enable the Edge or Test repo by setting the respective vars to `1`. ## Dependencies