Date: 2004-02-12T12:43:48
Editor: 209.233.18.245 <>
Wiki: Apache Geronimo Wiki
Page: BuildingAndRunning
URL: http://wiki.apache.org/geronimo/BuildingAndRunning
no comment
Change Log:
------------------------------------------------------------------------------
@@ -10,6 +10,23 @@
----
+= For the impatient ... =
+
+Assuming you have Maven 1.0-RC1 installed.
+{{{
+$ cvs -qz3 -d:pserver:[EMAIL PROTECTED]:/home/cvspublic co incubator-geronimo
+$ cd incubator-geronimo
+$ cvs -qz3 update -dP
+$ maven plugins
+$ maven
+$ cd assembly
+$ maven
+$ java -Dgeronimo.base.dir=target -jar target/bin/server.jar
target/config-store org/apache/geronimo/System org/apache/geronimo/Server
+}}}
+
+You should check back here occasionally as things may well change.
+----
+
= New To Maven? =
You don't build this project with Ant (directly), you build it with Maven.
Maven manages downloading all the external dependencies for you, as well as
handling the large number of modules to build and then creating one
consolidated Geronimo build based on that.
@@ -50,8 +67,7 @@
= Building Offline =
If you're not online (so Maven fails to download), use the -o flag to maven
(i.e. run `maven -o`).
-----
-`??maven -o seems to be not working ??`
+
= Bypassing Tests =
If you don't want to run test at all, try adding `-Dmaven.test.skip=true` to
your maven command line.
@@ -77,17 +93,36 @@
= Running The Server =
== For HEAD revision: ==
-(Jan 29, 2004) Deploying and running applications is now a multi step
process. There is a maven plugin to help with the needed tasks. The current
examples are in the assembly directory, and there are maven goals to run each
step. Currently only gbean packages can be reliably deployed, although we
expect this to change rapidly.
+(Feb 12, 2004) Deployment is still changing but hopefully is a little less
fraught than it has been for the last couple of weeks. There is a now a
standalone deployer (bin/deploy.jar) that is a front-end to a GBean based
deployment system. Currently there is a GBean deployer but work is going on to
move the WAR and RAR deployers over.
-1. Prepare your package. For gbean packages this should be a jar or zip file
with class jars at the root and a META-INF/geronimo-service.xml file. The
class jars need to be listed in <path> elements in geronimo-service.xml.
Geronimo modules can include dependency jars in the package by including
<package>true</package> in the dependency's property section. Packages are
built automatically for geronimo modules with a
src/etc/META-INF/geronimo-service.xml file.
+Configurations are pre-built for the Geronimo server.
-2. Deploy your package singly or in combination with other packages. This
converts whatever you are deploying into the gbeans that will exist on the
running Geronimo server and serializes the persistent GBean state and the
classes needed into a .car (configuration archive). There is a maven plugin
task def to help with this. An example is the assembly deploy:server goal
which deploys a geronimo server. (It should have pretty much everything we have
working in it).
+||Config ID||Purpose||
+||org/apache/geronimo/System||Critical services for all server configurations||
+||org/apache/geronimo/Server||Normal server configuration||
-3. Install your configuration archive into a servers local configuration
store. This informs the server that the configuration exists and indexes it.
There is a maven plugin task to help with this. An example is the assembly
install:server goal which installs the configuration constructed in (1).
+To run these use the `server.jar` command:
+{{{
+$ cd assembly/target
+$ java -Dgeronimo.base.dir=. -jar bin/server.jar config-store
org/apache/geronimo/System org/apache/geronimo/Server
+}}}
+
+To stop the server use ctrl-C or an equivilent; a proper shutdown command will
be made available when the deployment includes the remoting framework.
+
+The deployer uses an XML deployment plan to figure out what to do. Ultimately
this will be produced by a JSR-88 tool but for now an XML aware text editor is
the best choice. The deployer uses the namespace of this file to select an
appropriate builder.
-4. Start a server with a particular configuration. This can be done from
maven in-vm using the load or loadAndWait tasks, examples being load:server
and loadAndWait:server, or in a separate vm, examples being run:server and
debug:server.
+||Namespace||Schema file||Root Element||Type||
+||http://geronimo.apache.org/xml/ns/deployment||geronimo-config.xsd||configuration||GBean
configuration||
+
+You can find the schema files in ${geronimo.base.dir}/schema
+
+To deploy a new configuation use the `deploy.jar` command:
+{{{
+$ cd assembly/target
+$ java -Dgeronimo.base.dir=. -jar bin/deploy.jar --install --plan
<your-plan>.xml --store config-store --deployer
org/apache/geronimo/ServiceDeployer
+}}}
-There is also a "do it all" deployinstallrun goal.
+The need to define the store and deployer will be removed soon when the WAR
and RAR deployers have been converted. You should also only run this with the
server stopped - online deployment will be available soon when default
deployment includes the remoting layer.
== For the legacy last_geronimombean tagged copy: ==
Once you've downloaded the source code, installed Maven and built the server,
type `maven run:main` to run the server.
@@ -96,7 +131,7 @@
= Accessing The Geronimo-Web-Console =
-Enter http://localhost:8080/geronimo-web-console to access the JMX Agent View.
+Enter http://localhost:8080/geronimo-web-console to access the JMX Debug
Application.
= Cleaning your workspace =
