Commit Graph

519 Commits

Author SHA1 Message Date
Jason Sommer
201b4f8776 Added gitfs_root option 2013-08-17 20:14:57 -05:00
Erik Johnson
a59b5149c6 Clarify the minion ID generation docs 2013-08-15 22:23:14 -05:00
Erik Johnson
ce9b2728a0 Add documentation on how the minion id is derived 2013-08-15 18:03:38 -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
Seth House
db4d7bcb59 Added rST anchors to pillar and GitFS for easy cross-referencing 2013-08-07 14:34:47 -06:00
Erik Johnson
4ce370b679 improve formatting in remote execution tutorial 2013-08-06 19:21:39 -05:00
Erik Johnson
02cd6d1868 Fix additional broken links
This takes care of the last of the warnings generated by sphinx when
building the HTML docs.
2013-08-03 23:35:50 -05:00
Erik Johnson
c78a06c833 Remove links to nonexistant pages
Would be good to write these eventually, but for now don't try linking
to them since they do not exist.
2013-08-03 19:12:09 -05:00
Erik Johnson
beedffc62c Added links, formatting fix for standalone minion docs 2013-08-03 18:54:30 -05:00
Erik Johnson
eb339ef1fa Replace references to 0.16.1 with 0.16.2 2013-08-01 20:10:45 -05:00
Forrest
a860e5d002 Fixed a typo in pki minion information.
Modified path to properly reference the key location.
2013-07-29 22:35:28 -07:00
Erik Johnson
a7110e9305 Add practical example 2013-07-26 12:13:32 -05:00
Erik Johnson
49839b72aa Add a 4th step to the states tutorial
This adds a step showing how file roots can be used to "promote" states
from dev -> QA -> prod.
2013-07-25 20:41:21 -05:00
Seth House
1ad733a2c0 Added missing 's' in cross-reference 2013-07-23 16:07:03 -06:00
Pedro Algarvio
a91b6ae02c Linked the dictionaries, strings, lists and numbers to the python documentation. 2013-07-23 21:42:33 +01:00
Erik Johnson
50b34955c3 Rename network.hwaddr to network.hw_addr
This also adds the aliases network.hwaddr, as well as network.ipaddrs
and network.ipaddrs6. Fixes #5061.
2013-07-22 21:52:52 -05:00
Joseph Hall
f62771a227 Merge pull request #6268 from terminalmage/issue6127
Function parity between pillar and grains modules
2013-07-22 14:15:48 -07:00
Erik Johnson
f863417790 Update references to pillar.data in docs 2013-07-22 16:09:51 -05:00
Seth House
24723629be Fixed rST cross-reference syntax in two tutorials 2013-07-22 14:35:49 -06:00
Erik Johnson
e28f8bcf65 Make templating notes flow better with renderer docs
Did not realize that renderers are mentioned a few paragraphs before the
section I added in 8c3cb95. This commit moves that data up to the
section describing the renderers.
2013-07-21 16:57:12 -05:00
Erik Johnson
8c3cb95d84 Add note RE: templating to "starting states" doc 2013-07-21 15:58:37 -05:00
Erik Johnson
60faa582f8 Improve walkthrough
Several formatting changes, including links to function documentation
where appropriate. Also reworded a bit and added some additional
sections, including an example of how to verify a minion's public key
before accepting it, as requested in #6245.
2013-07-20 21:10:17 -05:00
Colton Myers
94fe24c905 Fix bad example in the state tutorial part 3, Fix #6165 2013-07-15 15:44:17 -06:00
pille
fda2218a41 fix doc hyperlink 2013-07-05 14:15:28 +02:00
Seth House
858df860c2 Wrapped file:// in literals 2013-07-01 13:42:58 -06:00
Erik Johnson
323243332e Document the SLS file namespace 2013-06-20 19:51:19 -05:00
Chris Rebert
6a5ff56426 copyediting and formatting 2013-06-18 15:01:57 -07:00
Thomas S Hatch
28d93ab426 Add multi master tutorial 2013-06-18 01:53:35 -06:00
Thomas S Hatch
32fda56f8d Add some comments on yaml arg parsing per #5483 2013-06-11 11:10:08 -06:00
yinchuan
ddc3423a16 correct the line reference [#5408][https://github.com/saltstack/salt/issues/5408] 2013-06-06 10:55:43 +08:00
yinchuan
6c136b7a86 modify a sentence for more accurate 2013-05-30 18:17:39 +09:00
Valentin Bud
f9e74255d2 Update GitFS Backend Walkthrough to include GitFS over SSH
A small description on how to configure GitFS over SSH transport.
2013-05-24 10:36:56 +03:00
Ulrich Dangel
96b64b9992 Fix spelling errors reported by lintian 2013-05-19 22:31:55 +01:00
Chris Rebert
e89cbf4447 capitalize Linux in comments/docs 2013-05-15 19:21:50 -07:00
Thomas S Hatch
4b5c3e6106 Only pass the retcode out to salt-call if retcode_passthrough is
set, first fix for #4904
2013-05-13 07:59:28 -06:00
Thomas S Hatch
c1a25bd619 Start on cloud controller tutorial 2013-05-14 00:40:42 -06:00
Colton Myers
cbd6492950 Add docs for file:// in gitfs 2013-05-07 11:21:26 -06:00
hvnsweeting
73c12a2cf4 add require for service state in examples 2013-05-03 09:49:23 +07:00
Chris Rebert
498d2999db more typo fixes 2013-05-01 16:52:52 -07:00
Thomas S Hatch
4de347fb39 Some more notes on service names 2013-04-30 13:15:01 -06:00
Thomas S Hatch
20ee5dcd1c Add note on package and service names 2013-04-29 17:26:49 -06:00
David Boucha
4233743c68 Merge pull request #4517 from timhollinger/develop
added 'be' to 'need to updated' since I need a verb there.
2013-04-16 14:34:25 -07:00
Tim Hollinger
bf043f6603 added 'be' to 'need to updated' since I need a verb there.
Added a verb to 'need to updated' so it looks as though I passed 2nd
grade English :P
2013-04-16 15:32:52 -06:00
James Kyle
4333141e87 Corrected syntax error in include example for python-libs.
Changed

include:
  - python-libs

to

include:
  - python.python-libs
2013-04-13 09:35:40 -07:00
Tim Hollinger
c773fc115c Changed to 3rd person
Changed to 3rd person
2013-04-05 18:56:42 -06:00
Tim Hollinger
50917223c2 minor fixes
Fixed Debian / Redhat httpd
2013-04-05 17:25:46 -06:00
Tim Hollinger
96fa0c48f9 Changed to 3rd person
Changed to 3rd person
2013-04-05 14:52:51 -06:00
Tim Hollinger
98ca53c218 Fixed 80 column width
Due to fussy programmers that still live with 1972 standards :P
2013-04-05 14:20:36 -06:00
Tim Hollinger
164e3c796f Improved readability, grammar
Swapped 'a' for 'an' where necessary.  Changed verb agreement.
Uncluttered scentences.
2013-04-05 13:49:51 -06:00
Tim Hollinger
f13aedfc2b Improved readability, small grammar changes
swapped 'a' for 'an' where appropriate, fixed gramatical errors,
corrected verb agreement
2013-04-03 18:29:05 -06:00
Gary Wilson Jr
bd499e5640 Fixed several minor misspellings and acronym capitalizations. 2013-03-18 16:42:57 -05:00
Gary Wilson Jr
8c39c1743a Added a couple missing language specifiers for the code-block directive and switched a couple 'yaml' specifications to 'jinja' to get proper highlighting. 2013-03-18 16:42:56 -05:00
Gary Wilson Jr
3850e189e5 Corrected walkthrough path in doc reference. 2013-03-18 16:42:56 -05:00
Gary Wilson Jr
cc72ebb1fb Fixed :doc: uses in the docs that were not rendering due to an extra space. 2013-03-18 16:42:56 -05:00
Thomas S Hatch
b03ca985c2 update the pillar walkthrough with the new get functions 2013-03-18 13:38:47 -06:00
Thomas S Hatch
a91a12cbfb doc fix for some links 2013-03-14 10:18:26 -06:00
Thomas S Hatch
e3cb131d8a Add pillar walkthrough 2013-03-13 23:45:44 -06:00
Thomas S Hatch
7ad7a28acc Add gitfs tutorial 2013-03-13 23:45:44 -06:00
Thomas S Hatch
d6ad39fd89 Add refs to walkthrough to new tutorials 2013-03-13 23:45:43 -06:00
Thomas S Hatch
8f4216b025 Add note about pillar walkthrough to starting states 2013-03-13 23:45:43 -06:00
Thomas S Hatch
430cd2788b Add redirect to pillar walkthrough at the end 2013-03-13 23:45:43 -06:00
Valentin Bud
7ac3e35a6c Update walkthrough.rst 2013-03-07 20:01:31 +02:00
Valentin Bud
09f39c4859 Update walkthrough.rst 2013-03-07 19:31:41 +02:00
Valentin Bud
a487e884bb Update walkthrough.rst 2013-03-07 18:58:21 +02:00
Seth House
e1c52914f1 Switched hard-coded URL to use the :blob: ref 2013-03-04 14:38:36 -07:00
Matt Schartman
0fe10d4e55 Update doc/topics/tutorials/walkthrough.rst
Changed 'coppied' to 'copied'
2013-02-27 15:54:58 -08:00
Nelson Chen
9311ef4c1c Fix for minor typo in walkthrough
s/sill/still/
2013-02-27 14:12:29 -08:00
Thomas S Hatch
f6df098a42 Merge pull request #3850 from seanchannel/develop
Ubuntu firewall rules are already included
2013-02-26 10:26:46 -08:00
Sean Channel
07d37bfab0 Ubuntu firewall rules are already included 2013-02-26 10:19:46 -08:00
Jack Kuan
28f2569879 Fix a typo and try to squeeze in pydsl along the py renderer to give it more publicity! ;) 2013-02-26 13:16:02 -05:00
Daniel Hepper
59635e81ac Fixed typo in Walkthrough 2013-02-26 09:50:03 +01:00
Thomas S Hatch
6c94d8136f Fix more of the walkthrough and add a few more pieces 2013-02-25 19:15:50 -07:00
Thomas S Hatch
88902aca33 minor fixes to walkthrough 2013-02-25 18:32:32 -07:00
Thomas S Hatch
91dc74cec7 Finish first draft of the walkthrough 2013-02-25 18:15:39 -07:00
Thomas S Hatch
ff88e0b0d1 More on the walkthhrough 2013-02-25 14:37:00 -07:00
Thomas S Hatch
f25cb3e46b Add some good functions to walkthrough 2013-02-24 19:31:16 -07:00
Thomas S Hatch
d1aa2a2286 Add notes to walkthrough 2013-02-23 23:01:19 -07:00
Thomas S Hatch
0490ca7852 Start work on the official walkthrough 2013-02-22 14:03:43 -07:00
HVN
c66201898c fixbug on extend example 2013-02-18 15:47:00 +07:00
David Boucha
de1f73f602 Add missing letter. 2013-01-31 09:46:18 -07:00
Erik Johnson
b7251d8013 small spelling correction 2013-01-24 15:01:54 -06:00
Seth House
dc737520b9 Moved document fragments into excluded directory
This avoids "document isn't included in any toctree" warnings.
2013-01-24 00:06:02 -07:00
Seth House
567a1edac7 Misc rST fixes 2013-01-23 23:40:24 -07:00
Seth House
915ad76273 Added all tutorials to a local TOC 2013-01-23 23:29:59 -07:00
John Albietz
11125d41e4 additional example for multiple target types. 2013-01-20 00:08:39 -08:00
Thomas S Hatch
5c2db52f0f Change docs to be third person 2013-01-18 23:33:03 -07:00
HVN
2ec5605e11 add command to run standalone minion 2013-01-19 11:50:08 +07:00
David Boucha
5e675c9904 Update doc/topics/tutorials/bootstrap_ec2.rst
config file is now copied directly to /etc/salt/minion, not /etc/salt/minion.template

No need for the copy operation.
2013-01-17 16:41:27 -07:00
DaveQB
6ac1fa35ac Edited for the new layout of the pki directory in version 0.11+ 2013-01-07 15:44:09 +11:00
Alec Koumjian
1f02f680c3 Create quickstart.rst 2012-12-13 15:07:10 -08:00
Aaron Tygart
a1a1b3cd2a Fix mistake in esky documentation 2012-11-14 16:22:56 -06:00
David Boucha
aacfeaff9f Remove :term: - just highlight the word 2012-11-09 12:26:01 -07:00
David Boucha
7f0601f2cd Fix code-block error 2012-11-09 12:26:01 -07:00
David Boucha
ef0a4d143e Add cron example 2012-11-09 12:26:01 -07:00
David Boucha
7514364bef Add tutorial on using cron to run salt-call 2012-11-09 12:26:01 -07:00
Jay Pipes
ef5e11168c Adds a note to starting_states tutorial explaining file.managed shortcut
address issue #2412

Just adds a note section to the starting_states tutorial doc
page that explains the file.managed shortcut to make it a bit
easier for beginner Salt users to understand...
2012-10-31 16:47:58 -04:00
Jay Pipes
0332c76147 Tiny YAML correction in starting_states tutorial doc page. 2012-10-31 16:11:54 -04: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
G. Clifford Williams
86abc2ae3a added wempy to tutoials/starting_states 2012-10-16 14:52:26 -05:00
Ask Bjørn Hansen
a6130890e7 Update doc/topics/tutorials/bootstrap_ec2.rst
Simplify and fix sed syntax in bootstrap tutorial
2012-10-12 13:02:12 -07:00
Thomas S Hatch
c20ef03995 Add the :: 2012-10-11 23:37:20 -06:00
Thomas S Hatch
c40b47722c Using a diff and not specifying that it is a diff in the doc...
can be confusing
2012-10-11 22:27:36 -06:00
Seth House
47a1ede6f4 Moved the Esky docs to topics & added to the TOC 2012-10-04 18:52:51 -06:00
Thomas S Hatch
f7f053b3b2 Merge pull request #2152 from alejandrogomez/typo
Fix typo in states tutorial part 3
2012-10-02 09:33:33 -07:00
Alejandro Gómez
0112549c00 Fix typo in states tutorial part 3 2012-10-02 18:01:44 +02:00
anentropic
ee2f597c95 Update doc/topics/tutorials/bootstrap_ec2.rst
'E: Unable to locate package salt'

I think you have to install `salt-master` and `salt-minion` packages as shown on the Ubuntu install page: http://docs.saltstack.org/en/latest/topics/installation/ubuntu.html

(I assume we're on Ubuntu since we're also using Canonical CloudInit and the `apt-get` command is used)
2012-10-02 14:27:29 +02:00
Ryan P. Kelly
e08cd261ff Generic keyword argument usage documentation 2012-10-01 20:13:34 -04:00
Clint Savage
9a5d086bf3 more documentation cleanup 2012-08-03 00:23:39 -06:00
Clint Savage
015766d28b reworded paragraphs and fixed up some grammar 2012-08-02 22:04:37 -06:00
Clint Savage
4fcc3fdc35 added a period as it should have been :( 2012-08-02 20:59:57 -06:00
Clint Savage
a791a60de6 hopefully better wording of a very confusing statement 2012-08-02 18:35:18 -06:00
Clint Savage
db3ed4e72d fixed another set of paths in documentation 2012-08-02 17:35:29 -06:00
Clint Savage
4b06beae7e paths were inconsistent and really shouldn't appear as though they are in / 2012-08-02 17:30:25 -06:00
Thomas S Hatch
a2730242fd change the tense of the document.
Documentation should not use "I" or "you" statements
2012-07-19 10:16:58 -06:00
John Albietz
3530285a78 fixed the lokkit example that I gave before. added new system-config-firewall-tui command. 2012-07-19 00:42:46 -07:00
John Albietz
374c1e333a added information on how to properly configure the firewall for salt-masters on CentOS 6 / RHEL. 2012-07-18 21:06:45 -07:00
Brian Riley
a3c456f8cd Fix for bad installation link
The tutorials had a link to a non-existant installation page. I changed
this to link to the installation index document. I also removed the
unused installtion link from `conf.py`.
2012-07-16 15:55:23 -07:00
Brian Riley
425ce24e68 Remove :orphan: as per request
I removed the `:orphan:` element at the top as per whiteinge's request
on IRC.
2012-07-16 15:35:08 -07:00
Andreas Gerstmayr
2ae0097401 fix typo in doc/states tutorial 2012-07-11 21:59:02 +03:00
peacetara
2f54587cbc Adding 'Running and debugging salt states' section. That shows off the salt-call command, to help you debug. Also shows you how in the world to run a .sls file, which is always a good thing :) 2012-06-28 11:51:25 -07:00
Seth House
b7a49ec403 Updated function declarations in tutorials to use the short syntax 2012-06-18 00:04:51 -07:00
Alec Koumjian
39e4d8d976 Added tutorial for preseeding minions with accepted keys. 2012-06-14 09:26:47 -07:00
Baiju Muthukadan
cdd7937b37 It's three components (salt,grains & pillar) 2012-06-13 06:51:40 +05:30
Seth House
4b15fb7f0e Fixed several link target syntaxes 2012-06-10 09:23:42 -07:00
Seth House
6c770e3d44 Marked include tmpl as an orphan to avoid Sphinx warnings 2012-06-10 08:55:12 -07:00
Gavrie Philipson
785e92bd4d Another typo fix 2012-06-10 15:32:34 +03:00
Gavrie Philipson
0323803816 Fixed typo. 2012-06-10 15:17:51 +03:00
Matt Haggard
8035751678 Clarified where the top.sls file goes 2012-06-05 14:54:21 -06:00
Baiju Muthukadan
ada24af53c Few reStructuredText fixes/cleanups 2012-05-30 16:02:24 +05:30
L.C. Rees
3315dad9e7 documentation updates 2012-05-22 22:43:12 -06:00
Thomas S Hatch
fd17c6a1dd Add doc for standalone minion 2012-05-14 13:33:20 -06:00
Jeroen Dekkers
6106f1d829 Use the correct port numbers in documentation 2012-04-26 01:57:43 +02:00
Taavi Burns
dc7b86d9c9 Fix misspelling of "curly". 2012-04-16 01:33:45 -04:00
Taavi Burns
7273403cd9 Indenting Python code in the tutorial
I have to imagine that the docstring and return function should
actually be indented. :)
2012-04-15 23:52:23 -04:00
Jens Rantil
c08771d584 Fixing a weird sentence in documentation
I made a comment about the sentence here:
a7a136fd8d (commitcomment-1111231)
2012-03-21 00:47:06 +01:00
Thomas S Hatch
1655ab59e0 fixed this issue where using a dot is now much cleaner 2012-03-19 15:30:42 -06:00
Seth House
a7749524a4 Fixed old references to grains doc 2012-03-19 05:46:20 -06:00
Jeff Schroeder
9ce7db9710 Fix a busted link in the docs to grain info 2012-03-18 17:55:53 -07:00
Jeff Schroeder
4119f4f9dc Fix some sphinx warnings and link docs better 2012-03-18 17:41:22 -07:00
Jeff Schroeder
5280efafca Big update to the "Starting States" doc 2012-03-18 17:41:21 -07:00
Jeff Schroeder
2908f18b04 Added doc bits about firewall config on Ubuntu and Debian 2012-03-18 17:41:21 -07:00
Gordon McAllister
72c2014767 War on typos
Also cleanup whitespace and break some long lines
2012-03-14 17:09:19 -07:00
David Boucha
3a5bb0407d Various Doc fixes.
Mainly small typo fixes and clarifying some language
2012-03-08 21:05:52 -07:00
Christer Edwards
f8dd5a9c8b fixed typo and added note re: FreeBSD file_roots 2012-02-29 13:45:46 -07:00
Christer Edwards
f2902790e3 initial attempt at a firewall doc for salt master 2012-02-29 13:39:07 -07:00
Christer Edwards
f227c335b6 formatting and clarification cleanup in docs 2012-02-27 21:19:29 -07:00
Erik Johnson
57d417fe41 simplify MAC address example by using network.hwaddr instead of parsing ifconfig with cmd.run 2012-02-27 16:51:04 -06:00
Seth House
2ed2241ff7 Moved platform-specific tutorials into the installation instructions 2012-02-25 14:56:28 -07:00
Christer Edwards
e47f498d7c created basic installation tutorial for fedora 16 2012-02-20 18:29:28 -07:00
Christer Edwards
eb97e55252 created archlinux installation tutorial 2012-02-20 16:37:12 -07:00
Christer Edwards
361d1f9eb1 removed instructions re: path changes
the Makefile has been patched so those manual
changes are no longer needed. Also updated
the tested versions.
2012-02-19 22:46:10 -07:00
Seth House
f7dce9a7ee Replaced links to installation instructions 2012-02-08 03:20:41 -07:00
Thomas S Hatch
0d524920e7 move the ec2 bootstrap into tutorials 2012-01-31 22:35:50 -07:00
Erik Johnson
84cd002e64 need empty line before code blocks. added ones that were missing. 2012-01-30 11:25:08 -06:00
Erik Johnson
56ac9dec70 add link to state.highstate 2012-01-29 19:02:05 -06:00
Erik Johnson
a475787f41 Add warning about using dots in ID declaration 2012-01-29 18:51:57 -06:00
Thomas S Hatch
57fff21be1 fix missing : 2012-01-25 21:15:01 -07:00
Christer Edwards
ef576c607a freebsd installation documentation and tutorial 2012-01-02 22:47:05 -07:00
Seth House
e5ffaf193d Fixed a bone-headed typo; thanks for the report, Zheng Liu! 2011-12-21 08:15:35 -07:00
Thomas S Hatch
a7a136fd8d Add starting states doc 2011-12-10 00:28:29 -07:00
Seth House
2f8616a42e Fixed bad ref to grains 2011-11-26 02:16:32 -07:00
Seth House
e47b629d51 Fixed mismatched glossary entries/definitions in the highstates docs 2011-11-26 02:16:30 -07:00
Seth House
be3eabb0da Fixed bad `watch` example; added a note about name declarations 2011-11-16 14:41:44 -07:00
Seth House
7e5f8be530 Fixed and improved the States tutorials
Got rid of the references to state.template and jumped straight into
state.highstate use and configuration.
2011-11-16 09:23:33 -07:00
Seth House
67c62c270c Finished the States tutorials
They still need quite a bit of polish.
2011-10-30 19:43:18 -06:00
Seth House
8582075a55 Moved requires into include for module & states tutorials 2011-10-30 19:28:02 -06:00
Seth House
c019fa1291 wip: Split States tutorial into separate steps 2011-10-30 12:41:14 -06:00
Seth House
b78d0d8b0b wip: Moved how to use the minion into its own tutorial 2011-10-30 12:41:10 -06:00