Commit Graph

470 Commits

Author SHA1 Message Date
Nicolas Kuttler
657878dcdc Add missing colons 2012-12-20 16:51:30 +01:00
Erik Johnson
7415755653 More docs updates
Added the same links to returner and renderer docs as I did for grains,
states, and modules last night.
2012-12-19 14:35:43 -06:00
Erik Johnson
5def1dd54c Updated docs for grains, modules, and states
Added links to module function documentation, as well as to
"file_roots", and mentioned the saltutil.sync_* functions. Will probably
do the same for returners and renderers soon. This should help people
navigate through the docs easier.
2012-12-18 23:29:36 -06:00
Erik Johnson
15cd4278a4 change reference to 0.10.6 to 0.11.0 2012-12-16 01:25:05 -06:00
Thomas S Hatch
5bee3b8c15 update salt-syndic manpage 2012-12-14 06:48:46 -07:00
Thomas S Hatch
49dfd75660 remove deprecated --config 2012-12-14 06:48:11 -07:00
Thomas S Hatch
e12df0b745 update the salt-run manpage 2012-12-14 06:47:26 -07:00
Thomas S Hatch
1924df2f4b update the salt-minion manpage 2012-12-14 06:46:30 -07:00
Thomas S Hatch
64655a2ca4 Add version options to salt-key manpage 2012-12-14 06:45:31 -07:00
Thomas S Hatch
61792628ae Add --versions-report to salt-call manpage 2012-12-14 06:44:23 -07:00
Thomas S Hatch
025736216f Add --versions-report to salt manpage 2012-12-14 06:43:05 -07:00
Thomas S Hatch
eb1f18f3dc update salt-master manpage 2012-12-14 06:42:18 -07:00
Thomas S Hatch
a98c05f5fe update salt-key manpage 2012-12-14 06:39:38 -07:00
Thomas S Hatch
7feabb7043 update salt-call manpage 2012-12-14 06:32:23 -07:00
Thomas S Hatch
b6bd9bc616 update the sale manpage 2012-12-14 06:28:39 -07:00
Thomas S Hatch
66716492d0 change salt-call manpage with outputter option 2012-12-14 06:20:22 -07:00
Thomas S Hatch
e9f7f5dc2c -Q has been gone for a while! And add --out to salt manpage 2012-12-14 06:18:49 -07:00
Thomas S Hatch
85d6d584a5 Add docs to the master for state_output and state_verbose
Fix #2857
2012-12-10 17:39:21 -07:00
Thomas S Hatch
ee0158ebe2 Add state_output option docs 2012-12-10 17:37:42 -07:00
David Boucha
e2dba0ecae Add module field list documentation 2012-12-03 11:39:38 -07:00
Seth House
cc7c16957b Added docs for new modules 2012-12-02 16:09:43 -07:00
Seth House
d19b10117f Added docs on the client API interfaces 2012-12-02 15:48:03 -07:00
Jack Kuan
bf0eff9785 Move stateconf module doc to its own rst file.
Also added an example of using render pipes(#!jinja|mako|yaml) as
per @UtahDave's request.
2012-11-28 23:08:56 -05:00
Jack Kuan
06484a2d8b Some random doc updates. 2012-11-24 02:07:53 -05:00
David Boucha
1db1287fab Add MySQL to list of returners.
Add MySQL to list of returners.
Improve formatting of docstring so it looks better
in the actual documentation.
Add python module requirement
2012-11-22 22:30:34 -07:00
Thomas S Hatch
f9f0200eca Add docs on executing the overstate 2012-11-19 23:28:57 -07:00
Thomas S Hatch
12fce1d79c Add overstate docs 2012-11-19 22:51:19 -07:00
Jack Kuan
0b9e5e1f9e Fix doc to align with last change. 2012-11-15 11:20:44 -05:00
Jack Kuan
cf7f7faba9 Merge branch 'develop' of github.com:saltstack/salt into develop
Conflicts:
	salt/renderers/jinja.py
	salt/renderers/json.py
	salt/renderers/mako.py
	salt/renderers/wempy.py
2012-11-15 01:29:34 -05:00
Jack Kuan
bc1183924f Doc updates, typo fixes. Add -s option for template renderers. 2012-11-15 01:20:10 -05:00
Ryan Schneider
2ccf589425 Refactor: make_dirs -> makedirs, gzip_compression -> gzip 2012-11-14 18:06:53 -08:00
Ryan Schneider
ad1a43012a Add gzip and template to cp.get_dir, expose make_dirs on cp.get_file 2012-11-14 16:48:26 -08:00
Seth House
659ca23a92 Added docs for new state modules 2012-11-14 12:51:54 -07:00
Seth House
a534cf0b69 Added/updated docs on new/changed execution modules 2012-11-14 12:48:43 -07:00
Seth House
702305902e Updated docs for new pipelined renderers 2012-11-14 12:41:52 -07:00
Jack Kuan
7f3ac3fe89 Add some docs on render pipe.
Also, added a stateconf state so that its stateconf.set function
can be used by the stateconf renderer.
2012-11-13 02:01:34 -05:00
Mike Yumatov
bafd02e827 Fix pillar_roots configuration example 2012-11-12 10:12:40 +04:00
Thomas S Hatch
4afe355d87 Use often instead of must 2012-11-10 22:06:16 -07:00
Thomas S Hatch
537e9141e2 fix small typo 2012-11-08 18:52:09 -07:00
Ryan Schneider
c638617612 Add gzip_compression support to cp.get_file 2012-11-08 16:09:38 -08:00
Ryan Schneider
deaf32b877 Add template rendering to cp.get_file src/dest 2012-11-06 19:36:51 -08:00
Seth House
818858c023 Added a documentation reference section on Salt internals
This sections should collect documentation on how Salt is organized
internally and where interesting/important bits of the code reside.

Refs #2417
2012-11-06 08:56:37 -07:00
Seth House
87cef23b34 Added output modules docs 2012-10-29 19:16:25 -06:00
Seth House
e624126add Added daemontools module docs 2012-10-29 18:31:55 -06:00
Seth House
902cf94512 Replaced ca module docs with tls 2012-10-29 18:31:55 -06:00
Seth House
95d44b000f Added wheel module documentation 2012-10-29 18:31:55 -06:00
Seth House
747c6ff6a8 Normalized the "all" modules pages to use the qualified module term 2012-10-29 18:23:56 -06:00
Seth House
e55262f60a Added a documentation anchor for the master/minion config 2012-10-25 15:31:38 -06:00
Seth House
c6f7337ecd A bevy of line-length adjustments and misc rST fixes 2012-10-25 14:36:02 -06:00
Seth House
6db5a8f94b Added / updated module docs 2012-10-25 14:36:02 -06:00
G. Clifford Williams
5886991459 another minor typo correction 2012-10-25 12:26:52 -05:00
G. Clifford Williams
6b0ea10b7e minor typo correction 2012-10-25 12:19:35 -05:00
Thomas S Hatch
099d37fcbe Update manpage for eauth 2012-10-23 14:31:12 -06:00
G. Clifford Williams
aacdf24aca minor typo fixes 2012-10-20 18:10:18 -05:00
G. Clifford Williams
a4c0963340 fix missed merge error 2012-10-20 13:17:48 -05:00
G. Clifford Williams
607dab0e71 Merge branch 'develop' of https://github.com/saltstack/salt into develop
resolution of documentation merge with upstream develop branch
2012-10-20 13:13:59 -05:00
G. Clifford Williams
d399da4259 Merge branch 'master' of https://github.com/saltstack/salt into develop
Conflicts:
	doc/ref/renderers/all/index.rst
2012-10-20 11:54:50 -05:00
Seth House
4f6eb195e8 Added documentation for runners o_O
You may be asking yourself, "How on earth did runners go undocumented
for so long?!" My response would be, "You seem like an intelligent and
interesting person and I would like to buy you lunch so I can pick your
brain on your thoughts of how to be successful and succeed at life."
2012-10-18 17:02:16 -06:00
Dave Boucha
d20586ba2f Add pillar_ldap documentation to list of pillars 2012-10-17 10:36:09 -06:00
Dave Boucha
e2a7d768e9 Change reference to returners to pillars 2012-10-17 10:30:19 -06:00
Thomas S Hatch
b57bdefcf6 Add hook for ext_nodes 2012-10-16 16:37:22 -06:00
Thomas S Hatch
ade639390e Add initial master tops module tracking docs 2012-10-16 16:35:46 -06:00
G. Clifford Williams
c45ad72284 updated man page and index.rst to include wempy 2012-10-16 14:44:31 -05:00
G. Clifford Williams
1c5042c2ec added wempy to list in ./doc/ref/renderers/index.rst 2012-10-16 11:21:00 -05:00
Dave Boucha
acdbd79652 Update docs regarding recent update to salt-key -d 2012-10-16 09:31:49 -06:00
Ask Bjørn Hansen
2cefd8f0b1 Fix typo in ref/topology.rst 2012-10-12 13:05:45 -07:00
Thomas S Hatch
a6ac5ce8f3 Add some docs 2012-10-11 23:01:18 -06:00
Seth House
c4ff039147 Added a note about the providers minion conf; misc fixes 2012-10-11 14:44:23 -06:00
Seth House
207c826cde Added providers config option to docs 2012-10-11 14:17:10 -06:00
Seth House
1c0a0e5965 Removed incorrect colon from function dec in highstate structure 2012-10-11 11:41:15 -06:00
Seth House
4512aa1bb7 Minor rST fixes 2012-10-11 00:36:07 -06:00
Seth House
b845c4a746 Added glossary entry for the module sync system 2012-10-11 00:35:42 -06:00
Seth House
1efeae5e6c Misc rST fixes and minor text fixes 2012-10-11 00:11:06 -06:00
Seth House
2e0cfc1feb Added a glossary entry for environments 2012-10-11 00:11:06 -06:00
Seth House
47a1ede6f4 Moved the Esky docs to topics & added to the TOC 2012-10-04 18:52:51 -06:00
Seth House
4246b27ff0 Fixed misc rST syntax errors 2012-10-04 18:52:51 -06:00
Seth House
c5302ae0d6 Added new/missing modules/states to docs TOC & generated files 2012-10-04 18:52:50 -06:00
Thomas S Hatch
6bbef3df8e Merge pull request #2168 from archtaku/develop
Add Subnet/IP address matcher
2012-10-04 13:16:04 -07:00
Erik Johnson
3eed6c857e Add Subnet/IP address matcher
This implements #653. Note that there appears to be an underlying
problem with how highstates instantiate Matcher objects, which is
keeping this from working in an SLS file. See issue #2167 for more
details on that.
2012-10-04 13:02:59 -05:00
Sean Channel
22baa7ca69 Update doc/ref/clientacl.rst
delete extra 's' on the key removal
2012-10-04 10:48:12 -07:00
Ryan P. Kelly
e08cd261ff Generic keyword argument usage documentation 2012-10-01 20:13:34 -04:00
Thomas S Hatch
fae2acfc2d Merge branch 'develop' of github.com:saltstack/salt into develop 2012-09-27 19:28:31 -06:00
Thomas S Hatch
818c2bafaa Fix #2125 2012-09-27 19:28:08 -06:00
Aaron Tygart
06c02ca6f4 Add Windows frozen minion docs 2012-09-27 19:49:10 -05:00
Thomas S Hatch
857cff66af Fix #458 2012-09-27 15:40:17 -06:00
Sean Channel
810c1ca3ad make it not a bug 2012-09-25 19:24:33 -07:00
Jeff Bauer
8daf10e373 update salt-key man page 2012-09-25 14:31:16 -05:00
Alec Koumjian
eb907cb084 Update doc/ref/renderers/index.rst
Telling users where they can put their custom renderers.
2012-09-23 16:21:05 -07:00
Aaron Tygart
d445ad0e2b Merge branch 'upstream/develop' into mongo_pillar 2012-09-22 23:30:56 -05:00
Thomas S Hatch
ec1df1769d Add exclude docs 2012-09-22 15:55:32 -06:00
Sean Channel
974a7042ed add backup_mode to minion config and config reference 2012-09-21 18:48:41 -07:00
Sean Channel
e204440766 change location of sock dir
per issue #2044 / commit 075c754
2012-09-20 16:46:06 -07:00
Thomas S Hatch
528600692b Add docs for the new startup_states option 2012-09-20 12:22:12 -06:00
Thomas S Hatch
d76f051610 dd some more docs making the order to requitie relationship
a little more clear
2012-09-20 09:39:16 -06:00
Thomas S Hatch
07a834a3b0 Merge pull request #2024 from gekitsuu/develop
Moved docs from .rst file to docstring
2012-09-12 20:42:58 -07:00
Adam Glenn
a1f1e50889 Moved docs from .rst file to docstring 2012-09-12 21:30:13 -04:00
Thomas S Hatch
1d59e4caeb Merge pull request #2022 from gekitsuu/develop
Added some documentation about mongodb returner
2012-09-12 14:24:50 -07:00
Adam Glenn
f3ff3cd710 Added some documentation about configuring minions 2012-09-12 16:48:54 -04:00
Thomas S Hatch
2e89eb0049 Add docs for the test: True config option 2012-09-12 13:18:15 -06:00
Aaron Tygart
892afaef7f Add Esky documentation 2012-09-12 00:23:31 -05:00
Aaron Tygart
c8cef428ca Add configuration documentation for esky
* Add example in minion configuration template
* Add details in minion configuration documentation
2012-09-11 22:44:00 -05:00
Thomas S Hatch
ed1ba8ac3b Document issues with upgrading and client acl 2012-09-10 10:13:26 -06:00
Thomas S Hatch
3e23074b43 Add docs for new client_acl capabilities 2012-09-10 10:10:55 -06:00
Sean Channel
9572e67d11 minimal description added per Issue #1605
manpage had no description. the added text is excerpted from salt(7).

pls. advise if there are other/better ways to update docs.
2012-09-09 12:05:10 -07:00
Sean Channel
6ffe36f322 misplaced space
"tot he" -> "to the"
2012-08-30 16:02:55 -07:00
Sean Channel
61a0318ae9 delete the word "Facter"
seems just fine without it
2012-08-30 14:28:52 -07:00
Clint Savage
a79caf940d fixed 'recurse' typo in several locations 2012-08-27 21:26:41 -06:00
Aaron Tygart
89630283cc Update doc references to include ext_pillar docs 2012-08-27 13:53:25 -05:00
Aaron Tygart
d4b371f3a6 Add ext_pillar documentation
Signed-off-by: Aaron Tygart <aaron.tygart@firehost.com>
2012-08-27 13:49:26 -05:00
Thomas S Hatch
3fb8e20d97 initial docs on testing interface 2012-08-27 10:44:00 -06:00
Ulrich Dangel
6fda0d22e7 Mention autosigning in master documentation 2012-08-24 16:20:19 +01:00
Ulrich Dangel
878e53db1b Update documentation about default includes 2012-08-24 16:14:21 +01:00
Clint Savage
54a9fe4d28 documenting the CA module 2012-08-22 17:48:50 -06:00
Thomas S Hatch
32856600c2 Add client_acl to master config docs 2012-08-18 00:34:40 -06:00
Thomas S Hatch
1543f1223f there is no 1.0 2012-08-03 00:31:25 -06:00
Thomas S Hatch
8883bb6442 Update man page source 2012-08-02 20:58:52 -06:00
Seth House
01c654d8f1 Added missing modules/states/renderers docs to reference TOC 2012-07-30 00:53:21 -07:00
Thomas S Hatch
cc06749a3c fix doc for runner command 2012-07-27 14:13:55 -06:00
Marcin Kuzminski
24223e57ae fixed salt runner doc typo 2012-07-27 21:19:36 +02:00
Thomas S Hatch
eeef52f52c Add backup_mode doc 2012-07-27 00:05:01 -06:00
Seth House
27f7ff6b4c Updated cmdmod doc with new name 2012-07-25 10:45:18 -07:00
Ulrich Dangel
217c69f2b7 Add debian_service to documentation 2012-07-24 00:53:53 +02:00
Thomas S Hatch
c954cefd65 Add topology doc 2012-07-19 12:04:30 -06:00
Thomas S Hatch
53285798e0 The watcher function is called mod_watch now
and has been for some time...
2012-07-15 01:03:26 -06:00
Intchanter
588f93a5cd Made some language clearer. 2012-07-15 00:57:53 -06:00
Thomas S Hatch
ab7e02544e Add verbose flag to salt manpage 2012-07-12 11:46:56 -06:00
Ulrich Dangel
ede5e4ba13 Add augeas module to documentation 2012-07-10 17:08:32 +02:00
Seth House
36effed649 Revert "Merge branch 'doc-autosummary-headings' into develop"
This reverts commit 7997ed4842, reversing
changes made to 83c901a174.
2012-07-09 16:03:40 -07:00
Alec Koumjian
a22773bdde Instruct authors of state modules to check for the test parameter 2012-07-03 14:17:52 -07:00
Andy Sykes
29c2763527 Fix documentation oops in 'include' option 2012-06-26 21:55:21 +01:00
Andy Sykes
df096d754f Documentation oops 2012-06-26 20:54:56 +01:00
Andy Sykes
fbbe74bb35 Bugfixes/documentation update for the 'include' option
Bugfixes:
- handle case where 'include' option has an empty value
- globs were not handled correctly
- warning issued if any include option fails to match any files; this
may be deliberate by the user, but it's there to catch the case where
someone typos the path

Documentation updated with a few examples of how to use it. Minion
template config file also updated with similar examples.
2012-06-26 20:53:27 +01:00
Thomas S Hatch
cf0f96567a Add a comma to some docs 2012-06-22 08:26:38 -06:00
Thomas S Hatch
ff7317f946 Add docs for new caller api 2012-06-19 23:51:58 -06:00
Thomas S Hatch
e2e74d0b88 some more spelling errors 2012-06-18 15:12:10 -06:00
Thomas S Hatch
ae8a1cae27 horrid spelling errors. 2012-06-18 15:10:29 -06:00
Seth House
753ed3a500 Updated modules/states/renderers/returners with new autosummary layout 2012-06-18 00:45:15 -07:00
Seth House
fca05d214e Updated autosummary template to output headings for the Contents sidebar 2012-06-18 00:42:19 -07:00
Seth House
13acaab80a Revert "Revert "Merge pull request #1449 from elfixit/develop""
This reverts commit 6440faa4d0 but
restores the salt/states/service.py from last correct version.
2012-06-18 00:31:14 -07:00
Seth House
6440faa4d0 Revert "Merge pull request #1449 from elfixit/develop"
This reverts commit 31b093dd93, reversing
changes made to edf676a23e.

There was a mistake added that changed the salt/states/service.py file
to a binary type.

Conflicts:

	doc/ref/states/highstate.rst
	doc/ref/states/index.rst
	doc/ref/states/ordering.rst
2012-06-18 00:26:36 -07:00
Thomas S Hatch
3b31eb5423 Better explanation of what a function declaration is 2012-06-18 00:22:06 -06:00
Thomas S Hatch
51a8789bd2 Repair docs that violate the "double short dec" problem
This problem exists because these statements are not valid yaml. An
example is in the troubleshooting guide.
2012-06-18 00:09:38 -06:00
elfixit
3574518dec updated state docs to new style state syntax
updated the state docs to the new state syntax from:
http://salt.readthedocs.org/en/latest/topics/releases/0.9.9.html#state-syntax-update
2012-06-17 15:40:21 +02:00
Thomas S Hatch
9737c36708 Add docs for job_cache 2012-06-13 15:50:31 -06:00
Erik Johnson
0d08e4a137 Clarify match types in top.sls documentation
Examples of pillar, grain, grain_pcre, list, etc. are added.
2012-06-12 17:21:59 -05:00
Thomas S Hatch
ac4510fb42 Add reference documentation for peer_run 2012-06-02 21:05:17 -06:00
Baiju Muthukadan
f09e13187b Add brew & win_pkg to pkg virtual module index 2012-05-31 19:22:37 +05:30
Thomas S Hatch
326659faa2 Add docs for peer runner interface, Fix #1370 2012-05-30 23:37:14 -06:00
Baiju Muthukadan
ada24af53c Few reStructuredText fixes/cleanups 2012-05-30 16:02:24 +05:30
Thomas S Hatch
2515033c08 Add docs on extend
Make sure people understand that using the extend keyword twice in a
single sls will cause unexpected results
2012-05-28 16:19:00 -06:00