Preparing the Package Using the Deployment Tool

Creating the Package

Zend's Deployment Tool allows you to create a skeleton package, and pack the contents into a .zpk package. For more information on the tool see The Deployment Tool.

Note:

The deployment feature is only available for Zend Server running on Apache and Zend Server Cluster Manager on Linux.

To create the package skeleton:

Select a directory and use the create command (Linux: '<install_dir>/bin/zdpack create <application-name>'; Windows: zdpack.exe create <application-name>' where <application-name> is your application's name) to create the skeleton of your .zpk package. This includes the XML descriptor file, the data folder and the hook scripts (templates).

Go to the directory to see the resources that have been created:

Data folder - The folder that will contain your application files.
Scripts folder - The hook script skeletons available for you to edit as needed. For more information on the available scripts see Understanding the Package Structure.
deployment.xml file - The template of the XML descriptor for you to edit as needed.

Perform the following actions:

Place your application files in the data folder.
Edit the hook scripts according to your needs.
Edit the XML file as needed. The XML template is made up of example elements. The required elements are name, version and appdir. For more information see the The XML Descriptor File .
Validate the package by using the validate command (Linux: '<install_dir>/bin/zdpack validate [--schema=<xsd-file>] <package-xml-descriptor-file>'; Windows: 'zdpack.exe validate [--schema=<xsd-file>] <package-xml-descriptor-file>').

Use the pack command (Linux: '<install_dir>/bin/zdpack pack <application-name>'; Windows: 'zdpack.exe pack <application-name>') to pack the contents into a .zpk package. By default, the Deployment Tool will create the package in the working directory.

Once you have a .zpk application package ready and packed, you can deploy your application or update an existing application.

The Deployment Tool

The Deployment Tool usage includes the following:

Tool location - The tool is located in: Linux - '/usr/local/zend/bin/zdpack'; Windows - 'C:Program Files\Zend\ZendServer\bin\zdpack' -OR- as a standalone (if downloaded separately from the product).

Usage - Run the help command (Linux: '<install_dir>/bin/zdpack --help'; Windows: 'zdpack.exe --help') from the bin directory to see the usage.

The command line actions are:

Create a skelaton for new application
create <application-name>

Validate a given zend package descriptor against the schema file
validate [--schema=<xsd-file>] <package-xml-descriptor-file>

Create a package. The pack options should contain pointers to the application data directory, the package descriptor file, and the package scripts directory.
pack

Command Line Options:

package-directory
A directory containing the data and the script directories, in addition to the package descriptor file.

--src-dir=directory
The directory that contains the application resources (PHP sources, JavaScript, etc.). The directory's internal structure must match the necessary structure for the application to be functional.

--scripts-dir=directory
The directory which contains the package deployment scripts. The Deployment Tool will search this directory for the expected files (as described in section 2.2.1) and then packs them.

--package-descriptor=xml-file
The package descriptor file.

--output-dir=directory
The directory in which the package is created. The package name will be created as "<app-name>-<app-version>.zpk".

--php-exe=php-executable
The PHP executable to use for lint.

--lint
Performs a PHP lint test on the deployment scripts before creating the package.

--help
Displays the tool's usage.

--schema=xsd-file
The path to the package descriptor schema used for validation.