-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(changelog): version 1.2.17 [citest skip] (#102)
Update changelog and .README.html for version 1.2.17 Signed-off-by: Sergei Petrosian <[email protected]>
- Loading branch information
Showing
2 changed files
with
257 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,223 @@ | ||
| <!DOCTYPE html> | ||
| <!-- | ||
| ============================================================================== | ||
| "GitHub HTML5 Pandoc Template" v2.2 — by Tristano Ajmone | ||
| ============================================================================== | ||
| Copyright © Tristano Ajmone, 2017-2020, MIT License (MIT). Project's home: | ||
| - https://github.com/tajmone/pandoc-goodies | ||
| The CSS in this template reuses source code taken from the following projects: | ||
| - GitHub Markdown CSS: Copyright © Sindre Sorhus, MIT License (MIT): | ||
| https://github.com/sindresorhus/github-markdown-css | ||
| - Primer CSS: Copyright © 2016-2017 GitHub Inc., MIT License (MIT): | ||
| http://primercss.io/ | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
| The MIT License | ||
| Copyright (c) Tristano Ajmone, 2017-2020 (github.com/tajmone/pandoc-goodies) | ||
| Copyright (c) Sindre Sorhus <[email protected]> (sindresorhus.com) | ||
| Copyright (c) 2017 GitHub Inc. | ||
| "GitHub Pandoc HTML5 Template" is Copyright (c) Tristano Ajmone, 2017-2020, | ||
| released under the MIT License (MIT); it contains readaptations of substantial | ||
| portions of the following third party softwares: | ||
| (1) "GitHub Markdown CSS", Copyright (c) Sindre Sorhus, MIT License (MIT). | ||
| (2) "Primer CSS", Copyright (c) 2016 GitHub Inc., MIT License (MIT). | ||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. | ||
| ==============================================================================--> | ||
| <html> | ||
| <head> | ||
| <meta charset="utf-8" /> | ||
| <meta name="generator" content="pandoc" /> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" /> | ||
| <title>tlog</title> | ||
| <style type="text/css"> | ||
| @charset "UTF-8";.markdown-body{-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%;color:#24292e;font-family:-apple-system,system-ui,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";font-size:16px;line-height:1.5;word-wrap:break-word;box-sizing:border-box;min-width:200px;margin:0 auto;padding:45px}.markdown-body a{color:#0366d6;background-color:transparent;text-decoration:none;-webkit-text-decoration-skip:objects}.markdown-body a:active,.markdown-body a:hover{outline-width:0}.markdown-body a:hover{text-decoration:underline}.markdown-body a:not([href]){color:inherit;text-decoration:none}.markdown-body strong{font-weight:600}.markdown-body h1,.markdown-body h2,.markdown-body h3,.markdown-body h4,.markdown-body h5,.markdown-body h6{margin-top:24px;margin-bottom:16px;font-weight:600;line-height:1.25}.markdown-body h1{font-size:2em;margin:.67em 0;padding-bottom:.3em;border-bottom:1px solid #eaecef}.markdown-body h2{padding-bottom:.3em;font-size:1.5em;border-bottom:1px solid #eaecef}.markdown-body h3{font-size:1.25em}.markdown-body h4{font-size:1em}.markdown-body h5{font-size:.875em}.markdown-body h6{font-size:.85em;color:#6a737d}.markdown-body img{border-style:none}.markdown-body svg:not(:root){overflow:hidden}.markdown-body hr{box-sizing:content-box;height:.25em;margin:24px 0;padding:0;overflow:hidden;background-color:#e1e4e8;border:0}.markdown-body hr::before{display:table;content:""}.markdown-body hr::after{display:table;clear:both;content:""}.markdown-body input{margin:0;overflow:visible;font:inherit;font-family:inherit;font-size:inherit;line-height:inherit}.markdown-body [type=checkbox]{box-sizing:border-box;padding:0}.markdown-body *{box-sizing:border-box}.markdown-body blockquote{margin:0}.markdown-body ol,.markdown-body ul{padding-left:2em}.markdown-body ol ol,.markdown-body ul ol{list-style-type:lower-roman}.markdown-body ol ol,.markdown-body ol ul,.markdown-body ul ol,.markdown-body ul ul{margin-top:0;margin-bottom:0}.markdown-body ol ol ol,.markdown-body ol ul ol,.markdown-body ul ol ol,.markdown-body ul ul ol{list-style-type:lower-alpha}.markdown-body li>p{margin-top:16px}.markdown-body li+li{margin-top:.25em}.markdown-body dd{margin-left:0}.markdown-body dl{padding:0}.markdown-body dl dt{padding:0;margin-top:16px;font-size:1em;font-style:italic;font-weight:600}.markdown-body dl dd{padding:0 16px;margin-bottom:16px}.markdown-body code{font-family:SFMono-Regular,Consolas,"Liberation Mono",Menlo,Courier,monospace}.markdown-body pre{font:12px SFMono-Regular,Consolas,"Liberation Mono",Menlo,Courier,monospace;word-wrap:normal}.markdown-body blockquote,.markdown-body dl,.markdown-body ol,.markdown-body p,.markdown-body pre,.markdown-body table,.markdown-body ul{margin-top:0;margin-bottom:16px}.markdown-body blockquote{padding:0 1em;color:#6a737d;border-left:.25em solid #dfe2e5}.markdown-body blockquote>:first-child{margin-top:0}.markdown-body blockquote>:last-child{margin-bottom:0}.markdown-body table{display:block;width:100%;overflow:auto;border-spacing:0;border-collapse:collapse}.markdown-body table th{font-weight:600}.markdown-body table td,.markdown-body table th{padding:6px 13px;border:1px solid #dfe2e5}.markdown-body table tr{background-color:#fff;border-top:1px solid #c6cbd1}.markdown-body table tr:nth-child(2n){background-color:#f6f8fa}.markdown-body img{max-width:100%;box-sizing:content-box;background-color:#fff}.markdown-body code{padding:.2em 0;margin:0;font-size:85%;background-color:rgba(27,31,35,.05);border-radius:3px}.markdown-body code::after,.markdown-body code::before{letter-spacing:-.2em;content:" "}.markdown-body pre>code{padding:0;margin:0;font-size:100%;word-break:normal;white-space:pre;background:0 0;border:0}.markdown-body .highlight{margin-bottom:16px}.markdown-body .highlight pre{margin-bottom:0;word-break:normal}.markdown-body .highlight pre,.markdown-body pre{padding:16px;overflow:auto;font-size:85%;line-height:1.45;background-color:#f6f8fa;border-radius:3px}.markdown-body pre code{display:inline;max-width:auto;padding:0;margin:0;overflow:visible;line-height:inherit;word-wrap:normal;background-color:transparent;border:0}.markdown-body pre code::after,.markdown-body pre code::before{content:normal}.markdown-body .full-commit .btn-outline:not(:disabled):hover{color:#005cc5;border-color:#005cc5}.markdown-body kbd{box-shadow:inset 0 -1px 0 #959da5;display:inline-block;padding:3px 5px;font:11px/10px SFMono-Regular,Consolas,"Liberation Mono",Menlo,Courier,monospace;color:#444d56;vertical-align:middle;background-color:#fcfcfc;border:1px solid #c6cbd1;border-bottom-color:#959da5;border-radius:3px;box-shadow:inset 0 -1px 0 #959da5}.markdown-body :checked+.radio-label{position:relative;z-index:1;border-color:#0366d6}.markdown-body .task-list-item{list-style-type:none}.markdown-body .task-list-item+.task-list-item{margin-top:3px}.markdown-body .task-list-item input{margin:0 .2em .25em -1.6em;vertical-align:middle}.markdown-body::before{display:table;content:""}.markdown-body::after{display:table;clear:both;content:""}.markdown-body>:first-child{margin-top:0!important}.markdown-body>:last-child{margin-bottom:0!important}.Alert,.Error,.Note,.Success,.Warning{padding:11px;margin-bottom:24px;border-style:solid;border-width:1px;border-radius:4px}.Alert p,.Error p,.Note p,.Success p,.Warning p{margin-top:0}.Alert p:last-child,.Error p:last-child,.Note p:last-child,.Success p:last-child,.Warning p:last-child{margin-bottom:0}.Alert{color:#246;background-color:#e2eef9;border-color:#bac6d3}.Warning{color:#4c4a42;background-color:#fff9ea;border-color:#dfd8c2}.Error{color:#911;background-color:#fcdede;border-color:#d2b2b2}.Success{color:#22662c;background-color:#e2f9e5;border-color:#bad3be}.Note{color:#2f363d;background-color:#f6f8fa;border-color:#d5d8da}.Alert h1,.Alert h2,.Alert h3,.Alert h4,.Alert h5,.Alert h6{color:#246;margin-bottom:0}.Warning h1,.Warning h2,.Warning h3,.Warning h4,.Warning h5,.Warning h6{color:#4c4a42;margin-bottom:0}.Error h1,.Error h2,.Error h3,.Error h4,.Error h5,.Error h6{color:#911;margin-bottom:0}.Success h1,.Success h2,.Success h3,.Success h4,.Success h5,.Success h6{color:#22662c;margin-bottom:0}.Note h1,.Note h2,.Note h3,.Note h4,.Note h5,.Note h6{color:#2f363d;margin-bottom:0}.Alert h1:first-child,.Alert h2:first-child,.Alert h3:first-child,.Alert h4:first-child,.Alert h5:first-child,.Alert h6:first-child,.Error h1:first-child,.Error h2:first-child,.Error h3:first-child,.Error h4:first-child,.Error h5:first-child,.Error h6:first-child,.Note h1:first-child,.Note h2:first-child,.Note h3:first-child,.Note h4:first-child,.Note h5:first-child,.Note h6:first-child,.Success h1:first-child,.Success h2:first-child,.Success h3:first-child,.Success h4:first-child,.Success h5:first-child,.Success h6:first-child,.Warning h1:first-child,.Warning h2:first-child,.Warning h3:first-child,.Warning h4:first-child,.Warning h5:first-child,.Warning h6:first-child{margin-top:0}h1.title,p.subtitle{text-align:center}h1.title.followed-by-subtitle{margin-bottom:0}p.subtitle{font-size:1.5em;font-weight:600;line-height:1.25;margin-top:0;margin-bottom:16px;padding-bottom:.3em}div.line-block{white-space:pre-line} | ||
| </style> | ||
| <style type="text/css">code{white-space: pre;}</style> | ||
| <style type="text/css"> | ||
| pre > code.sourceCode { white-space: pre; position: relative; } | ||
| 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; } | ||
| div.sourceCode { margin: 1em 0; } | ||
| pre.sourceCode { margin: 0; } | ||
| @media screen { | ||
| div.sourceCode { overflow: auto; } | ||
| } | ||
| @media print { | ||
| pre > code.sourceCode { white-space: pre-wrap; } | ||
| pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; } | ||
| } | ||
| pre.numberSource code | ||
| { counter-reset: source-line 0; } | ||
| pre.numberSource code > span | ||
| { position: relative; left: -4em; counter-increment: source-line; } | ||
| pre.numberSource code > span > a:first-child::before | ||
| { content: counter(source-line); | ||
| position: relative; left: -1em; text-align: right; vertical-align: baseline; | ||
| border: none; display: inline-block; | ||
| -webkit-touch-callout: none; -webkit-user-select: none; | ||
| -khtml-user-select: none; -moz-user-select: none; | ||
| -ms-user-select: none; user-select: none; | ||
| padding: 0 4px; width: 4em; | ||
| color: #aaaaaa; | ||
| } | ||
| pre.numberSource { margin-left: 3em; border-left: 1px solid #aaaaaa; padding-left: 4px; } | ||
| div.sourceCode | ||
| { } | ||
| @media screen { | ||
| pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; } | ||
| } | ||
| code span.al { color: #ff0000; font-weight: bold; } /* Alert */ | ||
| code span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */ | ||
| code span.at { color: #7d9029; } /* Attribute */ | ||
| code span.bn { color: #40a070; } /* BaseN */ | ||
| code span.bu { color: #008000; } /* BuiltIn */ | ||
| code span.cf { color: #007020; font-weight: bold; } /* ControlFlow */ | ||
| code span.ch { color: #4070a0; } /* Char */ | ||
| code span.cn { color: #880000; } /* Constant */ | ||
| code span.co { color: #60a0b0; font-style: italic; } /* Comment */ | ||
| code span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */ | ||
| code span.do { color: #ba2121; font-style: italic; } /* Documentation */ | ||
| code span.dt { color: #902000; } /* DataType */ | ||
| code span.dv { color: #40a070; } /* DecVal */ | ||
| code span.er { color: #ff0000; font-weight: bold; } /* Error */ | ||
| code span.ex { } /* Extension */ | ||
| code span.fl { color: #40a070; } /* Float */ | ||
| code span.fu { color: #06287e; } /* Function */ | ||
| code span.im { color: #008000; font-weight: bold; } /* Import */ | ||
| code span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */ | ||
| code span.kw { color: #007020; font-weight: bold; } /* Keyword */ | ||
| code span.op { color: #666666; } /* Operator */ | ||
| code span.ot { color: #007020; } /* Other */ | ||
| code span.pp { color: #bc7a00; } /* Preprocessor */ | ||
| code span.sc { color: #4070a0; } /* SpecialChar */ | ||
| code span.ss { color: #bb6688; } /* SpecialString */ | ||
| code span.st { color: #4070a0; } /* String */ | ||
| code span.va { color: #19177c; } /* Variable */ | ||
| code span.vs { color: #4070a0; } /* VerbatimString */ | ||
| code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */ | ||
| </style> | ||
| <!--[if lt IE 9]> | ||
| <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script> | ||
| <![endif]--> | ||
| </head> | ||
| <body> | ||
| <article class="markdown-body"> | ||
| <header> | ||
| <h1 class="title">tlog</h1> | ||
| </header> | ||
| <hr> | ||
| <nav id="TOC"> | ||
| <h1 class="toc-title">Contents</h1> | ||
| <ul> | ||
| <li><a href="#requirements" id="toc-requirements">Requirements</a> | ||
| <ul> | ||
| <li><a href="#collection-requirements" | ||
| id="toc-collection-requirements">Collection requirements</a></li> | ||
| </ul></li> | ||
| <li><a href="#role-variables" id="toc-role-variables">Role | ||
| Variables</a></li> | ||
| <li><a href="#example-playbook" id="toc-example-playbook">Example | ||
| Playbook</a></li> | ||
| <li><a href="#testing" id="toc-testing">Testing</a></li> | ||
| <li><a href="#license" id="toc-license">License</a></li> | ||
| <li><a href="#author-information" id="toc-author-information">Author | ||
| Information</a></li> | ||
| </ul> | ||
| </nav> | ||
| <hr> | ||
| <p>This role configures a system for <a | ||
| href="https://github.com/scribery">Terminal session recording</a>. The | ||
| role will configure tlog to log recording data to the systemd | ||
| journal.</p> | ||
| <h1 id="requirements">Requirements</h1> | ||
| <p>This role is only supported on RHEL8/CentOS8 and Fedora | ||
| distributions.</p> | ||
| <h2 id="collection-requirements">Collection requirements</h2> | ||
| <p>This role requires the <code>ini_file</code> module from | ||
| <code>community.general</code>. If you are using | ||
| <code>ansible-core</code> you must install that collection.</p> | ||
| <div class="sourceCode" id="cb1"><pre | ||
| 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> | ||
| <p>If you are using Ansible Engine 2.9, or are using an Ansible bundle | ||
| which includes these collections/modules, you should have to do | ||
| nothing.</p> | ||
| <h1 id="role-variables">Role Variables</h1> | ||
| <p>Configure session recording with SSSD, the preferred way of managing | ||
| recorded users or groups. This causes the SSSD files provider to be | ||
| enabled explicitly.</p> | ||
| <ul> | ||
| <li><code>tlog_use_sssd</code> (default: <code>true</code>)</li> | ||
| </ul> | ||
| <p>Configure SSSD recording scope - <code>all</code> / <code>some</code> | ||
| / <code>none</code>:</p> | ||
| <ul> | ||
| <li><code>tlog_scope_sssd</code> (default: <code>none</code>)</li> | ||
| </ul> | ||
| <p>YAML list of users to be recorded:</p> | ||
| <ul> | ||
| <li><code>tlog_users_sssd</code> (default: <code>[]</code>)</li> | ||
| </ul> | ||
| <p>YAML list of groups to be recorded:</p> | ||
| <ul> | ||
| <li><code>tlog_groups_sssd</code> (default: <code>[]</code>)</li> | ||
| </ul> | ||
| <p>YAML list of users to be excluded from recording (only applicable | ||
| when scope=all):</p> | ||
| <ul> | ||
| <li><code>tlog_exclude_users_sssd</code> (default: <code>[]</code>)</li> | ||
| </ul> | ||
| <p>YAML list of groups to be excluded from recording (only applicable | ||
| when scope=all):</p> | ||
| <ul> | ||
| <li><code>tlog_exclude_groups_sssd</code> (default: | ||
| <code>[]</code>)</li> | ||
| </ul> | ||
| <h1 id="example-playbook">Example Playbook</h1> | ||
| <div class="sourceCode" id="cb2"><pre | ||
| 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"> Deploy session recording</span></span> | ||
| <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> | ||
| <span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">roles</span><span class="kw">:</span></span> | ||
| <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"> linux-system-roles.tlog</span></span> | ||
| <span id="cb2-5"><a href="#cb2-5" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">vars</span><span class="kw">:</span></span> | ||
| <span id="cb2-6"><a href="#cb2-6" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">tlog_scope_sssd</span><span class="kw">:</span><span class="at"> some</span></span> | ||
| <span id="cb2-7"><a href="#cb2-7" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">tlog_users_sssd</span><span class="kw">:</span></span> | ||
| <span id="cb2-8"><a href="#cb2-8" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> recordeduser</span></span></code></pre></div> | ||
| <h1 id="testing">Testing</h1> | ||
| <p>Testing is done with the <code>tests/tests_*.yml</code> playbooks. | ||
| See <code>contributing.md</code>.</p> | ||
| <h1 id="license">License</h1> | ||
| <p>GPL v3.0</p> | ||
| <h1 id="author-information">Author Information</h1> | ||
| <ul> | ||
| <li><p>Nathan Kinder @nkinder</p></li> | ||
| <li><p>Kirill Glebov @sabbaka</p></li> | ||
| </ul> | ||
| </article> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,40 @@ | ||
| Changelog | ||
| ========= | ||
|
|
||
| [1.2.17] - 2023-09-07 | ||
| -------------------- | ||
|
|
||
| ### Other Changes | ||
|
|
||
| - ci: Add markdownlint, test_converting_readme, and build_docs workflows (#99) | ||
|
|
||
| - markdownlint runs against README.md to avoid any issues with | ||
| converting it to HTML | ||
| - test_converting_readme converts README.md > HTML and uploads this test | ||
| artifact to ensure that conversion works fine | ||
| - build_docs converts README.md > HTML and pushes the result to the | ||
| docs branch to publish dosc to GitHub pages site. | ||
| - Fix markdown issues in README.md | ||
|
|
||
| Signed-off-by: Sergei Petrosian <[email protected]> | ||
|
|
||
| - docs: Make badges consistent, run markdownlint on all .md files (#100) | ||
|
|
||
| - Consistently generate badges for GH workflows in README RHELPLAN-146921 | ||
| - Run markdownlint on all .md files | ||
| - Add custom-woke-action if not used already | ||
| - Rename woke action to Woke for a pretty badge | ||
|
|
||
| Signed-off-by: Sergei Petrosian <[email protected]> | ||
|
|
||
| - ci: Remove badges from README.md prior to converting to HTML (#101) | ||
|
|
||
| - Remove thematic break after badges | ||
| - Remove badges from README.md prior to converting to HTML | ||
|
|
||
| Signed-off-by: Sergei Petrosian <[email protected]> | ||
|
|
||
|
|
||
| [1.2.16] - 2023-07-19 | ||
| -------------------- | ||
|
|
||
|
|
||