From b32c4c651aea22eb3e0135de895af433a90d88d7 Mon Sep 17 00:00:00 2001 From: Gari Singh Date: Sun, 2 Apr 2017 09:10:03 -0400 Subject: [PATCH] [FAB-2789] Document minimum Docker Compose version The docs specify the Docker version but not the Docker Compose version. Add Docker Compose 1.8.1+ as prereq. Also changes MacOSX to macOS as that's what Apple is using these days https://jira.hyperledger.org/browse/FAB-2789 [ci-skip] Change-Id: I62e4adb78126e14e3a4e59a6e77cc2f2891b6283 Signed-off-by: Gari Singh --- docs/source/dev-setup/devenv.rst | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/source/dev-setup/devenv.rst b/docs/source/dev-setup/devenv.rst index b3f3fc79079..be76fb817c9 100644 --- a/docs/source/dev-setup/devenv.rst +++ b/docs/source/dev-setup/devenv.rst @@ -4,15 +4,15 @@ Setting up the development environment Overview ~~~~~~~~ -Through the v0.6 release, the development environment utilized Vagrant +Prior to the v1.0.0 release, the development environment utilized Vagrant running an Ubuntu image, which in turn launched Docker containers as a means of ensuring a consistent experience for developers who might be -working with varying platforms, such as MacOSX, Windows, Linux, or +working with varying platforms, such as macOS, Windows, Linux, or whatever. Advances in Docker have enabled native support on the most -popular development platforms: MacOSX and Windows. Hence, we have +popular development platforms: macOS and Windows. Hence, we have reworked our build to take full advantage of these advances. While we still maintain a Vagrant based approach that can be used for older -versions of MacOSX and Windows that Docker does not support, we strongly +versions of macOS and Windows that Docker does not support, we strongly encourage that the non-Vagrant development setup be used. Note that while the Vagrant-based development setup could not be used in @@ -26,12 +26,13 @@ Prerequisites - `Git client `__ - `Go `__ - 1.7 or later (for releases before v1.0, 1.6 or later) -- For MacOSX, +- For macOS, `Xcode `__ must be installed - `Docker `__ - 1.12 or later +- `Docker Compose `__ - 1.8.1 or later - `Pip `__ -- (MacOSX) you may need to install gnutar, as MacOSX comes with bsdtar +- (macOS) you may need to install gnutar, as macOS comes with bsdtar as the default, but the build uses some gnutar flags. You can use Homebrew to install it as follows: @@ -123,7 +124,7 @@ Boostrapping the VM using Vagrant If you are planning on using the Vagrant developer environment, the following steps apply. **Again, we recommend against its use except for -developers that are limited to older versions of MacOSX and Windows that +developers that are limited to older versions of macOS and Windows that are not supported by Docker for Mac or Windows.** ::