From e0861fee3a3cb34096a0764541e7200563c16cb3 Mon Sep 17 00:00:00 2001 From: Jeff Byrnes Date: Wed, 3 Apr 2019 11:22:51 -0400 Subject: [PATCH] Update INSTALL docs re: docker-compose prereqs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit As it turns out, the docker-compose Python module is required, and docker-py doesn’t cut it. Even more confusing, docker-compose Python module installs the docker Python module, which conflicts with docker-py. To avoid this, there are additional docs to call this out. --- INSTALL.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 95839530e7..65cda0954e 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -59,7 +59,9 @@ Before you can run a deployment, you'll need the following installed in your loc - [Ansible](http://docs.ansible.com/ansible/latest/intro_installation.html) Requires Version 2.4+ - [Docker](https://docs.docker.com/engine/installation/) -- [docker-py](https://github.com/docker/docker-py) Python module +- [docker](https://pypi.org/project/docker/) Python module + + This is incompatible with `docker-py`. If you have previously installed `docker-py`, please uninstall it. + + We use this module instead of `docker-py` because it is what the `docker-compose` Python module requires. - [GNU Make](https://www.gnu.org/software/make/) - [Git](https://git-scm.com/) Requires Version 1.8.4+ - [Node 8.x LTS version](https://nodejs.org/en/download/) @@ -396,7 +398,8 @@ Unlike Openshift's `Route` the Kubernetes `Ingress` doesn't yet handle SSL termi ### Prerequisites - [Docker](https://docs.docker.com/engine/installation/) on the host where AWX will be deployed. After installing Docker, the Docker service must be started (depending on your OS, you may have to add the local user that uses Docker to the ``docker`` group, refer to the documentation for details) -- [docker-py](https://github.com/docker/docker-py) Python module. +- [docker-compose](https://pypi.org/project/docker-compose/) Python module. + + This also installs the `docker` Python module, which is incompatible with `docker-py`. If you have previously installed `docker-py`, please uninstall it. - [Docker Compose](https://docs.docker.com/compose/install/). ### Pre-build steps