diff --git a/docs/gettinginvolved/infrastructure/release-process.rst b/docs/gettinginvolved/infrastructure/release-process.rst index cacfb6ef01..c63c3223b7 100644 --- a/docs/gettinginvolved/infrastructure/release-process.rst +++ b/docs/gettinginvolved/infrastructure/release-process.rst @@ -30,6 +30,8 @@ Software - an up-to-date clone of the `Flocker repository `_ +- an up-to-date clone of the `homebrew-tap repository `_ + Access ~~~~~~ @@ -115,7 +117,18 @@ Preparing for a release $ git checkout -b release/flocker-${VERSION%.*} origin/release/flocker-"${VERSION%.*}" -#. Update the version number in the downloads in ``docs/gettingstarted/linux-install.sh`` and ``docs/gettingstarted/osx-install.sh``, as well as the two RPMs in ``docs/gettingstarted/tutorial/Vagrantfile`` (a total of 4 locations). +#. Update the version number in the download in ``docs/gettingstarted/linux-install.sh``, as well as the two RPMs in ``docs/gettingstarted/tutorial/Vagrantfile``, and the Homebrew recipe in the `homebrew-tap`_ repository (a total of 4 locations). + +#. Update the ``sha1`` in the Homebrew recipe in the `homebrew-tap`_. + + With Homebrew on OS X you can get the ``sha1`` using ``brew fetch flocker`` if the latest ``flocker.rb`` is in ``/usr/local/Library/formula``. + + On Linux: + + .. code-block:: console + + wget https://github.com/ClusterHQ/flocker/archive/${VERSION}.tar.gz + sha1sum ${VERSION}.tar.gz #. Commit the changes: @@ -212,3 +225,4 @@ Announcing Releases .. _gsutil: https://developers.google.com/storage/docs/gsutil .. _wheel: https://pypi.python.org/pypi/wheel .. _Google cloud storage: https://console.developers.google.com/project/apps~hybridcluster-docker/storage/archive.clusterhq.com/ +.. _homebrew-tap: https://github.com/ClusterHQ/homebrew-tap \ No newline at end of file diff --git a/docs/gettingstarted/installation.rst b/docs/gettingstarted/installation.rst index 18373ba679..7dbd5424b4 100644 --- a/docs/gettingstarted/installation.rst +++ b/docs/gettingstarted/installation.rst @@ -73,68 +73,39 @@ You'll need to do this every time you start a new shell. OS X ---- -To install ``flocker-cli`` on OS X you can install ``virtualenv`` and then run the ``flocker-cli`` install script: - -Installing virtualenv -^^^^^^^^^^^^^^^^^^^^^ - Install the `Homebrew`_ package manager. Make sure Homebrew has no issues: .. code-block:: console - alice@mercury:~/flocker-tutorial$ brew doctor + alice@mercury:~$ brew doctor ... - alice@mercury:~/flocker-tutorial$ + alice@mercury:~$ Fix anything which ``brew doctor`` recommends that you fix by following the instructions it outputs. -Install ``Python``, ``pip`` and ``virtualenv``: +Add the ``ClusterHQ/flocker`` tap to Homebrew and install ``flocker``: .. code-block:: console - alice@mercury:~/flocker-tutorial$ brew update - alice@mercury:~/flocker-tutorial$ brew install python + alice@mercury:~$ brew tap ClusterHQ/tap ... - alice@mercury:~/flocker-tutorial$ pip install virtualenv + alice@mercury:~$ brew install flocker ... - alice@mercury:~/flocker-tutorial$ - - -Running the Install Script -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -:download:`osx-install.sh` - -.. literalinclude:: osx-install.sh - :language: sh - -Save the script to a file and then run it: - -.. code-block:: console - - alice@mercury:~$ sh osx-install.sh + alice@mercury:~$ brew test flocker ... alice@mercury:~$ -The ``flocker-deploy`` command line program will now be available in ``flocker-tutorial/bin/``: - -.. code-block:: console - - alice@mercury:~$ cd flocker-tutorial - alice@mercury:~/flocker-tutorial$ bin/flocker-deploy --version - 0.1.0 - alice@mercury:~/flocker-tutorial$ +You can see the Homebrew recipe in the `homebrew-tap`_ repository. -If you want to omit the prefix path you can e.g. add the appropriate directory to your ``$PATH``. -You'll need to do this every time you start a new shell. +The ``flocker-deploy`` command line program will now be available: .. code-block:: console - alice@mercury:~/flocker-tutorial$ export PATH="${PATH:+${PATH}:}${PWD}/bin" - alice@mercury:~/flocker-tutorial$ flocker-deploy --version + alice@mercury:~$ flocker-deploy --version 0.1.0 - alice@mercury:~/flocker-tutorial$ + alice@mercury:~$ -.. _`Homebrew`: http://brew.sh +.. _Homebrew: http://brew.sh +.. _homebrew-tap: https://github.com/ClusterHQ/homebrew-tap \ No newline at end of file diff --git a/docs/gettingstarted/osx-install.sh b/docs/gettingstarted/osx-install.sh deleted file mode 100755 index 46fa17e0e2..0000000000 --- a/docs/gettingstarted/osx-install.sh +++ /dev/null @@ -1,13 +0,0 @@ -#!/bin/sh - -# Create a virtualenv, an isolated Python environment, in a new directory called -# "flocker-tutorial": -virtualenv --python=/usr/local/bin/python2.7 flocker-tutorial - -# Upgrade the pip Python package manager to its latest version inside the -# virtualenv. Some older versions of pip have issues installing Python wheel -# packages. -flocker-tutorial/bin/pip install --upgrade pip - -# Install flocker-cli and dependencies inside the virtualenv: -flocker-tutorial/bin/pip install https://storage.googleapis.com/archive.clusterhq.com/downloads/flocker/Flocker-0.1.0-py2-none-any.whl