Jump to: navigation, search

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

< Equinox‎ | p2
 
(30 intermediate revisions by 13 users not shown)
Line 1: Line 1:
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.  
+
The [http://help.eclipse.org/indigo/index.jsp?topic=/org.eclipse.platform.doc.isv/guide/p2_director.html 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 of 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
+
Depending on the needs, this application can be executed inside or outside of the application being provisioned. For complete documentation on the director, including a full list of supported arguments and related examples, see the official [http://help.eclipse.org/indigo/index.jsp?topic=/org.eclipse.platform.doc.isv/guide/p2_director.html p2 director documentation].
  
 +
== Scripted Examples ==
 +
* [[Equinox_p2_director_application/Examples/Install_into_dropins|Install into eclipse/dropins/]]
 +
* [[Equinox_p2_director_application/Examples/Install_into_dropins_with_link_file|Install into eclipse/dropins/ with .link file]]
 +
* [[Equinox_p2_director_application/Examples/Install_into_eclipse_using_SDKProfile|Install into eclipse/ using SDKProfile]] (the [[Equinox_p2_Update_UI_Users_Guide|p2 Update UI]]'s default behaviour)
  
== Terminology ==
+
== See Also ==
; 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).
+
* [http://help.eclipse.org/indigo/index.jsp?topic=/org.eclipse.platform.doc.isv/guide/p2_director.html Installing software using the p2 director application]
  
The following example shows the command line used to install CDT into the SDK.
+
[[Category:Equinox_p2|Director application]] [[Category:Equinox_p2_Director]]
<tt>
+
    <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
+
</tt>
+
 
+
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.
+
 
+
<tt>
+
    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
+
</tt>
+
 
+
Note that there is no need to describe the os/ws/arch of the platform being targeted because all this information is already being available in the profile.
+
 
+
=== Installing a complete product ===
+
The creation of a complete product using the director application only needs a few extra arguments to the previous example. Most of these consist in values used to initialize the profile in which the application will be provisioned.
+
 
+
<tt>
+
-application org.eclipse.equinox.p2.director.app.application
+
-installIU ${p2.director.installIU}
+
 
+
-p2.os ${p2.os}
+
-p2.ws ${p2.ws}
+
-p2.arch ${p2.arch}
+
-roaming
+
-profile ${p2.director.profile}
+
-metadataRepository file:${p2.repo}
+
-artifactRepository file:${p2.repo}
+
 
+
-destination ${p2.director.install.path}
+
-bundlepool ${p2.director.install.path}
+
-vmargs"
+
-Declipse.p2.data.area=${p2.director.install.path}/p2"
+
</tt>
+
 
+
== 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".
+
; -version :the version of the IU to be installed. If not specified, the highest version available in the repositoy will be picked.
+
; -destination :the folder in which the targeted product is located.
+
; -profile :the profile id containing the description of the targeted product. This ID is usually found eclipse.p2.profile property contained in the config.ini of the targeted product. For the Eclipse SDK the ID is "SDKProfile"
+
; eclipse.p2.data.area :this property points at location of the profile registry containing the description of the profile set in "-profile". This property *must* be set as a VM argument.
+
 
+
 
+
[[Category:Equinox_p2|Director application]]
+

Latest revision as of 08:03, 29 June 2011

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 of 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. For complete documentation on the director, including a full list of supported arguments and related examples, see the official p2 director documentation.

Scripted Examples

See Also