File package deployment configuration file

When installing a file package, the rsdeploy agent on each host retrieves the deployment.xml configuration file from within the file package and executes the specified installation command. Likewise, when uninstalling a file package, the rsdeploy agent executes the specified uninstallation command.

The following is an example of the deployment.xml file, which defines installations for Windows and Linux environments running on x86 machines (OS types NTX86 and LINUX86):

<?xml version="1.0" encoding="UTF-8"?>
<Deployment xmlns="http://www.platform.com/Symphony/Deployment>
 <install>
  <osTypes>
    <osType name="NTX86" startCmd="cmd /c cmd /c wininst.bat" timeout="600" successCodes="0,1,2,3">
        <env name="WIN_ENV">c:\temp</env>
    </osType>
    <osType name="LINUX86" startCmd="/bin/sh linuxinst.sh" timeout="600" successCodes="0,1,2,3">
        <env name="LINUX_ENV">/tmp</env>
    </osType>
  </osTypes>
 </install>
 <uninstall>
  <osTypes>
    <osType name="NTX86" startCmd=" cmd /c cmd /c winuninst.bat " timeout="600" successCodes="0,1,2,3">
        <env name="WIN_ENV">c:\temp</env>
    </osType>
    <osType name="LINUX86" startCmd="/bin/sh linuxuninst.sh" timeout="600" successCodes="0,1,2,3">
        <env name="LINUX_ENV">/tmp</env>
    </osType>
  </osTypes>
 </uninstall>
</Deployment>

When creating a deployment.xml file, consider the following:

  • The deployment.xml file must be in the root location in the file package.

  • The startCmd current working directory is set to the deployment directory.

  • Success codes are compared to the exit code of the startCmd. If the successCodes attribute is not defined, there is no exit code checking.

  • The <env> section can be used to set up the environment for the install and uninstall commands.

  • In a mixed cluster, each package can be associated with a specific OS type (using the ‑o option with rsdeploy). If the file package is to be installed on multiple OS types, install and uninstall sections should include all the supported OS types.

  • The exit code of a script is usually the exit code of the last command that the script executes.

  • The timeout periods for the install and uninstall scripts are specified in seconds. The default is no timeout period.

Related tasks
Create a file package