File Plugin Manual

Preface

This document describes the functionality provided by the File Plugin.

Refer to the XL Deploy Reference Manual for background information on XL Deploy and deployment concepts.

Overview

In many cases, an application depends on external resources for its configuration. The application accesses these resources from a predefined location or using a predefined mechanism.

In the simplest of forms, a resource can be described as a file, an archive (ZIP), or a folder (collection of files). The File Plugin enables the definition of such resources in a deployment package and subsequently managing them on a target host.

The resources can contain placeholders that the plugin will replace when targeting to the specific host, thus allowing resources to be defined independent of their environment.

Features

Deploy, upgrade, and undeploy a file based resource on a Host.

• File
• Folder
• Archive

Requirements

This plugin requires:

• XL Deploy: version 4.0+

Usage in Deployment Packages

Please refer to Packaging Manual for more details about the DAR packaging format.

Sample DAR manifest entries defining a file, folder, and archive resource:

<udm.DeploymentPackage version="1.0" application="FilePluginSample">
    <file.File name="sampleFile" file="sampleFile.txt"/>
    <file.Archive name="sampleArchive" file="sampleArchive.zip" />
    <file.Folder name="sampleFolder" file="sampleFolder" />
</udm.DeploymentPackage>

Using the deployables and deployeds

Deployable vs. Container Table

The following table describes which deployable / container combinations are possible. Note that the CIs can only be targeted to containers derived from Host.

Deployed Actions Table

The following table describes the effect a deployed has on its container.