Difference between revisions of "Equinox/p2/Director application"

From Eclipsepedia

< Equinox‎ | p2
Jump to: navigation, search
(Installing / uninstalling IUs into a target product)
(Installing / uninstalling IUs into a target product)
Line 33: Line 33:
 
To install or uninstall something into an existing target product a few extra arguments than in the "inside" mode need to be set. It mostly consist in letting the provisioning operation the ID of the profile it needs to operate on, and where it is located on disk.
 
To install or uninstall something into an existing target product a few extra arguments than in the "inside" mode need to be set. It mostly consist in letting the provisioning operation the ID of the profile it needs to operate on, and where it is located on disk.
  
For example, if from a directory called "d:\builder", I want to install CDT into an existing SDK located into "d:\eclipse", I will use the following command line.
+
For example, if from a directory called "d:\builder", I want to install CDT into an existing SDK located into "d:\eclipse", I will use the following command line. It is important to note the presence of the VM args and set it properly.
  
 
<tt>
 
<tt>
 +
    d:\builder\eclipse.exe
 
     -application org.eclipse.equinox.p2.director.app.application
 
     -application org.eclipse.equinox.p2.director.app.application
 
     -metadataRepository file:d:/tmp/cdt/site.xml
 
     -metadataRepository file:d:/tmp/cdt/site.xml

Revision as of 11:54, 24 April 2008

The director application is a headless way of performing some of the p2 operations such as installing or uninstalling installable units. Given the appropriate metadata, this application is capable on provisioning a complete installation from scratch or simply extending your application.

Depending on the needs, this application can be executed inside or outside of the application being provisioned


Contents

Terminology

Director application 
the application performing p2 operations such as install or uninstall. This application is provided by the org.eclipse.equinox.p2.director.app bundle.
Provisioning operation 
an operation installing, uninstalling features.
Target product 
the installation targeted by the provisioning operation.

Running inside the target application

In this mode, the provisioning operation happens from within the targeted produced that you are provisioning. It is equivalent to starting up the targeted product and using the p2 UI to perform the equivalent operation.

This means that the target application has to be in a runnable state and that it has to contain the director application bundle. Also since the target product will have run, cache files will have been created in the configuration folder (e.g. configuration/org.eclipse.osgi).

The following example shows the command line used to install CDT into the SDK.

   <targetProductFolder>/eclipse.exe 
   -application org.eclipse.equinox.p2.director.app.application 
   -metadataRepository file:d:/tmp/cdt/site.xml 
   -artifactRepository file:d:/tmp/cdt/site.xml
   -installIU org.eclipse.cdt.feature.group

Note that this mode is equivalent to the former update manager command line application (http://help.eclipse.org/help33/index.jsp?topic=/org.eclipse.platform.doc.isv/reference/misc/update_standalone.html).

Provisioning without running the target application

In this case the provisioning operation is happening "outside" of the targeted product. The "targeted product" is *not* started. This allows to both modify an existing installation and create a complete installation from scratch given proper metadata.

It also has the advantage that since the targeted product does not need to be started, the provisioning operation can be performed on any platform for any other platform (e.g. on my windows machine, I can create add plug-ins to a linux-based target application).

Installing / uninstalling IUs into a target product

To install or uninstall something into an existing target product a few extra arguments than in the "inside" mode need to be set. It mostly consist in letting the provisioning operation the ID of the profile it needs to operate on, and where it is located on disk.

For example, if from a directory called "d:\builder", I want to install CDT into an existing SDK located into "d:\eclipse", I will use the following command line. It is important to note the presence of the VM args and set it properly.

   d:\builder\eclipse.exe
   -application org.eclipse.equinox.p2.director.app.application
   -metadataRepository file:d:/tmp/cdt/site.xml
   -artifactRepository file:d:/tmp/cdt/site.xml
   -installIU org.eclipse.cdt.feature.group
   -destination d:/eclipse/
   -profile SDKProfile
   
   -vmArgs
   -Declipse.p2.data.area=d:/eclipse/p2

Installing a complete system

Arguments

-application org.eclipse.equinox.p2.director.app.application 
the application ID.
-metadataRepository 
the metadata repository where the installable unit to be installed is found.
-artifactRepository 
the artifact repositiry where the artifacts will be found.
-installIU 
the identifier of the installable unit to install. If you are looking to install a feature, the identifier of the feature has to be suffixed with ".feature.group".