红帽全球峰会此内容没有您所选择的语言版本。
Chapter 3. Karaf Migration
This section covers the changes in the Karaf version from 2.x to 4.x.
3.1. Migrating application code
Applications will need to be recompiled to align with the new versions provided. Use the Maven Bill of Materials (BOM) file to migrate Maven dependencies to the new versions and see also Component Details.
3.2. Karaf Console Commands
The console commands have been renamed in Apache Karaf 4.x and differ from what they are in 2.x. The purpose is to standardize the naming convention.
All of the admin:* and instance:* commands (for managing child Karaf containers) are deprecated in Fuse 7.0 and will be removed in a future release. If you need to deploy multiple instances of a Karaf container on a single host, the recommended approach is to use OpenShift.
The following table lists the old commands and the new commands:
| Apache karaf 2.x | Apache karaf 4.x |
|---|---|
| dev:create-dump | dev:dump-create |
| features:add-url | feature:repo-add |
| features:chooseurl | feature:repo-add |
| features:info | feature:info |
| features:install | feature:install |
| features:listVersions | feature:version-list |
| features:list | feature:list |
| features:listRepositories | feature:repo-list |
| features:listUrl | feature:repo-list |
| features:refreshUrl | feature:repo-refresh |
| features:removeRepository | feature:repo-remove |
| features:removeUrl | feature:repo-remove |
| features:uninstall | feature:uninstall |
| jaas:pending | jaas:pending-list |
| jaas:realms | jaas:realm-list |
| jaas:users | jaas:user-list |
| jaas:manage | jaas:realm-manage |
| jaas:roleadd | jaas:role-add |
| jaas:roledel | jaas:role-delete |
| jaas:useradd | jaas:user-add |
| jaas:userdel | jaas:user-delete |
| config:propappend | config:property-append |
| config:propdel | config:property-delete |
| config:proplist | config:property-list |
| config:propset | config:property-set |
| dev:dynamic-import | bundle:dynamic-import |
| dev:framework | system:framework |
| dev:print-stack-traces | shell:stack-traces-print |
| dev:restart | system:shutdown |
| dev:show-tree | bundle:tree-show |
| dev:system-property | system:property |
| dev:wait-for-service | service:wait |
| dev:watch | bundle:watch |
| log:display-exception | log:exception-display |
| obr:addUrl | obr:url-add |
| obr:listUrl | obr:url-list |
| obr:refreshUrl | obr:url-refresh |
| obr:removeUrl | obr:url-remove |
| osgi:bundle-level | bundle:start-level |
| osgi:classes | bundle:classes |
| osgi:find-class | bundle:find-class |
| osgi:headers | bundle:headers |
| osgi:info | bundle:info |
| osgi:install | bundle:install |
| osgi:bundle-services | bundle:services |
| osgi:list | bundle:list |
| osgi:ls | service:list |
| osgi:name | system:name |
| osgi:refresh | bundle:refresh |
| osgi:resolve | bundle:resolve |
| osgi:restart | bundle:restart |
| osgi:shutdown | system:shutdown |
| osgi:start | bundle:start |
| osgi:start-level | bundle:start-level |
| osgi:stop | bundle:stop |
| osgi:uninstall | bundle:uninstall |
| osgi:update | bundle:update |
| osgi:version | system:version |
| packages:exports | package:exports |
| packages:imports | package:imports |
Fuse 7.0 defines aliases for the Karaf 2.x commands. So you can continue using the old commands.
3.3. JMX Object Names in Karaf 4.x
The JMX MBeans object names are renamed and the operations are dispatched in new MBeans.
The table below lists the old JMX MBeans object names and the respective new object names.
| Apache Karaf 2.x | Apache Karaf 4.x |
|---|---|
| org.apache.karaf:type=bundles,name=* | org.apache.karaf:type=bundle,name=* |
| org.apache.karaf:type=config,name=* | org.apache.karaf:type=config,name=* |
| org.apache.karaf:type=dev,name=* | org.apache.karaf:type=system,name=* |
| org;apache.karaf:type=log,name=* | org.apache.karaf:type=log,name=* |
| org.apache.karaf:type=obr,name=* | org.apache.karaf:type=obr,name=* |
| org.apache.karaf:type=packages,name=* | org.apache.karaf:type=package,name=* |
| org.apache.karaf:type=services,name=* | org.apache.karaf:type=service,name=* |
| org.apache.karaf:type=system,name=* | org.apache.karaf:type=system,name=* |
| org.apache.karaf:type=web,name=* | org.apache.karaf:type=web,name=* |
3.4. Karaf Migration Changes
This section covers the changes in Karaf 2.x to Karaf 3.x.
3.4.1. Migrating from Karaf 2.x to Karaf 3.x
The changes to Apache Karaf that must be considered before upgrading from versions 2.x to 3.x are:
- The files in the different Apache Karaf folders have changed, and the merge/diff is very large so it is advisable to start a new Apache Karaf 3.x container rather than overriding the folders from an Apache Karaf 2.x container.
-
The future Apache Karaf versions will introduce the concept of
Karaf Profilesto simplify the update process. -
WebApplications using the
WebApp-Contextheaders in theMANIFESTare no longer supported. -
Apache Karaf now supports the OSGi standard
Web-ContextPathheader in theMANIFEST. - Apache Karaf 3.0.x is fully supported by OPS4J Pax Exam.
3.4.2. Migrating from Karaf 3.x to Karaf 4.x
The changes to Karaf that must be considered before upgrading from Karaf 2.x to Karaf 3.x.
- Karaf 4.x supports Java8.
-
If you upgrade an existing Karaf container, make a note to update the
libandsystemfolders. For theetcfolder, a diff is required. - Karaf 4.x has a new Feature Resolver. The purpose is to simplify the features installation and lifecycle. The new resolver now checks the feature requirements defined in the features XML, and check which bundles provides the capabilities to satisfy these requirements. It allows Karaf to automatically install bundles required by features. This feature is not enabled in Karaf 3.x.
3.5. New Commands in Karaf 4.x
| Apache Karaf 4.x |
|---|
| feature:requirement-list |
| feature:requirement-add |
| feature:requirement-remove |
| feature:regions |
| feature:start |
| feature:stop |
| jaas:group-create |
| jaas:group-add |
| jaas:group-delete |
| jaas:group-list |
| jaas:group-role-add |
| jaas:group-role-delete |
| jaas:su |
| jaas:sudo |
| shell:edit |
| shell:env |
| shell:less |
| shell:stack-traces-print |
| shell:threads |
| shell:while |
| log:list |
| bundle:capabilities |
| bundle:diag |
| bundle:id |
| bundle:load-test |
| bundle:requirements |
| bundle:resolve |
| system:name |
- In development environment you can use the blueprint definition as used in Karaf 2.x and 3.x with the corresponding annotations.
-
In Karaf 4.x, you can use DS and new annotations and avoid the usage of a blueprint XML. The new annotations are:
@Service,@Completion,@Parsing,@Reference. You can define the command directly in the command class. -
Karaf 4.x provides the karaf-services-maven-plugin in
org.apache.karaf.toolingMaven groupId to simplify the generation of the code and OSGi headers.
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}