Build Status

Preface

This document describes the functionality provided by the Unix File Plugin (Adds ability to set unix permissions).

Refer to the XL Deploy Deploy 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 Unix 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.

• UnixFile
• UnixFolder

Requirements

This plugin requires:

• XL Deploy: version 5.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="UnixFilePluginSample">
    <file.UnixFile name="sampleFile" file="sampleFile.txt"/>
    <file.UnixFolder 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.

Deployables	Containers	Generated Deployed
file.UnixFile	overthere.Host	file.CopiedUnixFile
file.UnixFolder	overthere.Host	file.CopiedUnixFolder

Deployed Actions Table

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

Deployed	Create	Destroy	Modify
file.CopiedUnixFile	Create target path on host, if needed Copy file to target path on host Set Unix file permissions	Delete file from host	Delete old file from host Copy modified file to target path on host Set Unix file permissions
file.CopiedUnixFolder	Create target folder on host, if needed Copy folder content to target folder on host Set Unix file permissions	Delete folder content from host If folder is not a shared folder, the folder itself is deleted from host	Perform actions as described by Destroy for old folder Perform actions as described by Create for modified folder Set Unix file permissions