From 3b94b499a078368ea982c3916a035b24245d7b58 Mon Sep 17 00:00:00 2001
From: Jakuje <Jakuje@users.noreply.github.com>
Date: Thu, 19 Dec 2024 10:33:52 +0000
Subject: [PATCH] Update README.html for latest

---
 docs/index.html    | 31 +++++++++++++++++++++++++------
 latest/README.html | 31 +++++++++++++++++++++++++------
 2 files changed, 50 insertions(+), 12 deletions(-)

diff --git a/docs/index.html b/docs/index.html
index 80d076f..eff72ac 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -58,8 +58,9 @@ SOFTWARE.
   </style>
   <style type="text/css">code{white-space: pre;}</style>
   <style type="text/css">
+html { -webkit-text-size-adjust: 100%; }
 pre > code.sourceCode { white-space: pre; position: relative; }
-pre > code.sourceCode > span { line-height: 1.25; }
+pre > code.sourceCode > span { display: inline-block; line-height: 1.25; }
 pre > code.sourceCode > span:empty { height: 1.2em; }
 .sourceCode { overflow: visible; }
 code.sourceCode > span { color: inherit; text-decoration: inherit; }
@@ -70,7 +71,7 @@ div.sourceCode { overflow: auto; }
 }
 @media print {
 pre > code.sourceCode { white-space: pre-wrap; }
-pre > code.sourceCode > span { display: inline-block; text-indent: -5em; padding-left: 5em; }
+pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; }
 }
 pre.numberSource code
   { counter-reset: source-line 0; }
@@ -152,6 +153,8 @@ id="toc-sshd_skip_defaults">sshd_skip_defaults</a></li>
 id="toc-sshd_manage_service">sshd_manage_service</a></li>
 <li><a href="#sshd_allow_reload"
 id="toc-sshd_allow_reload">sshd_allow_reload</a></li>
+<li><a href="#sshd_allow_restart"
+id="toc-sshd_allow_restart">sshd_allow_restart</a></li>
 <li><a href="#sshd_install_service"
 id="toc-sshd_install_service">sshd_install_service</a></li>
 <li><a href="#sshd_manage_firewall"
@@ -270,6 +273,16 @@ module - it will set <code>PermitRootLogin without-password</code> which
 will allow access via SSH key but not via simple password. If you need
 this functionality, be sure to set <code>sshd_PermitRootLogin yes</code>
 for those hosts.</p>
+<p><strong>NOTE</strong> The sshd service is reloaded/restarted
+automatically, only if the role is invoked using <code>roles</code>
+keyword. Using <code>include_role</code> won't trigger handlers as
+described in the Ansible <a
+href="https://github.com/ansible/proposals/issues/136">'taskify
+includes' proposal</a>. To work around this, call
+<code>meta: flush_handlers</code> as detailed in the <a
+href="https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_handlers.html#controlling-when-handlers-run">official
+Ansible documentation</a>. If you need to invoke the handlers in this
+case, use <code>meta: flush_handlers</code>.</p>
 <h1 id="requirements">Requirements</h1>
 <p>Tested on:</p>
 <ul>
@@ -353,10 +366,16 @@ support <code>enabled</code> for AIX)</p>
 <h3 id="sshd_allow_reload">sshd_allow_reload</h3>
 <p>If set to <em>false</em>, a reload of sshd won't happen on change.
 This can help with troubleshooting. You'll need to manually reload sshd
-if you want to apply the changed configuration. Defaults to the same
-value as <code>sshd_manage_service</code>. (Except on AIX, where
-<code>sshd_manage_service</code> is default <em>false</em>, but
-<code>sshd_allow_reload</code> is default <em>true</em>)</p>
+if you want to apply the changed configuration. Defaults to
+<em>true</em>.</p>
+<h3 id="sshd_allow_restart">sshd_allow_restart</h3>
+<p>Some changes, for example of the sysconfig and environment files
+require the full restart of the service. If set to <em>false</em>, a
+restart of sshd won't happen on these changes. This can help with
+troubleshooting. You'll need to manually restart sshd if you want to
+apply the changed configuration. Defaults to <em>true</em> (except on
+AIX where the reload is handled by specific restart command and this
+option does not have any effect).</p>
 <h3 id="sshd_install_service">sshd_install_service</h3>
 <p>If set to <em>true</em>, the role will install service files for the
 ssh service. Defaults to <em>false</em>.</p>
diff --git a/latest/README.html b/latest/README.html
index 80d076f..eff72ac 100644
--- a/latest/README.html
+++ b/latest/README.html
@@ -58,8 +58,9 @@ SOFTWARE.
   </style>
   <style type="text/css">code{white-space: pre;}</style>
   <style type="text/css">
+html { -webkit-text-size-adjust: 100%; }
 pre > code.sourceCode { white-space: pre; position: relative; }
-pre > code.sourceCode > span { line-height: 1.25; }
+pre > code.sourceCode > span { display: inline-block; line-height: 1.25; }
 pre > code.sourceCode > span:empty { height: 1.2em; }
 .sourceCode { overflow: visible; }
 code.sourceCode > span { color: inherit; text-decoration: inherit; }
@@ -70,7 +71,7 @@ div.sourceCode { overflow: auto; }
 }
 @media print {
 pre > code.sourceCode { white-space: pre-wrap; }
-pre > code.sourceCode > span { display: inline-block; text-indent: -5em; padding-left: 5em; }
+pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; }
 }
 pre.numberSource code
   { counter-reset: source-line 0; }
@@ -152,6 +153,8 @@ id="toc-sshd_skip_defaults">sshd_skip_defaults</a></li>
 id="toc-sshd_manage_service">sshd_manage_service</a></li>
 <li><a href="#sshd_allow_reload"
 id="toc-sshd_allow_reload">sshd_allow_reload</a></li>
+<li><a href="#sshd_allow_restart"
+id="toc-sshd_allow_restart">sshd_allow_restart</a></li>
 <li><a href="#sshd_install_service"
 id="toc-sshd_install_service">sshd_install_service</a></li>
 <li><a href="#sshd_manage_firewall"
@@ -270,6 +273,16 @@ module - it will set <code>PermitRootLogin without-password</code> which
 will allow access via SSH key but not via simple password. If you need
 this functionality, be sure to set <code>sshd_PermitRootLogin yes</code>
 for those hosts.</p>
+<p><strong>NOTE</strong> The sshd service is reloaded/restarted
+automatically, only if the role is invoked using <code>roles</code>
+keyword. Using <code>include_role</code> won't trigger handlers as
+described in the Ansible <a
+href="https://github.com/ansible/proposals/issues/136">'taskify
+includes' proposal</a>. To work around this, call
+<code>meta: flush_handlers</code> as detailed in the <a
+href="https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_handlers.html#controlling-when-handlers-run">official
+Ansible documentation</a>. If you need to invoke the handlers in this
+case, use <code>meta: flush_handlers</code>.</p>
 <h1 id="requirements">Requirements</h1>
 <p>Tested on:</p>
 <ul>
@@ -353,10 +366,16 @@ support <code>enabled</code> for AIX)</p>
 <h3 id="sshd_allow_reload">sshd_allow_reload</h3>
 <p>If set to <em>false</em>, a reload of sshd won't happen on change.
 This can help with troubleshooting. You'll need to manually reload sshd
-if you want to apply the changed configuration. Defaults to the same
-value as <code>sshd_manage_service</code>. (Except on AIX, where
-<code>sshd_manage_service</code> is default <em>false</em>, but
-<code>sshd_allow_reload</code> is default <em>true</em>)</p>
+if you want to apply the changed configuration. Defaults to
+<em>true</em>.</p>
+<h3 id="sshd_allow_restart">sshd_allow_restart</h3>
+<p>Some changes, for example of the sysconfig and environment files
+require the full restart of the service. If set to <em>false</em>, a
+restart of sshd won't happen on these changes. This can help with
+troubleshooting. You'll need to manually restart sshd if you want to
+apply the changed configuration. Defaults to <em>true</em> (except on
+AIX where the reload is handled by specific restart command and this
+option does not have any effect).</p>
 <h3 id="sshd_install_service">sshd_install_service</h3>
 <p>If set to <em>true</em>, the role will install service files for the
 ssh service. Defaults to <em>false</em>.</p>