Skip to content

Commit

Permalink
Notes for things I had to do on my OS X laptop.
Browse files Browse the repository at this point in the history
  • Loading branch information
smcquay committed Feb 2, 2013
1 parent 1e80c7d commit 7ca812c
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 1 deletion.
15 changes: 14 additions & 1 deletion HACKING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Install Salt (and dependencies) into the virtualenv::

pip install M2Crypto # Don't install on Debian/Ubuntu (see below)
pip install pyzmq PyYAML pycrypto msgpack-python jinja2 psutil
pip install -e ./salt # the path to the salt git clone from above
pip install -e ./salt # the path to the salt git clone from above (or . if you're already in that directory)

.. note:: Installing M2Crypto

Expand Down Expand Up @@ -150,6 +150,18 @@ Install Salt (and dependencies) into the virtualenv::
.. _`CentOS`: http://centos.org/
.. _`Fedora Linux`: http://fedoraproject.org/
.. _`Amazon Linux`: https://aws.amazon.com/amazon-linux-ami/

.. note:: Installing dependencies on OS X.

One simple way to get all needed dependencies on OS X is to use homebrew,
and install the following packages::

brew install swig
brew install zmq

Afterward the pip commands should run without a hitch. Also be sure to set
max_open_files to 2048 (see below).

Running a self-contained development version
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand All @@ -173,6 +185,7 @@ Edit the master config file:
``/path/to/your/virtualenv/salt-master.pid``.
4. If you are also running a non-development version of Salt you will have to
change the ``publish_port`` and ``ret_port`` values as well.
5. On OS X also set max_open_files to 2048.

Edit the minion config file:

Expand Down
11 changes: 11 additions & 0 deletions doc/topics/hacking.rst
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,16 @@ Install Salt (and dependencies) into the virtualenv::
.. _`Fedora Linux`: http://fedoraproject.org/
.. _`Amazon Linux`: https://aws.amazon.com/amazon-linux-ami/

.. note:: Installing dependencies on OS X.

One simple way to get all needed dependencies on OS X is to use homebrew,
and install the following packages::

brew install swig
brew install zmq

Afterward the pip commands should run without a hitch. Also be sure to set
max_open_files to 2048 (see below).

Running a self-contained development version
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -200,6 +210,7 @@ Edit the master config file:
``/path/to/your/virtualenv/salt-master.pid``.
4. If you are also running a non-development version of Salt you will have to
change the ``publish_port`` and ``ret_port`` values as well.
5. On OS X also set max_open_files to 2048.

Edit the minion config file:

Expand Down
1 change: 1 addition & 0 deletions doc/topics/installation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ These guides go into detail how to install salt on a given platform.
gentoo
windows
solaris
osx


Dependencies
Expand Down
31 changes: 31 additions & 0 deletions doc/topics/installation/osx.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
====
OS X
====

Now go to the :doc:`Configuring Salt</topics/configuration>` page.

Dependency installation
-----------------------

There are many ways to skin the dependency cat. One solution that I found
simple enough was to install two key packages with the fine homebrew package
manager:


.. code-block:: bash
brew install swig
brew install zmq
and then install the python dependencies as follows:


.. code-block:: bash
pip install M2Crypto pyzmq PyYAML pycrypto msgpack-python jinja2 psutil
Post-installation tasks
=======================

Now go to the :doc:`Configuring Salt</topics/configuration>` page.

0 comments on commit 7ca812c

Please sign in to comment.