Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "EIG:Install into Apache Karaf"

(Installing ECF Remote Services SDK into Karaf)
Line 5: Line 5:
 
==What is Karaf?==
 
==What is Karaf?==
  
Karaf is a lightweight OSGi container that supports installing Karaf-based features into the runtime.  For more information about Karaf, and/or to download see [http://karaf.apache.org/ here], and for more information about Karaf provisioning see [http://karaf.apache.org/manual/latest/users-guide/provisioning.html here].
+
Karaf is a lightweight OSGi server that supports installing Karaf-based features into the runtime.  For more information about Karaf, and/or to download see [http://karaf.apache.org/ here], and for more information about Karaf provisioning see [http://karaf.apache.org/manual/latest/users-guide/provisioning.html here].
  
 
==Installing ECF Remote Services SDK into Karaf==
 
==Installing ECF Remote Services SDK into Karaf==
  
*[http://karaf.apache.org/index/community/download.html Download] and [http://karaf.apache.org/manual/latest/quick-start.html Install] Karaf v3.0.0 or higher
+
*[http://karaf.apache.org/index/community/download.html Download] and [http://karaf.apache.org/manual/latest/quick-start.html Install] Karaf v3.x or v4.x
*Recommended but not required: [http://karaf.apache.org/manual/latest/users-guide/webconsole.html Install the Karaf webconsole]This makes it easier to install components like ECF RemoteServices and monitor the resulting runtime.
+
 
**To install webconsole, at the Karaf command shell enter:  '''feature:install webconsole'''
+
===Karaf 3.x Install===
**Open a Web Browser at '''http://localhost:8181/system/console'''
+
 
*In the Karaf webconsole, add the ECF Repository
+
JVM Requirements: Karaf 3.x requires Java 1.7 (1.8 is not supported). 
 +
 
 +
In the Install instructions below, use the following for the '''repo url'''
 +
 
 +
'''http://download.eclipse.org/rt/ecf/latest/site.p2/karaf-features.xml'''
 +
 
 +
===Karaf 4.x Install===
 +
 
 +
JVM requirements:  Karaf 4.x can use either Java 1.7 or 1.8.
 +
 
 +
1.7 '''repo url''': '''http://download.eclipse.org/rt/ecf/latest/site.p2/karaf4-features.xml'''
 +
1.8 '''repo url''':  '''http://download.eclipse.org/rt/ecf/latest/site.p2/karaf4-j8-features.xml'''
 +
 
 +
===ECF Remote Services SDK Install===
 +
 
 +
*Install the Karaf webconsole
 +
**In Karaf command shell:  '''feature:install webconsole'''
 +
**Open a Web Browser at '''http://localhost:8181/system/console''' and login.  See [http://karaf.apache.org/manual/latest-3.0.x/users-guide/webconsole.html here] for default username/password and other information about the webconsole.
 +
*In the webconsole, add the ECF Repository
 
**From the Karaf Main menu choose '''Main->Features'''
 
**From the Karaf Main menu choose '''Main->Features'''
**Add the ECF SDK URL:  '''http://download.eclipse.org/rt/ecf/latest/site.p2/karaf-features.xml''' and choose '''Add URL''' button
+
**Add the appropriate '''repo url''' above to in the text box, and select '''Add URL''' button
 
[[File:Karafinst1.png]]
 
[[File:Karafinst1.png]]
The available ECF 3.8.0 Karaf features will then be shown in the panel below (e.g. '''ecf.rs.sdk''')
+
The available ECF <version> Karaf features will then be shown in the panel below (e.g. '''ecf.rs.sdk''')
 
[[File:Karafinst2.png]]
 
[[File:Karafinst2.png]]
 
*Install the ECF SDK
 
*Install the ECF SDK
**In the webconsole. click on the arrow for the '''ecf.rs.sdk''' feature/row underneath the '''Actions''' column.  Once the install has started, this will take some time (minutes), and install progress can be monitored via the LogService.
+
**To install from the webconsole, click on the arrow for the '''ecf.rs.sdk''' feature/row underneath the '''Actions''' column to install.
**If you would rather install from the Karaf command console, enter this command:  '''feature:install -v ecf.rs.sdk'''
+
**To install from the Karaf command console, enter this command:  '''feature:install -v ecf.rs.sdk'''
**Once all bundles have been installed and started, the Karaf webconsole bundles list should appear
+
**When install is complete, the bundles list will have all ECF bundles active
 
[[File:Karafinst3.png]]
 
[[File:Karafinst3.png]]
 
The ECF RS SDK is installed and running in Karaf
 
The ECF RS SDK is installed and running in Karaf

Revision as of 14:47, 6 July 2015

Introduction

ECFs Remote Services/Remote Service Admin implementation may be used on any OSGi R4.3+ compatible Framework Implementation. Starting with ECF 3.8.0 we will provide the Apache Karaf provisioning metadata to allow ECF RS/RSA SDK to be easily installed into a Karaf installation.

What is Karaf?

Karaf is a lightweight OSGi server that supports installing Karaf-based features into the runtime. For more information about Karaf, and/or to download see here, and for more information about Karaf provisioning see here.

Installing ECF Remote Services SDK into Karaf

Karaf 3.x Install

JVM Requirements: Karaf 3.x requires Java 1.7 (1.8 is not supported).

In the Install instructions below, use the following for the repo url

http://download.eclipse.org/rt/ecf/latest/site.p2/karaf-features.xml

Karaf 4.x Install

JVM requirements: Karaf 4.x can use either Java 1.7 or 1.8.

1.7 repo url: http://download.eclipse.org/rt/ecf/latest/site.p2/karaf4-features.xml 1.8 repo url: http://download.eclipse.org/rt/ecf/latest/site.p2/karaf4-j8-features.xml

ECF Remote Services SDK Install

  • Install the Karaf webconsole
    • In Karaf command shell: feature:install webconsole
    • Open a Web Browser at http://localhost:8181/system/console and login. See here for default username/password and other information about the webconsole.
  • In the webconsole, add the ECF Repository
    • From the Karaf Main menu choose Main->Features
    • Add the appropriate repo url above to in the text box, and select Add URL button

Karafinst1.png The available ECF <version> Karaf features will then be shown in the panel below (e.g. ecf.rs.sdk) Karafinst2.png

  • Install the ECF SDK
    • To install from the webconsole, click on the arrow for the ecf.rs.sdk feature/row underneath the Actions column to install.
    • To install from the Karaf command console, enter this command: feature:install -v ecf.rs.sdk
    • When install is complete, the bundles list will have all ECF bundles active

Karafinst3.png The ECF RS SDK is installed and running in Karaf

Back to the top