Skip to content

Commit

Permalink
[FAB-2789] Document minimum Docker Compose version
Browse files Browse the repository at this point in the history
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 <gari.r.singh@gmail.com>
  • Loading branch information
mastersingh24 committed Apr 2, 2017
1 parent 4e5f45c commit b32c4c6
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions docs/source/dev-setup/devenv.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -26,12 +26,13 @@ Prerequisites
- `Git client <https://git-scm.com/downloads>`__
- `Go <https://golang.org/>`__ - 1.7 or later (for releases before
v1.0, 1.6 or later)
- For MacOSX,
- For macOS,
`Xcode <https://itunes.apple.com/us/app/xcode/id497799835?mt=12>`__
must be installed
- `Docker <https://www.docker.com/products/overview>`__ - 1.12 or later
- `Docker Compose <https://docs.docker.com/compose/>`__ - 1.8.1 or later
- `Pip <https://pip.pypa.io/en/stable/installing/>`__
- (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:

Expand Down Expand Up @@ -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.**

::
Expand Down

0 comments on commit b32c4c6

Please sign in to comment.