Gitweb: http://git.fedorahosted.org/git/cluster.git?p=cluster.git;a=commitdiff;h=64c... Commit: 64c6eca0cecb66050ad614236535ee9ca1fa7eff Parent: c3d9629bd1d8d3ce9dce942624c3c6112eab6ee9 Author: Lon Hohberger lhh@redhat.com AuthorDate: Tue Jun 15 15:44:23 2010 -0400 Committer: Lon Hohberger lhh@redhat.com CommitterDate: Mon Jun 21 09:40:32 2010 -0400
config: Add missing resource docs to cluster.rng
Resolves: rhbz#604298
Signed-off-by: Lon Hohberger lhh@redhat.com --- config/tools/xml/cluster.rng.in | 786 ++++++++++++---------------- rgmanager/src/resources/ra2rng.xsl | 17 +- rgmanager/src/resources/resources.rng.tail | 10 +- rgmanager/src/resources/service.sh | 52 +-- rgmanager/src/resources/vm.sh | 70 ++-- 5 files changed, 410 insertions(+), 525 deletions(-)
diff --git a/config/tools/xml/cluster.rng.in b/config/tools/xml/cluster.rng.in index aeba2d0..647b2c8 100644 --- a/config/tools/xml/cluster.rng.in +++ b/config/tools/xml/cluster.rng.in @@ -243,19 +243,19 @@ To validate your cluster.conf against this schema, run: <optional> <element name="quorumd" rha:description="This element and its attributes define parameters for the quorum disk daemon, - quorumd."> + quorumd. qdisk(5)."> <optional> <attribute name="interval" rha:description="The frequency of - read/write cycles, in seconds." rha:sample=""/> + read/write cycles, in seconds. qdisk(5)." rha:sample=""/> </optional> <optional> <attribute name="tko" rha:description="The number of cycles a node - must miss to be declared dead." rha:sample=""/> + must miss to be declared dead. qdisk(5)." rha:sample=""/> </optional> <optional> <attribute name="votes" rha:description="The number of votes the quorum daemon advertises to CMAN when it has a high enough - score." rha:sample=""/> + score. qdisk(5)." rha:sample=""/> </optional> <optional> <attribute name="min_score" rha:description="The minimum score for a @@ -263,12 +263,12 @@ To validate your cluster.conf against this schema, run: function, floor((n+1)/2), is used, where n is the sum of the heuristics scores. The Minimum Score value must never exceed the sum of the heuristic scores; otherwise, the quorum disk cannot - be available." rha:sample=""/> + be available. qdisk(5)." rha:sample=""/> </optional> <optional> <attribute name="device" rha:description="The storage device the quorum daemon uses. The device must be the same on all - nodes." rha:sample=""/> + nodes. qdisk(5)." rha:sample=""/> </optional> <optional> <attribute name="label" rha:description="Specifies the quorum disk @@ -277,40 +277,40 @@ To validate your cluster.conf against this schema, run: used, the quorum daemon reads /proc/partitions and checks for qdisk signatures on every block device found, comparing the label against the specified label. This is useful in configurations - where the quorum device name differs among nodes." rha:sample=""/> + where the quorum device name differs among nodes. qdisk(5)." rha:sample=""/> </optional> <optional> - <attribute name="status_file" rha:description="" rha:sample=""/> + <attribute name="status_file" rha:description="Debugging file. qdisk(5)." rha:sample=""/> </optional> <optional> - <attribute name="scheduler" rha:description="" rha:sample=""/> + <attribute name="scheduler" rha:description="Scheduler. qdisk(5)." rha:sample=""/> </optional> <optional> - <attribute name="reboot" rha:description="" rha:sample=""/> + <attribute name="reboot" rha:description="Reboot if our score drops too low. qdisk(5)." rha:sample=""/> </optional> <optional> - <attribute name="priority" rha:description="" rha:sample=""/> + <attribute name="priority" rha:description="Scheduler priority. qdisk(5)." rha:sample=""/> </optional> <optional> - <attribute name="stop_cman" rha:description="" rha:sample=""/> + <attribute name="stop_cman" rha:description="Stop cman if the quorum disk cannot be found during startup. qdisk(5)." rha:sample=""/> </optional> <optional> - <attribute name="paranoid" rha:description="" rha:sample=""/> + <attribute name="paranoid" rha:description="Reboot if we are running too slowly. qdisk(5)." rha:sample=""/> </optional> <optional> - <attribute name="allow_kill" rha:description="" rha:sample=""/> + <attribute name="allow_kill" rha:description="Instruct cman to evict nodes which are not updating the quorum disk. qdisk(5)." rha:sample=""/> </optional> <optional> - <attribute name="max_error_cycles" rha:description="" rha:sample=""/> + <attribute name="max_error_cycles" rha:description="Die after this many cycles which receive I/O errors. qdisk(5)." rha:sample=""/> </optional> <optional> - <attribute name="io_timeout" rha:description="" rha:sample=""/> + <attribute name="io_timeout" rha:description="Die if we cannot get a write out to disk after interval*tko. qdisk(5)." rha:sample=""/> </optional> <optional> - <attribute name="master_wins" rha:description="" rha:sample=""/> + <attribute name="master_wins" rha:description="Enable master-wins mode (two node clusters). qdisk(5)." rha:sample=""/> </optional> <zeroOrMore> - <element name="heuristic" rha:description=""> + <element name="heuristic" rha:description="Defines a heuristic. qdisk(5)."> <attribute name="program" rha:description="The program used to determine if this heuristic is alive. This can be anything that can be executed by /bin/sh -c. A return value of 0 indicates @@ -322,11 +322,11 @@ To validate your cluster.conf against this schema, run: </optional> <optional> <attribute name="interval" rha:description="The frequency (in - seconds) at which the heuristic is polled." rha:default="2" + seconds) at which the heuristic is polled. qdisk(5)." rha:default="2" rha:sample=""/> </optional> <optional> - <attribute name="tko" rha:description="" rha:sample=""/> + <attribute name="tko" rha:description="The number of consecutive failures before a heuristic is discounted. qdisk(5)." rha:sample=""/> </optional> </element> </zeroOrMore> @@ -777,24 +777,24 @@ To validate your cluster.conf against this schema, run: </attribute> </optional> <optional> - <attribute name="status_child_max" rha:description="" rha:sample=""> + <attribute name="status_child_max" rha:description="Maximum number of status child threads." rha:sample=""> <data type="integer"/> </attribute> </optional> <optional> - <attribute name="status_poll_interval" rha:description="" + <attribute name="status_poll_interval" rha:description="Scan the resource tree every X seconds for resources which need to be checked." rha:sample=""> <data type="integer"/> </attribute> </optional> <optional> - <attribute name="transition_throttling" rha:description="" + <attribute name="transition_throttling" rha:description="During transitions, keep the event processor alive for this many seconds." rha:sample=""> <data type="integer"/> </attribute> </optional> <optional> - <attribute name="central_processing" rha:description="" + <attribute name="central_processing" rha:description="Enable central processing mode (requires cluster-wide shut down and restart of rgmanager.)." rha:sample=""> <data type="integer"/> </attribute> @@ -806,7 +806,7 @@ To validate your cluster.conf against this schema, run: </optional> <interleave> <optional> - <element name="failoverdomains" rha:description=""> + <element name="failoverdomains" rha:description="Failover domain definitions."> <zeroOrMore> <element name="failoverdomain" rha:description="Specifies properties of a specific failover domain"> @@ -823,7 +823,7 @@ To validate your cluster.conf against this schema, run: unrestricted." rha:default="0" rha:sample="1"/> </optional> <optional> - <attribute name="nofailback" rha:description="" rha:sample=""/> + <attribute name="nofailback" rha:description="Do not move service to a more preferred node if it is currently running." rha:sample=""/> </optional> <zeroOrMore> <element name="failoverdomainnode" rha:description="A node in @@ -843,47 +843,47 @@ To validate your cluster.conf against this schema, run: </element> </optional> <!-- End of failoverdomains block --> <optional> - <element name="events" rha:description=""> + <element name="events" rha:description="Event definitions (central_processing only)."> <zeroOrMore> - <element name="event" rha:description=""> - <attribute name="name" rha:description="" rha:sample=""/> + <element name="event" rha:description="Defines an event."> + <attribute name="name" rha:description="Symbolic name for an event." rha:sample=""/> <optional> <text/> </optional> <optional> - <attribute name="file" rha:description="" rha:sample=""/> + <attribute name="file" rha:description="Path to S/Lang script to execute." rha:sample=""/> </optional> <optional> - <attribute name="priority" rha:description="" rha:sample=""/> + <attribute name="priority" rha:description="Order (1..99) of event." rha:sample=""/> </optional> <optional> - <attribute name="class" rha:description="" rha:sample=""/> + <attribute name="class" rha:description="Event class (service, node)." rha:sample=""/> </optional> <!-- Service event class attributes --> <optional> - <attribute name="service" rha:description="" rha:sample=""/> + <attribute name="service" rha:description="(Service) The service name (service:foo) must match the specified value in order for the event script to be run." rha:sample=""/> </optional> <optional> - <attribute name="service_state" rha:description="" rha:sample=""/> + <attribute name="service_state" rha:description="(Service) The service's state must match the specified value in order for the script to be run (started, stopped, disabled, failed)." rha:sample=""/> </optional> <optional> - <attribute name="service_owner" rha:description="" rha:sample=""/> + <attribute name="service_owner" rha:description="(Service) The service owner must match the specified value in order for the event script to be run." rha:sample=""/> </optional> <!-- Node event --> <optional> - <attribute name="node" rha:description="" rha:sample=""/> + <attribute name="node" rha:description="(Node) The node name must match the specified value in order for the script to be run." rha:sample=""/> </optional> <optional> - <attribute name="node_id" rha:description="" rha:sample=""/> + <attribute name="node_id" rha:description="(Node) The node ID must match the specified value in order for the script to be run." rha:sample=""/> </optional> <optional> - <attribute name="node_state" rha:description="" rha:sample=""/> + <attribute name="node_state" rha:description="(Node) The node state must match the specified value (0 or 1) in order for the script to be run." rha:sample=""/> </optional> <optional> - <attribute name="node_clean" rha:description="" rha:sample=""/> + <attribute name="node_clean" rha:description="(Node) The node must have been fenced in order for the script to be run." rha:sample=""/> </optional> <optional> - <attribute name="node_local" rha:description="" rha:sample=""/> + <attribute name="node_local" rha:description="(Node) This script may only run on the current central processing node." rha:sample=""/> </optional> <!-- Config event attributes --> <!-- NOT USED --> @@ -892,7 +892,7 @@ To validate your cluster.conf against this schema, run: </element> </optional> <!-- End of events block --> <optional> - <element name="resources" rha:description=""> + <element name="resources" rha:description="Defines global resources."> <zeroOrMore> <ref name="CHILDREN"/> </zeroOrMore> @@ -933,64 +933,60 @@ To validate your cluster.conf against this schema, run: <!-- Autogenerated. Paste in to cluster.ng in the 'resources' section -->
<define name="SERVICE"> - <element name="service"> - <!-- Defines a services. --> + <element name="service" rha:description="Defines a service (resource group)."> <choice> <group> <!-- rgmanager specific stuff --> - <attribute name="ref"/> + <attribute name="ref" rha:description="Reference to existing service resource in the resources section."/> </group> <group> - <attribute name="name"/> + <attribute name="name" rha:description="Name."/> <optional> - <attribute name="domain"/> + <attribute name="domain" rha:description="Failover domain."/> </optional> <optional> - <attribute name="autostart"/> + <attribute name="autostart" rha:description="Automatic start after quorum formation"/> </optional> <optional> - <attribute name="hardrecovery"/> + <attribute name="exclusive" rha:description="Exclusive service."/> </optional> <optional> - <attribute name="exclusive"/> + <attribute name="nfslock" rha:description="Enable NFS lock workarounds."/> </optional> <optional> - <attribute name="nfslock"/> + <attribute name="nfs_client_cache" rha:description="Enable exportfs list caching (performance)."/> </optional> <optional> - <attribute name="nfs_client_cache"/> + <attribute name="recovery" rha:description="Failure recovery policy (restart, relocate, or disable)."/> </optional> <optional> - <attribute name="recovery"/> + <attribute name="depend" rha:description="Top-level service this depends on, in service:name format."/> </optional> <optional> - <attribute name="depend"/> + <attribute name="depend_mode" rha:description="Service dependency mode (soft or hard)."/> </optional> <optional> - <attribute name="depend_mode"/> + <attribute name="max_restarts" rha:description="Maximum restarts for this service."/> </optional> <optional> - <attribute name="max_restarts"/> + <attribute name="restart_expire_time" rha:description="Restart expiration time; amount of time before a restart is forgotten."/> </optional> <optional> - <attribute name="restart_expire_time"/> - </optional> - <optional> - <attribute name="priority"/> + <attribute name="priority" rha:description="Service priority."/> </optional> </group> </choice> <optional> - <attribute name="__independent_subtree"/> + <attribute name="__independent_subtree" rha:description="Treat this and all children as an independent subtree."/> </optional> <optional> - <attribute name="__enforce_timeouts"/> + <attribute name="__enforce_timeouts" rha:description="Consider a timeout for operations as fatal."/> </optional> <optional> - <attribute name="__max_failures"/> + <attribute name="__max_failures" rha:description="Maximum number of failures before returning a failure to a status check."/> </optional> <optional> - <attribute name="__failure_expire_time"/> + <attribute name="__failure_expire_time" rha:description="Amount of time before a failure is forgotten."/> </optional> <optional> <ref name="CHILDREN"/> @@ -1000,40 +996,39 @@ To validate your cluster.conf against this schema, run:
<define name="IP"> - <element name="ip"> - <!-- This is an IP address. --> + <element name="ip" rha:description="This is an IP address."> <choice> <group> <!-- rgmanager specific stuff --> - <attribute name="ref"/> + <attribute name="ref" rha:description="Reference to existing ip resource in the resources section."/> </group> <group> - <attribute name="address"/> + <attribute name="address" rha:description="IP Address"/> <optional> - <attribute name="family"/> + <attribute name="family" rha:description="Family"/> </optional> <optional> - <attribute name="monitor_link"/> + <attribute name="monitor_link" rha:description="Monitor NIC Link"/> </optional> <optional> - <attribute name="nfslock"/> + <attribute name="nfslock" rha:description="Enable NFS lock workarounds"/> </optional> <optional> - <attribute name="sleeptime"/> + <attribute name="sleeptime" rha:description="Amount of time (seconds) to sleep."/> </optional> </group> </choice> <optional> - <attribute name="__independent_subtree"/> + <attribute name="__independent_subtree" rha:description="Treat this and all children as an independent subtree."/> </optional> <optional> - <attribute name="__enforce_timeouts"/> + <attribute name="__enforce_timeouts" rha:description="Consider a timeout for operations as fatal."/> </optional> <optional> - <attribute name="__max_failures"/> + <attribute name="__max_failures" rha:description="Maximum number of failures before returning a failure to a status check."/> </optional> <optional> - <attribute name="__failure_expire_time"/> + <attribute name="__failure_expire_time" rha:description="Amount of time before a failure is forgotten."/> </optional> <optional> <ref name="CHILDREN"/> @@ -1043,50 +1038,49 @@ To validate your cluster.conf against this schema, run:
<define name="NFSCLIENT"> - <element name="nfsclient"> - <!-- Defines an NFS client. --> + <element name="nfsclient" rha:description="Defines an NFS client."> <choice> <group> <!-- rgmanager specific stuff --> - <attribute name="ref"/> + <attribute name="ref" rha:description="Reference to existing nfsclient resource in the resources section."/> </group> <group> - <attribute name="name"/> - <attribute name="target"/> + <attribute name="name" rha:description="Client Name"/> + <attribute name="target" rha:description="Target Hostname, Wildcard, or Netgroup"/> <optional> - <attribute name="path"/> + <attribute name="path" rha:description="Path to Export"/> </optional> <optional> - <attribute name="svcname"/> + <attribute name="svcname" rha:description=""/> </optional> <optional> - <attribute name="fsid"/> + <attribute name="fsid" rha:description="File system ID"/> </optional> <optional> - <attribute name="options"/> + <attribute name="options" rha:description="Export Options"/> </optional> <optional> - <attribute name="allow_recover"/> + <attribute name="allow_recover" rha:description="Allow recovery"/> </optional> <optional> - <attribute name="service_name"/> + <attribute name="service_name" rha:description="Service Name"/> </optional> <optional> - <attribute name="use_cache"/> + <attribute name="use_cache" rha:description="Enable exportfs list caching"/> </optional> </group> </choice> <optional> - <attribute name="__independent_subtree"/> + <attribute name="__independent_subtree" rha:description="Treat this and all children as an independent subtree."/> </optional> <optional> - <attribute name="__enforce_timeouts"/> + <attribute name="__enforce_timeouts" rha:description="Consider a timeout for operations as fatal."/> </optional> <optional> - <attribute name="__max_failures"/> + <attribute name="__max_failures" rha:description="Maximum number of failures before returning a failure to a status check."/> </optional> <optional> - <attribute name="__failure_expire_time"/> + <attribute name="__failure_expire_time" rha:description="Amount of time before a failure is forgotten."/> </optional> <optional> <ref name="CHILDREN"/> @@ -1096,37 +1090,36 @@ To validate your cluster.conf against this schema, run:
<define name="NFSEXPORT"> - <element name="nfsexport"> - <!-- This defines an NFS export. --> + <element name="nfsexport" rha:description="This defines an NFS export."> <choice> <group> <!-- rgmanager specific stuff --> - <attribute name="ref"/> + <attribute name="ref" rha:description="Reference to existing nfsexport resource in the resources section."/> </group> <group> - <attribute name="name"/> + <attribute name="name" rha:description="Name"/> <optional> - <attribute name="device"/> + <attribute name="device" rha:description="If you can see this, your GUI is broken."/> </optional> <optional> - <attribute name="path"/> + <attribute name="path" rha:description="If you can see this, your GUI is broken."/> </optional> <optional> - <attribute name="fsid"/> + <attribute name="fsid" rha:description="If you can see this, your GUI is broken."/> </optional> </group> </choice> <optional> - <attribute name="__independent_subtree"/> + <attribute name="__independent_subtree" rha:description="Treat this and all children as an independent subtree."/> </optional> <optional> - <attribute name="__enforce_timeouts"/> + <attribute name="__enforce_timeouts" rha:description="Consider a timeout for operations as fatal."/> </optional> <optional> - <attribute name="__max_failures"/> + <attribute name="__max_failures" rha:description="Maximum number of failures before returning a failure to a status check."/> </optional> <optional> - <attribute name="__failure_expire_time"/> + <attribute name="__failure_expire_time" rha:description="Amount of time before a failure is forgotten."/> </optional> <optional> <ref name="CHILDREN"/> @@ -1136,32 +1129,31 @@ To validate your cluster.conf against this schema, run:
<define name="SCRIPT"> - <element name="script"> - <!-- LSB-compliant init script as a clustered resource. --> + <element name="script" rha:description="LSB-compliant init script as a clustered resource."> <choice> <group> <!-- rgmanager specific stuff --> - <attribute name="ref"/> + <attribute name="ref" rha:description="Reference to existing script resource in the resources section."/> </group> <group> - <attribute name="name"/> - <attribute name="file"/> + <attribute name="name" rha:description="Name"/> + <attribute name="file" rha:description="Path to script"/> <optional> - <attribute name="service_name"/> + <attribute name="service_name" rha:description="Inherit the service name."/> </optional> </group> </choice> <optional> - <attribute name="__independent_subtree"/> + <attribute name="__independent_subtree" rha:description="Treat this and all children as an independent subtree."/> </optional> <optional> - <attribute name="__enforce_timeouts"/> + <attribute name="__enforce_timeouts" rha:description="Consider a timeout for operations as fatal."/> </optional> <optional> - <attribute name="__max_failures"/> + <attribute name="__max_failures" rha:description="Maximum number of failures before returning a failure to a status check."/> </optional> <optional> - <attribute name="__failure_expire_time"/> + <attribute name="__failure_expire_time" rha:description="Amount of time before a failure is forgotten."/> </optional> <optional> <ref name="CHILDREN"/> @@ -1171,43 +1163,42 @@ To validate your cluster.conf against this schema, run:
<define name="NETFS"> - <element name="netfs"> - <!-- Defines an NFS/CIFS file system mount. --> + <element name="netfs" rha:description="Defines an NFS/CIFS file system mount."> <choice> <group> <!-- rgmanager specific stuff --> - <attribute name="ref"/> + <attribute name="ref" rha:description="Reference to existing netfs resource in the resources section."/> </group> <group> - <attribute name="name"/> - <attribute name="mountpoint"/> - <attribute name="host"/> - <attribute name="export"/> + <attribute name="name" rha:description="File System Name"/> + <attribute name="mountpoint" rha:description="Mount Point"/> + <attribute name="host" rha:description="IP or Host"/> + <attribute name="export" rha:description="Export"/> <optional> - <attribute name="fstype"/> + <attribute name="fstype" rha:description="File System Type"/> </optional> <optional> - <attribute name="no_unmount"/> + <attribute name="no_unmount" rha:description="Skip unmount opration"/> </optional> <optional> - <attribute name="force_unmount"/> + <attribute name="force_unmount" rha:description="Force Unmount"/> </optional> <optional> - <attribute name="options"/> + <attribute name="options" rha:description="Mount Options"/> </optional> </group> </choice> <optional> - <attribute name="__independent_subtree"/> + <attribute name="__independent_subtree" rha:description="Treat this and all children as an independent subtree."/> </optional> <optional> - <attribute name="__enforce_timeouts"/> + <attribute name="__enforce_timeouts" rha:description="Consider a timeout for operations as fatal."/> </optional> <optional> - <attribute name="__max_failures"/> + <attribute name="__max_failures" rha:description="Maximum number of failures before returning a failure to a status check."/> </optional> <optional> - <attribute name="__failure_expire_time"/> + <attribute name="__failure_expire_time" rha:description="Amount of time before a failure is forgotten."/> </optional> <optional> <ref name="CHILDREN"/> @@ -1217,85 +1208,47 @@ To validate your cluster.conf against this schema, run:
<define name="CLUSTERFS"> - <element name="clusterfs"> - <!-- Defines a cluster file system mount. --> + <element name="clusterfs" rha:description="Defines a cluster file system mount."> <choice> <group> <!-- rgmanager specific stuff --> - <attribute name="ref"/> + <attribute name="ref" rha:description="Reference to existing clusterfs resource in the resources section."/> </group> <group> - <attribute name="name"/> - <attribute name="mountpoint"/> - <attribute name="device"/> - <optional> - <attribute name="fstype"/> - </optional> + <attribute name="name" rha:description="File System Name"/> + <attribute name="mountpoint" rha:description="Mount Point"/> + <attribute name="device" rha:description="Device or Label"/> <optional> - <attribute name="force_unmount"/> + <attribute name="fstype" rha:description="File system type"/> </optional> <optional> - <attribute name="options"/> + <attribute name="force_unmount" rha:description="Force Unmount"/> </optional> <optional> - <attribute name="self_fence"/> + <attribute name="options" rha:description="Mount Options"/> </optional> <optional> - <attribute name="fsid"/> + <attribute name="self_fence" rha:description="Seppuku Unmount"/> </optional> <optional> - <attribute name="nfslock"/> - </optional> - </group> - </choice> - <optional> - <attribute name="__independent_subtree"/> - </optional> - <optional> - <attribute name="__enforce_timeouts"/> - </optional> - <optional> - <attribute name="__max_failures"/> - </optional> - <optional> - <attribute name="__failure_expire_time"/> - </optional> - <optional> - <ref name="CHILDREN"/> - </optional> - </element> - </define> - - - <define name="SMB"> - <element name="smb"> - <!-- Dynamic smbd/nmbd resource agent --> - <choice> - <group> - <!-- rgmanager specific stuff --> - <attribute name="ref"/> - </group> - <group> - <attribute name="name"/> - <optional> - <attribute name="workgroup"/> + <attribute name="fsid" rha:description="NFS File system ID"/> </optional> <optional> - <attribute name="service_name"/> + <attribute name="nfslock" rha:description="Enable NFS lock workarounds"/> </optional> </group> </choice> <optional> - <attribute name="__independent_subtree"/> + <attribute name="__independent_subtree" rha:description="Treat this and all children as an independent subtree."/> </optional> <optional> - <attribute name="__enforce_timeouts"/> + <attribute name="__enforce_timeouts" rha:description="Consider a timeout for operations as fatal."/> </optional> <optional> - <attribute name="__max_failures"/> + <attribute name="__max_failures" rha:description="Maximum number of failures before returning a failure to a status check."/> </optional> <optional> - <attribute name="__failure_expire_time"/> + <attribute name="__failure_expire_time" rha:description="Amount of time before a failure is forgotten."/> </optional> <optional> <ref name="CHILDREN"/> @@ -1305,43 +1258,42 @@ To validate your cluster.conf against this schema, run:
<define name="APACHE"> - <element name="apache"> - <!-- Defines an Apache web server --> + <element name="apache" rha:description="Defines an Apache web server"> <choice> <group> <!-- rgmanager specific stuff --> - <attribute name="ref"/> + <attribute name="ref" rha:description="Reference to existing apache resource in the resources section."/> </group> <group> - <attribute name="name"/> + <attribute name="name" rha:description="Name"/> <optional> - <attribute name="server_root"/> + <attribute name="server_root" rha:description="Initial ServerRoot"/> </optional> <optional> - <attribute name="config_file"/> + <attribute name="config_file" rha:description="Initial ServerConfigFile"/> </optional> <optional> - <attribute name="httpd_options"/> + <attribute name="httpd_options" rha:description="Other command-line options for httpd"/> </optional> <optional> - <attribute name="shutdown_wait"/> + <attribute name="shutdown_wait" rha:description="Wait X seconds for correct end of service shutdown"/> </optional> <optional> - <attribute name="service_name"/> + <attribute name="service_name" rha:description="Inherit the service name."/> </optional> </group> </choice> <optional> - <attribute name="__independent_subtree"/> + <attribute name="__independent_subtree" rha:description="Treat this and all children as an independent subtree."/> </optional> <optional> - <attribute name="__enforce_timeouts"/> + <attribute name="__enforce_timeouts" rha:description="Consider a timeout for operations as fatal."/> </optional> <optional> - <attribute name="__max_failures"/> + <attribute name="__max_failures" rha:description="Maximum number of failures before returning a failure to a status check."/> </optional> <optional> - <attribute name="__failure_expire_time"/> + <attribute name="__failure_expire_time" rha:description="Amount of time before a failure is forgotten."/> </optional> <optional> <ref name="CHILDREN"/> @@ -1351,43 +1303,42 @@ To validate your cluster.conf against this schema, run:
<define name="OPENLDAP"> - <element name="openldap"> - <!-- Defines an Open LDAP server --> + <element name="openldap" rha:description="Defines an Open LDAP server"> <choice> <group> <!-- rgmanager specific stuff --> - <attribute name="ref"/> + <attribute name="ref" rha:description="Reference to existing openldap resource in the resources section."/> </group> <group> - <attribute name="name"/> + <attribute name="name" rha:description="Name"/> <optional> - <attribute name="config_file"/> + <attribute name="config_file" rha:description="Config File"/> </optional> <optional> - <attribute name="url_list"/> + <attribute name="url_list" rha:description="URL list"/> </optional> <optional> - <attribute name="slapd_options"/> + <attribute name="slapd_options" rha:description="Other command-line options for slapd"/> </optional> <optional> - <attribute name="shutdown_wait"/> + <attribute name="shutdown_wait" rha:description="Wait X seconds for correct end of service shutdown"/> </optional> <optional> - <attribute name="service_name"/> + <attribute name="service_name" rha:description="Inherit the service name."/> </optional> </group> </choice> <optional> - <attribute name="__independent_subtree"/> + <attribute name="__independent_subtree" rha:description="Treat this and all children as an independent subtree."/> </optional> <optional> - <attribute name="__enforce_timeouts"/> + <attribute name="__enforce_timeouts" rha:description="Consider a timeout for operations as fatal."/> </optional> <optional> - <attribute name="__max_failures"/> + <attribute name="__max_failures" rha:description="Maximum number of failures before returning a failure to a status check."/> </optional> <optional> - <attribute name="__failure_expire_time"/> + <attribute name="__failure_expire_time" rha:description="Amount of time before a failure is forgotten."/> </optional> <optional> <ref name="CHILDREN"/> @@ -1397,43 +1348,42 @@ To validate your cluster.conf against this schema, run:
<define name="SAMBA"> - <element name="samba"> - <!-- Dynamic smbd/nmbd resource agent --> + <element name="samba" rha:description="Dynamic smbd/nmbd resource agent"> <choice> <group> <!-- rgmanager specific stuff --> - <attribute name="ref"/> + <attribute name="ref" rha:description="Reference to existing samba resource in the resources section."/> </group> <group> - <attribute name="name"/> + <attribute name="name" rha:description="Samba Name"/> <optional> - <attribute name="config_file"/> + <attribute name="config_file" rha:description="Config File"/> </optional> <optional> - <attribute name="smbd_options"/> + <attribute name="smbd_options" rha:description="Other command-line options for smbd"/> </optional> <optional> - <attribute name="nmbd_options"/> + <attribute name="nmbd_options" rha:description="Other command-line options for nmbd"/> </optional> <optional> - <attribute name="shutdown_wait"/> + <attribute name="shutdown_wait" rha:description="Wait X seconds for correct end of service shutdown"/> </optional> <optional> - <attribute name="service_name"/> + <attribute name="service_name" rha:description="Inherit the service name."/> </optional> </group> </choice> <optional> - <attribute name="__independent_subtree"/> + <attribute name="__independent_subtree" rha:description="Treat this and all children as an independent subtree."/> </optional> <optional> - <attribute name="__enforce_timeouts"/> + <attribute name="__enforce_timeouts" rha:description="Consider a timeout for operations as fatal."/> </optional> <optional> - <attribute name="__max_failures"/> + <attribute name="__max_failures" rha:description="Maximum number of failures before returning a failure to a status check."/> </optional> <optional> - <attribute name="__failure_expire_time"/> + <attribute name="__failure_expire_time" rha:description="Amount of time before a failure is forgotten."/> </optional> <optional> <ref name="CHILDREN"/> @@ -1443,46 +1393,45 @@ To validate your cluster.conf against this schema, run:
<define name="MYSQL"> - <element name="mysql"> - <!-- Defines a MySQL database server --> + <element name="mysql" rha:description="Defines a MySQL database server"> <choice> <group> <!-- rgmanager specific stuff --> - <attribute name="ref"/> + <attribute name="ref" rha:description="Reference to existing mysql resource in the resources section."/> </group> <group> - <attribute name="name"/> + <attribute name="name" rha:description="Name"/> <optional> - <attribute name="config_file"/> + <attribute name="config_file" rha:description="Define configuration file"/> </optional> <optional> - <attribute name="listen_address"/> + <attribute name="listen_address" rha:description="Define an IP address for MySQL server. If the address is not given then first IP address from the service is taken."/> </optional> <optional> - <attribute name="mysqld_options"/> + <attribute name="mysqld_options" rha:description="Other command-line options for mysqld"/> </optional> <optional> - <attribute name="startup_wait"/> + <attribute name="startup_wait" rha:description="Wait X seconds for correct end of service startup"/> </optional> <optional> - <attribute name="shutdown_wait"/> + <attribute name="shutdown_wait" rha:description="Wait X seconds for correct end of service shutdown"/> </optional> <optional> - <attribute name="service_name"/> + <attribute name="service_name" rha:description="Inherit the service name."/> </optional> </group> </choice> <optional> - <attribute name="__independent_subtree"/> + <attribute name="__independent_subtree" rha:description="Treat this and all children as an independent subtree."/> </optional> <optional> - <attribute name="__enforce_timeouts"/> + <attribute name="__enforce_timeouts" rha:description="Consider a timeout for operations as fatal."/> </optional> <optional> - <attribute name="__max_failures"/> + <attribute name="__max_failures" rha:description="Maximum number of failures before returning a failure to a status check."/> </optional> <optional> - <attribute name="__failure_expire_time"/> + <attribute name="__failure_expire_time" rha:description="Amount of time before a failure is forgotten."/> </optional> <optional> <ref name="CHILDREN"/> @@ -1492,43 +1441,42 @@ To validate your cluster.conf against this schema, run:
<define name="POSTGRES-8"> - <element name="postgres-8"> - <!-- Defines a PostgreSQL server --> + <element name="postgres-8" rha:description="Defines a PostgreSQL server"> <choice> <group> <!-- rgmanager specific stuff --> - <attribute name="ref"/> + <attribute name="ref" rha:description="Reference to existing postgres-8 resource in the resources section."/> </group> <group> - <attribute name="name"/> + <attribute name="name" rha:description="Name"/> <optional> - <attribute name="config_file"/> + <attribute name="config_file" rha:description="Config File"/> </optional> <optional> - <attribute name="postmaster_user"/> + <attribute name="postmaster_user" rha:description="User who runs the database server"/> </optional> <optional> - <attribute name="postmaster_options"/> + <attribute name="postmaster_options" rha:description="Other command-line options for postmaster"/> </optional> <optional> - <attribute name="shutdown_wait"/> + <attribute name="shutdown_wait" rha:description="Wait X seconds for correct end of service shutdown"/> </optional> <optional> - <attribute name="service_name"/> + <attribute name="service_name" rha:description="Inherit the service name."/> </optional> </group> </choice> <optional> - <attribute name="__independent_subtree"/> + <attribute name="__independent_subtree" rha:description="Treat this and all children as an independent subtree."/> </optional> <optional> - <attribute name="__enforce_timeouts"/> + <attribute name="__enforce_timeouts" rha:description="Consider a timeout for operations as fatal."/> </optional> <optional> - <attribute name="__max_failures"/> + <attribute name="__max_failures" rha:description="Maximum number of failures before returning a failure to a status check."/> </optional> <optional> - <attribute name="__failure_expire_time"/> + <attribute name="__failure_expire_time" rha:description="Amount of time before a failure is forgotten."/> </optional> <optional> <ref name="CHILDREN"/> @@ -1538,46 +1486,45 @@ To validate your cluster.conf against this schema, run:
<define name="TOMCAT-5"> - <element name="tomcat-5"> - <!-- Defines a Tomcat server --> + <element name="tomcat-5" rha:description="Defines a Tomcat server"> <choice> <group> <!-- rgmanager specific stuff --> - <attribute name="ref"/> + <attribute name="ref" rha:description="Reference to existing tomcat-5 resource in the resources section."/> </group> <group> - <attribute name="name"/> + <attribute name="name" rha:description="Name"/> <optional> - <attribute name="config_file"/> + <attribute name="config_file" rha:description="Config File"/> </optional> <optional> - <attribute name="tomcat_user"/> + <attribute name="tomcat_user" rha:description="User who runs the Tomcat server"/> </optional> <optional> - <attribute name="catalina_options"/> + <attribute name="catalina_options" rha:description="Other command-line options for Catalina"/> </optional> <optional> - <attribute name="catalina_base"/> + <attribute name="catalina_base" rha:description="Catalina base directory (differs for each service)"/> </optional> <optional> - <attribute name="shutdown_wait"/> + <attribute name="shutdown_wait" rha:description="Wait X seconds for correct end of service shutdown"/> </optional> <optional> - <attribute name="service_name"/> + <attribute name="service_name" rha:description="Inherit the service name."/> </optional> </group> </choice> <optional> - <attribute name="__independent_subtree"/> + <attribute name="__independent_subtree" rha:description="Treat this and all children as an independent subtree."/> </optional> <optional> - <attribute name="__enforce_timeouts"/> + <attribute name="__enforce_timeouts" rha:description="Consider a timeout for operations as fatal."/> </optional> <optional> - <attribute name="__max_failures"/> + <attribute name="__max_failures" rha:description="Maximum number of failures before returning a failure to a status check."/> </optional> <optional> - <attribute name="__failure_expire_time"/> + <attribute name="__failure_expire_time" rha:description="Amount of time before a failure is forgotten."/> </optional> <optional> <ref name="CHILDREN"/> @@ -1587,38 +1534,37 @@ To validate your cluster.conf against this schema, run:
<define name="LVM"> - <element name="lvm"> - <!-- LVM Failover script --> + <element name="lvm" rha:description="LVM Failover script"> <choice> <group> <!-- rgmanager specific stuff --> - <attribute name="ref"/> + <attribute name="ref" rha:description="Reference to existing lvm resource in the resources section."/> </group> <group> - <attribute name="name"/> - <attribute name="vg_name"/> + <attribute name="name" rha:description="Name"/> + <attribute name="vg_name" rha:description="Volume group name"/> <optional> - <attribute name="lv_name"/> + <attribute name="lv_name" rha:description="Logical Volume name (optional)."/> </optional> <optional> - <attribute name="self_fence"/> + <attribute name="self_fence" rha:description="Fence the node if it is not able to clean up LVM tags"/> </optional> <optional> - <attribute name="nfslock"/> + <attribute name="nfslock" rha:description="Enable NFS lock workarounds"/> </optional> </group> </choice> <optional> - <attribute name="__independent_subtree"/> + <attribute name="__independent_subtree" rha:description="Treat this and all children as an independent subtree."/> </optional> <optional> - <attribute name="__enforce_timeouts"/> + <attribute name="__enforce_timeouts" rha:description="Consider a timeout for operations as fatal."/> </optional> <optional> - <attribute name="__max_failures"/> + <attribute name="__max_failures" rha:description="Maximum number of failures before returning a failure to a status check."/> </optional> <optional> - <attribute name="__failure_expire_time"/> + <attribute name="__failure_expire_time" rha:description="Amount of time before a failure is forgotten."/> </optional> <optional> <ref name="CHILDREN"/> @@ -1628,85 +1574,81 @@ To validate your cluster.conf against this schema, run:
<define name="VM"> - <element name="vm"> - <!-- Defines a Virtual Machine --> + <element name="vm" rha:description="Defines a Virtual Machine"> <choice> <group> <!-- rgmanager specific stuff --> - <attribute name="ref"/> + <attribute name="ref" rha:description="Reference to existing vm resource in the resources section."/> </group> <group> - <attribute name="name"/> - <optional> - <attribute name="domain"/> - </optional> + <attribute name="name" rha:description="Name"/> <optional> - <attribute name="autostart"/> + <attribute name="domain" rha:description="Cluster failover Domain"/> </optional> <optional> - <attribute name="hardrecovery"/> + <attribute name="autostart" rha:description="Automatic start after quorum formation"/> </optional> <optional> - <attribute name="exclusive"/> + <attribute name="exclusive" rha:description="Exclusive resource group"/> </optional> <optional> - <attribute name="recovery"/> + <attribute name="recovery" rha:description="Failure recovery policy"/> </optional> <optional> - <attribute name="migration_mapping"/> + <attribute name="migration_mapping" rha:description="memberhost:targethost,memberhost:targethost .."/> </optional> <optional> - <attribute name="use_virsh"/> + <attribute name="use_virsh" rha:description="If set to 1, vm.sh will use the virsh command to manage virtual machines instead of xm. This is required when using non-Xen virtual machines (e.g. qemu / KVM)."/> </optional> <optional> - <attribute name="xmlfile"/> + <attribute name="xmlfile" rha:description="Full path to libvirt XML file describing the domain."/> </optional> <optional> - <attribute name="migrate"/> + <attribute name="migrate" rha:description="Migration type (live or pause, default = live)."/> </optional> <optional> - <attribute name="path"/> + <attribute name="path" rha:description="Path to virtual machine configuration files."/> </optional> <optional> - <attribute name="snapshot"/> + <attribute name="snapshot" rha:description="Path to the snapshot directory where the virtual machine image will be stored."/> </optional> <optional> - <attribute name="depend"/> + <attribute name="depend" rha:description="Top-level service this depends on, in service:name format."/> </optional> <optional> - <attribute name="depend_mode"/> + <attribute name="depend_mode" rha:description="Service dependency mode (soft or hard)."/> </optional> <optional> - <attribute name="max_restarts"/> + <attribute name="max_restarts" rha:description="Maximum restarts for this service."/> </optional> <optional> - <attribute name="restart_expire_time"/> + <attribute name="restart_expire_time" rha:description="Restart expiration time; amount of time before a restart is forgotten."/> </optional> <optional> - <attribute name="status_program"/> + <attribute name="status_program" rha:description="Additional status check program"/> </optional> <optional> - <attribute name="hypervisor"/> + <attribute name="hypervisor" rha:description="Hypervisor"/> </optional> <optional> - <attribute name="hypervisor_uri"/> + <attribute name="hypervisor_uri" rha:description="Hypervisor URI (normally automatic)."/> </optional> <optional> - <attribute name="migration_uri"/> + <attribute name="migration_uri" rha:description="Migration URI (normally automatic)."/> </optional> </group> </choice> <optional> - <attribute name="__independent_subtree"/> + <attribute name="__independent_subtree" rha:description="Treat this and all children as an independent subtree."/> </optional> <optional> - <attribute name="__enforce_timeouts"/> + <attribute name="__enforce_timeouts" rha:description="Consider a timeout for operations as fatal."/> </optional> <optional> - <attribute name="__max_failures"/> + <attribute name="__max_failures" rha:description="Maximum number of failures before returning a failure to a status check."/> </optional> <optional> - <attribute name="__failure_expire_time"/> + <attribute name="__failure_expire_time" rha:description="Amount of time before a failure is forgotten."/> </optional> <optional> <ref name="CHILDREN"/> @@ -1716,55 +1658,54 @@ To validate your cluster.conf against this schema, run:
<define name="SAPINSTANCE"> - <element name="SAPInstance"> - <!-- SAP instance resource agent --> + <element name="SAPInstance" rha:description="SAP instance resource agent"> <choice> <group> <!-- rgmanager specific stuff --> - <attribute name="ref"/> + <attribute name="ref" rha:description="Reference to existing SAPInstance resource in the resources section."/> </group> <group> - <attribute name="InstanceName"/> + <attribute name="InstanceName" rha:description="instance name: SID_INSTANCE_VIR-HOSTNAME"/> <optional> - <attribute name="DIR_EXECUTABLE"/> + <attribute name="DIR_EXECUTABLE" rha:description="path of sapstartsrv and sapcontrol"/> </optional> <optional> - <attribute name="DIR_PROFILE"/> + <attribute name="DIR_PROFILE" rha:description="path of start profile"/> </optional> <optional> - <attribute name="START_PROFILE"/> + <attribute name="START_PROFILE" rha:description="start profile name"/> </optional> <optional> - <attribute name="START_WAITTIME"/> + <attribute name="START_WAITTIME" rha:description="Check the successful start after that time (do not wait for J2EE-Addin)"/> </optional> <optional> - <attribute name="AUTOMATIC_RECOVER"/> + <attribute name="AUTOMATIC_RECOVER" rha:description="Enable or disable automatic startup recovery"/> </optional> <optional> - <attribute name="PRE_START_USEREXIT"/> + <attribute name="PRE_START_USEREXIT" rha:description="path to a pre-start script"/> </optional> <optional> - <attribute name="POST_START_USEREXIT"/> + <attribute name="POST_START_USEREXIT" rha:description="path to a post-start script"/> </optional> <optional> - <attribute name="PRE_STOP_USEREXIT"/> + <attribute name="PRE_STOP_USEREXIT" rha:description="path to a pre-start script"/> </optional> <optional> - <attribute name="POST_STOP_USEREXIT"/> + <attribute name="POST_STOP_USEREXIT" rha:description="path to a post-start script"/> </optional> </group> </choice> <optional> - <attribute name="__independent_subtree"/> + <attribute name="__independent_subtree" rha:description="Treat this and all children as an independent subtree."/> </optional> <optional> - <attribute name="__enforce_timeouts"/> + <attribute name="__enforce_timeouts" rha:description="Consider a timeout for operations as fatal."/> </optional> <optional> - <attribute name="__max_failures"/> + <attribute name="__max_failures" rha:description="Maximum number of failures before returning a failure to a status check."/> </optional> <optional> - <attribute name="__failure_expire_time"/> + <attribute name="__failure_expire_time" rha:description="Amount of time before a failure is forgotten."/> </optional> <optional> <ref name="CHILDREN"/> @@ -1774,68 +1715,67 @@ To validate your cluster.conf against this schema, run:
<define name="SAPDATABASE"> - <element name="SAPDatabase"> - <!-- SAP database resource agent --> + <element name="SAPDatabase" rha:description="SAP database resource agent"> <choice> <group> <!-- rgmanager specific stuff --> - <attribute name="ref"/> + <attribute name="ref" rha:description="Reference to existing SAPDatabase resource in the resources section."/> </group> <group> - <attribute name="SID"/> + <attribute name="SID" rha:description="SAP system ID"/> <optional> - <attribute name="DIR_EXECUTABLE"/> + <attribute name="DIR_EXECUTABLE" rha:description="path of sapstartsrv and sapcontrol"/> </optional> - <attribute name="DBTYPE"/> + <attribute name="DBTYPE" rha:description="database vendor"/> <optional> - <attribute name="NETSERVICENAME"/> + <attribute name="NETSERVICENAME" rha:description="listener name"/> </optional> <optional> - <attribute name="DBJ2EE_ONLY"/> + <attribute name="DBJ2EE_ONLY" rha:description="only JAVA stack installed"/> </optional> <optional> - <attribute name="JAVA_HOME"/> + <attribute name="JAVA_HOME" rha:description="Path to Java SDK"/> </optional> <optional> - <attribute name="STRICT_MONITORING"/> + <attribute name="STRICT_MONITORING" rha:description="Activates application level monitoring"/> </optional> <optional> - <attribute name="AUTOMATIC_RECOVER"/> + <attribute name="AUTOMATIC_RECOVER" rha:description="Enable or disable automatic startup recovery"/> </optional> <optional> - <attribute name="DIR_BOOTSTRAP"/> + <attribute name="DIR_BOOTSTRAP" rha:description="path to j2ee bootstrap directory"/> </optional> <optional> - <attribute name="DIR_SECSTORE"/> + <attribute name="DIR_SECSTORE" rha:description="path to j2ee secure store directory"/> </optional> <optional> - <attribute name="DB_JARS"/> + <attribute name="DB_JARS" rha:description="file name of the jdbc driver"/> </optional> <optional> - <attribute name="PRE_START_USEREXIT"/> + <attribute name="PRE_START_USEREXIT" rha:description="path to a pre-start script"/> </optional> <optional> - <attribute name="POST_START_USEREXIT"/> + <attribute name="POST_START_USEREXIT" rha:description="path to a post-start script"/> </optional> <optional> - <attribute name="PRE_STOP_USEREXIT"/> + <attribute name="PRE_STOP_USEREXIT" rha:description="path to a pre-start script"/> </optional> <optional> - <attribute name="POST_STOP_USEREXIT"/> + <attribute name="POST_STOP_USEREXIT" rha:description="path to a post-start script"/> </optional> </group> </choice> <optional> - <attribute name="__independent_subtree"/> + <attribute name="__independent_subtree" rha:description="Treat this and all children as an independent subtree."/> </optional> <optional> - <attribute name="__enforce_timeouts"/> + <attribute name="__enforce_timeouts" rha:description="Consider a timeout for operations as fatal."/> </optional> <optional> - <attribute name="__max_failures"/> + <attribute name="__max_failures" rha:description="Maximum number of failures before returning a failure to a status check."/> </optional> <optional> - <attribute name="__failure_expire_time"/> + <attribute name="__failure_expire_time" rha:description="Amount of time before a failure is forgotten."/> </optional> <optional> <ref name="CHILDREN"/> @@ -1845,46 +1785,45 @@ To validate your cluster.conf against this schema, run:
<define name="NAMED"> - <element name="named"> - <!-- Defines an instance of named server --> + <element name="named" rha:description="Defines an instance of named server"> <choice> <group> <!-- rgmanager specific stuff --> - <attribute name="ref"/> + <attribute name="ref" rha:description="Reference to existing named resource in the resources section."/> </group> <group> - <attribute name="name"/> + <attribute name="name" rha:description="Name"/> <optional> - <attribute name="config_file"/> + <attribute name="config_file" rha:description="Config File"/> </optional> <optional> - <attribute name="named_sdb"/> + <attribute name="named_sdb" rha:description="Simplified Database Backend"/> </optional> <optional> - <attribute name="named_working_dir"/> + <attribute name="named_working_dir" rha:description="Other command-line options for named"/> </optional> <optional> - <attribute name="named_options"/> + <attribute name="named_options" rha:description="Other command-line options for named"/> </optional> <optional> - <attribute name="shutdown_wait"/> + <attribute name="shutdown_wait" rha:description="Wait X seconds for correct end of service shutdown"/> </optional> <optional> - <attribute name="service_name"/> + <attribute name="service_name" rha:description="Inherit the service name."/> </optional> </group> </choice> <optional> - <attribute name="__independent_subtree"/> + <attribute name="__independent_subtree" rha:description="Treat this and all children as an independent subtree."/> </optional> <optional> - <attribute name="__enforce_timeouts"/> + <attribute name="__enforce_timeouts" rha:description="Consider a timeout for operations as fatal."/> </optional> <optional> - <attribute name="__max_failures"/> + <attribute name="__max_failures" rha:description="Maximum number of failures before returning a failure to a status check."/> </optional> <optional> - <attribute name="__failure_expire_time"/> + <attribute name="__failure_expire_time" rha:description="Amount of time before a failure is forgotten."/> </optional> <optional> <ref name="CHILDREN"/> @@ -1894,70 +1833,37 @@ To validate your cluster.conf against this schema, run:
<define name="ASEHAAGENT"> - <element name="ASEHAagent"> - <!-- Sybase ASE Failover Instance --> - <choice> - <group> - <!-- rgmanager specific stuff --> - <attribute name="ref"/> - </group> - <group> - <attribute name="name"/> - <attribute name="sybase_home"/> - <attribute name="sybase_ase"/> - <attribute name="sybase_ocs"/> - <attribute name="server_name"/> - <attribute name="login_file"/> - <attribute name="interfaces_file"/> - <attribute name="sybase_user"/> - <attribute name="shutdown_timeout"/> - <attribute name="start_timeout"/> - <attribute name="deep_probe_timeout"/> - </group> - </choice> - <optional> - <attribute name="__independent_subtree"/> - </optional> - <optional> - <attribute name="__enforce_timeouts"/> - </optional> - <optional> - <attribute name="__max_failures"/> - </optional> - <optional> - <attribute name="__failure_expire_time"/> - </optional> - <optional> - <ref name="CHILDREN"/> - </optional> - </element> - </define> - - - <define name="DRBD"> - <element name="drbd"> - <!-- This is a DRBD resource. --> + <element name="ASEHAagent" rha:description="Sybase ASE Failover Instance"> <choice> <group> <!-- rgmanager specific stuff --> - <attribute name="ref"/> + <attribute name="ref" rha:description="Reference to existing ASEHAagent resource in the resources section."/> </group> <group> - <attribute name="name"/> - <attribute name="resource"/> + <attribute name="name" rha:description="name"/> + <attribute name="sybase_home" rha:description="SYBASE home directory"/> + <attribute name="sybase_ase" rha:description="SYBASE_ASE directory name"/> + <attribute name="sybase_ocs" rha:description="SYBASE_OCS directory name"/> + <attribute name="server_name" rha:description="ASE server name"/> + <attribute name="login_file" rha:description="Login file"/> + <attribute name="interfaces_file" rha:description="Interfaces file"/> + <attribute name="sybase_user" rha:description="Sybase user"/> + <attribute name="shutdown_timeout" rha:description="Shutdown timeout value"/> + <attribute name="start_timeout" rha:description="Start timeout value"/> + <attribute name="deep_probe_timeout" rha:description="Deep probe timeout value"/> </group> </choice> <optional> - <attribute name="__independent_subtree"/> + <attribute name="__independent_subtree" rha:description="Treat this and all children as an independent subtree."/> </optional> <optional> - <attribute name="__enforce_timeouts"/> + <attribute name="__enforce_timeouts" rha:description="Consider a timeout for operations as fatal."/> </optional> <optional> - <attribute name="__max_failures"/> + <attribute name="__max_failures" rha:description="Maximum number of failures before returning a failure to a status check."/> </optional> <optional> - <attribute name="__failure_expire_time"/> + <attribute name="__failure_expire_time" rha:description="Amount of time before a failure is forgotten."/> </optional> <optional> <ref name="CHILDREN"/> @@ -1967,54 +1873,53 @@ To validate your cluster.conf against this schema, run:
<define name="FS"> - <element name="fs"> - <!-- Defines a file system mount. --> + <element name="fs" rha:description="Defines a file system mount."> <choice> <group> <!-- rgmanager specific stuff --> - <attribute name="ref"/> + <attribute name="ref" rha:description="Reference to existing fs resource in the resources section."/> </group> <group> - <attribute name="name"/> - <attribute name="mountpoint"/> - <attribute name="device"/> + <attribute name="name" rha:description="File System Name"/> + <attribute name="mountpoint" rha:description="Mount Point"/> + <attribute name="device" rha:description="Device or Label"/> <optional> - <attribute name="fstype"/> + <attribute name="fstype" rha:description="File system type"/> </optional> <optional> - <attribute name="force_unmount"/> + <attribute name="force_unmount" rha:description="Force Unmount"/> </optional> <optional> - <attribute name="quick_status"/> + <attribute name="quick_status" rha:description="Quick/brief status checks."/> </optional> <optional> - <attribute name="self_fence"/> + <attribute name="self_fence" rha:description="Seppuku Unmount"/> </optional> <optional> - <attribute name="nfslock"/> + <attribute name="nfslock" rha:description="Enable NFS lock workarounds"/> </optional> <optional> - <attribute name="fsid"/> + <attribute name="fsid" rha:description="NFS File system ID"/> </optional> <optional> - <attribute name="force_fsck"/> + <attribute name="force_fsck" rha:description="Force fsck support"/> </optional> <optional> - <attribute name="options"/> + <attribute name="options" rha:description="Mount Options"/> </optional> </group> </choice> <optional> - <attribute name="__independent_subtree"/> + <attribute name="__independent_subtree" rha:description="Treat this and all children as an independent subtree."/> </optional> <optional> - <attribute name="__enforce_timeouts"/> + <attribute name="__enforce_timeouts" rha:description="Consider a timeout for operations as fatal."/> </optional> <optional> - <attribute name="__max_failures"/> + <attribute name="__max_failures" rha:description="Maximum number of failures before returning a failure to a status check."/> </optional> <optional> - <attribute name="__failure_expire_time"/> + <attribute name="__failure_expire_time" rha:description="Amount of time before a failure is forgotten."/> </optional> <optional> <ref name="CHILDREN"/> @@ -2024,39 +1929,38 @@ To validate your cluster.conf against this schema, run:
<define name="ORACLEDB"> - <element name="oracledb"> - <!-- Oracle 10g Failover Instance --> + <element name="oracledb" rha:description="Oracle 10g Failover Instance"> <choice> <group> <!-- rgmanager specific stuff --> - <attribute name="ref"/> + <attribute name="ref" rha:description="Reference to existing oracledb resource in the resources section."/> </group> <group> - <attribute name="name"/> + <attribute name="name" rha:description="Oracle SID"/> <optional> - <attribute name="listener_name"/> + <attribute name="listener_name" rha:description="Oracle Listener Instance Name"/> </optional> - <attribute name="user"/> - <attribute name="home"/> + <attribute name="user" rha:description="Oracle User Name"/> + <attribute name="home" rha:description="Oracle Home Directory"/> <optional> - <attribute name="type"/> + <attribute name="type" rha:description="Oracle Installation Type"/> </optional> <optional> - <attribute name="vhost"/> + <attribute name="vhost" rha:description="Virtual Hostname"/> </optional> </group> </choice> <optional> - <attribute name="__independent_subtree"/> + <attribute name="__independent_subtree" rha:description="Treat this and all children as an independent subtree."/> </optional> <optional> - <attribute name="__enforce_timeouts"/> + <attribute name="__enforce_timeouts" rha:description="Consider a timeout for operations as fatal."/> </optional> <optional> - <attribute name="__max_failures"/> + <attribute name="__max_failures" rha:description="Maximum number of failures before returning a failure to a status check."/> </optional> <optional> - <attribute name="__failure_expire_time"/> + <attribute name="__failure_expire_time" rha:description="Amount of time before a failure is forgotten."/> </optional> <optional> <ref name="CHILDREN"/> @@ -2076,7 +1980,6 @@ To validate your cluster.conf against this schema, run: <ref name="SCRIPT"/> <ref name="NETFS"/> <ref name="CLUSTERFS"/> - <ref name="SMB"/> <ref name="APACHE"/> <ref name="OPENLDAP"/> <ref name="SAMBA"/> @@ -2089,7 +1992,6 @@ To validate your cluster.conf against this schema, run: <ref name="SAPDATABASE"/> <ref name="NAMED"/> <ref name="ASEHAAGENT"/> - <ref name="DRBD"/> <ref name="FS"/> <ref name="ORACLEDB"/> <ref name="RESOURCEACTION"/> @@ -2107,16 +2009,16 @@ To validate your cluster.conf against this schema, run:
<define name="RESOURCEACTION"> <zeroOrMore> - <element name="action"> - <attribute name="name"/> + <element name="action" rha:description="Overrides resource action timings for a resource instance."> + <attribute name="name" rha:description="Name of resource action (start, stop, status, etc.)."/> <optional> - <attribute name="depth"/> + <attribute name="depth" rha:description="Status check depth (resource agent dependent; * = all depths)."/> </optional> <optional> - <attribute name="interval"/> + <attribute name="interval" rha:description="Status check interval."/> </optional> <optional> - <attribute name="timeout"/> + <attribute name="timeout" rha:description="Action timeout. Meaningless unless __enforce_timeouts is set for this resource."/> </optional> </element> </zeroOrMore> diff --git a/rgmanager/src/resources/ra2rng.xsl b/rgmanager/src/resources/ra2rng.xsl index af65ee9..425faa9 100644 --- a/rgmanager/src/resources/ra2rng.xsl +++ b/rgmanager/src/resources/ra2rng.xsl @@ -8,36 +8,35 @@
<xsl:template match="/resource-agent"> <define name="<xsl:call-template name="capitalize"><xsl:with-param name="value" select="@name"/></xsl:call-template>"> - <element name="<xsl:value-of select="@name"/>"> - <!-- <xsl:value-of select="normalize-space(shortdesc)"/> --> + <element name="<xsl:value-of select="@name"/>" rha:description="<xsl:value-of select="normalize-space(shortdesc)"/>"> <choice> <group> <!-- rgmanager specific stuff --> - <attribute name="ref"/> + <attribute name="ref" rha:description="Reference to existing <xsl:value-of select="@name"/> resource in the resources section."/> </group> <group><xsl:for-each select="parameters/parameter"> xsl:choose <xsl:when test="@required = 1 or @primary = 1"> - <attribute name="<xsl:value-of select="@name"/>"/></xsl:when> + <attribute name="<xsl:value-of select="@name"/>" rha:description="<xsl:value-of select="normalize-space(shortdesc)"/>"/></xsl:when> xsl:otherwise <optional> - <attribute name="<xsl:value-of select="@name"/>"/> + <attribute name="<xsl:value-of select="@name"/>" rha:description="<xsl:value-of select="normalize-space(shortdesc)"/>"/> </optional></xsl:otherwise> </xsl:choose> </xsl:for-each> </group> </choice> <optional> - <attribute name="__independent_subtree"/> + <attribute name="__independent_subtree" rha:description="Treat this and all children as an independent subtree."/> </optional> <optional> - <attribute name="__enforce_timeouts"/> + <attribute name="__enforce_timeouts" rha:description="Consider a timeout for operations as fatal."/> </optional> <optional> - <attribute name="__max_failures"/> + <attribute name="__max_failures" rha:description="Maximum number of failures before returning a failure to a status check."/> </optional> <optional> - <attribute name="__failure_expire_time"/> + <attribute name="__failure_expire_time" rha:description="Amount of time before a failure is forgotten."/> </optional> <optional> <ref name="CHILDREN"/> diff --git a/rgmanager/src/resources/resources.rng.tail b/rgmanager/src/resources/resources.rng.tail index c273680..765c2d9 100644 --- a/rgmanager/src/resources/resources.rng.tail +++ b/rgmanager/src/resources/resources.rng.tail @@ -14,16 +14,16 @@
<define name="RESOURCEACTION"> <zeroOrMore> - <element name="action"> - <attribute name="name"/> + <element name="action" rha:description="Overrides resource action timings for a resource instance."> + <attribute name="name" rha:description="Name of resource action (start, stop, status, etc.)."/> <optional> - <attribute name="depth"/> + <attribute name="depth" rha:description="Status check depth (resource agent dependent; * = all depths)."/> </optional> <optional> - <attribute name="interval"/> + <attribute name="interval" rha:description="Status check interval."/> </optional> <optional> - <attribute name="timeout"/> + <attribute name="timeout" rha:description="Action timeout. Meaningless unless __enforce_timeouts is set for this resource."/> </optional> </element> </zeroOrMore> diff --git a/rgmanager/src/resources/service.sh b/rgmanager/src/resources/service.sh index 5adcc37..e37f518 100644 --- a/rgmanager/src/resources/service.sh +++ b/rgmanager/src/resources/service.sh @@ -23,7 +23,7 @@ meta_data() group or cluster service. </longdesc> <shortdesc lang="en"> - Defines a services. + Defines a service (resource group). </shortdesc>
<parameters> @@ -32,18 +32,18 @@ meta_data() This is the name of the resource group. </longdesc> <shortdesc lang="en"> - Name + Name. </shortdesc> <content type="string"/> </parameter>
<parameter name="domain" reconfig="1"> <longdesc lang="en"> - Fail over domains define lists of cluster members + Failover domains define lists of cluster members to try in the event that a resource group fails. </longdesc> <shortdesc lang="en"> - Fail over Domain + Failover domain. </shortdesc> <content type="string"/> </parameter> @@ -61,21 +61,6 @@ meta_data() <content type="boolean" default="1"/> </parameter>
- <parameter name="hardrecovery" reconfig="1"> - <longdesc lang="en"> - If set to yes, the last owner will reboot if this resource - group fails to stop cleanly, thus allowing the resource - group to fail over to another node. Use with caution; a - badly-behaved resource could cause the entire cluster to - reboot. This should never be enabled if the automatic - start feature is used. - </longdesc> - <shortdesc lang="en"> - Reboot if stop phase fails - </shortdesc> - <content type="boolean" default="0"/> - </parameter> - <parameter name="exclusive" reconfig="1"> <longdesc lang="en"> If set, this resource group will only relocate to @@ -88,7 +73,7 @@ meta_data() operations. </longdesc> <shortdesc lang="en"> - Exclusive resource group + Exclusive service. </shortdesc> <content type="boolean" default="0"/> </parameter> @@ -104,7 +89,7 @@ meta_data() the -H parameter. </longdesc> <shortdesc lang="en"> - Enable NFS lock workarounds + Enable NFS lock workarounds. </shortdesc> <content type="boolean" default="0"/> </parameter> @@ -124,7 +109,7 @@ meta_data() is called. </longdesc> <shortdesc lang="en"> - Enable exportfs list caching + Enable exportfs list caching (performance). </shortdesc> <content type="integer" default="0"/> </parameter> @@ -141,33 +126,33 @@ meta_data() recovered without a restart will be. </longdesc> <shortdesc lang="en"> - Failure recovery policy + Failure recovery policy (restart, relocate, or disable). </shortdesc> <content type="string" default="restart"/> </parameter>
<parameter name="depend"> <longdesc lang="en"> - Top-level service this depends on, in "service:name" format. - </longdesc> - <shortdesc lang="en"> Service dependency; will not start without the specified service running. + </longdesc> + <shortdesc lang="en"> + Top-level service this depends on, in service:name format. </shortdesc> <content type="string"/> </parameter>
<parameter name="depend_mode"> <longdesc lang="en"> - Dependency mode - </longdesc> - <shortdesc lang="en"> Service dependency mode. hard - This service is stopped/started if its dependency is stopped/started soft - This service only depends on the other service for initial startip. If the other service stops, this service is not stopped. + </longdesc> + <shortdesc lang="en"> + Service dependency mode (soft or hard). </shortdesc> <content type="string" default="hard"/> </parameter> @@ -184,15 +169,16 @@ meta_data()
<parameter name="restart_expire_time"> <longdesc lang="en"> - Restart expiration time - </longdesc> - <shortdesc lang="en"> Restart expiration time. A restart is forgotten after this time. When combined with the max_restarts option, this lets administrators specify a threshold for when to fail over services. If max_restarts is exceeded in this given expiration time, the service is relocated instead of restarted again. + </longdesc> + <shortdesc lang="en"> + Restart expiration time; amount of time before a restart + is forgotten. </shortdesc> <content type="string" default="0"/> </parameter> @@ -207,7 +193,7 @@ meta_data() on. </longdesc> <shortdesc lang="en"> - Service priority + Service priority. </shortdesc> <content type="integer" default="0"/> </parameter> diff --git a/rgmanager/src/resources/vm.sh b/rgmanager/src/resources/vm.sh index 53ada42..08fd097 100644 --- a/rgmanager/src/resources/vm.sh +++ b/rgmanager/src/resources/vm.sh @@ -40,12 +40,12 @@ meta_data()
<parameter name="domain" reconfig="1"> <longdesc lang="en"> - Fail over domains define lists of cluster members + Failover domains define lists of cluster members to try in the event that the host of the virtual machine fails. </longdesc> <shortdesc lang="en"> - Cluster Fail Over Domain + Cluster failover Domain </shortdesc> <content type="string"/> </parameter> @@ -63,21 +63,6 @@ meta_data() <content type="boolean" default="1"/> </parameter>
- <parameter name="hardrecovery" reconfig="1"> - <longdesc lang="en"> - If set to yes, the last owner will reboot if this resource - group fails to stop cleanly, thus allowing the resource - group to fail over to another node. Use with caution; a - badly-behaved resource could cause the entire cluster to - reboot. This should never be enabled if the automatic - start feature is used. - </longdesc> - <shortdesc lang="en"> - Reboot if stop phase fails - </shortdesc> - <content type="boolean" default="0"/> - </parameter> - <parameter name="exclusive" reconfig="1"> <longdesc lang="en"> If set, this resource group will only relocate to @@ -121,7 +106,7 @@ meta_data()
<parameter name="use_virsh"> <longdesc lang="en"> - Use virsh instead of XM + Force use of virsh instead of xm on Xen machines. </longdesc> <shortdesc lang="en"> If set to 1, vm.sh will use the virsh command to manage @@ -133,30 +118,31 @@ meta_data()
<parameter name="xmlfile"> <longdesc lang="en"> - Use xmlfile to create the vm (libvirt) + Full path to libvirt XML file describing the domain. </longdesc> <shortdesc lang="en"> + Full path to libvirt XML file describing the domain. </shortdesc> <content type="string"/> </parameter>
<parameter name="migrate"> <longdesc lang="en"> - Migration type live or pause, default = live. + Migration type (live or pause, default = live). </longdesc> <shortdesc lang="en"> - Migration type live or pause, default = live. + Migration type (live or pause, default = live). </shortdesc> <content type="string" default="live"/> </parameter>
<parameter name="path"> <longdesc lang="en"> - Path specification 'xm create' will search for the specified - VM configuration file + Path specification vm.sh will search for the specified + VM configuration file. /path1:/path2:... </longdesc> <shortdesc lang="en"> - Path to virtual machine configuration files + Path to virtual machine configuration files. </shortdesc> <content type="string"/> </parameter> @@ -175,26 +161,26 @@ meta_data()
<parameter name="depend"> <longdesc lang="en"> - Top-level service this depends on, in "service:name" format. - </longdesc> - <shortdesc lang="en"> Service dependency; will not start without the specified service running. + </longdesc> + <shortdesc lang="en"> + Top-level service this depends on, in service:name format. </shortdesc> <content type="string"/> </parameter>
<parameter name="depend_mode"> <longdesc lang="en"> - Dependency mode - </longdesc> - <shortdesc lang="en"> Service dependency mode. hard - This service is stopped/started if its dependency is stopped/started soft - This service only depends on the other service for initial startip. If the other service stops, this service is not stopped. + </longdesc> + <shortdesc lang="en"> + Service dependency mode (soft or hard). </shortdesc> <content type="string" default="hard"/> </parameter> @@ -210,6 +196,18 @@ meta_data() </parameter>
<parameter name="restart_expire_time" reconfig="1"> + <longdesc lang="en"> + Restart expiration time. A restart is forgotten + after this time. When combined with the max_restarts + option, this lets administrators specify a threshold + for when to fail over services. If max_restarts + is exceeded in this given expiration time, the service + is relocated instead of restarted again. + </longdesc> + <shortdesc lang="en"> + Restart expiration time; amount of time before a restart + is forgotten. + </shortdesc> <content type="string" default="0"/> </parameter>
@@ -239,24 +237,24 @@ meta_data() </parameter>
<parameter name="hypervisor_uri"> - <shortdesc lang="en"> - Hypervisor URI - </shortdesc > <longdesc lang="en"> Hypervisor URI. Generally, this is keyed off of the hypervisor and does not need to be set. </longdesc> + <shortdesc lang="en"> + Hypervisor URI (normally automatic). + </shortdesc > <content type="string" default="auto" /> </parameter>
<parameter name="migration_uri"> - <shortdesc lang="en"> - Migration URI - </shortdesc > <longdesc lang="en"> Migration URI. Generally, this is keyed off of the hypervisor and does not need to be set. </longdesc> + <shortdesc lang="en"> + Migration URI (normally automatic). + </shortdesc > <content type="string" default="auto" /> </parameter>
cluster-commits@lists.fedorahosted.org
-
Lon Hohberger