Maven plugin

The Apache Maven plugin is a project artifact plugin that is used to integrate the framework with the Maven artifact and dependency management tooling. It allows an external Maven repository to be used as the artifact store.

Prerequisites

A folder in a filesystem with read/write access and sufficient space for the plugin to create a local maven Repository.

Usage

RapidDeploy stores all of its deployable artifacts as versioned packages in jar, tar or zip format. Depending on the project configuration, each package will contain:

  1. Code only package
    1. All of the built code (for example ear, war, jar files)
    2. Properties files to update the built artifacts with environment specific values
    3. The configuration, for each defined target environment, to build from scratch or update this applications dependent container resources such as Database or JMS Providers
  2. Code and configuration package
    1. All of the built code (for example ear, war, jar files)
    2. Properties files to update the built artifacts with environment specific values
    3. The configuration, for each defined target environment, to build from scratch or update the environment (for example create or update a WebSphere cluster and dependent container resources such as Database or JMS Providers).
  3. Configuration only package (configuration only projects)
    1. The configuration, for each defined target environment, to build from scratch or update the environment (for example create or update a WebSphere cluster and any shared resources such as Database or JMS providers).

    The name of the package is usually derived from the label or baseline created in the SCM repository during the build or continuous integration process used to build the deployable code and/or configuration.

    By default, the framework server comes with a FileSystem plugin that allows you to store deployable artifacts in a folder on the RapidDeploy framework Server. Please see the FileSystem artifact plugin data sheet for more information on this plugin.

    The Apache Maven plugin extends this functionality by allowing you to use a Maven repository to store and retrieve artifacts. The plugin will create a local maven repository on the server(s) it is running on and will download artifacts as required.

    The plugin can be set, in the project panel, to upload new artifacts to the remote repository if required.

    This plugin does not require a separate maven repository installation on the RapidDeploy framework server.

    The plugins supports authentication to remote maven repositories and connections to the maven repositories via a proxy server.

Tasks

This plugin includes the following orchestration tasks that may be run during deployment jobs.

downloadFromMavenTask

  • Prerequisites

    A folder in a filesystem on each target node where the task will run, with read/write access and sufficient space for the task to create/update a local maven Repository.

    Each target node will need network access to the remote Maven repository where the artifacts are stored.

  • Usage

    Task that allows jobs to download, directly to the remote server, artifacts and optionally their dependencies from a maven repository as part of an orchestration. This is useful where for example there is a requirement to obtain some artifacts at a particular version prior to performing some further action on them. A simple example might be downloading a jar file from a repository using the downloadFromMavenTask and then running it via a LocalScriptRunnerTask.

Attributes and parameters

List and description of all user interface plugin parameters.
List and description of all tasks and resources.