mirror of
https://github.com/saltstack/salt.git
synced 2025-04-17 10:10:20 +00:00
merge differences and mention fetching tags
This commit is contained in:
Sean Channel
parent
eea587f853
commit
a7a1c01530
2 changed files with 97 additions and 16 deletions
101
HACKING.rst
101
HACKING.rst
|
|
@ -11,6 +11,11 @@ Setting a Github pull request
|
|||
|
||||
This is the preferred method for contributions, simply create a Github
|
||||
fork, commit your changes to the fork, and then open up a pull request.
|
||||
If you want to make our life really easier, please also enable Travis-CI on
|
||||
your fork. Salt is already configured, all you need to do is follow the first
|
||||
two(2) steps on their `Getting Started Doc`_.
|
||||
|
||||
.. _`Getting Started Doc`: http://about.travis-ci.org/docs/user/getting-started
|
||||
|
||||
Posting patches to the mailing list
|
||||
-----------------------------------
|
||||
|
|
@ -50,7 +55,13 @@ Then::
|
|||
- The docs use ``reStructuredText`` for markup. See a live demo at
|
||||
http://rst.ninjs.org/
|
||||
- The help information on each module or state is culled from the python code
|
||||
that runs for that piece. Find them in ``salt/modules/`` or ``salt/states/``
|
||||
that runs for that piece. Find them in ``salt/modules/`` or ``salt/states/``.
|
||||
- If you are developing using Arch Linux (or any other distribution for which
|
||||
Python 3 is the default Python installation), then ``sphinx-build`` may be
|
||||
named ``sphinx-build2`` instead. If this is the case, then you will need to
|
||||
run the following ``make`` command::
|
||||
|
||||
make SPHINXBUILD=sphinx-build2 html
|
||||
|
||||
Installing Salt for development
|
||||
-------------------------------
|
||||
|
|
@ -76,19 +87,29 @@ Create a new `virtualenv`_::
|
|||
|
||||
virtualenv /path/to/your/virtualenv
|
||||
|
||||
.. note:: site packages
|
||||
|
||||
If you wish to use installed packages rather than have pip download and
|
||||
compile new ones into this environment, add "--system-site-packages".
|
||||
|
||||
.. _`virtualenv`: http://pypi.python.org/pypi/virtualenv
|
||||
|
||||
On Arch Linux, where Python 3 is the default installation of Python, use the
|
||||
``virtualenv2`` command instead of ``virtualenv``.
|
||||
|
||||
.. note:: Using your system Python modules in the virtualenv
|
||||
|
||||
If you have the required python modules installed on your system already
|
||||
and would like to use them in the virtualenv rather than having pip
|
||||
download and compile new ones into this environment, run ``virtualenv``
|
||||
with the ``--system-site-packages`` option. If you do this, you can skip
|
||||
the pip command below that installs the dependencies (pyzmq, M2Crypto,
|
||||
etc.), assuming that the listed modules are all installed in your system
|
||||
PYTHONPATH at the time you create your virtualenv.
|
||||
|
||||
Activate the virtualenv::
|
||||
|
||||
source /path/to/your/virtualenv/bin/activate
|
||||
|
||||
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
|
||||
|
||||
.. note:: Installing M2Crypto
|
||||
|
|
@ -105,6 +126,30 @@ Install Salt (and dependencies) into the virtualenv::
|
|||
|
||||
apt-get install python-m2crypto
|
||||
|
||||
This also means that you should use ``--system-site-packages`` when
|
||||
creating the virtualenv, to pull in the M2Crypto installed using apt.
|
||||
|
||||
|
||||
.. note:: Important note for those developing using RedHat variants
|
||||
|
||||
If you are developing on a RedHat variant, be advised that the package
|
||||
provider for newer Redhat-based systems (:doc:`yumpkg.py
|
||||
<../ref/modules/all/salt.modules.yumpkg>`) relies on RedHat's python
|
||||
interface for yum. The variants that use this module to provide package
|
||||
support include the following:
|
||||
|
||||
* `RHEL`_ and `CentOS`_ releases 6 and later
|
||||
* `Fedora Linux`_ releases 11 and later
|
||||
* `Amazon Linux`_
|
||||
|
||||
If you are developing using one of these releases, you will want to create
|
||||
your virtualenv using the ``--system-site-packages`` option so that these
|
||||
modules are available in the virtualenv.
|
||||
|
||||
.. _`RHEL`: https://www.redhat.com/products/enterprise-linux/
|
||||
.. _`CentOS`: http://centos.org/
|
||||
.. _`Fedora Linux`: http://fedoraproject.org/
|
||||
.. _`Amazon Linux`: https://aws.amazon.com/amazon-linux-ami/
|
||||
Running a self-contained development version
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
|
|
@ -115,23 +160,29 @@ the configuration, log, and cache files contained in the virtualenv as well.
|
|||
Copy the master and minion config files into your virtualenv::
|
||||
|
||||
mkdir -p /path/to/your/virtualenv/etc/salt
|
||||
cp ./salt/conf/master.template /path/to/your/virtualenv/etc/salt/master
|
||||
cp ./salt/conf/minion.template /path/to/your/virtualenv/etc/salt/minion
|
||||
cp ./salt/conf/master /path/to/your/virtualenv/etc/salt/master
|
||||
cp ./salt/conf/minion /path/to/your/virtualenv/etc/salt/minion
|
||||
|
||||
Edit the master config file:
|
||||
|
||||
1. Uncomment and change the ``user: root`` value to your own user.
|
||||
2. Uncomment and change the ``root_dir: /`` value to point to
|
||||
``/path/to/your/virtualenv``.
|
||||
3. If you are also running a non-development version of Salt you will have to
|
||||
3. If you are running version 0.11.1 or older, uncomment and change the
|
||||
``pidfile: /var/run/salt-master.pid`` value to point to
|
||||
``/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.
|
||||
|
||||
Edit the minion config file:
|
||||
|
||||
1. Repeat the edits you made in the master config for the ``user`` and
|
||||
``root_dir`` values as well as any port changes.
|
||||
2. Uncomment and change the ``master: salt`` value to point at ``localhost``.
|
||||
3. Uncomment and change the ``id:`` value to something descriptive like
|
||||
2. If you are running version 0.11.1 or older, uncomment and change the
|
||||
``pidfile: /var/run/salt-minion.pid`` value to point to
|
||||
``/path/to/your/virtualenv/salt-minion.pid``.
|
||||
3. Uncomment and change the ``master: salt`` value to point at ``localhost``.
|
||||
4. Uncomment and change the ``id:`` value to something descriptive like
|
||||
"saltdev". This isn't strictly necessary but it will serve as a reminder of
|
||||
which Salt installation you are working with.
|
||||
|
||||
|
|
@ -140,17 +191,39 @@ Edit the minion config file:
|
|||
If you plan to run `salt-call` with this self-contained development
|
||||
environment in a masterless setup, you should invoke `salt-call` with
|
||||
``-c /path/to/your/virtualenv/etc/salt`` so that salt can find the minion
|
||||
config file. Without the ``-c`` option, Salt finds its config files in `/etc/salt`.
|
||||
config file. Without the ``-c`` option, Salt finds its config files in
|
||||
`/etc/salt`.
|
||||
|
||||
Start the master and minion, accept the minon's key, and verify your local Salt
|
||||
installation is working::
|
||||
|
||||
cd /path/to/your/virtualenv
|
||||
salt-master -c ./etc/salt -d
|
||||
salt-minion -c ./etc/salt -d
|
||||
salt-key -c ./etc/salt -L
|
||||
salt-key -c ./etc/salt -A
|
||||
salt -c ./etc/salt '*' test.ping
|
||||
|
||||
Running the master and minion in debug mode can be helpful when developing. To
|
||||
do this, add ``-l debug`` to the calls to ``salt-master`` and ``salt-minion``.
|
||||
If you would like to log to the console instead of to the log file, remove the
|
||||
``-d``.
|
||||
|
||||
Once the minion starts, you may see an error like the following::
|
||||
|
||||
zmq.core.error.ZMQError: ipc path "/path/to/your/virtualenv/var/run/salt/minion/minion_event_7824dcbcfd7a8f6755939af70b96249f_pub.ipc" is longer than 107 characters (sizeof(sockaddr_un.sun_path)).
|
||||
|
||||
This means the the path to the socket the minion is using is too long. This is
|
||||
a system limitation, so the only workaround is to reduce the length of this
|
||||
path. This can be done in a couple different ways:
|
||||
|
||||
1. Create your virtualenv in a path that is short enough.
|
||||
2. Edit the :conf_minion:`sock_dir` minion config variable and reduce its
|
||||
length. Remember that this path is relative to the value you set in
|
||||
:conf_minion:`root_dir`.
|
||||
|
||||
``NOTE:`` The socket path is limited to 107 characters on Solaris and Linux,
|
||||
and 103 characters on BSD-based systems.
|
||||
File descriptor limit
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
|
|
@ -167,10 +240,6 @@ If it is less than 2047, you should increase it with::
|
|||
Running the tests
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
You will need a recent version of ``virtualenv``::
|
||||
|
||||
pip install "virtualenv>=1.8.2"
|
||||
|
||||
You will need ``mock`` to run the tests::
|
||||
|
||||
pip install mock
|
||||
|
|
|
|||
|
|
@ -69,6 +69,18 @@ Installing Salt for development
|
|||
Clone the repository using::
|
||||
|
||||
git clone https://github.com/saltstack/salt
|
||||
.. note:: tags
|
||||
|
||||
Just cloning the repository is enough to work with Salt and make
|
||||
contributions. However, you must fetch additional tags into your clone to
|
||||
have Salt report the correct version for itself. To do this you must first
|
||||
add the git repository as an upstream source.::
|
||||
|
||||
git remote add upstream http://github.com/saltstack/salt
|
||||
|
||||
Fetching tags is done with the git 'fetch' utility::
|
||||
|
||||
git fetch --tags upstream
|
||||
|
||||
Create a new `virtualenv`_::
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue