[jboss-cvs] JBossAS SVN: r95732 - in projects/ejb3/trunk/package-manager/docs/guide/en: modules and 1 other directory.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Thu Oct 29 04:10:23 EDT 2009
Author: jaikiran
Date: 2009-10-29 04:10:23 -0400 (Thu, 29 Oct 2009)
New Revision: 95732
Added:
projects/ejb3/trunk/package-manager/docs/guide/en/modules/package-manager-database.xml
Modified:
projects/ejb3/trunk/package-manager/docs/guide/en/master.xml
projects/ejb3/trunk/package-manager/docs/guide/en/modules/components.xml
projects/ejb3/trunk/package-manager/docs/guide/en/modules/status.xml
Log:
EJBTHREE-1942 Docs for package manager updated
Modified: projects/ejb3/trunk/package-manager/docs/guide/en/master.xml
===================================================================
--- projects/ejb3/trunk/package-manager/docs/guide/en/master.xml 2009-10-29 06:57:36 UTC (rev 95731)
+++ projects/ejb3/trunk/package-manager/docs/guide/en/master.xml 2009-10-29 08:10:23 UTC (rev 95732)
@@ -5,6 +5,7 @@
<!ENTITY overview SYSTEM "modules/overview.xml">
<!ENTITY components SYSTEM "modules/components.xml">
<!ENTITY ivyDepMgr SYSTEM "modules/ivy-dep-manager.xml">
+<!ENTITY packageManagerDB SYSTEM "modules/package-manager-database.xml">
<!ENTITY status SYSTEM "modules/status.xml">
]>
<book lang="en">
@@ -23,5 +24,6 @@
&overview;
&components;
&ivyDepMgr;
+ &packageManagerDB;
&status;
</book>
\ No newline at end of file
Modified: projects/ejb3/trunk/package-manager/docs/guide/en/modules/components.xml
===================================================================
--- projects/ejb3/trunk/package-manager/docs/guide/en/modules/components.xml 2009-10-29 06:57:36 UTC (rev 95731)
+++ projects/ejb3/trunk/package-manager/docs/guide/en/modules/components.xml 2009-10-29 08:10:23 UTC (rev 95732)
@@ -714,6 +714,24 @@
</tbody>
<tbody>
<row>
+ <entry>-u</entry>
+ <entry>The -u option can be used to upgrade a package.
+ When the -u option is used, it expects the path to the package to be specified too.
+ See later section on what the valid values for path are.
+ </entry>
+ </row>
+ </tbody>
+ <tbody>
+ <row>
+ <entry>-r</entry>
+ <entry>The -r option can be used to remove/uninstall a package.
+ When the -r option is used, it expects the name of the already installed package to
+ be specified.
+ </entry>
+ </row>
+ </tbody>
+ <tbody>
+ <row>
<entry>-p</entry>
<entry>This option right now is mandatory and it points to
the JBoss Package Manager home folder. The JBoss Package Manager folder can be
@@ -754,15 +772,48 @@
can handle file:// protocol and http:// protocols. So the JBoss Package Manager, in it's current
form is able to work on package available either on the file system or through an HTTP URL.
</para>
+ <para>
+ If a package with the same package name is already installed in the system, then this new installation
+ will not be allowed. The package manager will throw an error indicating the presence of an already
+ installed package with the same name. In situations like this, you might want to consider using the
+ upgrade option of the package manager. The details of upgrading a package will be discussed in later
+ sections.
+ </para>
</sect2>
<sect2>
<title>Removing a Package</title>
<para>
- This is still work-in-progress. Details will be added soon.
+ An already installed package can be removed by using the -r argument to the package manager. The -r option
+ should be followed by the name of the package which is already installed. The package manager will look
+ for the installed package by this name and if not found, will throw back an error. If the package with
+ this name is found to be installed, the package will be removed.
</para>
+ <para>
+ Removing a package from a system, includes the process of removing any files that were installed during
+ the installation of the package. Any pre/post uninstall scripts, corresponding to this package being removed,
+ will also be run.
+ <important>
+ <para>
+ Uninstalling a package will NOT uninstall the dependencies. For example, if a package ABC was
+ installed along with its dependency packages XYZ and PQR, then during the uninstallation of
+ package ABC, neither XYZ nor PQR will be uninstalled.
+ </para>
+ </important>
+ <note>
+
+ <para>
+ TODO: How and where do we keep the pre/post uninstall scripts? Because during uninstall, we will
+ not have access to the original package contents.
+ </para>
+ </note>
+ </para>
+ <para>
+ Also note that, if there are other packages which are dependent on the package ABC being uninstalled,
+ then such package ABC will not be uninstalled.
+ </para>
</sect2>
<sect2>
- <title>Updating a Package</title>
+ <title>Upgrading a Package</title>
<para>
This is still work-in-progress. Details will be added soon.
</para>
Added: projects/ejb3/trunk/package-manager/docs/guide/en/modules/package-manager-database.xml
===================================================================
--- projects/ejb3/trunk/package-manager/docs/guide/en/modules/package-manager-database.xml (rev 0)
+++ projects/ejb3/trunk/package-manager/docs/guide/en/modules/package-manager-database.xml 2009-10-29 08:10:23 UTC (rev 95732)
@@ -0,0 +1,70 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!--
+ ~ JBoss, Home of Professional Open Source
+ ~ Copyright 2005, JBoss Inc., and individual contributors as indicated
+ ~ by the @authors tag. See the copyright.txt in the distribution for a
+ ~ full listing of individual contributors.
+ ~
+ ~ This is free software; you can redistribute it and/or modify it
+ ~ under the terms of the GNU Lesser General Public License as
+ ~ published by the Free Software Foundation; either version 2.1 of
+ ~ the License, or (at your option) any later version.
+ ~
+ ~ This software is distributed in the hope that it will be useful,
+ ~ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ ~ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ ~ Lesser General Public License for more details.
+ ~
+ ~ You should have received a copy of the GNU Lesser General Public
+ ~ License along with this software; if not, write to the Free
+ ~ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ ~ 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ -->
+<chapter id="packagemanager_db">
+ <title>JBoss Package Manager Database</title>
+ <para>
+ In order to keep track of the packages that have been installed in the system (i.e. JBoss Application Server), the
+ package manager maintains a database.
+ </para>
+ <sect1>
+ <title>Implementation Details</title>
+ <para>
+ This section provides a brief overview of the implementation details about the package manager database. Normal
+ users of the package manager may skip this section. But if you are interested in knowing some of the implementation
+ details, then read on!
+ </para>
+ <sect2>
+ <title>Database server</title>
+ <para>
+ The default implementation of the package manager uses Derby Embedded database. Derby Embedded database allows
+ for the database to created and managed from within another Java application. One of the goals of the package manager
+ is to reduce the additional software installations, for using the package manager. Derby fits in, because it
+ does not require the DB server to be installed or started externally.
+ <note>
+ <para>
+ At this point, there's no way to configure a different DB server to be used with the JBoss Package Manager.
+ There are no immediate plans to allow this either. But if in future, this feature is required, then
+ it should be easy enough to provide it.
+ </para>
+ </note>
+ </para>
+ <para>
+ Furthermore, the package manager implementation uses JPA (Java Persistence API) for it's interaction with the
+ database.
+ </para>
+
+ </sect2>
+
+ <sect2>
+ <title>Schema</title>
+ <para>
+ <note>
+ <para>
+ TODO: This section will be updated soon, with the schema diagram.
+ </para>
+ </note>
+ </para>
+ </sect2>
+
+ </sect1>
+</chapter>
Modified: projects/ejb3/trunk/package-manager/docs/guide/en/modules/status.xml
===================================================================
--- projects/ejb3/trunk/package-manager/docs/guide/en/modules/status.xml 2009-10-29 06:57:36 UTC (rev 95731)
+++ projects/ejb3/trunk/package-manager/docs/guide/en/modules/status.xml 2009-10-29 08:10:23 UTC (rev 95732)
@@ -34,21 +34,6 @@
<itemizedlist>
<listitem>
<para>
- Dependency Management implementation through Ivy
- </para>
- </listitem>
- <listitem>
- <para>
- A simple database management which allows for maintaining/tracking installed package information
- </para>
- </listitem>
- <listitem>
- <para>
- Update/Remove(Un-Install) features
- </para>
- </listitem>
- <listitem>
- <para>
Diff/Merging of configuration files and maybe checksum comparisons on files being installed
</para>
</listitem>
@@ -74,6 +59,9 @@
and the functionality. The test is named org.jboss.ejb3.packagemanager.test.dependency.unit.DependencyInstallTestCase.
</para>
<para>
+ For tests around remove/uninstall functionality, have a look at org.jboss.ejb3.packagemanager.test.uninstall.unit.UnInstallTestCase.
+ </para>
+ <para>
To run the tests, use the following Maven command on the package-manager project root:
<programlisting>
<![CDATA[
More information about the jboss-cvs-commits
mailing list