Author: jawi
Date: Tue Apr 29 10:26:51 2014
New Revision: 1590940
URL: http://svn.apache.org/r1590940
Log:
Added x-ref to user guide for additional configuration.
Modified:
ace/site/trunk/content/user-doc/getting-started.mdtext
Modified: 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=1590940&r1=1590939&r2=1590940&view=diff
==============================================================================
--- ace/site/trunk/content/user-doc/getting-started.mdtext (original)
+++ ace/site/trunk/content/user-doc/getting-started.mdtext Tue Apr 29 10:26:51
2014
@@ -1,6 +1,6 @@
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.
+This guide shows the core functionality of ACE, organising bundles and other
artifacts into logical features and distributions and associating those with
specific targets, all done using a convenient web interface.
## Download the distribution
@@ -11,15 +11,19 @@ To start using ACE, you must first launc
## Start the ACE server
-1. Open a terminal and navigate nto the root of the distribution.
-1. Navigate to the sub directory `server-allinone`.
-1. Start the server using `java -jar server-allinone.jar`
+1. Open a terminal and navigate to the root of the distribution;
+1. Navigate to the sub directory `server-allinone`;
+1. Start the server using `java -jar server-allinone.jar`.
+
+The server is configured by means of configuration files found in the
<tt>conf</tt> directory.
## Start an ACE target
-1. Open a terminal and navigate into the root of the distribution.
-1. Navigate to the sub directory `target`.
-1. Start the target using `java -jar target.jar`
+1. Open a terminal and navigate into the root of the distribution;
+1. Navigate to the sub directory `target`;
+1. Start the target using `java -jar target.jar`.
+
+Configuring the target can by done by supplying it commandline parameters, as
described in the [user guide](user-guide.html#running-a-target).
## Provisioning some bundles
@@ -27,21 +31,21 @@ Apache ACE has both a Web UI and a [REST
The following steps can be followed to get started:
-1. 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. The
column on the right will show you have a target running with name
`defaultTargetID`. The other columns remain empty as this is an initial empty
version of the repository.
-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. Drag the distribution onto the target to associate it.
+1. 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. The
column on the right will show you have a target running with name
`defaultTargetID`. The other columns remain empty as this is an initial empty
version of the repository;
+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. Drag the distribution onto the target to associate it;
1. Click on 'Store' to actually store changes on the server, which should
trigger the actual deployment of the artifacts to the target.
## Validating that it works
After following the steps listed above the bundles should have been
provisioned onto the target. But did it work? There are a lot of things that
can go wrong the first time. For example, remember you are provisioning into an
empty OSGi framework so the deployment should be able to resolve. Two ways to
debug problems are;
-1. Inspect state and log of the target by double-clicking it in the webui.
+1. Inspect state and log of the target by double-clicking it in the web UI;
1. Start of by provisioning a shell to allow inspection of the target itself.
-Note: In version 1.0 the default binary target comes with a [Gogo
shell](http://felix.apache.org/site/apache-felix-gogo.html) pre-installed. It
can be used right away.
+Note: As of version 1.0, the default target includes a [Gogo
shell](http://felix.apache.org/site/apache-felix-gogo.html), allowing it to be
used right away.
