Installation on JBoss EAP

Red Hat JBoss Fuse

Install JBoss Fuse 6.3 on JBoss EAP 6.4

Red Hat

Version 6.3
16 Jul 2018

Abstract

Use this guide to help you install JBoss Fuse on JBoss EAP

Chapter 1. Installation Guide Overview

Structure of Red Hat JBoss Fuse 6.3

In Red Hat JBoss Fuse 6.3 (JBoss Fuse) you have a choice of installation platforms. JBoss Fuse can be installed on Red Hat JBoss Enterprise Application Platform 6.4 (JBoss EAP) or as a standalone JBoss Fuse on Karaf package.
The product is installed in packages. There are the base packages for JBoss Fuse on JBoss EAP or Karaf, and supplementary packages for additional functionality.
Installation Type Components Prerequisite Packages
JBoss Fuse on Karaf
jboss-fuse-karaf-6.3.0.redhat-187
Optional packages:
  • Integration Pack
  • JBoss ON Pack
None
JBoss Fuse on JBoss EAP
fuse-eap-installer-6.3.0.redhat-187
Optional packages:
  • Integration Pack
  • JBoss ON Pack
JBoss EAP 6.4
Note
There is a Governance Pack available for JBoss Fuse on JBoss EAP, but it is only available for existing customers of JBoss Fuse Service Works 6.2.

Contents of JBoss Fuse Packages

The packages for JBoss Fuse contain discrete sets of functionality. The base package for the chosen platform is mandatory but the additional packages are optional.

Package Name Contents
jboss-fuse-karaf-6.3.0.redhat-187
  • Apache Camel
  • SwitchYard
  • Apache CXF
  • Apache ActiveMQ
fuse-eap-installer-6.3.0.redhat-187
  • Apache Camel
  • SwitchYard
  • BPEL/Riftsaw
Integration PackContains integration components and quickstarts to enable integration of JBoss Fuse components with other products that are not part of JBoss Fuse.
JON PackRed Hat JBoss Operations Network plug-ins package.

Chapter 2. Read Me

2.1. Back Up Your Data

Warning
Red Hat recommends that you back up your system settings and data before undertaking any of the configuration tasks mentioned in this book.

2.2. Red Hat Documentation Site

Red Hat's official documentation site is at https://access.redhat.com/documentation/en/. There you will find the latest version of every book, including this one.

2.3. EAP_HOME

EAP_HOME refers to the root directory of the Red Hat JBoss Enterprise Application Platform installation on which JBoss Fuse is deployed.

2.4. MODE

MODE refers to the mode that your instance of JBoss EAP is running in. MODE will either be standalone or domain. For more information about MODE see JBoss EAP Operating Modes. Substitute either standalone or domain whenever you see MODE in a file path in this documentation.

Chapter 3. Install JBoss Fuse on JBoss EAP

Prerequisites

JBoss Fuse must be installed on JBoss EAP 6.4. If you need to install JBoss EAP 6.4, download it from JBoss EAP 6.4 Installer Download. See JBoss EAP 6.4 Installation Guide for installation instructions.
Important
We also recommend that you apply the latest patch to JBoss EAP 6.4. The JBoss EAP patch level should be at least 6.4.10, to avoid known issues. Patches are available from the JBoss EAP 6.4 Patches tab of the download page.

Install JBoss Fuse using Installer

  1. Download the Red Hat JBoss Fuse 6.3.0 on EAP Installer:
    1. Browse to the JBoss Fuse Software Downloads page on the Red Hat Customer Portal and, when prompted, login to your customer account.
    2. Select version 6.3.0 from the Version dropdown menu and click the Download link for the Red Hat JBoss Fuse 6.3.0 on EAP Installer package.
  2. Navigate to $EAP_HOME of a clean instance of JBoss EAP.
  3. Run the downloaded installer with the following command:
    java -jar TEMP_LOCATION/fuse-eap-installer-6.3.0.redhat-187.jar
Note
Once a datastore has been has been selected at installation, it can not be changed.

Installing Red Hat JBoss Development Tools

The JBoss Fuse development environment is included in JBoss Developer Studio starting with Developer Studio 11.0. After you download Developer Studio, see the Red Hat JBoss Developer Studio 11.0 Installation Guide. During installation, in the Select Additional Features to Install page, be sure to select JBoss Fuse Tooling.
Switchyard is included in JBoss Developer Studio Integration Stack. To install Switchyard tooling, see the Red Hat JBoss Developer Studio Integration Stack Installation Guide.

Chapter 4. Start and Stop the Application Server

You need to start the JBoss Enterprise Application Platform instance for JBoss Fuse to run. This is because the JBoss Fuse components run on the JBoss Enterprise Application Platform container.
Note
For more information about starting and stopping JBoss Enterprise Application Platform using alternative and more advanced methods, see the Red Hat JBoss Enterprise Application Platform Administration and Configuration Guide.

4.1. Start JBoss EAP 6

Summary

This topic covers the steps to start JBoss EAP 6.4.

Procedure 4.1. Start the Platform Service as a Standalone Server

  1. For Red Hat Enterprise Linux.

    Run the command: EAP_HOME/bin/standalone.sh
  2. For Microsoft Windows Server.

    Run the command: EAP_HOME\bin\standalone.bat
  3. Optional: Specify additional parameters.

    To print a list of additional parameters to pass to the start-up scripts, use the -h parameter.

Procedure 4.2. Start the Platform Service as a Domain Server

  1. For Red Hat Enterprise Linux.

    Run the command: EAP_HOME/bin/domain.sh
  2. For Microsoft Windows Server.

    Run the command: EAP_HOME\bin\domain.bat
  3. Optional: Specify additional parameters.

    To print a list of additional parameters to pass to the start-up scripts, use the -h parameter.

4.2. Stop JBoss EAP 6.4

You can stop JBoss EAP using the Management CLI or by pressing CTRL+C in the terminal.
  1. Stop JBoss EAPl using the Management CLI.

    • Run the EAP_HOME/bin/jboss-cli.sh command to launch the Management CLI.
      $ EAP_HOME/bin/jboss-cli.sh
    • Run the connect command to connect to the server.
      [disconnected /] connect
    • Run the shutdown command to stop the server.
      [standalone@localhost:9999 /] shutdown
    • Run the quit command to close the Management CLI.
      [standalone@localhost:9999 /] quit
  2. Stop JBoss Enterprise Application Platform in terminal window.

    Navigate to the terminal where JBoss EAP is running. Press Ctrl+C.

Chapter 5. Patching Fuse on JBoss EAP

This chapter provides instructions on how to apply patches to the technology stack that belongs to Fuse on JBoss EAP. This does not include patches for the underlying JBoss EAP container, which must be patched separately.

5.1. How to apply a patch to Fuse on JBoss EAP

To patch an existing installation of Fuse on JBoss EAP, perform the following steps:
  1. Browse to the JBoss Fuse Software Downloads page on the Red Hat Customer Portal and, when prompted, log in to your customer account.
  2. Select version 6.3 from the Version dropdown menu.
  3. Search under the Patches tab and the Security Advisories tab for the latest package of the form Red Hat JBoss Fuse 6.3 Rollup X on EAP, where X is the number of the rollup patch.
  4. Download the patch file, fuse-eap-installer-6.3.0.redhat-XXX.jar, to TEMP_LOCATION.
  5. Open a shell prompt and change directory to the $JBOSS_HOME directory of the existing installation of Fuse on JBoss EAP that you want to patch.
  6. From the shell prompt, enter the following command to patch the installation of Fuse on JBoss EAP (replacing the file name with the actual file name of the downloaded patch):
    java -jar TEMP_LOCATION/fuse-eap-installer-6.3.0.redhat-XXX.jar
Note
The underlying JBoss EAP instance can be patched independently. Recent patches to JBoss EAP require you to apply patch 9 first (it is a prerequisite for later patches). For more details about patching the JBoss EAP container, see the JBoss EAP Patching and Upgrading Guide.

Appendix A. Red Hat JBoss Fuse Maven Repositories

Abstract

Red Hat JBoss Fuse strongly supports Maven, an open source build system available from Apache Maven. To use Maven to build your projects, you need to specify, in a Maven settings.xml file, where required artifacts are located.
For details on setting up Maven to work with Red Hat JBoss Fuse, see chapter "Building with Maven" in "Deploying into Apache Karaf".

A.1. Maven Repositories

The following repositories contain artifacts your projects may need:
  • JBoss Fuse repository
    Provides access to the artifacts in the Red Hat Maven repository. This repository is required:
    https://maven.repository.redhat.com/ga
  • JBoss Fuse early access repository
    Provides access to the artifacts in the Red Hat Maven repository for early access releases. This repository is optional:
    https://maven.repository.redhat.com/earlyaccess/all

Appendix B. Verify Your Red Hat JBoss Fuse Installation

After you complete the JBoss Fuse installation, you can verify if the product has been installed successfully.
If no error was reported, you can verify the installation by performing the following steps:
  1. Start the JBoss EAP server by running standalone.sh command
  2. Open the server.log file to check if any error messages have been logged and that SwitchYard (and other component subsystems) have loaded correctly
  3. Open the Fuse Management Console (http://localhost:8080/hawtio) in a browser. Sign in using the administrative user that you set up on the JBoss EAP installer. If the Fuse Management Console runs and you can log in then the installation has been successful.

Add a User ID to Fuse on JBoss Fuse on JBoss EAP

To add further administrative userids to JBoss EAP, use the add-user utility script provided with JBoss EAP.
  1. Navigate to $EAP_HOME/bin.
  2. Run the add-user utility script.
  3. Press ENTER to select the default option a to add a management user. All the defaults can be selected by pressing ENTER.
  4. Enter a User ID and password. Repeat the password.
  5. Enter yes to indicate that you want to add the new userid to the Management Realm.
  6. Enter no to indicate that the new userid is not for a remote connection of any kind.
[userid@localhost bin] $ ./add-user.sh

What type of user do you wish to add?
 a) Management User (mgmt-users.properties)
 b) Application User (application-users.properties)
(a):

Enter the details of the new user to add.
Realm (ManagementRealm) :
Username : manageuser
Password requirements are listed below. To modify these restrictions edit the add-user.properties configuration file.
 - The password must not be one of the following restricted values {root, admin, administrator}
 - The password must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), 1 non-alphanumeric symbol(s)
 - The password must be different from the username
Password :
Re-enter Password :
What groups do you want this user to belong to? (Please enter a comma separated list, or leave blank for none)[  ]:
About to add user 'manageuser' for realm 'ManagementRealm'
Is this correct yes/no? yes
Added user 'manageuser' to file '$EAP_HOME/standalone/configuration/mgmt-users.properties'
Added user 'manageuser' to file '$EAP_HOME/domain/configuration/mgmt-users.properties'
Added user 'manageuser' with groups  to file '$EAP_HOME/standalone/configuration/mgmt-groups.properties'
Added user 'manageuser' with groups  to file '$EAP_HOME/domain/configuration/mgmt-groups.properties'
Is this new user going to be used for one AS process to connect to another AS process?
e.g. for a slave host controller connecting to the master or for a Remoting connection for server to server EJB calls.
yes/no? no
For more information about creating users on JBoss EAP see Adding a Management User in the JBoss EAP Administration and Configuration Guide.

Legal Notice

Trademark Disclaimer

The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, MetaMatrix, Fedora, the Infinity Logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Apache, ServiceMix, Camel, CXF, and ActiveMQ are trademarks of Apache Software Foundation. Any other names contained herein may be trademarks of their respective owners.