You are viewing a plain text version of this content. The canonical link for it is here.
Posted to pluto-scm@portals.apache.org by dd...@apache.org on 2006/12/14 03:07:27 UTC
svn commit: r486928 -
/portals/pluto/trunk/pluto-site/src/site/xdoc/v11/deploying.xml
Author: ddewolf
Date: Wed Dec 13 18:07:26 2006
New Revision: 486928
URL: http://svn.apache.org/viewvc?view=rev&rev=486928
Log:
Updating deployment docs to reflect recent changes
Modified:
portals/pluto/trunk/pluto-site/src/site/xdoc/v11/deploying.xml
Modified: portals/pluto/trunk/pluto-site/src/site/xdoc/v11/deploying.xml
URL: http://svn.apache.org/viewvc/portals/pluto/trunk/pluto-site/src/site/xdoc/v11/deploying.xml?view=diff&rev=486928&r1=486927&r2=486928
==============================================================================
--- portals/pluto/trunk/pluto-site/src/site/xdoc/v11/deploying.xml (original)
+++ portals/pluto/trunk/pluto-site/src/site/xdoc/v11/deploying.xml Wed Dec 13 18:07:26 2006
@@ -30,7 +30,7 @@
<section name="Deploying Portlet to Pluto Portal">
<p>
- There are 3 steps to deploy a portlet to Pluto 1.1:
+ There are 2 involved in deploying a portlet application Pluto 1.1:
<ul>
<li>
<b>Assembly</b>: All portlet applications must be run through the
@@ -46,25 +46,13 @@
application is running. The current binary distribution uses
Tomcat 5.5 as the servlet engine.
</li>
- <li>
- <b>Publishing</b>: All portlet applications that are to be used
- within the Pluto Portal must be published to the Portal. Publishing
- notifies the Portal Application that a portlet application is bound
- (deployed) to a certain context within the appserver. This is done
- by adding records to <code>pluto-portal-driver-config.xml</code>.
- </li>
</ul>
</p>
- <subsection name="Portlet Assembly and Deployment using Maven 2">
+ <subsection name="Portlet Assembly">
<p>
- As of the second beta release of Pluto 1.1, the Maven 2 plugins for assembly and
- deployment are partially completed.
- Right now the maven-pluto-plugin correctly assembles the war with
- the proper <code>PortletServlet</code> records to web.xml, but the
- deployment plugin is not yet completed. We have created an example
- <!-- TODO: Review use of the word deploys -->
- Maven 2 pom.xml below that correctly assembles and deploys the portlet.
+ The maven-pluto-plugin can be used to assemble a portlet application war.
+ It will place the proper <code>PortletServlet</code> configuration in web.xml.
</p>
<p>
The custom Maven 2 build shown below also deploys
@@ -72,7 +60,7 @@
artifactId with an xml extension (e.g. HelloWorldPortlet.xml).
</p>
<p>
- To properly assemble and deploy your portlet using the Maven 2 script (pom.xml) below,
+ To properly assemble your portlet using the Maven 2 plugin,
your project's directory structure and artifact placement must conform to Maven's standard:
</p>
<p>
@@ -107,9 +95,8 @@
]]></source>
</p>
<p>
- The Maven 2 pom file (pom.xml) is what defines the build. Our example overrides
- the integration-test lifecycle phase in addition to using the maven-pluto-plugin
- to assemble the war. Use this as you pom file, changing the groupId, artifactId and version
+ To configure the maven-pluto-plugin, you must configure it in your pom.
+ For easy of setup, use this as you pom file, changing the groupId, artifactId and version
to values appropriate to your custom portlet.
<source><![CDATA[
<project xmlns="http://maven.apache.org/POM/4.0.0"
@@ -128,9 +115,9 @@
<!-- Dependency Version Properties ======================================= -->
<properties>
<!-- Change this for a new Pluto version -->
- <pluto.version>1.1.0-beta2</pluto.version>
+ <pluto.version>1.1.0</pluto.version>
<portlet-api.version>1.0</portlet-api.version>
- <servlet-api.version>2.3</servlet-api.version>
+ <servlet-api.version>2.4</servlet-api.version>
<jsp-api.version>2.0</jsp-api.version>
<junit.version>3.8.1</junit.version>
</properties>
@@ -185,46 +172,6 @@
</execution>
</executions>
</plugin>
- <plugin>
- <!-- Override the 'integration-test' lifecycle phase
- with a custom one that runs a simple Ant script -->
- <artifactId>maven-antrun-plugin</artifactId>
- <executions>
- <execution>
- <phase>integration-test</phase>
- <configuration>
- <tasks>
- <!-- Set tomcat.home to CATALINA_HOME environmental variable
- Use this to skip -Dpluto.home=/path/to/pluto on command line -->
- <property environment="env"/>
- <property name="pluto.home" value="${env.CATALINA_HOME}"/>
- <echo message="pluto.home=${pluto.home}"/>
- <!-- Remove former deployment because sometimes
- tomcat does not fully redeploy a war -->
- <delete
- dir="${pluto.home}/webapps/${pom.name}"
- failonerror="true"
- />
- <!-- Deploy war file -->
- <copy
- file="${project.build.directory}/${pom.name}.war"
- todir="${pluto.home}/PlutoDomain"
- overwrite="true"
- />
- <!-- Deploy context deployment descriptor for Tomcat -->
- <copy
- file="${basedir}/src/main/resources/${pom.name}.xml"
- todir="${pluto.home}/conf/Catalina/localhost"
- overwrite="false"
- />
- </tasks>
- </configuration>
- <goals>
- <goal>run</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
</plugins>
</build>
@@ -232,51 +179,36 @@
]]></source>
</p>
<p>
- Run the Maven 2 pom.xml script using 'mvn integration-test -Dpluto.home=/path/to/pluto1.1install'
- from the command line to create the war with web.xml modified for deployment to
- Pluto-1.1 and deploy it to a local install of Pluto-1.1.
- The embedded Ant script in the pom.xml was created to use the environmental variable
- CATALINA_HOME as the value of pluto.home.
- If you have set CATALINA_HOME to your Pluto-1.1 install, then you can just run
- the command 'mvn integration-test'.
- </p>
- <p>
- If you prefer to manually deploy the war to Tomcat, run 'mvn package' which will
- create the war file in the <code>target/</code> directory. Then manually deploy
- the war file and Tomcat context deployment descriptor to your Pluto-1.1 install.
+ Once configured, the war generated by an 'mvn package' (or install) will contain
+ the appropriate pluto configuration.
</p>
</subsection>
+
+ <subsection name="Portlet Deployment">
+ <p>
+ To deploy a portlet application, simply deploy the application war
+ using any standard mechanism for your application server. There are many
+ maven plugins and ant tasks that can assist with this, or you can use
+ a manager web interface. How to deploy to your application sever is
+ beyond the scope of this document.
+ </p>
+ </subsection>
<subsection name="Portlet Publishing">
<p>
- Currently, as of Pluto-1.1-beta2, the only way to publish an application to the portal
- is to manually update the Portal's configuration file <code>pluto-portal-driver-config.xml</code>
- located in the WEB-INF directory of the pluto webapp.
- Here's how to do it:
+ As soon as the portlet application (war) is deployed to the servlet container
+ the portlet application will be available to the portal and can be added to
+ pages using the page administration portlet.
</p>
- <p><b>Step 1: Portlet App Config</b></p>
+ <p><b>Portal Page Configuration</b></p>
<p>
- First, add a <code>portlet-app</code> config element to
- notify the Portal which portlet application is deployed to the
- appserver (Tomcat). In this element, you should specify the context path of
- your portlet app, as well as the names of portlets deployed. Here is
- an example:
- <source><![CDATA[
-<portlet-app>
- <context-path>/your_portlet_app_context_path</context-path>
- <portlets>
- <portlet name="your_portlet_1"/>
- <portlet name="your_portlet_2"/>
- ... ...
- </portlets>
-</portlet-app>
- ]]></source>
+ If you'd like for your page configuration to be consistent throughout
+ restarts of the application server (currently placements made through
+ the portlets are not persistent), you should then configure the page
+ layout in the portal-driver configuration file.
</p>
-
- <p><b>Step 2: Portal Page Config</b></p>
<p>
- You should then configure a portal page to display your portlets.
Do this by adding a <code>page</code> element in the <code>render-config</code>
element, like this:
<source><![CDATA[