(SIMP-10203) Fix SSL recovery documentation (#435)

- Correct SSL recovery documentation
- Convert all instances of 'puppet master' to 'puppet server'
- Convert all instances of 'SIMP master' to 'SIMP server'
- Correct a few links

SIMP-10203 #close

Author: trevor-vaughan

CHANGELOG

@@ -1,3 +1,8 @@
+* Wed Jul 14 2021 Trevor Vaughan <[email protected]>
+- Correct SSL recovery documentation
+- Convert all instances of 'puppet master' to 'puppet server'
+- Correct a few links
+
 * Wed Jun 30 2021 Trevor Vaughan <[email protected]>
 - Add 389-DS documentation
 

README.md

@@ -48,6 +48,10 @@ You may need some additional OS packages for building PDFs with sphinx
 Install python dependencies:
 
 ```sh
+virtualenv venv
+source venv/bin/activate
+
+pip install --upgrade pip setuptools
 pip install -r requirements.txt
 ```
 

docs/FAQ/Puppet.rst

@@ -27,7 +27,7 @@ troubleshoot the issue.
    .. code-block:: bash
 
       openssl s_client -host $(puppet config print server) \
-      -port $(puppet config print masterport) \
+      -port $(puppet config print serverport) \
       -cert $(puppet config print hostcert) \
       -key $(puppet config print hostprivkey) \
       -CAfile $(puppet config print localcacert)

docs/HOWTO/20_Puppet/Changing_Puppet_Masters.rst

@@ -3,7 +3,7 @@
 HOWTO Move a Client to a new Puppet Server
 ==========================================
 
-The following provides details on how to move an client to a new Puppet server.
+The following provides details on how to move an client to a new :term:`Puppet Server`.
 
 .. NOTE::
 
@@ -13,7 +13,7 @@ On the Old Puppet Server
 ------------------------
 
 The following procedures will archive the agent's artifacts from all environments, copy them to the new
-Puppet server, and clean out the agent's Hiera data.
+Puppet Server, and clean out the agent's :term:`Hiera` data.
 
 Archive the agent's artifacts from all environments
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -28,7 +28,7 @@ Archive the agent's artifacts from all environments
 
   .. code-block:: shell
 
-     find `puppet config --section master print vardir`/simp -name "*<agent-fqdn>*" -exec tar --selinux --xattrs -rpvf <agent-fqdn>_transfer.tar {} \;
+     find `puppet config --section server print vardir`/simp -name "*<agent-fqdn>*" -exec tar --selinux --xattrs -rpvf <agent-fqdn>_transfer.tar {} \;
 
 
 3. Archive the agent's Hiera data from all :term:`Puppet Environments`:
@@ -73,7 +73,7 @@ Remove agent-specific Hiera data from all environments
 
      puppetserver reload
 
-On the New Puppet Master
+On the New Puppet Server
 ------------------------
 
 .. WARNING::

docs/HOWTO/20_Puppet/Disconnect_PuppetDB_from_Puppet_Server.rst

@@ -18,7 +18,7 @@ restart the :program:`puppetserver` process without the connection.
    # /etc/puppetlabs/puppet (the default).
    mv /etc/puppetlabs/puppet/routes.yaml /etc/puppetlabs/puppet/routes.yaml.backup
 
-   puppet config set --section master storeconfigs false
+   puppet config set --section server storeconfigs false
    puppet config set --section main storeconfigs false
 
    puppet resource service puppetserver ensure=stopped

docs/HOWTO/20_Puppet/ENC_setup.rst

@@ -21,7 +21,7 @@ To use this script for your ENC, do the following as ``root``:
 
 #. Configure Puppet to use this script as an ENC
 
-   Set the following in the :code:`[master]` section of :file:`/etc/puppetlabs/puppet/puppet.conf`:
+   Set the following in the :code:`[server]` section of :file:`/etc/puppetlabs/puppet/puppet.conf`:
 
    a. Add or change the line :code:`node_terminus` to :code:`exec`.
    b. Set the :code:`external_nodes` entry to :file:`/usr/local/bin/set_environment`.
@@ -31,7 +31,7 @@ To use this script for your ENC, do the following as ``root``:
    .. code-block:: ini
 
       ...
-      [master]
+      [server]
       ...
       node_terminus = exec
       external_nodes = /usr/local/bin/set_environment
@@ -51,7 +51,7 @@ To use this script for your ENC, do the following as ``root``:
 
    .. code-block:: yaml
 
-      # The puppetmaster will use the production environment
+      # The puppet server will use the production environment
       'puppet.my.domain':            'production'
 
       # Any node in my.domain whose FQDN begins with test will use the test environment

docs/HOWTO/20_Puppet/Puppetmaster_Backup.rst

@@ -3,26 +3,26 @@
 HOWTO Back up the Puppet Server
 ===============================
 
-This section details the steps required to back up the Puppet master.
+This section details the steps required to back up the :term:`Puppet Server`.
 
 .. NOTE::
 
-   A default SIMP installation can use Git as a rudimentary method to back up
-   the Puppet server. If a different method is preferred, the user must install
-   and configure it first.
+   A default SIMP installation can use :term:`Git` as a rudimentary method to
+   back up the Puppet Server. If a different method is preferred, the user must
+   install and configure it first.
 
 #. Backup :file:`/etc/puppetlabs/puppet/ssl`
 #. Backup :file:`/etc/puppetlabs/puppet`
 #. Backup :file:`/var/simp`
-#. Backup :file:`\`puppet config --section master print vardir\`/simp`
+#. Backup :file:`\`puppet config --section server print vardir\`/simp`
 #. *Optional:* Backup :file:`/var/www`
 
 
 **Simple Full Backup Command**
 
 .. code-block:: bash
 
-   # tar --selinux --xattrs -czpvf simp_backup-$(date +%Y-%m-%d).tar.gz /etc/puppetlabs /var/simp `puppet config --section master print vardir`/simp /var/www /var/simp
+   # tar --selinux --xattrs -czpvf simp_backup-$(date +%Y-%m-%d).tar.gz /etc/puppetlabs /var/simp `puppet config --section server print vardir`/simp /var/www /var/simp
 
 **Simple Full Restore Command**
 
@@ -34,4 +34,4 @@ This section details the steps required to back up the Puppet master.
 .. NOTE::
 
    This only backs up data that is managed/owned by Puppet. It will not backup any
-   application-centric data (such as the contents of LDAP).
+   application-centric data (such as the contents of :term:`LDAP`).

docs/HOWTO/90_Misc/Kerberos.rst

@@ -107,7 +107,7 @@ Propagate the Keytabs
 
 Move all of the resulting keytab files SECURELY to
 ``/var/simp/environments/<client_environment>/site_files/krb5_files/keytabs/<fqdn>``
-on the Puppet master as appropriate for each file.
+on the :term:`Puppet Server` as appropriate for each file.
 
 .. NOTE::
 

docs/HOWTO/90_Misc/SNMPD.rst

@@ -2,7 +2,7 @@ HOWTO Configure SNMPD
 =====================
 
 This document details how to use the ``simp-simp_snmpd`` Puppet profile module
-to configure the SNMP daemon.
+to configure the :term:`SNMP` daemon.
 
 Simple instructions to configure the snmpd daemon using the
 ``simp-simp_snmpd`` profile module are described in its README file.
@@ -87,16 +87,16 @@ The profile module, by default, installs two users:
 * ``snmp_rw`` is configured for read/write access to everything
 
 User passwords are auto-generated using ``simplib::passgen()`` and stored on
-the Puppet master in a sub-directory in the :term:`SIMP Writable Environment`:
+the :term:`SIMP Server` in a sub-directory in the :term:`SIMP Writable Environment`:
 
 ``/opt/puppetlabs/server/data/puppetserver/simp/environments/production/simp_autofile/gen_passwd``.
 
 Access is configured by ``/etc/snmp/simp_snmpd.d/access.conf``
 
 * To create the ``access.conf`` file, the profile modules uses a set of hashes.
 * The default hashes are in the ``data/common.yaml`` file.
-* These hashes are merged with any hash you defined in the Hiera files on the
-  Puppet master.  Merging is described in
+* These hashes are merged with any hash you defined in the :term:`Hiera` files on the
+  :term:`Puppet Server`. Merging is described in
   `Puppet docs <https://puppet.com/docs/puppet/5.5/hiera_merging.html>`_
 * To remove something from the default hash add the name of object with no keys
 

docs/changelogs/6.5.0_Changelog.rst

@@ -2308,6 +2308,5 @@ the following:
 
 
 .. _submit an issue: https://simp-project.atlassian.net
-.. _simp-project.com: https://simp-project.com
+.. _simp-project.com: https://www.simp-project.com
 .. _packagecloud: https://packagecloud.io/simp-project
-