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"

(Created page with "==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 ...")
 
 
(36 intermediate revisions by the same user not shown)
Line 1: Line 1:
==Introduction==
+
==Installing ECF Remote Services SDK==
  
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 [http://karaf.apache.org/ Apache Karaf] provisioning metadata to allow ECF RS/RSA SDK to be easily installed into a Karaf installation.
+
Requirements: ECF 3.14+ requires [http://karaf.apache.org Karaf 4.2+ running on Java 8].
  
==What is Karaf?==
+
===Install Via Karaf Console===
  
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].
+
<pre>
 +
karaf@root()>feature:repo-add ecf
 +
karaf@root()>feature:repo-refresh ecf
 +
karaf@root()>feature:install -v ecf-rs-sdk
 +
</pre>
  
==Installing ECF Remote Services SDK into Karaf==
+
The ECF Karaf Remote Services SDK is now installed.
  
*[http://karaf.apache.org/index/community/download.html Download] and [http://karaf.apache.org/manual/latest/quick-start.html Install] Karaf 3.0.0 or higher
+
<b>NOTE:</b>There are a number of features included in the karaf-features, and ECF subsystems are represented as individual features. For example, their is a feature for the ECF Generic distribution provider 'ecf-rs-distribution-generic' and for the rosgi provider 'ecf-rs-distribution-rosgi'. There are also features for ECF discovery providers:  jmdns/zeroconf, slp, zookeeper. There are other [[Distribution Providers]] and [[Discovery Providers]].  There are also others at the [https://github.com/ECF ECF github site].
*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 the webconsole at the Karaf command shell type:  '''feature:install webconsole'''
+
To export an example remote service, see [[EIG:Install_Timeline_Example_into_Apache_Karaf | tutorial here]].
**Open a Web Browser at '''http://localhost:8181/system/console'''
+
 
*In the Karaf webconsole, add the ECF Repository
+
===Install Via Webconsole===
**The ECF SDK Karaf Features repository URL is:  '''http://download.eclipse.org/rt/ecf/3.8.0/site.p2/karaf-features.xml'''
+
 
**With the webconsole
+
<pre>
 +
karaf@root()>feature:install webconsole
 +
</pre>
 +
 
 +
**Open a Web Browser at '''http://localhost:8181/system/console'''.  See [http://karaf.apache.org/manual/latest-3.0.x/users-guide/webconsole.html here] for Karaf default username/password and other information about the use of the webconsole.
 +
*Add the ECF Repository
 +
**From the Webconsole Main menu choose '''Main->Features'''
 +
**Add the appropriate '''&lt;repo url&gt;''' from above to in the text box, and select '''Add URL''' button
 +
 
 +
[[File:Karafinst1.png]]
 +
 
 +
The available ECF's features will then be shown below (e.g. '''ecf-remoteservices-sdk''')
 +
 
 +
[[File:Karafinst2.png]]
 +
 
 +
*Click on the arrow for the '''ecf-rs-sdk''' feature/row underneath the '''Actions''' column to install.
 +
*When install is complete, the bundles list will have all ECF bundles active
 +
 
 +
[[File:Karafinst3.png]]
 +
 
 +
The ECF RS SDK is installed and running in Karaf.

Latest revision as of 01:14, 4 April 2019

Installing ECF Remote Services SDK

Requirements: ECF 3.14+ requires Karaf 4.2+ running on Java 8.

Install Via Karaf Console

karaf@root()>feature:repo-add ecf
karaf@root()>feature:repo-refresh ecf
karaf@root()>feature:install -v ecf-rs-sdk

The ECF Karaf Remote Services SDK is now installed.

NOTE:There are a number of features included in the karaf-features, and ECF subsystems are represented as individual features. For example, their is a feature for the ECF Generic distribution provider 'ecf-rs-distribution-generic' and for the rosgi provider 'ecf-rs-distribution-rosgi'. There are also features for ECF discovery providers: jmdns/zeroconf, slp, zookeeper. There are other Distribution Providers and Discovery Providers. There are also others at the ECF github site.

To export an example remote service, see tutorial here.

Install Via Webconsole

karaf@root()>feature:install webconsole
  • Add the ECF Repository
    • From the Webconsole Main menu choose Main->Features
    • Add the appropriate <repo url> from above to in the text box, and select Add URL button

Karafinst1.png

The available ECF's features will then be shown below (e.g. ecf-remoteservices-sdk)

Karafinst2.png

  • Click on the arrow for the ecf-rs-sdk feature/row underneath the Actions column to install.
  • 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