Doc:Sdk 4.0/awdguide/appbundle - Revision history

Bot: 12 revisions

2011-10-24T19:06:18Z

12 revisions

Stone: /* Application Bundle Format */

2009-03-26T18:37:38Z

‎Application Bundle Format

Stone at 18:54, 19 March 2009

2009-03-19T18:54:21Z

Stone at 16:27, 30 December 2008

2008-12-30T16:27:58Z

Stone at 16:27, 30 December 2008

2008-12-30T16:27:10Z

Stone: /* messages */

2008-12-30T16:26:38Z

‎messages

Stone at 16:26, 30 December 2008

2008-12-30T16:26:10Z

Stone: /* modifiers */

2008-12-30T16:25:12Z

‎modifiers

Stone at 16:24, 30 December 2008

2008-12-30T16:24:13Z

Stone: /* modifiers */

2008-12-30T16:22:12Z

‎modifiers

@@ Line 14: / Line 14: @@
 ====Classic XML====
-<pre>
+ <foo>
-<foo>
+   <bar>1</bar>
-  <bar>1</bar>
+ </foo>
-</foo>
-</pre>
 ====Compact XML====
-<pre>
+ <pre>
-<foo bar="1" />
+   <foo bar="1" />
-</pre>
+ </pre>
 ====Partially compacted XML====
-<pre>
+ <pre>
-<foo>
+ <foo>
-  <bar value="1"></bar>
+   <bar value="1"></bar>
-</foo>
+ </foo>
-</pre>
+ </pre>
-−
-−
 ===Example configuration file===
@@ Line 38: / Line 34: @@
 The following is a typical appcfg.xml configuration file.  This file is used in the SAFplus Platform virtualIp example provided with your SAFplus Platform source distribution:
-<pre>
+ <virtualIp ver="1.4.0.0">
-<virtualIp ver="1.4.0.0">
+ <programNames prog0="vip" />
-<programNames prog0="vip" />
+ <redundancyModel value="3+1" />
-<redundancyModel value="3+1" />
+ <totalNodes value="4" />
-<totalNodes value="4" />
+ <modifiers>
-<modifiers>
+   <failBack value="false" />
-  <failBack value="false" />
+   <autoRepair value="true" />
-  <autoRepair value="true" />
+   <restartsBeforeFailure value='0' />
-  <restartsBeforeFailure value='0' />
+   <activeStandbyRatio value='50' />
-  <activeStandbyRatio value='50' />
+ </modifiers>
-</modifiers>
+ <messages>
-<messages>
+   <newDeployment>Virtual IP application deployed.  Please edit the work assignment (SAF SI) to customize your virtual IP address and interface before starting it.</newDeployment>
-  <newDeployment>Virtual IP application deployed.  Please edit the work assignment (SAF SI) to customize your virtual IP address and interface before starting it.</newDeployment>
+ </messages>
-</messages>
+ <work>
-<work>
+   <firstIp VirtualIpAddress="192.168.1.250" VirtualNetMask="255.255.255.0" VirtualDevice="eth0:10" />
-  <firstIp VirtualIpAddress="192.168.1.250" VirtualNetMask="255.255.255.0" VirtualDevice="eth0:10" />
+ </work>
-</work>
+ </virtualIp>
-</virtualIp>
-</pre>
 The tags are described as follows:
@@ Line 90: / Line 84: @@
 Example:
-<redundancyModel value="3+1" />
+ <redundancyModel value="3+1" />
@@ Line 100: / Line 94: @@
 Example:
-<totalNodes value="4" />
+ <totalNodes value="4" />
@@ Line 107: / Line 101: @@
 Example:
-<pre>
-<modifiers>
+ <modifiers>
-  <failBack value="false" />
+   <failBack value="false" />
-  <autoRepair value="true" />
+   <autoRepair value="true" />
-  <restartsBeforeFailure value='0' />
+   <restartsBeforeFailure value='0' />
-  <activeStandbyRatio value='50' />
+   <activeStandbyRatio value='50' />
-</modifiers>
+ </modifiers>
-</pre>
@@ Line 177: / Line 170: @@
 Example:
-<pre>
+ <pre>
-<messages>
+   <messages>
-<newdeployment>This application is deployed onto the selected nodes.</newdeployment>
+   <newdeployment>This application is deployed onto the selected nodes.</newdeployment>
-</messages>
+   </messages>
-</pre>
+ </pre>
@@ Line 188: / Line 181: @@
 Example:
-<pre>
-<work>
+ <work>
-  <firstIp VirtualIpAddress="192.168.1.250" VirtualNetMask="255.255.255.0" VirtualDevice="eth0:10" />
+   <firstIp VirtualIpAddress="192.168.1.250" VirtualNetMask="255.255.255.0" VirtualDevice="eth0:10" />
-</work>
+ </work>
-</pre>

@@ Line 13: / Line 13: @@
 The appcfg.xml file describes the contents of the application bundle.  It is an xml V1.1 document with a simple layout.  As a simplification to standard XML, attributes and child tags are considered equivalent and the special attribute "value" is equivalent to child content.  The purpose is to allow the xml author to use whichever form is more convenient.  This concept is most easily understood by noting that all of the following are equivalent config files:
-===="Classic" XML====
+====Classic XML====
 <pre>
 <foo>
@@ Line 20: / Line 20: @@
 </pre>
-===="Compact" XML====
+====Compact XML====
 <pre>
 <foo bar="1" />

← Older revision		Revision as of 16:27, 30 December 2008
Line 1:		Line 1:
		+	{{AwdDocHeader}}
	==Application Bundle Format==		==Application Bundle Format==

@@ Line 166: / Line 166: @@
 ====reductionProcedure (Automatic active assignment )====
 As nodes are removed, standby work assignments are automatically removed to make room for active work assignments
 ===messages===
@@ Line 172: / Line 173: @@
 ====newDeployment====
 The new deployment tag specifies the message to print after a successful deployment of this application.
@@ Line 181: / Line 181: @@
 </messages>
 </pre>
 ===work===

@@ Line 168: / Line 168: @@
 ===messages===
 The messages section allows you to provide a message to the user during certain actions.
 ====newDeployment====
@@ Line 181: / Line 181: @@
 </messages>
 </pre>
 ===work===

@@ Line 11: / Line 11: @@
 The appcfg.xml file describes the contents of the application bundle.  It is an xml V1.1 document with a simple layout.  As a simplification to standard XML, attributes and child tags are considered equivalent and the special attribute "value" is equivalent to child content.  The purpose is to allow the xml author to use whichever form is more convenient.  This concept is most easily understood by noting that all of the following are equivalent config files:
 ===="Classic" XML====
@@ Line 19: / Line 18: @@
 </foo>
 </pre>
 ===="Compact" XML====
@@ Line 25: / Line 23: @@
 <foo bar="1" />
 </pre>
 ====Partially compacted XML====
@@ Line 86: / Line 83: @@
 ====Attribute: value====
 This specifies the redundancy model.  Possible values are:
 * "2N": 1 Active/1 standby redundancy
@@ Line 94: / Line 90: @@
 Example:
 <redundancyModel value="3+1" />
 ===totalNodes===
 Recommend the optimal number of nodes to run this application on.
 ====Attribute: value====
 A number specifying the number of nodes
@@ Line 108: / Line 103: @@
 ===modifiers===
 To override the default configuration for any Service Group configuration parameter, specify the parameter and value as a child tag of this tag.  The possible child tags are standard SAF and are also documented in the AWD GUI's deployment page under "Advanced Configuration", or in the SAF AMF, SAFplus Platform SDK or IDE documentation.
@@ Line 187: / Line 181: @@
 </messages>
 </pre>
 ===work===

@@ Line 123: / Line 123: @@
 ====failback====
 Should work be automatically moved back to the original location after a failure?
 ====autoRepair====
 After a failure, should a node be put directly back into service, or should an adminstrative reset be required.
 ====instantiateDuration (Instantiation delay)====
 How long to wait after system startup before starting this application.
 ====numPrefActiveSUs (Preferred number of active nodes)====
 Active nodes are executing your application.
 ====numPrefStandbySUs (Preferred number of standby nodes)====
 These nodes act as redundant backups for the active nodes.
 ====numPrefIdleSUs (Preferred number of idle nodes)====
 Idle nodes have the application running but no work assignments.  For example, if this number is 0 the application will not be started on any nodes until it is needed.  If 1 it will be started on 1 additional node (assuming that the app is deployed to enough nodes).
 ====maxActiveSIsPerSU (Maximum active work)====
 Maximum active work assignments on one program.
 ====maxStandbySIsPerSU (Maximum standby work)====
 Maximum standby work assignments on one program.
 ====compRestartDuration (Process validation period)====
 If a process fails X times within this duration the failure is escalated.  X is the 'Maximum process failure count' below.
 ====compRestartCountMax (Maximum process failure count)====
 How many times to restart a failed component before giving up and escalating to all processes on this node in this deployment.
 ====suRestartDuration (Service Unit restart duration)====
 If all processes in this deployment on one node take longer than this time to start up, the deployment is considered failed.
 ====suRestartCountMax (Maximum service unit failure count)====
 How many times to restart all the processes in this deployment before giving up and moving work to another node.
 ====isCollocationAllowed (Collocation)====
 Allow multiple instances to run on the same node.  WARNING: doing so may mean that work is assigned active and standby on the same node, which means you will not have physical redundancy!
 ====alpha (Redundancy degradation ratio)====
 Percent of active nodes vs standby nodes when the preferred configuration can not be met
 ====autoAdjust (Automatic work adjustment)====
 Automatically move work assignments between blades to match as closely as possible the configured work->node preferences.
 ====autoAdjustProbation (Work adjustment interval)====
 How long between checks to see if work adjustments need to be made
 ====reductionProcedure (Automatic active assignment )====
 As nodes are removed, standby work assignments are automatically removed to make room for active work assignments

@@ Line 11: / Line 11: @@
 The appcfg.xml file describes the contents of the application bundle.  It is an xml V1.1 document with a simple layout.  As a simplification to standard XML, attributes and child tags are considered equivalent and the special attribute "value" is equivalent to child content.  The purpose is to allow the xml author to use whichever form is more convenient.  This concept is most easily understood by noting that all of the following are equivalent config files:
 ===="Classic" XML====
@@ Line 18: / Line 19: @@
 </foo>
 </pre>
 ===="Compact" XML====
@@ Line 23: / Line 25: @@
 <foo bar="1" />
 </pre>
 ====Partially compacted XML====
@@ Line 30: / Line 33: @@
 </foo>
 </pre>
 ===Example configuration file===
@@ Line 57: / Line 62: @@
 The tags are described as follows:
 The root tag (in this case "virtualIp") is the name of the application (SAF Service Group).
 ====Attribute: ver====
-  It has a single attribute "ver" that specifies the version of the software in a 4 dotted digit format.
+It has a single attribute "ver" that specifies the version of the software in a 4 dotted digit format.
 ProgramNames specifies the names of every SAF component to be run in the application (SAF Service Group).  A single SAF Service Unit will be created on each node that this Service Group is deployed onto, and this SU will contain 1 component for every specified attribute to this tag.
 This tag takes any number of attributes, labelled prog0...progN.  Each attribute specifies the name of a Component to be created, and also the name of a binary located in "deploy/bin" that the component will run.
@@ Line 75: / Line 81: @@
   <programNames prog0="vip" prog1='myProg' />
 Specify what type of redundancy this Service Group requires