-
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.
- Loading branch information
Showing
10 changed files
with
620 additions
and
4 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
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
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,76 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!DOCTYPE topic | ||
| [ | ||
| <!ENTITY % entities SYSTEM "../common/generic-entities.ent"> | ||
| %entities; | ||
| ]> | ||
| <!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> --> | ||
| <!-- point back to this document with a similar comment added to your legacy doc piece --> | ||
| <!-- refer to README.md for file and id naming conventions --> | ||
| <!-- metadata is dealt with on the assembly level --> | ||
| <topic xml:id="healtch-checker" | ||
| role="concept" xml:lang="en" | ||
| xmlns="http://docbook.org/ns/docbook" version="5.2" | ||
| xmlns:its="http://www.w3.org/2005/11/its" | ||
| xmlns:xi="http://www.w3.org/2001/XInclude" | ||
| xmlns:xlink="http://www.w3.org/1999/xlink" | ||
| xmlns:trans="http://docbook.org/ns/transclusion"> | ||
| <info> | ||
| <title>Health checker</title><!-- can be changed via merge in the assembly --> | ||
| <!--add author's email address--> | ||
| <meta name="maintainer" content="[email protected]" its:translate="no"/> | ||
| <abstract><!-- can be changed via merge in the assembly --> | ||
| <para> | ||
| This topic provide an functional purpose and overview of the health checker. | ||
| </para> | ||
| </abstract> | ||
| </info> | ||
| <para> | ||
| Health checker is a program delivered with &priductnameshort; that checks whether | ||
| services are running properly during booting of your system. | ||
| </para> | ||
| <para> | ||
| During the boot process, <literal>systemd</literal> calls Health checker, | ||
| which in turn calls its plugins. Each plugin checks a particular service or | ||
| condition. If each check passes, a status file | ||
| (<filename>/var/lib/misc/health-check.state</filename>) is created. The | ||
| status file marks the current root file system as correct. | ||
| </para> | ||
| <para> | ||
| If any of the health checker plugins reports an error, the action taken | ||
| depends on a particular condition, as described below: | ||
| </para> | ||
| <variablelist> | ||
| <varlistentry> | ||
| <term><emphasis>The snapshot is booted for the first time.</emphasis></term> | ||
| <listitem> | ||
| <para> | ||
| If the current snapshot is different from the last one that worked | ||
| properly, an automatic rollback to the last working snapshot is performed. | ||
| This means that the last change performed to the file system broke the | ||
| snapshot. | ||
| </para> | ||
| </listitem> | ||
| </varlistentry> | ||
| <varlistentry> | ||
| <term><emphasis>The snapshot has already booted correctly in the past.</emphasis></term> | ||
| <listitem> | ||
| <para> | ||
| There could be just a temporary problem, and the system is rebooted | ||
| automatically. | ||
| </para> | ||
| </listitem> | ||
| </varlistentry> | ||
| <varlistentry> | ||
| <term><emphasis>The reboot of a previously correctly booted snapshot has failed.</emphasis></term> | ||
| <listitem> | ||
| <para> | ||
| If there was already a problem during boot and automatic reboot has been | ||
| triggered, but the problem still persists, then the system is kept running | ||
| to enable to the administrator to fix the problem. The services that are | ||
| tested by the health checker plugins are stopped if possible. | ||
| </para> | ||
| </listitem> | ||
| </varlistentry> | ||
| </variablelist> | ||
| </topic> |
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,42 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!DOCTYPE topic | ||
| [ | ||
| <!ENTITY % entities SYSTEM "../common/generic-entities.ent"> | ||
| %entities; | ||
| ]> | ||
| <!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> --> | ||
| <!-- point back to this document with a similar comment added to your legacy doc piece --> | ||
| <!-- refer to README.md for file and id naming conventions --> | ||
| <!-- metadata is dealt with on the assembly level --> | ||
| <topic xml:id="pcp-overview" | ||
| role="concept" xml:lang="en" | ||
| xmlns="http://docbook.org/ns/docbook" version="5.2" | ||
| xmlns:its="http://www.w3.org/2005/11/its" | ||
| xmlns:xi="http://www.w3.org/2001/XInclude" | ||
| xmlns:xlink="http://www.w3.org/1999/xlink" | ||
| xmlns:trans="http://docbook.org/ns/transclusion"> | ||
| <info> | ||
| <title>Concept</title><!-- can be changed via merge in the assembly --> | ||
| <!--add author's email address--> | ||
| <meta name="maintainer" content="[email protected]" its:translate="no"/> | ||
| <abstract><!-- can be changed via merge in the assembly --> | ||
| <para> | ||
| For performance monitoring purposes, &slema; provides a container image that | ||
| enables you to run the Performance Co-Pilot (PCP) analysis toolkit in a | ||
| container. The toolkit comprises tools for gathering and processing | ||
| performance information collected either in real time or from PCP archive | ||
| logs. | ||
| </para> | ||
| </abstract> | ||
| </info> | ||
| <para> | ||
| The performance data are collected by <emphasis>performance metrics domain | ||
| agents</emphasis> and passed to the <emphasis>pmcd</emphasis> daemon. The | ||
| daemon coordinates the gathering and exporting of performance statistics in | ||
| response to requests from the PCP monitoring tools. | ||
| <command>pmlogger</command> is then used to log the metrics. For details, | ||
| refer to the | ||
| <link xlink:href="https://pcp.readthedocs.io/en/latest/UAG/IntroductionToPcp.html#">PCP | ||
| documentation</link>. | ||
| </para> | ||
| </topic> |
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,43 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!DOCTYPE topic | ||
| [ | ||
| <!ENTITY % entities SYSTEM "../common/generic-entities.ent"> | ||
| %entities; | ||
| ]> | ||
| <!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> --> | ||
| <!-- point back to this document with a similar comment added to your legacy doc piece --> | ||
| <!-- refer to README.md for file and id naming conventions --> | ||
| <!-- metadata is dealt with on the assembly level --> | ||
| <topic xml:id="concept-toolbox" | ||
| role="concept" xml:lang="en" | ||
| xmlns="http://docbook.org/ns/docbook" version="5.2" | ||
| xmlns:its="http://www.w3.org/2005/11/its" | ||
| xmlns:xi="http://www.w3.org/2001/XInclude" | ||
| xmlns:xlink="http://www.w3.org/1999/xlink" | ||
| xmlns:trans="http://docbook.org/ns/transclusion"> | ||
| <info> | ||
| <title>Toolbox for &productnameshort; debugging</title><!-- can be changed via merge in the assembly --> | ||
| <!--add author's email address--> | ||
| <meta name="maintainer" content="[email protected]" its:translate="no"/> | ||
| <abstract><!-- can be changed via merge in the assembly --> | ||
| <para> | ||
| The topic provides overview of the toolbox funcionality. | ||
| </para> | ||
| </abstract> | ||
| </info> | ||
| <para> | ||
| &productnameshort; uses the &trup; command to apply | ||
| changes to the system, but the changes are applied only after reboot. That | ||
| solution has several benefits, but it also has some disadvantages. If you | ||
| need to debug your system and install a new tool, the tool will be available | ||
| only after reboot. Therefore you are not able to debug the currently running | ||
| system. For this reason a utility called <literal>toolbox</literal> has been | ||
| developed. | ||
| </para> | ||
| <para> | ||
| <literal>toolbox</literal> is a small script that pulls a container image and | ||
| runs a privileged container based on that image. In the toolbox container you | ||
| can install any tool you want with <command>zypper</command> and then use the | ||
| tool without rebooting your system. | ||
| </para> | ||
| </topic> |
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,74 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!DOCTYPE topic | ||
| [ | ||
| <!ENTITY % entities SYSTEM "../common/generic-entities.ent"> | ||
| %entities; | ||
| ]> | ||
| <!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> --> | ||
| <!-- point back to this document with a similar comment added to your legacy doc piece --> | ||
| <!-- refer to README.md for file and id naming conventions --> | ||
| <!-- metadata is dealt with on the assembly level --> | ||
| <topic xml:id="pcp-service-configuration" | ||
| role="reference" xml:lang="en" | ||
| xmlns="http://docbook.org/ns/docbook" version="5.2" | ||
| xmlns:its="http://www.w3.org/2005/11/its" | ||
| xmlns:xi="http://www.w3.org/2001/XInclude" | ||
| xmlns:xlink="http://www.w3.org/1999/xlink" | ||
| xmlns:trans="http://docbook.org/ns/transclusion"> | ||
| <info> | ||
| <title>Reference</title><!-- can be changed via merge in the assembly --> | ||
| <!--add author's email address--> | ||
| <meta name="maintainer" content="" its:translate="no"/> | ||
| <abstract><!-- can be changed via merge in the assembly --> | ||
| <para> | ||
| Introductory text | ||
| </para> | ||
| </abstract> | ||
| </info> | ||
| <section xml:id="reference-example-section"> | ||
| <title>Section title</title> | ||
| <para> | ||
| A paragraph of text. | ||
| </para> | ||
| <variablelist> | ||
| <title>A title</title> | ||
| <varlistentry> | ||
| <term><command>a-command --with-options</command></term> | ||
| <listitem> | ||
| <para> | ||
| A paragraph of text. | ||
| </para> | ||
| </listitem> | ||
| </varlistentry> | ||
| <varlistentry> | ||
| <term><command>another-command --with-options</command></term> | ||
| <listitem> | ||
| <para> | ||
| Another paragraph of text. | ||
| </para> | ||
| </listitem> | ||
| </varlistentry> | ||
| </variablelist> | ||
| <table> | ||
| <title>A table title</title> | ||
| <tgroup cols="2"> | ||
| <colspec colwidth="50*"/> | ||
| <colspec colwidth="50*"/> | ||
| <tbody> | ||
| <row> | ||
| <entry>an entry</entry> | ||
| <entry>another entry</entry> | ||
| </row> | ||
| <row> | ||
| <entry>an entry</entry> | ||
| <entry>another entry</entry> | ||
| </row> | ||
| <row> | ||
| <entry>an entry</entry> | ||
| <entry>another entry</entry> | ||
| </row> | ||
| </tbody> | ||
| </tgroup> | ||
| </table> | ||
| </section> | ||
| </topic> |
Oops, something went wrong.