Installing on Apache Karaf

Procedure

1. On the system on which you plan to install Fuse, confirm that it has:

   • 250 MB of free disk space
   • 2 GB of RAM

   This hardware requirement is for a full installation of Fuse on Apache Karaf. In addition, a system that is running Fuse requires space for caching, persistent message stores, and other functions. The actual requirement is dependent on what your Fuse applications do.

2. Confirm that the system on which you plan to install Fuse is running a supported platform. Red Hat tests and supports Fuse products on the platforms that are listed in Red Hat Fuse Supported Configurations.
3. Confirm that your system is running a Java runtime that is supported by Fuse on Apache Karaf. See Supported Java Versions in Red Hat Fuse Supported Configurations.
4. Ensure that your Java runtime is not installed under a directory path that includes whitespace. For example, C:\Program Files\Java\jdk8 is not an acceptable path. Whitespace in paths causes unpredictable errors in Fuse on Apache Karaf at run time.
5. Check the list of Red Hat Fuse Supported Standards to confirm that you are using supported standard software.

Procedure

1. In a browser, go to the Fuse Software Downloads page.

   If you are not already logged in to the Red Hat customer portal, there is a prompt to log in and then the download page appears.

   If you do not have customer portal log-in credentials, in the box that asks if you are new to Red Hat, click Register to obtain them, and then log in.

2. In the Fuse Software Downloads page, to the right of Red Hat Fuse 7.4 on Karaf Installer, click Download to obtain a local zip file.

3. Extract the contents of the zip file into a directory for which you have all permissions.

   Do not unpack the zip file into a directory that has spaces or any of the following special characters in its path name: #, %, ^, ". For example, do not unpack into C:\Documents and Settings\Greco#Roman\Desktop\fuse.

4. If you are using the IBM JDK, in your Fuse installation directory, in the /lib/endorsed directory, remove the saaj-api .jar file, for example:

   rm lib/endorsed/org.apache.servicemix.specs.saaj-api-1.3-2.9.0.jar

5. Set the JAVA_OPTS environment variable as follows:

   JAVA_OPTS=-Xshareclasses:none

   You must set the JAVA_OPTS environment variable before you start Fuse.

6. Add an administrator user to enable remote access to the Fuse on Karaf container and to access the Fuse Console.

   By default, no users are defined for the container. You can run the container in the foreground in this case, but you cannot access the container remotely and you cannot run it in the background. It is recommended that you create at least one user with the admin role by following these steps:

   1. In a text editor, open the etc/users.properties file, which is in your Fuse installation directory.

   2. Locate the following lines:

      #admin = admin,_g_:admingroup
      #_g_\:admingroup = group,admin,manager,viewer,systembundles,ssh

   3. For each line, remove the leading # character to uncomment the line.
   4. In the first line, change the first instance of admin to a username that you choose, for example user1.

   5. In the same line, change the second instance of admin to a password for that user, for example passw0rd.

      For example:

      user1 = passw0rd,_g_:admingroup
      _g_\:admingroup = group,admin,manager,viewer,systembundles,ssh

   6. Save and close the file.
7. To start Fuse, run bin/fuse on Linux/Unix or bin\fuse.bat on Windows.
8. Optionally, to access the Fuse Console, open the provided URL in a web browser and login with the username and password that you set in the etc/users.properties file. For more information about using the Fuse Console see Managing Fuse.

Procedure

1. Log in to the Red Hat customer portal.
2. Go to the Red Hat Customer Portal→Downloads→Red Hat Fuse→Downloads page.
3. Select 7.3.0 from the Version drop-down list on the Software Downloads page.

4. Download the Fuse extras archive.

   The extras archive file contains the following archive files nested inside it:

   • apache-camel-2.21.0.fuse-740039-redhat-00001.zip
   • apache-cxf-3.2.7.fuse-740026-redhat-00001.zip
5. Copy these files to the desired location and decompress them using the appropriate utility for your platform.

Procedure

1. Download the required patch from the Customer Portal.
2. Make a full backup of your Fuse on Apache Karaf installation before upgrading.

3. Open the terminal and start Fuse on Apache karaf server.

   [user@FUSE_HOME/bin ~] $ ./fuse

4. Add the patch to the container’s environment by entering the patch:add command. For example, to add the patch-xxx.zip patch file, enter:

   karaf@root()> patch:add 'file:///Downloads/patch-xxx.zip'
   [name]                 [installed] [rollup]   [description]
   my-patch-x 	       false       false       my-patch-x

5. Simulate installing the patch by entering the patch:simulate command.

   This generates a log of the changes that will be made to the container when the patch is installed, but will not make any actual changes to the container. Review the simulation log to understand these changes.

6. Enter patch:list command to view a list of added patches. In this list, the entries under the [name] heading are patch IDs.

   patch:list
   [name]                       [installed]   [description]
   my-patch-x                   false

7. Apply a patch to the container by entering the patch:install command and specifying the patch ID for the patch that you want to apply.

   patch:install my-patch-x

Procedure

1. Enter the patch:list command to obtain the patch ID of the most recently installed patch.

2. To rollback the updated bundle enter the following command:

   karaf@root()> patch:rollback my-patch-x
   INFO : org.jboss.fuse.modules.patch.patch-management (2): Rolling back non-rollup patch "my-patch-x"
   removing overriden feature: hawtio-rbac/2.0.0.fuse-000117
   refreshing features
   Enter feature:info command to view the information about the feature.

   karaf@root()> feature:info hawtio-rbac
   Feature hawtio-rbac 2.0.0.fuse-000117
   Details:
         Installs the hawtio RBAC enabler bundle(s)
   Feature has no configuration
   Feature has no configuration files
   Feature has no dependencies.
   Feature contains followed bundles:
         mvn:io.hawt/hawtio-osgi-jmx/2.0.0.fuse-000117
   Feature has no conditionals.

Procedure

1. Download the latest version of Maven from the Maven download page.

2. Ensure that your system is connected to the Internet.

   While building a project, the default behavior is that Maven searches external repositories and downloads the required artifacts. Maven looks for repositories that are accessible over the Internet.

   You can change this behavior so that Maven searches only repositories that are on a local network. That is, Maven can run in an offline mode. In offline mode, Maven looks for artifacts in its local repository. See Section 3.3, “Using local Maven repositories”.

Procedure

1. In the project directory that contains the pom.xml file, download a repository for a Maven project by running a command such as the following:

   mvn org.apache.maven.plugins:maven-dependency-plugin:3.1.0:go-offline -Dmaven.repo.local=/tmp/foo

   In this example, Maven dependencies and plug-ins that are required to build the project are downloaded to the /tmp/foo directory.

2. Edit the etc/org.ops4j.pax.url.mvn.cfg file to set org.ops4j.pax.url.mvn.offline to true. This enables offline mode:

   ##
   # If set to true, no remote repository will be accessed when resolving artifacts
   #
   org.ops4j.pax.url.mvn.offline = true

3. Distribute this customized Maven offline repository internally to any machines that do not have an Internet connection.