[jboss-cvs] JBossAS SVN: r86261 - in projects/jboss-osgi/trunk/build: docbook/en/images and 2 other directories.

jboss-cvs-commits at lists.jboss.org jboss-cvs-commits at lists.jboss.org
Tue Mar 24 10:34:15 EDT 2009 

Author: thomas.diesler at jboss.com
Date: 2009-03-24 10:34:15 -0400 (Tue, 24 Mar 2009)
New Revision: 86261

Added:
   projects/jboss-osgi/trunk/build/docbook/en/images/izpack-done.jpg
   projects/jboss-osgi/trunk/build/docbook/en/images/izpack-installpath.jpg
   projects/jboss-osgi/trunk/build/docbook/en/images/izpack-jboss-home.jpg
   projects/jboss-osgi/trunk/build/docbook/en/images/izpack-packs.jpg
   projects/jboss-osgi/trunk/build/docbook/en/images/izpack-structure.jpg
   projects/jboss-osgi/trunk/build/docbook/en/images/izpack-target-server.jpg
   projects/jboss-osgi/trunk/build/docbook/en/images/izpack-verify.jpg
   projects/jboss-osgi/trunk/build/docbook/en/images/izpack-welcome.jpg
Modified:
   projects/jboss-osgi/trunk/build/distribution/src/main/resources/installer/install-definition.xml
   projects/jboss-osgi/trunk/build/docbook/en/modules/gettingstarted.xml
   projects/jboss-osgi/trunk/build/docbook/en/modules/introduction.xml
   projects/jboss-osgi/trunk/build/hudson/hudson-home/config.xml
Log:
More work on userguide

Modified: projects/jboss-osgi/trunk/build/distribution/src/main/resources/installer/install-definition.xml
===================================================================
--- projects/jboss-osgi/trunk/build/distribution/src/main/resources/installer/install-definition.xml	2009-03-24 14:33:51 UTC (rev 86260)
+++ projects/jboss-osgi/trunk/build/distribution/src/main/resources/installer/install-definition.xml	2009-03-24 14:34:15 UTC (rev 86261)
@@ -86,7 +86,7 @@
     
     <pack name="JBossOSGi Distribution" required="yes">
     
-      <description>The JBossOSGi Distribution</description>
+      <description>Documentation, Binary Artifacts and Sources</description>
 
       <!-- JBossOSGi -->
       <fileset dir="@{deploy.artifacts.dir}/etc" targetdir="$INSTALL_PATH" override="true">
@@ -141,7 +141,7 @@
     
     <pack name="JBossOSGi Runtime" required="no" preselected="yes" condition="installRuntime">
     
-      <description>The JBossOSGi Runtime</description>
+      <description>Standalone JBossOSGi Runtime based on JBossAS</description>
 
       <!-- JBossOSGi Runtime -->
       <fileset dir="@{jboss.runtime.dir}" targetdir="$INSTALL_PATH/runtime" override="true"/>
@@ -181,7 +181,7 @@
     
     <pack name="JBossOSGi Integration" required="no" preselected="yes">
     
-      <description>The JBossOSGi Integration</description>
+      <description>Integration with an existing JBossAS instance</description>
 
       <!-- deployers -->
       <fileset dir="@{deploy.artifacts.dir}/etc/jboss501/server/deployers" targetdir="${jbossInstallPath}/server/${jbossTargetServer}/deployers" override="true" condition="isJBoss501">

Added: projects/jboss-osgi/trunk/build/docbook/en/images/izpack-done.jpg
===================================================================
(Binary files differ)


Property changes on: projects/jboss-osgi/trunk/build/docbook/en/images/izpack-done.jpg
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: projects/jboss-osgi/trunk/build/docbook/en/images/izpack-installpath.jpg
===================================================================
(Binary files differ)


Property changes on: projects/jboss-osgi/trunk/build/docbook/en/images/izpack-installpath.jpg
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: projects/jboss-osgi/trunk/build/docbook/en/images/izpack-jboss-home.jpg
===================================================================
(Binary files differ)


Property changes on: projects/jboss-osgi/trunk/build/docbook/en/images/izpack-jboss-home.jpg
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: projects/jboss-osgi/trunk/build/docbook/en/images/izpack-packs.jpg
===================================================================
(Binary files differ)


Property changes on: projects/jboss-osgi/trunk/build/docbook/en/images/izpack-packs.jpg
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: projects/jboss-osgi/trunk/build/docbook/en/images/izpack-structure.jpg
===================================================================
(Binary files differ)


Property changes on: projects/jboss-osgi/trunk/build/docbook/en/images/izpack-structure.jpg
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: projects/jboss-osgi/trunk/build/docbook/en/images/izpack-target-server.jpg
===================================================================
(Binary files differ)


Property changes on: projects/jboss-osgi/trunk/build/docbook/en/images/izpack-target-server.jpg
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: projects/jboss-osgi/trunk/build/docbook/en/images/izpack-verify.jpg
===================================================================
(Binary files differ)


Property changes on: projects/jboss-osgi/trunk/build/docbook/en/images/izpack-verify.jpg
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: projects/jboss-osgi/trunk/build/docbook/en/images/izpack-welcome.jpg
===================================================================
(Binary files differ)


Property changes on: projects/jboss-osgi/trunk/build/docbook/en/images/izpack-welcome.jpg
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Modified: projects/jboss-osgi/trunk/build/docbook/en/modules/gettingstarted.xml
===================================================================
--- projects/jboss-osgi/trunk/build/docbook/en/modules/gettingstarted.xml	2009-03-24 14:33:51 UTC (rev 86260)
+++ projects/jboss-osgi/trunk/build/docbook/en/modules/gettingstarted.xml	2009-03-24 14:34:15 UTC (rev 86261)
@@ -3,17 +3,165 @@
   <title>Getting Started</title>
   
   <para>This chapter takes you through the first steps of getting JBossOSGi and 
-  provides the initial pointers to get up and running in no time.</para>
+  provides the initial pointers to get up and running.</para>
   
-  <section id="Sec_Download_Install">  
+  <sect1>  
     <title>Installing JBossOSGi</title>
-  </section>
+    
+    <para>JBossOSGi is distributed as an <ulink url="http://izpack.org">IzPack</ulink> installer archive. 
+    Currently, the JBossOSGi Installer is available from the <ulink url="http://repository.jboss.org/maven2">JBoss Maven Repository</ulink>. 
+    You can download the latest version from <ulink url="http://repository.jboss.org/maven2/org/jboss/osgi/jboss-osgi-distribution">jboss-osgi-distribution</ulink> directory.
+    To run the installer execute the following command:</para>
+    
+    <note>
+      <para>TODO: Provide better download support</para>
+    </note>
+    
+    <programlisting>
+    java -jar jboss-osgi-distribution-1.0.0.Alpha3-installer.jar
+    </programlisting>
+      
+    <para>The installer first shows a welcome screen</para>
+    
+    <mediaobject>
+      <imageobject>
+        <imagedata fileref="images/izpack-welcome.jpg"/> 
+      </imageobject>
+    </mediaobject>
+    
+    <para>Then you select the installation path for the JBossOSGi distribution. This is the directory where you find the binary build artefacts,
+    the java sources, documentaion and the JBossOSGi Runtime.</para>
+    
+    <mediaobject>
+      <imageobject>
+        <imagedata fileref="images/izpack-installpath.jpg"/> 
+      </imageobject>
+    </mediaobject>
+    
+    <para>The installer contains multiple installation packs. Greyed packs are required, others are optional and can be deselected.</para>
+    
+    <mediaobject>
+      <imageobject>
+        <imagedata fileref="images/izpack-packs.jpg"/> 
+      </imageobject>
+    </mediaobject>
+
+    <itemizedlist>
+      <listitem><emphasis role="bold">JBossOSGi Distribution</emphasis> - Documentation, Binary Artifacts and Sources</listitem>
+      <listitem><emphasis role="bold">JBossOSGi Runtime</emphasis> - Standalone JBossOSGi Runtime based on JBossAS</listitem>
+      <listitem><emphasis role="bold">JBossOSGi Integration</emphasis> - Integration with an existing JBossAS instance</listitem>
+    </itemizedlist>
+    
+    
+    <para>In case you have selected 'JBossOSGi Integration', you will be presented with the choice of supported target containers.</para>
+    
+    <mediaobject>
+      <imageobject>
+        <imagedata fileref="images/izpack-target-server.jpg"/> 
+      </imageobject>
+    </mediaobject>
+    
+    <para>You will then have to point the installer to your existing <ulink url="http://http://jboss.org/jbossas">JBossAS</ulink> installation.</para>
+    
+    <mediaobject>
+      <imageobject>
+        <imagedata fileref="images/izpack-jboss-home.jpg"/> 
+      </imageobject>
+    </mediaobject>
+    
+    <para>You can then verify the selected installation options and proceed with the actual installation.</para>
+    
+    <mediaobject>
+      <imageobject>
+        <imagedata fileref="images/izpack-verify.jpg"/> 
+      </imageobject>
+    </mediaobject>
+    
+    <para>The installer reports its installation progress and finally displays a confirmation screen. You can now optionally generate
+    an "automatic installation script" that you can use when you want to repeat what you have just done without user interaction.</para>
+    
+    <mediaobject>
+      <imageobject>
+        <imagedata fileref="images/izpack-done.jpg"/> 
+      </imageobject>
+    </mediaobject>
+  </sect1>
   
-  <section>
-    <title>Project Infrastructure</title>
-    <para>The <ulink url="http://www.jboss.org/community/docs/DOC-13273">JBossOSGi Wiki</ulink> provides 
-    news, details about forums, mailing lists, issue tracker, downloads, source repositories, etc.
-    </para>
-  </section>
+  <sect1>
+    <title>JBossOSGi Runtime</title>
+    
+    <para>If you selected 'JBossOSGi Runtime' during installation you should see a <emphasis role="bold">runtime</emphasis> folder, which contains 
+    the JBossOSGi Runtime distribution.</para>
+    
+    <mediaobject>
+      <imageobject>
+        <imagedata fileref="images/izpack-structure.jpg"/> 
+      </imageobject>
+    </mediaobject>
+    
+    <para>The JBossOSGi Runtime is a customized version of the JBoss Application Server. From that we removed the services 
+    that are not absolutely necessary to run the installed OSGi Framework. Consequently, you can start the JBossOSGi Runtime in the same
+    way as you start JBossAS</para>
+    
+    <programlisting>
+    [tdiesler at tdvaio runtime]$ bin/run.sh
+    =========================================================================
+    
+      JBoss Bootstrap Environment
+    
+      JBOSS_HOME: /usr/java/jboss-osgi-1.0.0.Alpha3/runtime
+    
+      ...
+    
+    =========================================================================
+    
+    14:43:43,598 INFO  [ServerImpl] Starting JBoss (Microcontainer)...
+    ...
+    14:43:52,298 INFO  [FelixIntegration] OSGi Integration Felix - 1.0.0.Alpha3
+    14:43:52,692 INFO  [FelixIntegration] Installed bundle: org.osgi.compendium
+    14:43:52,700 INFO  [FelixIntegration] Installed bundle: org.jboss.osgi.service.logging
+    14:43:52,701 INFO  [FelixIntegration] Started bundle: org.osgi.compendium
+    14:43:52,766 INFO  [FelixIntegration] Started bundle: org.jboss.osgi.service.logging
+    14:43:53,290 INFO  [OSGiDeployer] Installed: jboss-osgi-service-webconsole [3][INSTALLED]
+    14:43:53,297 INFO  [OSGiDeployer] Installed: org.apache.felix.bundlerepository [4][INSTALLED]
+    14:43:53,308 INFO  [OSGiDeployer] Installed: org.apache.felix.configadmin [5][INSTALLED]
+    14:43:53,322 INFO  [OSGiDeployer] Installed: org.apache.felix.http.jetty [6][INSTALLED]
+    14:43:53,328 INFO  [OSGiDeployer] Installed: org.apache.felix.log [7][INSTALLED]
+    14:43:53,333 INFO  [OSGiDeployer] Installed: org.apache.felix.metatype [8][INSTALLED]
+    ...
+    14:43:55,250 INFO  [ServerImpl] JBoss (Microcontainer) [5.0.1.GA ...] Started in 11s:645ms
+    </programlisting>
+    
+    <sect2>
+      <title>Bundle Deployment</title>
+
+      <para>Bundle deployement works, as you would probably expect, by dropping your OSGi Bundle into the 
+      JBossOSGi Runtime <emphasis role="bold">deploy</emphasis> folder.</para>
+      
+      <programlisting>
+      [tdiesler at tdvaio testsuite]$ cp .../test-libs/jbosgi36-bundle.jar .../runtime/server/default/deploy
+      ...
+      15:11:50,490 INFO  [OSGiDeployer] Installed: jbosgi36 [9][INSTALLED]
+      15:11:50,491 INFO  [jbosgi36] BundleEvent INSTALLED
+      15:11:50,511 INFO  [jbosgi36] BundleEvent RESOLVED
+      15:11:50,513 INFO  [jbosgi36] ServiceEvent REGISTERED
+      15:11:50,514 INFO  [jbosgi36] BundleEvent STARTED
+      15:11:50,514 INFO  [BundleStartStopDeployer] Started: jbosgi36 [9][ACTIVE]
+      </programlisting>
+      
+      <note>
+        <para>TODO: Provide example bundles and use them here</para>
+      </note>
+      
+    </sect2>
+    
+    <sect2>
+      <title>Managing installed Bundles</title>
+      
+      <para>JBossOSGi comes with a simple Web Console 
+      integrates the <ulink url="http://felix.apache.org/site/apache-felix-web-console.html">Apache Felix Web Console</ulink>
+      project.</para>
+    </sect2>
+  </sect1>
   
 </chapter>
\ No newline at end of file

Modified: projects/jboss-osgi/trunk/build/docbook/en/modules/introduction.xml
===================================================================
--- projects/jboss-osgi/trunk/build/docbook/en/modules/introduction.xml	2009-03-24 14:33:51 UTC (rev 86260)
+++ projects/jboss-osgi/trunk/build/docbook/en/modules/introduction.xml	2009-03-24 14:34:15 UTC (rev 86261)
@@ -21,6 +21,13 @@
   
     <para>Developing on the OSGi platform means first building your application using OSGi APIs, then deploying it in an OSGi container.</para>
     
+    <para>The <ulink url="http://www.jboss.org/community/docs/DOC-13273">JBossOSGi Project</ulink> project has two distinct goals</para>
+    
+    <orderedlist>
+      <listitem>Provide an integration platform for 3rd party OSGi Frameworks</listitem>
+      <listitem>Provide an OSGi compliant framework implementation based on the <ulink url="http://www.jboss.org/jbossmc">JBoss Microcontainer</ulink></listitem>
+    </orderedlist>
+    
     <sect2>
       <title>What does OSGi offer to Java developers?</title>
       

Modified: projects/jboss-osgi/trunk/build/hudson/hudson-home/config.xml
===================================================================
--- projects/jboss-osgi/trunk/build/hudson/hudson-home/config.xml	2009-03-24 14:33:51 UTC (rev 86260)
+++ projects/jboss-osgi/trunk/build/hudson/hudson-home/config.xml	2009-03-24 14:34:15 UTC (rev 86261)
@@ -10,6 +10,7 @@
 <tr align="left"><th>Bind Addr</th><td>@jboss.bind.address@</td></tr>
 <tr align="left"><th>JavaDoc</th><td><a href='job/Container-JDK1.6/javadoc/'>SPI</a></td></tr>
 <tr align="left"><th>Userguide</th><td>
+<a href='job/Container-JDK1.6/ws/jboss-osgi/build/distribution/target/auto-install-dest/docs/userguide/pdf/JBossOSGi - Userguide.pdf'>PDF</a>&nbsp;
 <a href='job/Container-JDK1.6/ws/jboss-osgi/build/distribution/target/auto-install-dest/docs/userguide/html/index.html'>HTML</a>&nbsp;
 <a href='job/Container-JDK1.6/ws/jboss-osgi/build/distribution/target/auto-install-dest/docs/userguide/html_single/index.html'>HTML-Single</a>&nbsp;
 </td></tr>

More information about the jboss-cvs-commits mailing list