-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #370 from SUSE/jhalackova_vmhostd
Jhalackova vmhostd
- Loading branch information
Showing
7 changed files
with
800 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,8 @@ | ||
MAIN="vhostmd.asm.xml" | ||
SRC_DIR="articles" | ||
IMG_SRC_DIR="images" | ||
|
||
STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2022-ns" | ||
DOCBOOK5_RNG_URI="urn:x-suse:rng:v2:geekodoc-flat" | ||
PROFOS="slmicro" | ||
PROFCONDITION="alp-deployment-all" |
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,234 @@ | ||
<?xml version="1.0" encoding="UTF-8" standalone="no"?> | ||
<!-- This file originates from the project https://github.com/openSUSE/doc-kit --> | ||
<!-- This file can be edited downstream. --> | ||
<!DOCTYPE assembly | ||
[ | ||
<!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 --> | ||
<assembly version="5.2" xml:lang="en" | ||
xmlns:xlink="http://www.w3.org/1999/xlink" | ||
xmlns:trans="http://docbook.org/ns/transclusion" | ||
xmlns:its="http://www.w3.org/2005/11/its" | ||
xmlns:xi="http://www.w3.org/2001/XInclude" | ||
xmlns="http://docbook.org/ns/docbook"> | ||
<!-- resources section references all topic chunks used in the final article | ||
--> | ||
<!-- R E S O U R C E S --> | ||
<!-- Glue files --> | ||
|
||
<!-- Concept files --> | ||
<resources> | ||
<resource xml:id="_vhostmd_about" href="../concepts/vhostmd_about.xml"> | ||
<description>About vhostmd</description> | ||
</resource> | ||
<resource xml:id="_vhostmd_data_format" href="../concepts/vhostmd_data_format.xml"> | ||
<description>Metrics format</description> | ||
</resource> | ||
</resources> | ||
<!-- Tasks --> | ||
<resources> | ||
<resource xml:id="_vhostmd_installation" href="../tasks/vhostmd_installation.xml"> | ||
<description>Installation</description> | ||
</resource> | ||
<resource xml:id="_vhostmd_providing_information" href="../tasks/vhostmd_providing_information.xml"> | ||
<description>Pass metrics to VM</description> | ||
</resource> | ||
</resources> | ||
<!-- References --> | ||
<resources> | ||
<resource xml:id="_vhostmd_configuration" href="../references/vhostmd_configuration.xml"> | ||
<description>Configuring vhostmd</description> | ||
</resource> | ||
</resources> | ||
<!-- Legal --> | ||
<resources> | ||
<resource href="../common/legal.xml" xml:id="_legal"> | ||
<description>Legal Notice</description> | ||
</resource> | ||
<resource href="../common/license_gfdl1.2.xml" xml:id="_gfdl"> | ||
<description>GNU Free Documentation License</description> | ||
</resource> | ||
</resources> | ||
<!-- S T R U C T U R E --> | ||
<structure renderas="article" xml:id="vhostmd" xml:lang="en"> | ||
<merge> | ||
<title>Setting Up Virtual Host Metrics Daemon on &productname;</title> | ||
<!-- Create revision history to enable versioning; add most recent entries at the top. --> | ||
<!-- Check https://documentation.suse.com/style/current/single-html/docu_styleguide/#sec-revhistory for detailed instructions--> | ||
<revhistory xml:id="rh-vhostmd"> | ||
<revision><date>2024-10-14</date> | ||
<revdescription> | ||
<itemizedlist> | ||
<!-- Group by type of change (added/removed/changed)--> | ||
<listitem><para>Initial version</para> | ||
</listitem> | ||
</itemizedlist> | ||
</revdescription> | ||
</revision> | ||
</revhistory> | ||
<!-- TODO: provide a listing of possible and validatable meta entry values. Maybe in our geekodoc repo? --> | ||
<!-- add author's e-mail --> | ||
<meta name="maintainer" content="[email protected]" its:translate="no"/> | ||
<!-- ISO date of last update as YYYY-MM-DD --> | ||
<meta name="updated" content="2024-10-16" its:translate="no"/> | ||
<!-- this does not work yet. Use the dm tags listed below for now | ||
<meta name="bugtracker" its:translate="no"> | ||
<phrase role="url">https://bugzilla.suse.com/enter_bug.cgi</phrase> | ||
<phrase role="component">Non-product-specific documentation</phrase> | ||
<phrase role="product">Smart Docs</phrase> | ||
<phrase role="assignee">[email protected]</phrase> | ||
</meta> | ||
--> | ||
<!-- not supported, yet. Use dm: tag for now | ||
<meta name="translation" its:translate="no"> | ||
<phrase role="trans">yes</phrase> | ||
<phrase role="language">de-de,cs-cz</phrase> | ||
</meta> | ||
--> | ||
<!-- enter the platform identifier or a list of | ||
identifiers, separated by ; --> | ||
<!-- For a full list of meta tags and their values, | ||
see https://confluence.suse.com/x/aQDWNg | ||
--> | ||
<meta name="architecture"> | ||
<phrase>&x86-64;</phrase> | ||
<phrase>&power;</phrase> | ||
<phrase>&aarch64;</phrase> | ||
</meta> | ||
<!-- enter one or more product names and version --> | ||
<meta name="productname" its:translate="no"> | ||
<productname>&productname;</productname> | ||
</meta> | ||
<meta name="title" its:translate="yes">Setting Up Virtual Host Metrics Daemon</meta> | ||
<meta name="description" its:translate="yes">vhostmd is a tool that collects metrics from a virtual machine host | ||
and provides these metrics to virtual machines running on that host.</meta> | ||
<meta name="social-descr" its:translate="yes">vhostmd is a tool for collecting metrics</meta> | ||
<!-- suitable categories --> | ||
<meta name="category"> | ||
<phrase>Systems Management</phrase> | ||
</meta> | ||
<!-- Determines "filter by task" filter value --> | ||
<meta name="task"> | ||
<phrase>Configuration</phrase> | ||
<phrase>Installation</phrase> | ||
</meta> | ||
<meta name="series">Products & Solutions</meta> | ||
|
||
<dm:docmanager xmlns:dm="urn:x-suse:ns:docmanager"> | ||
<dm:bugtracker> | ||
<dm:url>https://bugzilla.suse.com/enter_bug.cgi</dm:url> | ||
<dm:component>Documentation</dm:component> | ||
<dm:product>SUSE Linux Enterprise Micro 6.1</dm:product> | ||
<!-- provide your BUGZILLA e-mail address, otherwise this does not work correctly--> | ||
<dm:assignee>[email protected]</dm:assignee> | ||
</dm:bugtracker> | ||
<dm:translation>yes</dm:translation> | ||
</dm:docmanager> | ||
<abstract> | ||
<variablelist> | ||
<varlistentry> | ||
<term>WHAT?</term> | ||
<listitem> | ||
<para> | ||
<literal>vhostmd</literal> is a tool that collects metrics from a virtual machine host | ||
and can provide these metrics to the virtual machines running on that host. | ||
</para> | ||
</listitem> | ||
</varlistentry> | ||
<varlistentry> | ||
<term>WHY?</term> | ||
<listitem> | ||
<para> | ||
The article describes how to install and configure <literal>vhostmd</literal> to | ||
enable collecting metrics. | ||
</para> | ||
</listitem> | ||
</varlistentry> | ||
<varlistentry> | ||
<term>EFFORT</term> | ||
<listitem> | ||
<para> | ||
It takes approximately 15 minutes to read the article. | ||
</para> | ||
</listitem> | ||
</varlistentry> | ||
<varlistentry> | ||
<term>GOAL</term> | ||
<listitem> | ||
<para> | ||
You will have the <literal>vhostmd</literal> tool running and collecting metrics. | ||
</para> | ||
</listitem> | ||
</varlistentry> | ||
<varlistentry> | ||
<term>REQUIREMENTS</term> | ||
<listitem> | ||
<itemizedlist> | ||
<listitem> | ||
<para> | ||
a running instance of &productname; | ||
</para> | ||
</listitem> | ||
<listitem> | ||
<para> | ||
virtual machines running on that instance | ||
</para> | ||
</listitem> | ||
</itemizedlist> | ||
</listitem> | ||
</varlistentry> | ||
</variablelist> | ||
</abstract> | ||
</merge> | ||
<!-- pull in all the topic files you need --> | ||
<!-- pick the appropriate type of include to match your needs --> | ||
<!-- pull in a topic as is --> | ||
<module resourceref="_vhostmd_about" renderas="section"> | ||
<merge> | ||
<abstract> | ||
<para/> | ||
</abstract> | ||
</merge> | ||
</module> | ||
<!-- pull in a topic and switch the title --> | ||
<module resourceref="_vhostmd_installation" renderas="section"> | ||
<merge> | ||
<abstract> | ||
<para/> | ||
</abstract> | ||
</merge> | ||
</module> | ||
|
||
<module resourceref="_vhostmd_providing_information" renderas="section"> | ||
<merge> | ||
<abstract> | ||
<para/> | ||
</abstract> | ||
</merge> | ||
</module> | ||
<module resourceref="_vhostmd_configuration" renderas="section"> | ||
<merge> | ||
<abstract> | ||
<para/> | ||
</abstract> | ||
</merge> | ||
</module> | ||
|
||
<module resourceref="_vhostmd_data_format" renderas="section"> | ||
<merge> | ||
<abstract> | ||
<para/> | ||
</abstract> | ||
</merge> | ||
</module> | ||
|
||
<module resourceref="_legal"/> | ||
<module resourceref="_gfdl"> | ||
<output renderas="appendix"/> | ||
</module> | ||
</structure> | ||
</assembly> |
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,41 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<!-- This file originates from the project https://github.com/openSUSE/doc-kit --> | ||
<!-- This file can be edited downstream. --> | ||
<!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="vhostmd-about" | ||
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>What is a virtual host metrics daemon aka <literal>vhostmd</literal>?</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> | ||
|
||
</para> | ||
</abstract> | ||
</info> | ||
<para> | ||
<literal>vhostmd</literal> is a daemon that runs in a host environment and provides a metrics | ||
communication channel between the host and guest machines. The daemon provides the guest | ||
machine administrator with a limited set of host resource usage data (usually in read-only mode), | ||
to help analyze issues with the guest machine. | ||
</para> | ||
<para> | ||
<literal>vhostdmd</literal> periodically writes metrics to a disk. The metrics to be | ||
collected, along with the | ||
frequency and storage location of the data, are configurable parameters. | ||
</para> | ||
</topic> |
Oops, something went wrong.