summaryrefslogtreecommitdiffstats
path: root/doc/client
diff options
context:
space:
mode:
Diffstat (limited to 'doc/client')
-rw-r--r--doc/client/metadata.txt33
-rw-r--r--doc/client/tools.txt37
-rw-r--r--doc/client/tools/vcs.txt15
-rw-r--r--doc/client/tools/yumng.txt16
4 files changed, 72 insertions, 29 deletions
diff --git a/doc/client/metadata.txt b/doc/client/metadata.txt
index 2a19f3a1a..27870ba9a 100644
--- a/doc/client/metadata.txt
+++ b/doc/client/metadata.txt
@@ -22,22 +22,23 @@ interaction:
* Statistics Upload
This construction process spans several server plugins. The
-:ref:`server-plugins-grouping-metadata` is responsible for initial
-instance creation, including the client hostname, profile, and basic
-group memberships. After this initial creation, Connector plugins (such as
-:ref:`server-plugins-probes-index` or :ref:`server-plugins-properties`)
-can add additional group memberships for clients. These memberships
-are merged into the instance; that is, the new group memberships are
-treated as if they were included in groups.xml. If any of these groups
-are defined in groups.xml, then groups included there are included in
-the ClientMetadata instance group list. At the end of this process, the
-ClientMetadata instance has its complete set of group memberships. At this
-point, each connector plugin has the opportunity to return an additional
-object which will be placed in an attribute corresponding to the Connector
-name. For example, the Probes plugin returns a dictionary of probe name
-to probe result mappings for the client. This dictionary is available as
-the "Probes" attribute. With this, ClientMetadata resolution is complete,
-and the ClientMetadata instance can be used by the rest of the system.
+:ref:`server-plugins-grouping-metadata` is responsible for
+initial instance creation, including the client hostname,
+profile, and basic group memberships. After this initial creation,
+Connector plugins (such as :ref:`server-plugins-probes-index` or
+:ref:`server-plugins-connectors-properties`) can add additional group
+memberships for clients. These memberships are merged into the instance;
+that is, the new group memberships are treated as if they were included
+in groups.xml. If any of these groups are defined in groups.xml,
+then groups included there are included in the ClientMetadata instance
+group list. At the end of this process, the ClientMetadata instance has
+its complete set of group memberships. At this point, each connector
+plugin has the opportunity to return an additional object which will be
+placed in an attribute corresponding to the Connector name. For example,
+the Probes plugin returns a dictionary of probe name to probe result
+mappings for the client. This dictionary is available as the "Probes"
+attribute. With this, ClientMetadata resolution is complete, and the
+ClientMetadata instance can be used by the rest of the system.
Contents
========
diff --git a/doc/client/tools.txt b/doc/client/tools.txt
index d9a9b76f4..bedcb9ab9 100644
--- a/doc/client/tools.txt
+++ b/doc/client/tools.txt
@@ -57,11 +57,15 @@ Chkconfig
Tool to manage services (primarily on Redhat based distros).
-.. note:: Start and stop are standard arguments, but the one for reload
- isn't consistent across services. You can specify which argument
- to use with the `restart` property in Service tags. Example:
- ``<Service name="ftp" restart="condrestart" status="on"
- type="chkconfig">``
+.. note::
+
+ Start and stop are standard arguments, but the one for reload
+ isn't consistent across services. You can specify which argument
+ to use with the ``target`` attribute in Service tags. Example:
+
+ .. code-block:: xml
+
+ <Service name="ftp" target="condrestart" status="on" type="chkconfig"/>
DebInit
-------
@@ -89,9 +93,13 @@ launchd
Mac OS X Services. To use this tool, you must maintain a standard launch
daemon .plist file in ``/Library/LaunchDaemons/`` (example ssh.plist)
-and setup a ``<Service name="com.openssh.sshd" type="launchd" status="on"
-/>`` entry in your config to load or unload the service. Note the name
-is the ''Label'' specified inside of the .plist file
+and setup an entry in your config to load or unload the service.
+
+.. code-block:: xml
+
+ <Service name="com.openssh.sshd" type="launchd" status="on"/>
+
+Note the name is the *Label* specified inside of the .plist file
Portage
-------
@@ -133,7 +141,18 @@ Example legacy run service (lrc):
.. code-block:: xml
- <BoundService name='/etc/rc2_d/S47pppd' FMRI='lrc:/etc/rc2_d/S47pppd' status='off' type='smf'/>
+ <Service name='/etc/rc2_d/S47pppd' FMRI='lrc:/etc/rc2_d/S47pppd' status='off' type='smf'/>
+
+Systemd
+-------
+
+Systemd service support.
+
+Example:
+
+.. code-block:: xml
+
+ <Service name='udev' status='on' type='systemd'/>
SYSV
----
diff --git a/doc/client/tools/vcs.txt b/doc/client/tools/vcs.txt
new file mode 100644
index 000000000..fb9c33684
--- /dev/null
+++ b/doc/client/tools/vcs.txt
@@ -0,0 +1,15 @@
+.. -*- mode: rst -*-
+
+.. _client-tools-vcs:
+
+===============
+VCS Client Tool
+===============
+
+.. warning: This tool is currently under development.
+
+.. note: Currently, the only supported VCS is git.
+
+The VCS tool allows you to checkout particular revisions from a VCS
+repository on the client to a specified path. The tool requires the
+appropriate python libraries for the VCS used to be installed.
diff --git a/doc/client/tools/yumng.txt b/doc/client/tools/yumng.txt
index dd712ddec..c2e9161a1 100644
--- a/doc/client/tools/yumng.txt
+++ b/doc/client/tools/yumng.txt
@@ -18,9 +18,15 @@ and SUSE based distributions.
Examples of this are:
-* SLES10 and openSUSE 10.2 both install six GPG keys. From an RPM perspective this means that there are six packages with the name gpg-pubkey.
-* YUM always installs, as opposed to upgrades, kernel packages. This is hard coded in YUM (actually it can be overridden in yum.conf), so systems using YUM will eventually have multiple kernel packages installed.
-* Red Hat family x86_64 based systems frequently have both an x86_64 and an i386 version of the same package installed.
+* SLES10 and openSUSE 10.2 both install six GPG keys. From an RPM
+ perspective this means that there are six packages with the name
+ gpg-pubkey.
+* YUM always installs, as opposed to upgrades, kernel packages. This is
+ hard coded in YUM (actually it can be overridden in yum.conf),
+ so systems using YUM will eventually have multiple kernel packages
+ installed.
+* Red Hat family x86_64 based systems frequently have both an x86_64
+ and an i386 version of the same package installed.
The new Pkgmgr format files with Instances are therefore the only way to
accurately describe an RPM based system. It is recommended that all RPM
@@ -50,7 +56,9 @@ Features
* Support for per instance ignoring of individual files for the RPM verification with the Ignore tag.
* Multiple package Instances with full version information listed in interactive mode.
* Support for installation and removal of gpg-pubkey packages.
-* Support for controlling what action is taken on package verification failure with the install_action, version_fail_action and verify_fail_action attributes.
+* Support for controlling what action is taken on package
+ verification failure with the install_action, version_fail_action and
+ verify_fail_action attributes.
RPMng Driver Overview