Skip to main content

Notice: This Wiki is now read only and edits are no longer 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"

 
(29 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 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].
+
<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 v3.x or v4.x
+
<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].
  
===Karaf 3.x Install===
+
To export an example remote service, see [[EIG:Install_Timeline_Example_into_Apache_Karaf | tutorial here]].
  
JVM Requirements:  Karaf 3.x requires Java 1.7 (1.8 is not supported). 
+
===Install Via Webconsole===
  
In the Install instructions below, use the following for the '''repo url'''
+
<pre>
 +
karaf@root()>feature:install webconsole
 +
</pre>
  
'''http://download.eclipse.org/rt/ecf/latest/site.p2/karaf-features.xml'''
+
**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
  
===Karaf 4.x Install===
+
[[File:Karafinst1.png]]
  
JVM requirements:  Karaf 4.x can use either Java 1.7 or 1.8.
+
The available ECF's features will then be shown below (e.g. '''ecf-remoteservices-sdk''')
  
1.7 '''repo url''': '''http://download.eclipse.org/rt/ecf/latest/site.p2/karaf4-features.xml'''
+
[[File:Karafinst2.png]]
1.8 '''repo url''':  '''http://download.eclipse.org/rt/ecf/latest/site.p2/karaf4-j8-features.xml'''
+
  
===ECF Remote Services SDK Install===
+
*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
  
*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'''
 
**Add the appropriate '''repo url''' above to in the text box, and select '''Add URL''' button
 
[[File:Karafinst1.png]]
 
The available ECF <version> Karaf features will then be shown in the panel below (e.g. '''ecf.rs.sdk''')
 
[[File: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
 
 
[[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.

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