valitydev/salt
14
0
Fork 0
mirror of https://github.com/valitydev/salt.git synced 2024-11-07 00:55:19 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Moved configuration into its own doc

Browse Source
This commit is contained in:
Seth House 2011-10-30 10:08:28 -06:00
parent b78d0d8b0b
commit 280c5ec4eb
2 changed files with 21 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/ref/cli/index.rst
View File

@ -26,7 +26,7 @@ environment variables ``SALT_MASTER_CONFIG`` and ``SALT_MINION_CONFIG``.
.. seealso::
:doc:`../configuration/index`
:doc:`/topics/configuration`
Using the Salt Command
======================

54
doc/topics/tutorial.rst → doc/topics/configuration.rst
View File

@ -1,10 +1,11 @@
========
Tutorial
========
================
Configuring Salt
================
The Salt system setup is amazingly simple, as this is one of the central design
goals of Salt. Setting up Salt only requires that the Salt :term:`master` be
running and the Salt :term:`minions <minion>` point to the master.
Salt configuration is very simple. The default configuration for the
:term:`master` will work for most installations and the only requirement for
setting up a :term:`minion` is to set the location of the master in the minion
configuration file.
.. glossary::
@ -12,55 +13,40 @@ running and the Salt :term:`minions <minion>` point to the master.
The Salt master is the central server that all minions connect to. You
run commands on the minions through the master and minions send data
back to the master (unless otherwise redirected with a :doc:`returner
<../ref/returners/index>`). It is started with the
</ref/returners/index>`). It is started with the
:command:`salt-master` program.
minion
Salt minions are the potentially hundreds or thousands of servers that
you query and control from the master.
Configuring Salt
================
Salt configuration is very simple. The default configuration for the
:term:`master` will work for most installations and the only requirement for
setting up a :term:`minion` is to set the location of the master in the minion
configuration file. The configuration files will be installed to
:file:`/etc/salt` and are named after the respective components,
:file:`/etc/salt/master` and :file:`/etc/salt/minion`.
The configuration files will be installed to :file:`/etc/salt` and are named
after the respective components, :file:`/etc/salt/master` and
:file:`/etc/salt/minion`.
To make a minion check into the correct master simply edit the
:conf_minion:`master` variable in the minion configuration file to reference
the master DNS name or IPv4 address.
.. seealso::
For further information consult the :doc:`configuration guide
<../ref/configuration/index>`.
Running Salt
============
1. Start the :term:`master` in the foreground (to daemonize the process, pass
the :option:`-d flag <salt-master -d>`)::
1. Start the master in the foreground (to daemonize the process, pass the
:option:`-d flag <salt-master -d>`)::
salt-master
2. Start the :term:`minion` in the foreground (to daemonize the process, pass
the :option:`-d flag <salt-minion -d>`)::
2. Start the minion in the foreground (to daemonize the process, pass the
:option:`-d flag <salt-minion -d>`)::
salt-minion
.. seealso:: :doc:`salt-master manpage <../ref/cli/salt-master>` and
:doc:`salt-minion manpage <../ref/cli/salt-minion>`
.. admonition:: Having trouble?
Arch Linux init scripts
-----------------------
The simplest way to troubleshoot Salt is to run the master and minion in
the foreground with :option:`log level <salt-master -l>` set to ``debug``::
.. code-block:: bash
/etc/rc.d/salt-master start
/etc/rc.d/salt-minion start
salt-master --log-level=debug
Manage Salt public keys
=======================
@ -82,4 +68,4 @@ the master can send commands to the minion the key needs to be "accepted".
salt-key -A
.. seealso:: :doc:`salt-key manpage <../ref/cli/salt-key>`
.. seealso:: :doc:`salt-key manpage </ref/cli/salt-key>`