Author: marrs
Date: Wed Feb 8 22:52:06 2012
New Revision: 1242161
URL: http://svn.apache.org/viewvc?rev=1242161&view=rev
Log:
New pages.
Added:
ace/site/trunk/content/user-doc/getting-started.mdtext
ace/site/trunk/content/user-doc/introduction.mdtext
Added: ace/site/trunk/content/user-doc/getting-started.mdtext
URL:
http://svn.apache.org/viewvc/ace/site/trunk/content/user-doc/getting-started.mdtext?rev=1242161&view=auto
==============================================================================
--- ace/site/trunk/content/user-doc/getting-started.mdtext (added)
+++ ace/site/trunk/content/user-doc/getting-started.mdtext Wed Feb 8 22:52:06
2012
@@ -0,0 +1,31 @@
+Title: Getting Started
+
+This guide shows the core functionality of ACE, organizing bundles and other
artifacts into logical features and distributions and associating those with
specific targets, all done using a convenient web interface.
+
+Using Apache ACE
+----------------
+
+
+The following steps can be followed to get started:
+
+1. First we need to actually checkout and [build ACE|Maven Build]. Follow the
link to get more information on how to do that.
+1. Once ACE is built, we can start the server with integrated Web UI. Go to
{{ace-target-devserver/target/org.apache.ace.target.devserver-*-distribution/ace-devserver}}.
Start it using the `run.sh` or `run.bat` file.
+1. Now the server is started, let's connect to it. Launch a browser and point
it to: http://localhost:8080/ace/ You should now be greeted with a login
prompt. Log in with user "d" password "f" and you should see a view with 4
empty columns and some buttons at the top of the screen.
+1. Click on 'Retrieve' to get the initial version of the repository. It will
look as if nothing's happened, but you have now in fact retrieved the first,
empty version of the repository and can start manipulating it. Once you're
happy with it, you can commit it back (which we'll do a bit later).
+1. Upload some sample bundles into the artifacts column by first clicking the
'Add Artifact...' button. In the dialog that appears, you can upload a bundle
using the 'Upload' button in the middle of the window. You can perform this
step multiple times if you want to upload more than one bundle. Finally, hit
the 'Add' button to add all uploaded artifacts to ACE.
+1. Create a feature by clicking on the 'Add Feature...' button. Features are
the first level of logical grouping for artifacts.
+1. Create a distribution by clicking on the 'Add Distribution...' button.
Distributions are another level of logical grouping: you group features into
distributions.
+1. Drag an artifact onto a feature to create an association between the two.
By repeating this process you can associate all relevant artifacts to features.
+1. Drag a feature onto a distribution and again repeat this process until
you've associated all your features with their relevant distributions.
+1. Now we need a target to actually deploy our artifacts to. To start a
target, go to `ace-launcher/target` and start it using `java -jar
org.apache.ace.launcher*.jar`.
+1. After a few seconds, the target should show up in the Web UI. To associate
it with a distribution, drag that distribution onto the target.
+1. Click on 'Store' to actually store changes on the server, which should
trigger the actual deployment of the artifacts to the target.
+
+Debugging
+---------
+
+You can hook up a standard remote debugger to either target. To do that, edit
the run.sh (or run.bat) script and include the following extra parameter for
Pax Runner:
+
+`--vmOptions="-Xdebug
-Xrunjdwp:transport=dt_socket,address=8000,server=y,suspend=y"`
+
+Now run the target, and start the debugger of your favorite IDE.
\ No newline at end of file
Added: ace/site/trunk/content/user-doc/introduction.mdtext
URL:
http://svn.apache.org/viewvc/ace/site/trunk/content/user-doc/introduction.mdtext?rev=1242161&view=auto
==============================================================================
--- ace/site/trunk/content/user-doc/introduction.mdtext (added)
+++ ace/site/trunk/content/user-doc/introduction.mdtext Wed Feb 8 22:52:06 2012
@@ -0,0 +1,25 @@
+Title: Introduction
+
+Since its birth in 1999, OSGi has steadily been gaining popularity as the
component model of choice for Java. Originally designed as a framework for home
gateways and other embedded systems, it has since moved on to desktop and
enterprise systems and embraced by major software vendors.
+
+OSGi allows you to build your systems out of well defined, reusable
components, which brings both exciting new benefits as well as a set of
challenges. One of these is the actual management of components, deployed on
different target systems.
+
+Traditional, monolithic systems usually have fairly straightforward and linear
release schedules. It is quite common for most target systems to have the same
version and configuration of such a system.
+
+Component based systems can easily be customized on a per target case, meaning
there might be many different configurations out there. When components are
developed over time, they might be released individually and a lot more often
than these traditional systems.
+
+Keeping track of what is installed where becomes quite a challenge if the
number of components and targets grows, and this is where Apache ACE comes in.
+
+Apache ACE is a software distribution framework. It is written as a set of
OSGi components and consists of three major subsystems:
+
+1. dependency management, which handles the complexity of managing the
dependencies between component, aggregating them into groups and licenses and
associating those to targets
+2. deployment management, which ensures that the right components get
installed onto the right targets in a robust and scalable way
+3. feedback management, which collects life cycle feedback on the target and
aggregates that on a central server
+
+A typical topology consists of:
+
+* a server, holding the components and their metadata
+* multiple target systems, which all connect to the server
+* a client, usually a web browser, on which the user interacts with the server
+
+The Apache ACE software, which consists of a set of OSGi bundles, gets
deployed on a server. A target can be any OSGi framework (Apache Felix, Equinox
or Knopflerfish) with the Apache ACE management agent installed. This agent
will connect to the server, identify itself and poll for updates.
\ No newline at end of file
