summaryrefslogtreecommitdiffstats
path: root/src/main/resources/META-INF/rhq-plugin.xml
blob: 955a09d8426e86bdd1cf94cbe36ff09465ad89df (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
<?xml version="1.0"?>
<plugin name="Puppet"
        displayName="Puppet System Administration And Configuration"
        package="org.rhq.plugins.puppet"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns="urn:xmlns:rhq-plugin"
        xmlns:c="urn:xmlns:rhq-configuration">

   <depends plugin="Script"/>

   <server name="Puppet Client"
           discovery="PuppetDiscovery"
           class="PuppetComponent"
           supportsManualAdd="true"
           description="The puppet client that will be invoked to process puppet recipes">

      <plugin-configuration>
         <c:group name="executableEnvironment" displayName="Executable Runtime Environment">
            <c:simple-property name="executable" required="true" description="The full path to the puppet client" />
            <c:simple-property name="workingDirectory" required="false" description="When the executable is invoked, this will be its working directory." />
            <c:list-property name="environmentVariables" required="false" description="Environment variables that are set when executing the executable">
               <c:map-property name="environmentVariable">
                  <c:simple-property name="name" type="string" required="true" summary="true" description="Name of the environment variable"/>
                  <c:simple-property name="value" type="string" required="true" summary="true" description="Value of the environment variable" />
               </c:map-property>
            </c:list-property>
         </c:group>
         <c:group name="avail" displayName="Availability Definition">
            <c:simple-property name="availabilityExecuteCheck" default="false" required="false" type="boolean" description="If specified and true, the ability to successfully execute the puppet client can determine whether or not it is considered up and available. If you set this to true, you normally do not set the availability regex settings in order to allow availability to be determined based solely on the successful execution, regardless of the exit code or output. If this is false, setting one of the avail regex settings will override it as if it were true."/>
            <c:simple-property name="availabilityExitCodeRegex" required="false" description="If specified, the executable must return an exit code that matches this regular expression if the managed resource is to be considered up and available"/>
            <c:simple-property name="availabilityOutputRegex" required="false" description="If specified, the executable must output text that matches this regular expression if the managed resource is to be considered up and available"/>
            <c:simple-property name="availabilityArguments" required="false" description="If the executable needs to be executed in order to determine availability, these are the arguments that will be passed to the executable. If you do not specify the regex settings and you set the execute check setting to false, the executable will not be executed and these arguments will not be used - in this case, availability will be determined by the mere existence of the executable file."/>
         </c:group>
         <c:group name="version" displayName="Version Definition">
            <c:simple-property name="versionArguments" default="--version" required="false" description="The arguments to pass to the executable that will help determine the version of the managed resource"/>
            <c:simple-property name="versionRegex" default=".*" required="false" description="The regex that can pick out the version from the executable output. If the regex has a captured group, its matched content will be used as the version. If there is no captured group, the entire output will be used as the version."/>
            <c:simple-property name="fixedVersion" required="false" description="If specified, this will be the version of the managed resource - the executable will not be invoked to determine it." />
         </c:group>
      </plugin-configuration>

      <operation name="dummyOperation">
         <!-- TODO supply parameters and return values -->
      </operation>

   </server>

</plugin>