Pedro Algarvio
77803997f3
Revert "Renamed sysmod
module to sys
while enforcing absolute imports."
...
This reverts commit 174a3e5b6c
.
2013-08-20 23:43:45 +01:00
Chris Rebert
d854574bf9
copyedit state ordering docs
2013-08-20 12:21:26 -07:00
Thomas S Hatch
e263e9a7b9
Add state_auto_order docs
2013-08-20 11:55:24 -06:00
Pedro Algarvio
174a3e5b6c
Renamed sysmod
module to sys
while enforcing absolute imports.
2013-08-19 17:53:14 +01:00
Pedro Algarvio
758e789d12
Fixed documentation linking.
2013-08-19 17:40:07 +01:00
Pedro Algarvio
791dc53ca6
Renamed localemod
module to locale
while enforcing absolute imports.
2013-08-19 17:01:42 +01:00
Pedro Algarvio
c4c58370d2
Renamed ldapmod
module to ldap
while enforcing absolute imports.
2013-08-19 16:31:27 +01:00
Pedro Algarvio
0f08e6088b
Renamed gentoolkitmod
module gentoolkit
while enforcing absolute imports.
2013-08-19 16:24:01 +01:00
Pedro Algarvio
2f4d82b295
Renamed djangomod
module and state to django
while enforcing absolute imports.
2013-08-19 16:13:38 +01:00
Pedro Algarvio
04e3874b42
Renamed debconfmod
module and state to debconf
while enforcing absolute imports.
2013-08-19 14:17:00 +01:00
Pedro Algarvio
e724e54199
Since the module/state got renamed, let's leave a link pointing to the new names.
2013-08-19 13:53:19 +01:00
Pedro Algarvio
1599cd0ba5
Since there are some links to salt.modules.cmdmod
point the user to the correct module.
2013-08-19 13:49:33 +01:00
Pedro Algarvio
3fa341280b
salt.modules.cmdmod
renamed to salt.modules.cmd
while enforcing absolute imports.
2013-08-19 13:45:56 +01:00
Pedro Algarvio
a1a2b49a72
By enforcing absolute imports, there's no need for module name aliases.
2013-08-19 13:23:46 +01:00
Pedro Algarvio
afddbc8ee9
Merge pull request #6734 from terminalmage/issue6645
...
Check /etc/hostname to derive minion id
2013-08-15 16:29:32 -07:00
Erik Johnson
ce9b2728a0
Add documentation on how the minion id is derived
2013-08-15 18:03:38 -05:00
Seth House
bb8e617c57
Quiet Sphinx warning for deprecated Python API doc
2013-08-15 16:15:49 -06:00
Seth House
4d3012d9db
Removed the "Python API" document in favor of the "Clients" doc
...
This change moves some docs into class docstrings and some into the
clients/index.rst document.
Fixes #6705
2013-08-15 16:00:02 -06:00
Erik Johnson
7d4739da2f
Audit module documentation (A to D)
...
This commit formats shell examples using bash code-block directives, so
that they get syntax highlighting. It also adds missing doc pages for
the ddns module.
2013-08-14 19:53:09 -05:00
Seth House
95971d96d6
Added docs for each fileserver module
2013-08-14 17:19:56 -06:00
Seth House
73c11e298f
Added fileserver modules to docs & index
2013-08-14 17:00:09 -06:00
Seth House
4d77e83d26
Added auth modules to the docs & index
2013-08-14 16:41:08 -06:00
Seth House
88671c18bb
Added auth module docs
...
O_o how has this not been done yet?
2013-08-14 16:41:08 -06:00
Erik Johnson
16b184bb5f
Add rst pages for new modjk state/module
...
This commit tells sphinx to build doc pages for these new files, and
adds them to the table of contents.
2013-08-13 11:02:44 -05:00
Erik Johnson
9c63495e04
Formatting fixes
...
This completes the documentation audit begun in cf365f7
, using proper
backticks and :strong: tags to emphasize text, converting groups of
shell commands to bash code-block sections, etc. This also replaces the
use of \* with the easier-to-grok '*', which will hopefully reduce
confusion among new users.
2013-08-11 22:17:47 -05:00
Chris Rebert
25ff009ee9
Some docs copyediting & formatting
2013-08-10 22:43:12 -07:00
Pedro Algarvio
23052f6c95
Let the note stand out.
2013-08-10 16:06:30 +01:00
Pedro Algarvio
30828a7c01
Re add the JSON note lost in a rebase.
2013-08-10 15:39:04 +01:00
Pedro Algarvio
8185dbd75f
Correct order and added missing options.
2013-08-10 15:37:38 +01:00
Pedro Algarvio
86521e62e8
salt-ssh
does not provide --return
.
2013-08-10 15:37:38 +01:00
Pedro Algarvio
19cdcd9970
Ordered the options output of salt-key
added missing finger options.
2013-08-10 15:37:38 +01:00
Pedro Algarvio
a611a35fe1
salt-run
also has the doc option.
2013-08-10 15:37:38 +01:00
Pedro Algarvio
836a557804
The timeout is now on a common document.
...
Added the missing includes.
2013-08-10 15:37:37 +01:00
Pedro Algarvio
fe43bb6558
Match option order and add missing --master
.
2013-08-10 15:37:37 +01:00
Pedro Algarvio
13c7255980
Common daemon options are now on a separate document.
2013-08-10 15:37:37 +01:00
Pedro Algarvio
c304872ab1
General options are now on a common document.
2013-08-10 15:37:37 +01:00
Pedro Algarvio
3fd8ac7924
Logging options is now on it's own, common, document.
...
* Added logging options for all the CLI tools that supported it and were lacking them.
2013-08-10 15:37:37 +01:00
Pedro Algarvio
5268601ef6
Fix include path.
2013-08-10 15:37:37 +01:00
Pedro Algarvio
153475fa60
Target selection documentation now reside on it's own, common, document.
2013-08-10 15:37:37 +01:00
Pedro Algarvio
d009a82998
Add --output-file
to the documentation. Minor formatting update.
2013-08-10 15:37:37 +01:00
Pedro Algarvio
f94e9f5e02
Add --force-color
to the documentation.
2013-08-10 15:37:37 +01:00
Pedro Algarvio
9f47a1a0ad
CLI Output options now reside on it's own, common, document.
2013-08-10 15:37:33 +01:00
Joseph Hall
e940f60c3c
Merge pull request #6600 from TheRealBill/develop
...
Adding some clarification about the use of --out=json and the output.
2013-08-09 12:47:08 -07:00
Bill Anderson
5cc8142d2a
Adding some clarification about the use of --out=json and the output.
2013-08-09 14:11:41 -05:00
Thomas S Hatch
f3d81dd4ef
Merge pull request #6579 from terminalmage/develop
...
Fix traceback on master when cp.push is used without file_recv being set
2013-08-08 14:44:10 -07:00
Erik Johnson
8f03781ca9
Add missing master configuration file parameters
...
This commit adds some recently-added master config options to the online
docs.
2013-08-08 15:10:32 -05:00
Tomé Duarte
27e939f8c1
Adds example to Using Peer Communication with a specified matcher
...
It took me a while to figure out I could do this, thought I'd clarify with an example.
Should more examples (for other matchers) be added?
2013-08-08 21:08:39 +01:00
Colton Myers
7743c77d9d
Add the salt.states.iptables docs
2013-08-05 18:10:41 -06:00
Colton Myers
34d156bd6d
Add iptables to state index
2013-08-05 18:08:15 -06:00
Erik Johnson
06a61bc5e6
Fix more broken links
...
Two links in doc/ref/states/highstate.rst were broken, resulting in
warnings when running sphinx-build to build the html docs. They were
trying to link within the same page, and the section did not exist,
these sections were probably split off into a separate page
(doc/ref/states/requisites.rst) some time ago and these were never
updated to reflect that.
2013-08-03 19:27:17 -05:00
Erik Johnson
56fbf9cdbf
Formatting fixes + added File Directory Settings
...
Added the configuration parameters made available with a local
fileclient.
2013-08-03 18:53:39 -05:00
Erik Johnson
f59cbc427f
Formatting corrections
2013-08-03 18:53:05 -05:00
Erik Johnson
ef9e7e5ab6
Merge pull request #6487 from s0undt3ch/features/doc-link-to-issues
...
Replace issue links with the `:issue:` extlink extension.
2013-08-01 17:56:53 -07:00
Erik Johnson
fa6170d9f4
Add explanation of the kwargs passed to states
2013-08-01 19:48:23 -05:00
Pedro Algarvio
87472875fe
Replace issue links with the :issue:
extlink extension.
2013-08-02 01:04:57 +01:00
Erik Johnson
c490a73517
pkg, not package
2013-08-01 13:01:49 -05:00
David Boucha
c552c6b537
Add doc on requiring an entire sls file
2013-08-01 11:03:21 -06:00
Erik Johnson
70e236d028
Docmentation tweaks in advance of 0.16.2 release
2013-07-31 20:43:37 -05:00
Tomé Duarte
7946bef5f3
Fix typo in pidfile code example.
2013-07-30 06:57:34 +01:00
David Boucha
5a8fb7a38d
better wording in winrepo
2013-07-28 00:50:44 -06:00
David Boucha
81bf77f4d3
mention winrepo execution module
2013-07-28 00:48:04 -06:00
Joseph Hall
ed29fa103a
Merge pull request #6376 from terminalmage/issue6322
...
Add functions to manage file backups
2013-07-27 16:27:13 -07:00
Erik Johnson
3a2fbbf7dc
add information to backup restoration docs
2013-07-27 18:20:06 -05:00
Erik Johnson
a77a7bd5f1
Document backup listing/restoring/deleting
2013-07-27 18:09:41 -05:00
Erik Johnson
c2b2f675c0
Add file.restore_backup, file.delete_backup
...
These functions allow you to restore a backup found with
file.list_backups, as well as remove unwanted backups.
2013-07-27 17:49:55 -05:00
Thomas L. Kula
54a0746b4e
Backoff when minion fails to connect
...
NOTE: This is a potential change --- I haven't actually gotten a
test environment to try this out.
This adds a configuration option to the minion,
`acceptance_wait_time_max', that if set changes the acceptance
wait loop to add `acceptance_wait_time' seconds to the wait between
each iteration, up to this maximum value.
POTENTIAL FIX: Issue #5813
2013-07-27 16:51:38 -04:00
Erik Johnson
13e9444329
Add file.list_backups execution function
...
This commit adds a function that will list the available backups for a
given path.
2013-07-27 14:48:20 -05:00
Joseph Hall
7062ff4366
Merge pull request #6344 from mikadosoftware/minor-doc-fix
...
Trivial doc spelling fix
2013-07-27 07:14:06 -07:00
Paul Brian (lifeisstillgood)
fe4559101e
Trivial doc spelling fix
...
It is trivial but it is my first commit / pull request so useful for
checking the process is correct. And it has a semicolon
2013-07-27 13:07:44 +01:00
Thomas S Hatch
45cb885301
Merge pull request #6331 from terminalmage/docs
...
Lots of docs on salt fileserver environments
2013-07-26 10:33:24 -07:00
Xavier Barbosa
45677a9875
added doc
2013-07-26 09:30:41 +02:00
Erik Johnson
1a9f069bf0
Document how top files are compiled from different envs
2013-07-25 17:11:33 -05:00
Pedro Algarvio
bc28a6276b
Link to python's glossary.
2013-07-23 21:45:26 +01:00
Pedro Algarvio
0df4f2e8d0
Link to the actual python False
constant.
2013-07-23 18:21:01 +01:00
Pedro Algarvio
1ff844dfb6
Link to the datetime
python documentation.
2013-07-23 18:03:42 +01:00
Pedro Algarvio
947f99a007
Link to string
and False
in the python documentation.
2013-07-23 17:55:45 +01:00
Pedro Algarvio
b83a749d60
Link to the dict
on python's typesmapping
and point to a docstring explanation.
2013-07-23 17:20:50 +01:00
Pedro Algarvio
e46e81e1f2
Direct link to python's documentation regarding the LogRecord
attributes.
2013-07-23 16:59:47 +01:00
Pedro Algarvio
868cfad2d0
Link minion.rst
to time.strftime
's python documentation.
2013-07-23 16:55:23 +01:00
Pedro Algarvio
70b57bd0a2
Link master.rst
to time.strftime
's python documentation.
2013-07-23 16:46:05 +01:00
Erik Johnson
ce22841d52
Rename pillar.data to pillar.items, add pillar.item
...
This brings function parity between the grains and pillar modules, while
preserving backwards compatibility for pillar.data.
2013-07-22 16:08:57 -05:00
David Boucha
92e386c72e
Merge pull request #6255 from terminalmage/docs
...
Add example of watch requisite
2013-07-21 06:55:13 -07:00
Crazybus
c595f80b92
Update winrepo documentation
...
Added in documentation about how full_name and versions are used when verifying installed packages and how to find this information. Added link to init.sls examples. Updated the information about package upgrades not being supported (now works in the latest version). Updated the 7zip example because it didn't verify correctly when running highstate.
2013-07-21 15:19:00 +02:00
Erik Johnson
38b2e3c991
Add example of watch requisite
2013-07-20 23:25:22 -05:00
Thomas S Hatch
b93369d334
Merge pull request #6233 from johnnoone/jinja-import-yaml
...
Jinja import yaml
2013-07-20 19:55:54 -07:00
Erik Johnson
a5627b0cc7
Tweak description of "id" minion config param
2013-07-20 21:14:59 -05:00
Thomas S Hatch
1bb60ff65d
Merge pull request #6243 from s0undt3ch/hotfix/docs-fix
...
Reclass and virtualenv docs fix
2013-07-20 18:56:13 -07:00
Pedro Algarvio
03f09eb99c
Updated documentation since virtualenv
module and state module were renamed to virtualenv_mod
.
2013-07-20 18:59:49 +01:00
Travis J Parker
9bca49af76
don't make it sound like returners prevent return data going back to the master
2013-07-19 10:14:50 -07:00
Xavier Barbosa
f8bf53b682
added doc for yaml / json tags
2013-07-19 16:02:29 +02:00
Erik Johnson
3cc1bb94f2
Add ref/tops/all/salt.tops.reclass_adapter.rst
...
auto-gen'ed rst file for new reclass adapter
2013-07-18 12:29:32 -05:00
Erik Johnson
87d0c07eb2
Remove ref to salt/modules in module writing docs
...
A beginner is not going to know what this means, so don't muddy the
waters with this info. Besides, new modules should only go in
salt/modules once they are accepted into salt proper. Custom modules
should pretty much always go into _modules.
2013-07-18 12:26:39 -05:00
Thomas S Hatch
b8f26dad8d
Merge pull request #6124 from johnnoone/strftime-formatter
...
Strftime formatter
2013-07-16 17:11:46 -07:00
Mathieu Le Marec - Pasquet
cff1fa6f53
fix/feat: let the syndic be way more configurable
...
- Fix micmac between configs
- Add options to configure pidfile, logfile, masterofmaster port
This fixes #6024 .
2013-07-15 20:30:26 +00:00
Xavier Barbosa
22e1da9148
changed dateutil by timelib saltstack/salt#6088
2013-07-15 11:12:23 +02:00
Xavier Barbosa
2c63eb00cf
added documentation saltstack/salt#6088
2013-07-15 11:12:23 +02:00
Erik Johnson
cc8812fa3e
Clarify returner docs
2013-07-13 23:06:35 -05:00
Erik Johnson
7693cd3f6e
Fix typo in top.sls docs
...
The extra ':' here negates the code-block section. Removed it.
2013-07-13 22:30:18 -05:00
David Boucha
e51f7dc94b
Add note about silent_flags on Windows installers.
2013-07-12 17:24:12 -06:00
Thomas S Hatch
46700b2e6c
Merge pull request #6039 from johnnoone/config-extension
...
Serialize dataset into file states and jinja templates
2013-07-12 10:28:47 -07:00
Erik Johnson
1b876fc53a
Clarify docs on custom types
2013-07-08 21:36:34 -05:00
Xavier Barbosa
02f48b7480
added 2 jinja filters: yaml and json
2013-07-08 14:26:39 +02:00
Thomas S Hatch
b12ce6c6e8
Start on salt-ssh manpage
2013-07-06 21:33:46 -06:00
Chris Rebert
bf03461f00
fix spelling: dependancy ==> dependency
2013-07-05 13:35:53 -07:00
Joost Cassee
26edf918fb
Add documentation for shorthand syntax
2013-07-04 00:31:07 +02:00
Seth House
be38b57382
Added git_pillar and updated reclass_adapter pillar/tops module docs
2013-07-03 15:43:42 -06:00
Seth House
3412729a84
Added bsd_shadow and portage_config execution/state module docs
2013-07-03 15:43:42 -06:00
Seth House
059b287f65
Fixed two rST mistakes
2013-07-01 13:42:59 -06:00
martin f. krafft
c7053e9adf
Reclass master_tops/ext_pillar docs update
...
Signed-off-by: martin f. krafft <madduck@madduck.net>
2013-07-01 15:01:11 +02:00
Pedro Algarvio
ce76fd78a4
Quiet sphinx.
2013-06-26 18:29:40 +01:00
ran
38aa906da0
fix mine while caching is disabled
2013-06-25 23:42:09 +03:00
David Boucha
0c874e9d32
document pkg.purge on Windows
2013-06-24 18:09:17 -06:00
Kevin Tran
7122651d20
Fixed spelling
2013-06-22 14:24:14 -07:00
Colton Myers
bad8ed6d28
Document that top files are combined from various environments
...
Ref #5440
2013-06-19 10:08:05 -06:00
Chris Rebert
6a5ff56426
copyediting and formatting
2013-06-18 15:01:57 -07:00
Thomas S Hatch
320652e211
Add docs on prereq and prereq_in
2013-06-18 01:52:10 -06:00
Colton Myers
ef4ba74c10
Add additional clarification for autosign in docs
2013-06-17 16:28:05 -06:00
Chris Rebert
d5b7c7d037
requisites.rst: minor copyediting
2013-06-17 13:02:27 -06:00
Jonathan Ballet
69d77d8c1a
output: fix typo introduced in 5f473b
2013-06-17 17:31:44 +02:00
Jonathan Ballet
5f473bb17e
output: new state output 'changes'
...
It displays states result in 'full' mode unless nothing changed, in
which case it displays results in 'terse' mode.
2013-06-17 15:22:57 +02:00
Thomas S Hatch
89d6d1241c
Add initial prereq docs, this needs a lot more, and a tutorial
2013-06-15 00:44:54 -06:00
Thomas Jackson
f6cf1ee206
Adding docs for "depends" decorator
2013-06-14 17:19:53 -07:00
Thomas S Hatch
47dad7a1f6
Merge pull request #5528 from ageron/fix_kwargs
...
Upgrade kwargs parsing
2013-06-13 14:24:11 -07:00
Aurélien Geron
9690cd7908
cleaned up and finished kwargs parsing upgrade, added et fixed doc
2013-06-13 17:58:10 +02:00
Seth House
370dc7881b
Removed line numbers from master/minion conf file examples
...
This change is to lazily side-step Sphinx issues rendering code
alongside line numbers. Aligning the line numbers <td> with the code
<td> is dumb and I'd like to patch the HTMLWriter to output
Bootstrap-compatible <ol>'s instead.
2013-06-12 12:15:40 -06:00
Thomas S Hatch
8583762d3c
Merge pull request #5497 from ageron/fix_compound_commands
...
Fixed compound commands parsing: do not split arguments
2013-06-12 07:29:42 -07:00
Aurélien Geron
7e4634a3e1
Document the new compound-commands arguments parsing
2013-06-12 12:50:41 +02:00
illumin-us-r3v0lution
9eefa831e6
make it more obvious that salt runners execute on the master
2013-06-11 21:17:48 -03:00
Thomas S Hatch
594eb74968
Add docs on minion_data_cache
2013-06-11 10:35:45 -06:00
Chris Rebert
7e79440c8d
copyedit states/layers.rst
2013-06-10 17:11:29 -07:00
Thomas S Hatch
f76fb045c2
Add initial state layer documentation
2013-06-09 16:28:27 -04:00
Seth House
cfd349afe1
Fixed rST indentation on seealso
2013-06-07 12:47:47 -06:00
yinchuan
3163cb5100
correct the doc for cli to fix issuse #5420
...
Hope that's a right fix.
https://github.com/saltstack/salt/issues/5420
2013-06-07 09:25:47 +08:00
Seth House
4499cfed0b
Added new state module docs
2013-06-06 17:05:50 -06:00
Seth House
c5bc3f0475
Added new module docs
2013-06-06 17:05:47 -06:00
Erik Johnson
47946a89f4
Remove old locale module rst file
2013-06-06 17:58:00 -05:00
Erik Johnson
91a26f1550
Update rst docs to reflect rename to salt/modules/localemod.py
...
This updates the rst docs to match the change made in ef90d58
.
2013-06-06 17:48:59 -05:00
Erik Johnson
f2b036b625
Update salt-key manpage to reflect changes to "-l" arg
2013-06-06 17:44:52 -05:00
yinchuan
b80f904853
Node Groups: 'L@foo.domain.com,bar.domain.com,baz.domain.com or bl*.domain.com' not 'and'
...
use 'and' at this confuse me, and in the http://docs.saltstack.com/topics/targeting/nodegroups.html also use 'or'.
2013-05-29 11:08:32 +08:00
Chris Rebert
cde16f8608
remove deleted modules from docs
2013-05-28 17:24:12 -07:00
Thomas S Hatch
4f1339305f
Add docs on overstate funciton calls
2013-05-28 04:45:47 +00:00
Thomas S Hatch
31c6045b01
Add vars reference document. Fix #5220
2013-05-27 18:48:21 +00:00
Colton Myers
5971b0e8a8
Fix syntax error in jinja context examples
...
Bad indentation meant it would pass in the pieces of context as part of
the **kwargs, rather than as part of the context kwarg.
2013-05-21 13:42:00 -06:00
David Boucha
1608814fc9
Some small doc improvements for Windows Repo page
2013-05-20 23:30:15 -06:00
Thomas S Hatch
856eeb7746
Add docs for #5035
2013-05-16 17:51:50 -06:00
Chris Rebert
4f4fe73d05
salt.renderers.stateconf.rst: add more missing spaces before open parens
2013-05-14 14:38:19 -07:00
Chris Rebert
571fdd7299
some copyediting of the stateconf renderer docs
2013-05-14 14:32:34 -07:00
Colton Myers
9a2c99419d
Add docs for state_output: 'mixed'
2013-05-06 15:40:13 -06:00
Thomas S Hatch
63058e3bde
Merge pull request #4715 from shadowfax-chc/lvm
...
Lvm State
2013-05-01 22:18:28 -07:00
Seth House
45fcf66ee1
Added docs files for new modules
2013-04-30 14:16:22 -06:00