|
|
| Home > Apache Geronimo v1.0 > Documentation > Apache Geronimo v1.0 - User's Guide > Deployment > Deployer tool |
The deployer application is a Java application that manages J2EE artifacts and GBean components in the Geronimo server. If the server is running, it will connect to the server and perform its action through the server's deployment service. If it cannot find a running server, it will manage the configuration it finds in its own installation directory.
The deployment tool is started by using the java -jar to invoke the main class in <geronimo_home>/bin/deployer.jar.
Typically, the deployment tool is started using the deploy script, but you can also run the application by starting a Java virtual machine using the following syntax:
java -jar deployer.jar <general_options> <command> <command_options>
where <general_options> specify common options that apply to all commands and control how the application behaves, <command> is a command name that specifies the action to be performed, and <command_options> are options unique to the command specified.
This section lists all the available general options for the Geronimo deployer tool.
The available commands for the Geronimo deployer tool are listed below:
Additionally, you can type help for further details on a given command, the syntax is as follows:
java -jar deployer.jar help <commands>
Use the deploy command to add and start a new module. The deploy command has the following syntax:
java -jar deployer.jar <general_options> deploy <module> <deployment_plan>
The most common <general_options> would be --user and --password.
The <module> specifies the application file name and location. The <deployment_plan> specifies the file name and location of the XML with the deployment plan. Sometimes the application module already has included in the package a deployment plan or the application is so simple that does not require any deployment plan, in these cases this parameter can be omited.
A module file can be one of the following:
If the server is not currently running at the time of deploying the application, the module will be marked to start next time the server is started.
Use the redeploy command to stop, replace and restart a module that has been deployed before. The redeploy command has the following syntax:
java -jar deployer.jar <general_options> redeploy <module> <deployment_plan>
Just like the deploy command, the redeploy command accepts the following modules file types:
Typically, both a module and a plan are specified. If the module contains a plan or if a default plan can be used, the plan can be omitted. However, if a plan is specified in this case, it overrides the other plans. If the plan references a server component already deployed in the server's environment, the module is omitted.
Use the start command to start a previously deployed module. The start command has the following syntax:
java -jar deployer.jar <general_options> start <moduleIDs>
Where <moduleIDs> is a list of one or more modules (configID) separated by blank space. The module identification (or ConfigID) is defined at deployment time in the respective deployment plan for each module previously deployed.
Use the stop command to stop a running module. The stop command has the following syntax:
java -jar deployer.jar <general_options> stop <moduleIDs>
Where <moduleIDs> is a list of one or more modules (configID) separated by blank space. The module identification (or ConfigID) is defined at deployment time in the respective deployment plan for each module previously deployed.
Use the undeploy command to stop and remove a module (running or not) and its deployment information from the server. The undeploy command has the following syntax:
java -jar deployer.jar <general_options> undeploy <moduleIDs>
Where <moduleIDs> is a list of one or more modules (configID) separated by blank space. The module identification (or ConfigID) is defined at deployment time in the respective deployment plan for each module previously deployed.
Use the distribute command to add a new module to the server. This command does not start the module nor mark it to be started in the future. The distribute command has the following syntax:
java -jar deployer.jar <general_options> distribute <module> <deployment_plan>
Just like with the deploy command, <module> specifies the application file name and location. The <deployment_plan> specifies the file name and location of the XML with the deployment plan. Sometimes the application module already has included in the package a deployment plan or the application is so simple that does not require any deployment plan, in these cases this parameter can be omited.
A module file can be one of the following:
Use the list-modules command to list all available modules on the server, note that for running this command the server must be runnning. The list-modules command has the following syntax:
java -jar deployer.jar <general_options> list-modules [--all|--started|--stopped]
Use the list-targets command to lists the targets known to the server you have connected to. The list-targets command has the following syntax:
java -jar deployer.jar <general_options> list-targets
In the case of Geronimo, each configuration store is a separate target. Geronimo does not yet support clusters as targets.
Use the package command to create a configuration JAR file rather than installing into the server environment. The package command has the following syntax:
java -jar deployer.jar <general_options> package [--classPath path] [--mainClass class] [--install] <module> <deployment_plan> fileName
The optional --classPath argument specifies a Class-Path to include in the JAR manifest. The optional --mainClass argument specifies the Main-Class to include in the JAR manifest. The --install option specifies that the configuration should be build into a JAR and also installed into the server configuration (otherwise it is packaged but not installed). The fileName argument specifies the JAR to create.
