fix errors in docs

This commit is contained in:
Clayton Parker 2014-06-25 22:54:37 -04:00
parent f4b30eddff
commit 23c494c8ce
6 changed files with 27 additions and 17 deletions

View File

@ -117,6 +117,7 @@ target a minion to a pillar file and then list the keys and values in the
pillar. Here is an example top file that illustrates this point: pillar. Here is an example top file that illustrates this point:
.. code-block:: yaml .. code-block:: yaml
base: base:
'*': '*':
- common_pillar - common_pillar
@ -124,6 +125,7 @@ pillar. Here is an example top file that illustrates this point:
And the actual pillar file at '/srv/salt/common_pillar.sls': And the actual pillar file at '/srv/salt/common_pillar.sls':
.. code-block:: yaml .. code-block:: yaml
foo: bar foo: bar
boo: baz boo: baz

View File

@ -32,7 +32,7 @@ Version 2014.1.5 is another bugfix release for :doc:`2014.1.0
- Fix for kmod modules with dashes (:issue:`13239`) - Fix for kmod modules with dashes (:issue:`13239`)
- Fix possible race condition for Windows minions in state module reloading - Fix possible race condition for Windows minions in state module reloading
(:issue:`12370`) (:issue:`12370`)
- Fix bug with roster for ``passwd``s that are loaded as non-string objects - Fix bug with roster for ``passwd`` option that is loaded as a non-string object
(:issue:`13249`) (:issue:`13249`)
- Keep duplicate version numbers from showing up in ``pkg.list_pkgs`` output - Keep duplicate version numbers from showing up in ``pkg.list_pkgs`` output
- Fixes for Jinja renderer, timezone :mod:`module - Fixes for Jinja renderer, timezone :mod:`module
@ -42,7 +42,8 @@ Version 2014.1.5 is another bugfix release for :doc:`2014.1.0
- Removed the deprecated external nodes classifier (originally accessible by - Removed the deprecated external nodes classifier (originally accessible by
setting a value for external_nodes in the master configuration file). Note setting a value for external_nodes in the master configuration file). Note
that this functionality has been marked deprecated for some time and was that this functionality has been marked deprecated for some time and was
replaced by the more general :doc:`master tops <topics/master_tops>` system. replaced by the more general :doc:`master tops </topics/master_tops/index>`
system.
- More robust escaping of ldap filter strings. - More robust escaping of ldap filter strings.
- Fix trailing slash in :conf_master:`gitfs_root` causing files not to be - Fix trailing slash in :conf_master:`gitfs_root` causing files not to be
available (:issue:`13185`) available (:issue:`13185`)

View File

@ -14,7 +14,7 @@ should probably not be used in production.
SDB Configuration SDB Configuration
================ =================
In order to use the SDB interface, a configuration profile must be set up in In order to use the SDB interface, a configuration profile must be set up in
either the master or minion configuration file. The configuration stanza either the master or minion configuration file. The configuration stanza
includes the name/ID that the profile will be referred to as, a ``driver`` includes the name/ID that the profile will be referred to as, a ``driver``

View File

@ -61,12 +61,15 @@ def _ip_sort(ip):
def cloud_init_interface(name, vm_=None, **kwargs): def cloud_init_interface(name, vm_=None, **kwargs):
''' '''
Interface between salt.cloud.lxc driver and lxc.init Interface between salt.cloud.lxc driver and lxc.init
vm_ is a mapping of vm opts in the salt.cloud format ``vm_`` is a mapping of vm opts in the salt.cloud format
as documented for the lxc driver. as documented for the lxc driver.
This can be used either: This can be used either:
- from the salt cloud driver
- because you find the argument to give easier here - from the salt cloud driver
than using directly lxc.init - because you find the argument to give easier here
than using directly lxc.init
WARNING: BE REALLY CAREFUL CHANGING DEFAULTS !!! WARNING: BE REALLY CAREFUL CHANGING DEFAULTS !!!
IT'S A RETRO COMPATIBLE INTERFACE WITH IT'S A RETRO COMPATIBLE INTERFACE WITH
THE SALT CLOUD DRIVER (ask kiorky). THE SALT CLOUD DRIVER (ask kiorky).
@ -107,7 +110,7 @@ def cloud_init_interface(name, vm_=None, **kwargs):
mac for the primary nic mac for the primary nic
netmask netmask
netmask for the primary nic (24) netmask for the primary nic (24)
= vm_.get('netmask', '24') = ``vm_.get('netmask', '24')``
bridge bridge
bridge^for the primary nic (lxcbr0) bridge^for the primary nic (lxcbr0)
gateway gateway
@ -646,6 +649,7 @@ def init(name,
[bridge=lxcbr0] [gateway=10.0.3.1] \\ [bridge=lxcbr0] [gateway=10.0.3.1] \\
[dnsservers[dns1,dns2]] \\ [dnsservers[dns1,dns2]] \\
[users=[foo]] password='secret' [users=[foo]] password='secret'
name name
Name of the container. Name of the container.
@ -693,11 +697,13 @@ def init(name,
nic_opts nic_opts
Extra options for network interfaces. E.g: Extra options for network interfaces. E.g:
{"eth0": {"mac": "aa:bb:cc:dd:ee:ff",
"ipv4": "10.1.1.1", "ipv6": "2001:db8::ff00:42:8329"}} ``{"eth0": {"mac": "aa:bb:cc:dd:ee:ff", "ipv4": "10.1.1.1", "ipv6": "2001:db8::ff00:42:8329"}}``
or or
{"eth0": {"mac": "aa:bb:cc:dd:ee:ff",
"ipv4": "10.1.1.1/24", "ipv6": "2001:db8::ff00:42:8329"}} ``{"eth0": {"mac": "aa:bb:cc:dd:ee:ff", "ipv4": "10.1.1.1/24", "ipv6": "2001:db8::ff00:42:8329"}}``
start start
Start the newly created container. Start the newly created container.
@ -990,10 +996,11 @@ def init(name,
def cloud_init(name, vm_=None, **kwargs): def cloud_init(name, vm_=None, **kwargs):
'''Thin wrapper to lxc.init to be used from the saltcloud lxc driver '''Thin wrapper to lxc.init to be used from the saltcloud lxc driver
name name
Name of the container Name of the container
may be None and then guessed from saltcloud mapping may be None and then guessed from saltcloud mapping
vm_ ``vm_``
saltcloud mapping defaults for the vm saltcloud mapping defaults for the vm
''' '''
init_interface = __salt__['lxc.cloud_init_interface'](name, vm_, **kwargs) init_interface = __salt__['lxc.cloud_init_interface'](name, vm_, **kwargs)
@ -1872,7 +1879,7 @@ def bootstrap(name, config=None, approve_key=True,
to the target host's master. to the target host's master.
approve_key approve_key
Request a pre-approval of the generated minion key. Requires Request a pre-approval of the generated minion key. Requires
that the salt-master be configured to either auto-accept all keys or that the salt-master be configured to either auto-accept all keys or
expect a signing request from the target host. Default: ``True`` expect a signing request from the target host. Default: ``True``

View File

@ -1,7 +1,7 @@
# encoding: utf-8 # encoding: utf-8
''' '''
A Websockets add-on to saltnado A Websockets add-on to saltnado
=================== ===============================
.. py:currentmodule:: salt.netapi.rest_tornado.saltnado .. py:currentmodule:: salt.netapi.rest_tornado.saltnado

View File

@ -164,8 +164,8 @@ def init(names, host=None, saltcloud_mode=False, quiet=False, **kwargs):
nic_opts nic_opts
Extra options for network interfaces. E.g: Extra options for network interfaces. E.g:
{"eth0": {"mac": "aa:bb:cc:dd:ee:ff", "ipv4": "10.1.1.1",
"ipv6": "2001:db8::ff00:42:8329"}} ``{"eth0": {"mac": "aa:bb:cc:dd:ee:ff", "ipv4": "10.1.1.1", "ipv6": "2001:db8::ff00:42:8329"}}``
start start
Start the newly created container. Start the newly created container.