Merge pull request #31444 from jacobhammons/ddns-docs

Documentation updates - ddns state, file.line state/exe function, installation dependencies

doc/topics/installation/index.rst

@@ -61,7 +61,6 @@ vary:
   * `ZeroMQ`_ >= 3.2.0
   * `pyzmq`_ >= 2.2.0 - ZeroMQ Python bindings
   * `PyCrypto`_ - The Python cryptography toolkit
-  * `M2Crypto`_ - "Me Too Crypto" - Python OpenSSL wrapper
 
 * RAET:
 
@@ -86,6 +85,11 @@ provided like:
 
   pip install --install-option="--salt-transport=raet" salt
 
+.. note::
+    Salt does not bundle dependencies that are typically distributed as part of
+    the base OS. If you have unmet dependencies and are using a custom or
+    minimal installation, you might need to install some additional packages
+    from your OS vendor.
 
 Optional Dependencies
 ---------------------
@@ -99,7 +103,6 @@ Optional Dependencies
 .. _`pyzmq`: https://github.com/zeromq/pyzmq
 .. _`msgpack-python`:  https://pypi.python.org/pypi/msgpack-python/
 .. _`PyCrypto`: https://www.dlitz.net/software/pycrypto/
-.. _`M2Crypto`: http://chandlerproject.org/Projects/MeTooCrypto
 .. _`YAML`: http://pyyaml.org/
 .. _`Jinja2`: http://jinja.pocoo.org/
 .. _`MarkupSafe`: https://pypi.python.org/pypi/MarkupSafe

doc/topics/installation/rhel.rst

@@ -103,6 +103,11 @@ To install using the SaltStack repository:
        gpgkey=https://repo.saltstack.com/yum/redhat/$releasever/$basearch/latest/SALTSTACK-GPG-KEY.pub
               https://repo.saltstack.com/yum/redhat/$releasever/$basearch/latest/base/RPM-GPG-KEY-CentOS-7
 
+.. note::
+    ``systemd`` and ``python-systemd`` are required by Salt, but are not
+    installed by the Red Hat 7 ``@base`` installation or by the Salt
+    installation. These dependencies might need to be installed before Salt.
+
 Installation from the Community Repository
 ==========================================
 

doc/topics/releases/2015.8.8.rst

@@ -0,0 +1,4 @@
+===========================
+Salt 2015.8.8 Release Notes
+===========================
+

salt/modules/file.py

@@ -1414,23 +1414,23 @@ def line(path, content, match=None, mode=None, location=None,
         a fragment of a string or regular expression.
 
     :param mode:
-        Ensure
+        :Ensure:
             If line does not exist, it will be added.
 
-        Replace
+        :Replace:
             If line already exist, it will be replaced.
 
-        Delete
+        :Delete:
             Delete the line, once found.
 
-        Insert
+        :Insert:
             Insert a line.
 
     :param location:
-        start
+        :start:
             Place the content at the beginning of the file.
 
-        end
+        :end:
             Place the content at the end of the file.
 
     :param before:
@@ -1439,25 +1439,24 @@ def line(path, content, match=None, mode=None, location=None,
     :param after:
         Regular expression or an exact case-sensitive fragment of the string.
 
-    :param show_changes
+    :param show_changes:
         Output a unified diff of the old file and the new file.
         If ``False`` return a boolean if any changes were made.
         Default is ``True``
 
         .. note::
-
             Using this option will store two copies of the file in-memory
             (the original version and the edited version) in order to generate the diff.
 
-    :param backup
+    :param backup:
         Create a backup of the original file with the extension:
         "Year-Month-Day-Hour-Minutes-Seconds".
 
-    :param quiet
+    :param quiet:
         Do not raise any exceptions. E.g. ignore the fact that the file that is
         tried to be edited does not exist and nothing really happened.
 
-    :param indent
+    :param indent:
         Keep indentation with the previous line.
 
     If an equal sign (``=``) appears in an argument to a Salt command, it is

salt/states/ddns.py

@@ -8,6 +8,11 @@ type dynamic updates.
 
 :depends: - `dnspython <http://www.dnspython.org/>`_
 
+.. note::
+    The ``dnspython`` module is required when managing DDNS using a TSIG key.
+    If you are not using a TSIG key, DDNS is allowed by ACLs based on IP
+    address and the ``dnspython`` module is not required.
+
 Example:
 
 .. code-block:: yaml
@@ -18,7 +23,7 @@ Example:
         - ttl: 60
         - data: 111.222.333.444
         - nameserver: 123.234.345.456
-        - keyfile: /srv/salt/dnspython_key.txt
+        - keyfile: /srv/salt/dnspy_tsig_key.txt
 '''
 
 

salt/states/file.py

@@ -2535,13 +2535,67 @@ def line(name, content, match=None, mode=None, location=None,
 
     .. versionadded:: 2015.8.0
 
-    Params are identical to the remote execution function
-    :mod:`file.line <salt.modules.file.line>`.
+    :param name:
+        Filesystem path to the file to be edited.
+
+    :param content:
+        Content of the line.
+
+    :param match:
+        Match the target line for an action by
+        a fragment of a string or regular expression.
+
+    :param mode:
+        :Ensure:
+            If line does not exist, it will be added.
+
+        :Replace:
+            If line already exist, it will be replaced.
+
+        :Delete:
+            Delete the line, once found.
+
+        :Insert:
+            Insert a line.
+
+    :param location:
+        :start:
+            Place the content at the beginning of the file.
+
+        :end:
+            Place the content at the end of the file.
+
+    :param before:
+        Regular expression or an exact case-sensitive fragment of the string.
+
+    :param after:
+        Regular expression or an exact case-sensitive fragment of the string.
+
+    :param show_changes:
+        Output a unified diff of the old file and the new file.
+        If ``False`` return a boolean if any changes were made.
+        Default is ``True``
+
+        .. note::
+            Using this option will store two copies of the file in-memory
+            (the original version and the edited version) in order to generate the diff.
+
+    :param backup:
+        Create a backup of the original file with the extension:
+        "Year-Month-Day-Hour-Minutes-Seconds".
+
+    :param quiet:
+        Do not raise any exceptions. E.g. ignore the fact that the file that is
+        tried to be edited does not exist and nothing really happened.
+
+    :param indent:
+        Keep indentation with the previous line.
 
     .. code-block: yaml
 
-       /etc/myconfig.conf:
+       update_config:
          file.line:
+           - name: /etc/myconfig.conf
            - mode: ensure
            - content: my key = my value
            - before: somekey.*?