Skip to content

Commit

Permalink
(SIMP-MAINT) FAQ role formatting touchups (#401)
Browse files Browse the repository at this point in the history
  • Loading branch information
op-ct committed Oct 27, 2020
1 parent 8ac27d0 commit f7d39f9
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 15 deletions.
5 changes: 3 additions & 2 deletions docs/FAQ/10_Password_Complexity.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,9 @@ Complexity Rules
You can check whether or not a password will meet the system requirements
as follows:

* On systems that use ``pam_pwquality``, use the ``pwscore`` utility.
* On systems that use ``pam_cracklib``, use the ``cracklib-check`` utility.

* On systems that use :program:`pam_pwquality`, use the :program:`pwscore` utility.
* On systems that use :program:`pam_cracklib`, use the :program:`cracklib-check` utility.

.. NOTE::

Expand Down
2 changes: 1 addition & 1 deletion docs/FAQ/Omni_Env_Exists.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ To do this, see :ref:`howto-use-an-alternate-simp-config-environment`.

Remember to assign nodes to this environment using your :term:`ENC` of choice.

For a simple inbuilt solution, see :ref:`howto-simp-enc`.
For a simple built-in solution, see :ref:`howto-simp-enc`.

Puppet Enterprise Users
-----------------------
Expand Down
16 changes: 8 additions & 8 deletions docs/FAQ/Puppet.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,9 @@ troubleshoot the issue.
-key $(puppet config print hostprivkey) \
-CAfile $(puppet config print localcacert)
If none of these items provides useful information, you may need to check permissions on your server
and/or dig more closely into the :program:`puppetserver` or client logs.
If none of these items provides useful information, you may need to check
permissions on your server and/or dig more closely into the
:program:`puppetserver` or client logs.

.. _faq-puppet-debug_mode_crash:

Expand Down Expand Up @@ -125,16 +126,15 @@ permissions. One way to do this is by running the following command:
This creates all files with the correct group ownership.


Automatically generating types after ``r10k deploy environment``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Automatically generating types after :command:`r10k deploy environment`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

If you are using :term:`r10k` to deploy :term:`Control Repository` branches
using :command:`r10k deploy environment`, you can set the `"generate_types" option`_
in the :file:`r10k.yaml` file to automatically run :command:`puppet generate
types` for each environment after it is deployed:

.. code-block:: yaml
:emphasize-lines: 3
:caption: Inside :file:`r10k.yaml`:
Expand All @@ -152,9 +152,9 @@ by running the following command:
( umask 0027 && sg puppet -c '/usr/share/simp/bin/r10k deploy environment production' )
This will deploy the environment with the correct permissions and group
ownership. If ``deploy/generate_types`` is set to ``true``, it will also
generate environment-safe type metadata files with the same permissions and
ownership.
ownership. If :code:`deploy/generate_types` is set to ``true`` in
:file:`r10k.yaml`, it will also generate environment-safe type metadata files
with the same permissions and ownership.

.. _SERVER-94: https://tickets.puppetlabs.com/browse/SERVER-94
.. _postrun: https://github.com/puppetlabs/r10k/blob/master/doc/dynamic-environments/configuration.mkd#postrun
Expand Down
8 changes: 4 additions & 4 deletions docs/FAQ/Rsync.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ rsync's syncing engine to reduce network load and Puppet run times.

The common SIMP use cases for rsync include:

* ``clamav``
* ``tftpboot``
* ``named``
* ``dhcpd``
* :program:`clamav`
* :program:`tftpboot`
* :program:`named`
* :program:`dhcpd`


Large Files
Expand Down

0 comments on commit f7d39f9

Please sign in to comment.