Jump to: navigation, search

Difference between revisions of "Equinox/p2/Admin UI Users Guide"

< Equinox‎ | p2
Line 13: Line 13:
 
* The RCP app is comprised of three views:
 
* The RCP app is comprised of three views:
 
** The '''Metadata Repositories''' view shows those metadata repositories known by the provisioning infrastructure.
 
** The '''Metadata Repositories''' view shows those metadata repositories known by the provisioning infrastructure.
[[Image:metadatarepo.jpg]]
+
*:[[Image:metadatarepo.jpg]]
 
***You can (and should) ignore those repositories located in your c:/equinox.prov directory.  Those are the repositories containing the RCP agent application.
 
***You can (and should) ignore those repositories located in your c:/equinox.prov directory.  Those are the repositories containing the RCP agent application.
 
***The repository of interest is the repository located on eclipse.org (http://download.eclipse.org/eclipse/equinox/provisioning/metadata/).
 
***The repository of interest is the repository located on eclipse.org (http://download.eclipse.org/eclipse/equinox/provisioning/metadata/).
Line 21: Line 21:
 
***You may install an IU to a specified profile using drag and drop or the popup menu.
 
***You may install an IU to a specified profile using drag and drop or the popup menu.
 
** The '''Artifact Repositories''' view shows those artifact repositories known by the provisioning infrastructure.
 
** The '''Artifact Repositories''' view shows those artifact repositories known by the provisioning infrastructure.
[[Image:ArtifactRepo.jpg]]
+
*:[[Image:ArtifactRepo.jpg]]
 
***You can (and should) ignore those repositories located in your c:/equinox.prov directory.  Those are the repositories containing the RCP agent application.
 
***You can (and should) ignore those repositories located in your c:/equinox.prov directory.  Those are the repositories containing the RCP agent application.
 
***The repository of interest is the repository located on eclipse.org (http://download.eclipse.org/eclipse/equinox/provisioning/artifacts/artifacts.xml).
 
***The repository of interest is the repository located on eclipse.org (http://download.eclipse.org/eclipse/equinox/provisioning/artifacts/artifacts.xml).
Line 29: Line 29:
 
***You can't examine the properties of the artifacts or otherwise manipulate them (yet)
 
***You can't examine the properties of the artifacts or otherwise manipulate them (yet)
 
** The '''Profiles''' view shows profiles defined for installing software.  Profiles are the target of an install operation.
 
** The '''Profiles''' view shows profiles defined for installing software.  Profiles are the target of an install operation.
[[Image:Profiles.jpg]]
+
*:[[Image:Profiles.jpg]]
 
***The '''EquinoxProvisioningUI''' profile represents the agent application itself.  It contains the IU's (bundles) that comprise the RCP app.
 
***The '''EquinoxProvisioningUI''' profile represents the agent application itself.  It contains the IU's (bundles) that comprise the RCP app.
 
***You may add or remove profiles using this view.
 
***You may add or remove profiles using this view.
Line 42: Line 42:
 
# Define a profile representing your Eclipse SDK install
 
# Define a profile representing your Eclipse SDK install
 
## From the profile view's local menu, toolbar, or popup menu, choose '''Add Profile...'''
 
## From the profile view's local menu, toolbar, or popup menu, choose '''Add Profile...'''
[[Image:NewProfile.jpg]]
+
*:[[Image:NewProfile.jpg]]
 
## Choose a unique id for your profile, such as "Eclipse SDK".
 
## Choose a unique id for your profile, such as "Eclipse SDK".
 
## You may optionally define a name and description to further describe your profile
 
## You may optionally define a name and description to further describe your profile
Line 49: Line 49:
 
## When you have pressed '''OK''' you should see the new profile in the view
 
## When you have pressed '''OK''' you should see the new profile in the view
 
# Locate the '''sdk''' IU in the eclipse metadata repository
 
# Locate the '''sdk''' IU in the eclipse metadata repository
[[Image:SDKInMetaRepo.jpg]]
+
*:[[Image:SDKInMetaRepo.jpg]]
 
# You may install the sdk in several ways by selecting the IU and dragging it to your newly created profile.  You can also select the IU and choose '''Install...''' from the popup menu.  You will be prompted for a target profile.
 
# You may install the sdk in several ways by selecting the IU and dragging it to your newly created profile.  You can also select the IU and choose '''Install...''' from the popup menu.  You will be prompted for a target profile.
 
# You should see a progress indicator that reports the progress of the install.  In some phases, progress reporting is very sparse.  You may see some long pauses without progress.
 
# You should see a progress indicator that reports the progress of the install.  In some phases, progress reporting is very sparse.  You may see some long pauses without progress.

Revision as of 10:44, 3 August 2007

About the Eclipse Provisioning RCP Agent

  • If you have not yet downloaded the Eclipse Provisioning RCP agent, see Getting started with M1. You will need to unzip the agent application into the root of your C:\ drive. (This will get more flexible later). Launch the eclipse.exe program located in c:\equinox.prov and you should see something like this:

RCPAgent.jpg

  • In general, the agent RCP application allows you to add, remove, and browse the provisioning repositories, and install and uninstall software into various profiles. It exercises the Equinox Provisioning framework.
  • For M1, our goal is to demonstrate that you can use the agent to install (and uninstall) an Eclipse 3.3 SDK
  • The agent application itself is structured on top of the provisioning framework, so you can (purposefully or inadvertantly) modify the agent application by manipulating its profile within the application.
  • The UI for the RCP app is simply a browsing interface into the provisioning API. It does not represent what we think actual user workflows for installing or updating an Eclipse-based application would be. We'll focus on that later on. In other words, it is not intended to replace the Eclipse Update Manager UI.
  • The workflow we are trying to demonstrate is very narrow, yet the UI is more flexible in manipulating the environment. Failures are brittle (vague error reporting that requires you to check your .log file).

Overview of the Eclipse Provisioning RCP Agent

  • The RCP app is comprised of three views:
    • The Metadata Repositories view shows those metadata repositories known by the provisioning infrastructure.
    Metadatarepo.jpg
      • You can (and should) ignore those repositories located in your c:/equinox.prov directory. Those are the repositories containing the RCP agent application.
      • The repository of interest is the repository located on eclipse.org (http://download.eclipse.org/eclipse/equinox/provisioning/metadata/).
      • You may add or remove repositories using this view.
      • Expanding a metadata repository will show you the installable units (IU's) available for installing.
      • You may examine the properties of repositories or IU's
      • You may install an IU to a specified profile using drag and drop or the popup menu.
    • The Artifact Repositories view shows those artifact repositories known by the provisioning infrastructure.
    ArtifactRepo.jpg
      • You can (and should) ignore those repositories located in your c:/equinox.prov directory. Those are the repositories containing the RCP agent application.
      • The repository of interest is the repository located on eclipse.org (http://download.eclipse.org/eclipse/equinox/provisioning/artifacts/artifacts.xml).
      • You may add or remove repositories using this view.
      • Expanding an artifact repository will show you what artifacts are located there
      • You may examine the properties of the repository
      • You can't examine the properties of the artifacts or otherwise manipulate them (yet)
    • The Profiles view shows profiles defined for installing software. Profiles are the target of an install operation.
    Profiles.jpg
      • The EquinoxProvisioningUI profile represents the agent application itself. It contains the IU's (bundles) that comprise the RCP app.
      • You may add or remove profiles using this view.
      • Expanding a profile shows you what IU's have been installed in the profile.
      • You may examine and change the properties of profiles and IU's.
      • You may uninstall an IU from a profile using the popup menu.
  • The Window>Preferences... menu item lets you control some application preferences:
    • You can control whether drag and drop operations should be confirmed first
    • You can control whether you view all IU's in the repositories and profiles, or just those that have been marked as a "group" IU. Viewing groups only helps reduce the clutter when you are trying to find something like the SDK.

Installing the Eclipse 3.3 SDK using the Provisioning RCP Agent

  1. Define a profile representing your Eclipse SDK install
    1. From the profile view's local menu, toolbar, or popup menu, choose Add Profile...
  • NewProfile.jpg
    1. Choose a unique id for your profile, such as "Eclipse SDK".
    2. You may optionally define a name and description to further describe your profile
    3. Choose an install folder for the profile (this is where the SDK will be installed).
    4. It is important to keep the defaults for the other values, or the install may fail with little explanation
    5. When you have pressed OK you should see the new profile in the view
  1. Locate the sdk IU in the eclipse metadata repository
  • SDKInMetaRepo.jpg
  1. You may install the sdk in several ways by selecting the IU and dragging it to your newly created profile. You can also select the IU and choose Install... from the popup menu. You will be prompted for a target profile.
  2. You should see a progress indicator that reports the progress of the install. In some phases, progress reporting is very sparse. You may see some long pauses without progress.
  3. When it is finished, you have a full Eclipse SDK located in the install folder of your profile.

Cool stuff you can try

  • If you install the SDK into the agent profile (EquinoxProvisioningUI), then the next time you launch the rcp app, you'll actually be running the Eclipse SDK!