Skip to content

Commit d43687f

Browse files
committed
docs(changelog): version 1.3.0 [citest skip]
Update changelog and .README.html for version 1.3.0 Signed-off-by: Rich Megginson <[email protected]>
1 parent 3bd8983 commit d43687f

File tree

2 files changed

+48
-23
lines changed

2 files changed

+48
-23
lines changed

.README.html

Lines changed: 36 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,11 @@ <h1 class="title">ssh</h1>
135135
<nav id="TOC">
136136
<h1 class="toc-title">Contents</h1>
137137
<ul>
138-
<li><a href="#requirements" id="toc-requirements">Requirements</a></li>
138+
<li><a href="#requirements" id="toc-requirements">Requirements</a>
139+
<ul>
140+
<li><a href="#collection-requirements"
141+
id="toc-collection-requirements">Collection requirements</a></li>
142+
</ul></li>
139143
<li><a href="#role-variables" id="toc-role-variables">Role Variables</a>
140144
<ul>
141145
<li><a href="#ssh_user" id="toc-ssh_user">ssh_user</a></li>
@@ -155,6 +159,7 @@ <h1 class="toc-title">Contents</h1>
155159
</ul></li>
156160
<li><a href="#example-playbook" id="toc-example-playbook">Example
157161
Playbook</a></li>
162+
<li><a href="#rpm-ostree" id="toc-rpm-ostree">rpm-ostree</a></li>
158163
<li><a href="#license" id="toc-license">License</a></li>
159164
<li><a href="#author-information" id="toc-author-information">Author
160165
Information</a></li>
@@ -171,6 +176,12 @@ <h1 id="requirements">Requirements</h1>
171176
<li>Debian</li>
172177
<li>Ubuntu</li>
173178
</ul>
179+
<h2 id="collection-requirements">Collection requirements</h2>
180+
<p>In order to manage <code>rpm-ostree</code> systems, the role requires
181+
modules from external collections. Use the following command to install
182+
them:</p>
183+
<div class="sourceCode" id="cb1"><pre
184+
class="sourceCode bash"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="ex">ansible-galaxy</span> collection install <span class="at">-vv</span> <span class="at">-r</span> meta/collection-requirements.yml</span></code></pre></div>
174185
<h1 id="role-variables">Role Variables</h1>
175186
<p>By default, the role should not modify the system configuration and
176187
generate global <code>ssh_config</code> that matches OS default (the
@@ -244,30 +255,32 @@ <h1 id="example-playbook">Example Playbook</h1>
244255
Additionally, it creates alias "example" for connecting to the
245256
example.com host as a user somebody. The last line disables X11
246257
forwarding.</p>
247-
<div class="sourceCode" id="cb1"><pre
248-
class="sourceCode yaml"><code class="sourceCode yaml"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="kw">-</span><span class="at"> </span><span class="fu">name</span><span class="kw">:</span><span class="at"> Manage ssh clients</span></span>
249-
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">hosts</span><span class="kw">:</span><span class="at"> all</span></span>
250-
<span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">tasks</span><span class="kw">:</span></span>
251-
<span id="cb1-4"><a href="#cb1-4" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="fu">name</span><span class="kw">:</span><span class="at"> Configure ssh clients</span></span>
252-
<span id="cb1-5"><a href="#cb1-5" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">include_role</span><span class="kw">:</span></span>
253-
<span id="cb1-6"><a href="#cb1-6" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">name</span><span class="kw">:</span><span class="at"> linux-system-roles.ssh</span></span>
254-
<span id="cb1-7"><a href="#cb1-7" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">vars</span><span class="kw">:</span></span>
255-
<span id="cb1-8"><a href="#cb1-8" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">ssh_user</span><span class="kw">:</span><span class="at"> root</span></span>
256-
<span id="cb1-9"><a href="#cb1-9" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">ssh</span><span class="kw">:</span></span>
257-
<span id="cb1-10"><a href="#cb1-10" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">Compression</span><span class="kw">:</span><span class="at"> </span><span class="ch">true</span></span>
258-
<span id="cb1-11"><a href="#cb1-11" aria-hidden="true" tabindex="-1"></a><span class="co"> # wokeignore:rule=master</span></span>
259-
<span id="cb1-12"><a href="#cb1-12" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">ControlMaster</span><span class="kw">:</span><span class="at"> auto</span></span>
260-
<span id="cb1-13"><a href="#cb1-13" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">ControlPath</span><span class="kw">:</span><span class="at"> ~/.ssh/.cm%C</span></span>
261-
<span id="cb1-14"><a href="#cb1-14" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">Match</span><span class="kw">:</span></span>
262-
<span id="cb1-15"><a href="#cb1-15" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="fu">Condition</span><span class="kw">:</span><span class="at"> </span><span class="st">&quot;final all&quot;</span></span>
263-
<span id="cb1-16"><a href="#cb1-16" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">GSSAPIAuthentication</span><span class="kw">:</span><span class="at"> </span><span class="ch">true</span></span>
264-
<span id="cb1-17"><a href="#cb1-17" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">Host</span><span class="kw">:</span></span>
265-
<span id="cb1-18"><a href="#cb1-18" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="fu">Condition</span><span class="kw">:</span><span class="at"> example</span></span>
266-
<span id="cb1-19"><a href="#cb1-19" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">Hostname</span><span class="kw">:</span><span class="at"> example.com</span></span>
267-
<span id="cb1-20"><a href="#cb1-20" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">User</span><span class="kw">:</span><span class="at"> somebody</span></span>
268-
<span id="cb1-21"><a href="#cb1-21" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">ssh_ForwardX11</span><span class="kw">:</span><span class="at"> </span><span class="ch">false</span></span></code></pre></div>
258+
<div class="sourceCode" id="cb2"><pre
259+
class="sourceCode yaml"><code class="sourceCode yaml"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="kw">-</span><span class="at"> </span><span class="fu">name</span><span class="kw">:</span><span class="at"> Manage ssh clients</span></span>
260+
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">hosts</span><span class="kw">:</span><span class="at"> all</span></span>
261+
<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">tasks</span><span class="kw">:</span></span>
262+
<span id="cb2-4"><a href="#cb2-4" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="fu">name</span><span class="kw">:</span><span class="at"> Configure ssh clients</span></span>
263+
<span id="cb2-5"><a href="#cb2-5" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">include_role</span><span class="kw">:</span></span>
264+
<span id="cb2-6"><a href="#cb2-6" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">name</span><span class="kw">:</span><span class="at"> linux-system-roles.ssh</span></span>
265+
<span id="cb2-7"><a href="#cb2-7" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">vars</span><span class="kw">:</span></span>
266+
<span id="cb2-8"><a href="#cb2-8" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">ssh_user</span><span class="kw">:</span><span class="at"> root</span></span>
267+
<span id="cb2-9"><a href="#cb2-9" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">ssh</span><span class="kw">:</span></span>
268+
<span id="cb2-10"><a href="#cb2-10" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">Compression</span><span class="kw">:</span><span class="at"> </span><span class="ch">true</span></span>
269+
<span id="cb2-11"><a href="#cb2-11" aria-hidden="true" tabindex="-1"></a><span class="co"> # wokeignore:rule=master</span></span>
270+
<span id="cb2-12"><a href="#cb2-12" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">ControlMaster</span><span class="kw">:</span><span class="at"> auto</span></span>
271+
<span id="cb2-13"><a href="#cb2-13" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">ControlPath</span><span class="kw">:</span><span class="at"> ~/.ssh/.cm%C</span></span>
272+
<span id="cb2-14"><a href="#cb2-14" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">Match</span><span class="kw">:</span></span>
273+
<span id="cb2-15"><a href="#cb2-15" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="fu">Condition</span><span class="kw">:</span><span class="at"> </span><span class="st">&quot;final all&quot;</span></span>
274+
<span id="cb2-16"><a href="#cb2-16" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">GSSAPIAuthentication</span><span class="kw">:</span><span class="at"> </span><span class="ch">true</span></span>
275+
<span id="cb2-17"><a href="#cb2-17" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">Host</span><span class="kw">:</span></span>
276+
<span id="cb2-18"><a href="#cb2-18" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="fu">Condition</span><span class="kw">:</span><span class="at"> example</span></span>
277+
<span id="cb2-19"><a href="#cb2-19" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">Hostname</span><span class="kw">:</span><span class="at"> example.com</span></span>
278+
<span id="cb2-20"><a href="#cb2-20" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">User</span><span class="kw">:</span><span class="at"> somebody</span></span>
279+
<span id="cb2-21"><a href="#cb2-21" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">ssh_ForwardX11</span><span class="kw">:</span><span class="at"> </span><span class="ch">false</span></span></code></pre></div>
269280
<p>More examples are in the <a
270281
href="examples"><code>examples/</code></a> directory.</p>
282+
<h1 id="rpm-ostree">rpm-ostree</h1>
283+
<p>See README-ostree.md</p>
271284
<h1 id="license">License</h1>
272285
<p>LGPLv3, see the file LICENSE for more information.</p>
273286
<h1 id="author-information">Author Information</h1>

CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
11
Changelog
22
=========
33

4+
[1.3.0] - 2023-11-30
5+
--------------------
6+
7+
### New Features
8+
9+
- feat: support for ostree systems (#124)
10+
11+
### Other Changes
12+
13+
- ci: fix ansible-lint issue in tests_user_config.yml (#125)
14+
- tests: Ensure backup/restore preserves file attributes (#126)
15+
416
[1.2.3] - 2023-11-06
517
--------------------
618

0 commit comments

Comments
 (0)