Deploy Commands

Name

deploy — an integrated platform for automating Linux system deployment

Synopsis

deploy [ [-c | --config ] PATH ] [ --macro ID:VALUE ] [ --offline ] [ --no-validate ] [ --validate-only ] [ [-l | --log-level ] N ] [ --log-file PATH ] [ --data-root PATH ] [ --lib-path PATH ] [ --share-path PATH ] [ --disable MODULE ] [ --enable MODULE ] [ --force MODULE ] [ --skip MODULE ] [ --list-events ] [ --force-event EVENT ] [ --skip-event EVENT ] DEFINITION

DESCRIPTION

Builds the system or application defined in the file at DEFINITION.

USAGE

deploy [OPTIONS] DEFINITION

OPTIONS refers to the command-line options described below. DEFINITION refers to a definition file, see the Deploy Definition File Reference at http://www.deployproject.org/docs for more information.

OPTIONS

Command options are listed in alphabetical order.

-c; --config DEPLOY_CONF

Specifies the directory and filename DEPLOY_CONF of the deploy configuration file. The default value is /etc/deploy/deploy.conf. See the deploy.conf(5) man page for Deploy configuration options.

--data-root PATH

Specifies the root directory PATH where Deploy should create definition data folders. The default path is the definition directory. See the Deploy Definition File Reference at http://www.deployproject.org/docs for more information on data files and folders.

--disable MODULE

Disables a MODULE. This option can be specified more than once, as in the example below:

--disable MODULE1 --disable MODULE2 --disable MODULE3

See the MODULES and EVENTS sections below for more information.

--enable MODULE

Enables a MODULE. This option can be specified more than once, as in the example below:

--enable MODULE1 --enable MODULE2 --enable MODULE3

See the MODULES and EVENTS sections below for more information.

--force MODULE

Forces the events of a MODULE to execute, even if the events would ordinarily be skipped for optimizations in speed. This option can be specified more than once, as in the example below:

--force MODULE1 --force MODULE2 --force MODULE3

See the MODULES and EVENTS sections below for more information.

--force-event EVENT

Forces an EVENT to execute, even if it would ordinarily be skipped for optimizations in speed. Forcing an event forces its children recursively. This option can be specified more than once, as in the example below:

--force-event EVENT1 --force-event EVENT2 --force-event EVENT3

See the EVENTS section below for more information.

--lib-path PATH

By default, Deploy searches directories listed on the system path to locate Deploy modules. The --lib-path option allows specifing additional directory PATHs to search. This option can be specified more than once; for example:

--lib-path PATH1 --lib-path PATH2 --lib-path PATH3

See the MODULES section below for more information.

--list-events

Provides a hierarchical list of events that will execute for the specified definition.

deploy --list-events DEFINITION

See the EVENTS section below for more information.

--log-file PATH

Specifies the directory and filename PATH to which Deploy writes logging information. The default path is /var/log/deploy.log. See also the command option --log-level.

--log-file PATH

-l; --log-level N

Specifies the level of detail displayed on the console during a build. There are six levels N (0 to 5) with Level 3 being Deploy's default level.

LEVELS

* Level 0: Displays errors only.
* Level 1: Displays build status.
* Level 2: Displays module status. See MODULES.
* Level 3: Displays file download and creation status (default).
* Level 4: Displays script output; file copy and delete status. 
* Level 5: Displays complete debug-level status.

Setting the log level to 0 will prevent all logging except errors to the screen, while levels 1 to 5 have increasingly more detail about the build process.

This setting controls the level of detail displayed on the console only, and not the log file. Level 5 detail is always written to the log file.

--macro

Specifies a macro ID and VALUE to use for placeholder substitution in the DEFINITION. ID and VALUE are text values separated by a colon. Specifically, VALUE may not contain XML. Placeholders in the DEFINITION take the form '%{ID}'. This option may be specified more than once, for example:

--macro ID1:VALUE1 --macro ID2:VALUE2 --macro ID3:VALUE3

--no-validate

Disables validation of DEPLOY_CONF and DEFINITION during the build process.

--offline

Instructs Deploy to retrieve files from the cache rather than from remote locations.

--share-path PATH

Specifies a directory PATH where Deploy can locate shared program data such as example files and XML schema files. The default path is /usr/share/deploy/. This option can be specified more than once, as demonstrated below:

--share-path PATH1 --share-path PATH2 --share-path PATH3

--skip MODULE

Prevents the events of a MODULE from executing, even if the events would ordinarily be executed due to changes in input, output or other factors. This option can be specified more than once, as in the example below:

--skip MODULE1 --skip MODULE2 --skip MODULE3

See the MODULES and EVENTS sections below for more information.

--skip-event EVENT

Prevents an EVENT from executing, even if it would ordinarily be executed due to changes in input, output or other factors. Skipping an event skips its childen recursively. This option can be specified more than once, as in the example below:

--skip-event EVENT1 --skip-event EVENT2 --skip-event EVENT3

See the EVENTS section below for more information.

--validate-only

Performs DEPLOY_CONF and DEFINITION validation only; it does not build the definition. The option also displays the complete DEFINITION file after resolving macro and include elements.

VARIABLES

Deploy command options, where indicated, use three variables: MODULE, PATH and DEPLOY_CONF.

DEPLOY_CONF

The directory and filename of the Deploy configuration file.

MODULE

The id of a Deploy module. See the MODULES section, below, for more information.

EVENT

The id of a Deploy event. See the EVENTS section, below, for more information.

PATH

A local file path. Deploy resolves paths relative to the current working directory.

MODULES

Modules are blocks of code that implement one or more related events in the build process. Users can skip and force all of the events in a module using the --skip and --force options.

Module names correspond to top-level elements in the DEFINITION.

Developers can write custom Deploy modules and direct Deploy to use them via the --lib-path deploy command option.

See the EVENTS section below for additional information.

EVENTS

Events perform steps in the build process, such as downloading software packages, creating packages or creating ISO images. On subsequent builds of the same definition, Deploy automatically determines whether an event can be skipped in favor of using cached data from a previous build. Users can override the default determination using the --skip-event and --force-event options.

The --list-events option provides a hierarchical list of events for a given definition.

BUGS

See the web site at http://www.deployproject.org for contact and support information.

SEE ALSO

deploy.conf(5), http://www.deployproject.org

AUTHOR

Deploy Foundation