Back to Top

Apache Install - Apt/Yum Package (Linux)

Class Name com.midvision.rapiddeploy.orchestration.tasks.binary.apache.LinuxInstallerTask
Category Apache Web Server

Apache Install using Linux Package installer.

Description

This task installs the APACHE binary files on Linux from the package management repositories for each Linux platform.

Usage

The task will determine which package installer is available for the platform.
yum will be used on Red Hat and Centos.
apt-get will be used on Ubuntu.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
outputParameter java.lang.String ${installerOutput} false The name of the output parameter, which holds the text string output from the task. The output will be the result of the 'apt-get/yum' command on the platform. Typically this will be blank if the user creation succeeds. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (later tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${installerOutput}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sudoPassword java.lang.String   true The sudo password, if required, to run the install through sudo. Only required if non-root user requiring sudo password.
verbose java.lang.Boolean false true Verbose mode. Equivalent to the -v/-V option.

Back to Top

Apache Install - Binary Disribution

Class Name com.midvision.rapiddeploy.orchestration.tasks.binary.apache.BinaryInstallTask
Category Apache Web Server

Apache install from binary distribution in the deployment package.

Description

This task install the APACHE binary files from the deployment archive on to the server.
PLEASE NOTE: If you use a zip file, it must contain compiled binaries for the target server architecture.

Alternatively, on Linux systems you can use the Yum Installer or Apt-Get installer options.

Usage

The deployment archive should contain a directory or zip file containing the apache files. This will be deployed to the installationPath on the target server.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
installationPath java.lang.String @@installationPath@@ true The top level directory of the Apache installation.
installerFileRegEx java.lang.String (?i)http true The regular expression to filter the files within deployment package and look up the installer one.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

Apache Install - Msi Package (Windows)

Class Name com.midvision.rapiddeploy.orchestration.tasks.binary.apache.ApacheMsiInstallerTask
Category Apache Web Server

Apache Install using Msi Installer

Description

This task install (or uninstall) the APACHE binaries on windows platforms using an msi package.

Usage

Will find any msi packages in the deployment archive (with an msi file extension) and install them.
Please see: Apache Documentation for parameters that may be passed to the installer.

Task Entries

This task is able to handle Environment Variables that you can specify as a task entries with type "VARIABLE"

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
allUsers java.lang.Boolean true true When set to true, the installation is available for all users.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
installationPath java.lang.String @@installationPath@@ false The top level directory of the Apache installation to create.
installerFileRegEx java.lang.String .*\.[Mm][Ss][Ii]$ true The regular expression to filter the files within deployment package and look up the installer one.
mode java.lang.Boolean true false The install mode. One of [true=install|false=uninstall]. Default value: [install]
serverAdmin java.lang.String administrator@mydomain.com true Server Admin email address.
serverDomain java.lang.String mydomain.com true Server Domain of the Apache Service.
serverName java.lang.String myserver true Server Name of the Apache Service.
serverPort java.lang.Integer 83 true Server Port for the Apache Service.
serviceName java.lang.String Apache2.2 false The Windows Service Name.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.

Back to Top

Apache Uninstall - Apt/Yum Package (Linux)

Class Name com.midvision.rapiddeploy.orchestration.tasks.binary.apache.LinuxUnInstallerTask
Category Apache Web Server

Apache uninstall using Linux Package installer.

Description

This task uninstalls APACHE files on Linux.

Usage

The task will determine which package installer is available for the platform.
yum will be used on Red Hat and Centos.
apt-get will be used on Ubuntu.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
outputParameter java.lang.String ${uninstallerOutput} false The name of the output parameter, which holds the text string output from the task. The output will be the result of the 'apt-get/yum' command on the platform. Typically this will be blank if the user creation succeeds. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (later tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${uninstallerOutput}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sudoPassword java.lang.String   true The sudo password, if required, to run the uninstall through sudo. Only required if non-root user requiring sudo password.
verbose java.lang.Boolean false true Verbose mode. Equivalent to the -v/-V option.

Back to Top

Deploy Apache Configuration

Class Name com.midvision.rapiddeploy.orchestration.tasks.apache.DeployConfigurationTask
Category Apache Web Server

Apache Deploy Configuration Task.

Description

This task deploys all the configuration contained within the deployment archive template into the Apache server. It copies the files into the following location: installationPath specified in parameters. Primarily this will be httpd.conf files that may be renamed according to the target.

Data Dictionary and Example

All variables in files under the templateDirectoryRelativePath that match the pattern @@VARIABLE_NAME@@ will be replaced in the target in-situ environment with the corresponding value from the data dictionary.

For example if an httpd.conf file in the template has: 
                     			ServerRoot "@@APACHE_SERVER_ROOT@@"
and the data dictionary value at target scope is "/usr/apps/apache" 
                     			@@APACHE_SERVER_ROOT@@=/usr/apps/apache
then at deployment time the httpd.conf will be deployed with 
                     			ServerRoot "/usr/apps/apache"

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
installationPath java.lang.String @@installationPath@@ false The top level directory of the Apache installation.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
templateDirectoryRelativePath java.lang.String apache/TEMPLATE false This is the relative path to the configuration files within the deployment archive to copy onto the Tomcat server.

Back to Top

Snapshot Apache Server

Class Name com.midvision.rapiddeploy.orchestration.tasks.apache.SnapshotTask
Category Apache Web Server

Create a snapshot of an Apache server

Description

This task creates a snapshot ZIP file of an Apache instance consisting on the specified included and excluded configuration files of the Apache installation location.

Usage

Using ANT fileset patterns set the included and excluded configuration files you want to be into the snapshot ZIP file.
By default the snapshot file will be saved in the RapidDeploy server in the location specified in the field 'Snapshots Path' of the environment configuration panel. If you want to use a different location (not recommended) you can set it using the 'snapshotDirectory' parameter.
If you select to save the snapshot file in the target server ('saveOnTarget') you need to specify the 'snapshotDirectory' parameter with the location in the target server where you want to save the snapshot file.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
binaryFilesetExcludes java.lang.String **/* true ANT based comma separated fileset patterns to exclude in a snapshot.
binaryFilesetIncludes java.lang.String   true ANT based comma separated fileset patterns to include in a snapshot.
configFilesetExcludes java.lang.String **/*.log, **/*.jar, **/*.war, **/*.rar true ANT based comma separated fileset patterns to exclude in a snapshot.
configFilesetIncludes java.lang.String **/*.conf true ANT based comma separated fileset patterns to include in a snapshot.
downloadBinaries java.lang.Boolean false true When set to true, the binaries filtered by the 'binaryFilesetIncludes' and 'binaryFilesetExcludes' parameters will be downloaded as part of the snapshot.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
installationPath java.lang.String @@installationPath@@ false The top level directory of the Apache installation. The ANT fileset patterns will be used to select files recursively below this directory to include in a snapshot.
rapiddeployUrl java.lang.String   true The URL of the RapidDeploy server that performs the call to the target server. This URL needs to be complete, including port and context path, e.g.: http://localhost:8080/MidVision. This parameter is used to send back the snapshot file to the host server running the RapidDeploy web application. It does NOT need to be set in most cases.
saveOnTarget java.lang.Boolean false true If set to 'true' the snapshot file will be saved in the target server and not sent back to the RapidDeploy server. This option is not recommended as RapidDeploy can not keep track of the snapshots taken and the snapshot comparison feature can not be used.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
snapshotDirectory java.lang.String   true The directory location where the snapshots should be stored. This option should be used only when 'saveOnTarget' is set to 'true' or if you want to set a specific snapshot location on the RapidDeploy server (not recommended).

Back to Top

Start Apache Server

Class Name com.midvision.rapiddeploy.orchestration.tasks.apache.StartApacheTask
Category Apache Web Server

Task to start an Apache instance.

Table of task Parameters

Name Type Default Value Optional Description
confFile java.lang.String   true httpd.conf File location. By default will use /etc/httpd/conf/httpd.conf on Linux.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
outputParameter java.lang.String ${apacheOutput} false The name of the output parameter, which holds the text string output from the task. The output will be the result of the 'start' command on the platform. Typically this will be blank if the user start succeeds. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (later tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${apacheOutput}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sudoPassword java.lang.String   true The sudo password, if required, to run the command through sudo. Only required if non-root user requiring sudo password.

Back to Top

Stop Apache Server

Class Name com.midvision.rapiddeploy.orchestration.tasks.apache.StopApacheTask
Category Apache Web Server

Task to stop an Apache instance.

Table of task Parameters

Name Type Default Value Optional Description
confFile java.lang.String   true httpd.conf File location. By default will use /etc/httpd/conf/httpd.conf on Linux.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
outputParameter java.lang.String ${apacheOutput} false The name of the output parameter, which holds the text string output from the task. The output will be the result of the 'stop' command on the platform. Typically this will be blank if the user stop succeeds. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (later tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${apacheOutput}.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sudoPassword java.lang.String   true The sudo password, if required, to run the command through sudo. Only required if non-root user requiring sudo password.