Red Hat JBoss Enterprise Application Platform Installation Methods

Procedure

1. Open your terminal emulator and navigate to the directory containing the downloaded jboss-eap-installation-manager.

2. Install JBoss EAP by running the following command:

   Syntax

   ./jboss-eap-installation-manager.sh install --profile eap-8.0 --dir eap-8

   Example

   ./jboss-eap-installation-manager.sh install --profile eap-8.0 --dir eap-8
   Installing profile: eap-8.0
   Using channels:
   # eap-8.0
     manifest: org.jboss.eap.channels:eap-8.0
     repositories:
       id: mrrc
       url: https://maven.repository.redhat.com/ga/

   Review the end user license agreement, and follow the rest of the prompts to install JBoss EAP.

   Accept the agreement(s) [y/N]y
   
   Feature-packs resolved.
   Packages installed.
   Downloaded artifacts.
   JBoss modules installed.
   Configurations generated.
   JBoss examples installed.

Procedure

1. Navigate to the directory containing the jboss-eap-installation-manager by using your terminal emulator.

2. View the history of all versions of JBoss EAP, which you have installed:

   ./jboss-eap-installation-manager.sh history --dir eap-8

   Note

   This command displays all JBoss EAP installations and updates with their respective installation state ID.

3. Investigate specific changes made to JBoss EAP during an update:

   ./jboss-eap-installation-manager.sh history --dir eap-8 --revision <Installation state>

   This command displays specific JBoss EAP components that have been updated

4. Revert JBoss EAP by specifying the installation state of the JBoss EAP version in the following command:

   Syntax

   ./jboss-eap-installation-manager.sh revert perform --dir eap-8 --revision <Installation state>

   Important

   You must specify the installation state of the JBoss EAP version.

   Example

   ./jboss-eap-installation-manager.sh revert perform --dir eap-8 --revision 6a6f55eb
   Feature-packs resolved.
   Packages installed.
   Downloaded artifacts.
   JBoss modules installed.
   Configurations generated.
   JBoss examples installed.
   
   Reverted server prepared, comparing changes
   No changes found

   Follow the rest of the prompts to revert JBoss EAP updates.

   Continue with revert [y/N]: y
   Applying changes
   
   Server reverted to state ea768519.
   Operation completed in 55.39 seconds.

Procedure

1. Extract the Maven repository archive file.
2. Open your terminal emulator and navigate to the directory containing the extracted Maven repository file.

3. Install JBoss EAP by running the following command:

   ./jboss-eap-installation-manager.sh install --profile eap-8.0 --dir eap-8 --repositories file:maven-repository

Procedure

1. Managing JBoss EAP installation channels

   1. Investigate the channels your JBoss EAP installation is currently subscribed to by using the following command:

      ./jboss-eap-installation-manager.sh channel list --dir eap-8

   2. Subscribe your JBoss EAP installation to a new channel by using the following command:

      ./jboss-eap-installation-manager.sh channel add --channel-name <CHANNEL_NAME> --manifest <GROUP_ID:ARTIFACT_ID> --repositories <ID::REPOSITORY_URL> --dir eap-8

   3. unsubscribe your JBoss EAP installation from a channel using the following command:

      ./jboss-eap-installation-manager.sh channel remove --channel-name <CHANNEL_NAME> --dir eap-8

   4. Export a server snapshot by using the following command:

      ./jboss-eap-installation-manager.sh clone export --dir=<directory> --path=<target_archive>

Procedure

1. Log in to the Red Hat Customer Portal.
2. From the Product Downloads list, select Red Hat JBoss Enterprise Application Platform.
3. Click Downloads.
4. From the Version drop-down list, select 8.0.

Procedure

1. Open a terminal instance and navigate to the directory containing the downloaded JBoss EAP installer file.

2. Run the graphical installer using the following command:

   $ java -jar jboss-eap-8.0.0-installer.jar

3. Choose your preferred language for the installer, and then click OK.
4. Agree with the prompt for The EULA for RED HAT JBOSS MIDDLEWARE by selecting "I accept the terms of this license agreement", and then click Next.

5. Select the installation path or choose a Maven source repository for JBoss EAP, and then click Next.

   

6. Select the components to install. Required components are disabled for deselection.

   

Procedure

1. Open a terminal and navigate to EAP_HOME/Uninstaller.

2. Run the graphical uninstaller using the following command:

   $ java -jar uninstaller.jar

   

3. When prompted, click Uninstall to start the uninstall process.
4. When the uninstall process is finished, click Quit to exit the uninstaller.

Procedure

1. Open your terminal emulator and navigate to the directory containing the downloaded jboss-eap-installation-manager.

2. Define the channels, that provide the feature packs, you want your JBoss EAP server subscribed to:

   ./jboss-eap-installation-manager.sh channel add \
     --channel-name feature-pack-channel \
     --repositories https://fp.repo.org/maven \
     --manifest com.example:feature-pack

3. Create and subscribe your JBoss EAP installation to a channel providing additional artifacts. For more information see Creating and subscribing your JBoss EAP installation to a channel providing additional artifacts.

1. Provide the necessary layers for the installation.

   $ ./jboss-eap-installation-manager.sh feature-pack add \
     --fpl com.example:feature-pack \
     --layers layer-one,layer-two \
     --dir jboss-eap8

2. Provide the necessary layers for the installation and choose the configuration file you want to modify.

   $ ./jboss-eap-installation-manager.sh feature-pack add \
     --fpl com.example:feature-pack \
     --layers layer-one,layer-two \
     --target-config standalone-ha.xml
     --dir jboss-eap8

   Note
   • You can modify the default feature pack configuration file by using the --target-config parameter. This parameter selects the configuration file in the standalone/configuration folder that will receive the changes.
   • If you have changed the chosen configuration file before, the updates won’t overwrite it. Instead, the changes will be saved in a new file named with a .glnew ending. You’ll need to handle and merge any conflicts yourself.
   • The feature pack can only modify standalone configuration files and not files in a managed domain.
   • The supported values for the --target-config parameter are the names of the configuration files provided by the base EAP8/XP5 servers. Additional feature packs should not provide additional configurations.

Procedure

1. Open the terminal emulator and navigate to the directory containing jboss-eap-installation-manager.

2. Create a provisioning.xml file and define the feature packs you want to install:

   <?xml version="1.0" ?>
   
   <installation xmlns="urn:jboss:galleon:provisioning:3.0">
       <feature-pack location="org.jboss.eap:wildfly-ee-galleon-pack:zip">
           <packages>
               <include name="docs.examples.configs"/>
           </packages>
       </feature-pack>
       <feature-pack location="<FEATURE_PACK_GROUP_ID>:<FEATURE_ARTIFACT_ID>:zip">
           <default-configs inherit="false"/>
           <packages inherit="false"/>
       </feature-pack>
       <config model="standalone" name="standalone.xml">
           <layers>
               <include name="<FEATURE_PACK_LAYER>"/>
           </layers>
       </config>
   </installation>

3. Create a channels.yaml file, and define the channels you want JBoss EAP subscribed to.

     schemaVersion: "2.0.0"
     name: "eap-8.0"
     repositories:
       - id: "mrrc"
         url: "file:/Users/spyrkob/workspaces/set/prospero/prod-prospero/jboss-eap-8.0.0.GA-maven-repository/maven-repository"
     manifest:
       maven:
         groupId: "org.jboss.eap.channels"
         artifactId: "eap-8.0"
     ---
     schemaVersion: "2.0.0"
     name: "feature-pack-channel"
     repositories:
       - id: "feature-pack-repository"
         url: "https://repository.example.com/feature-pack"
     manifest:
       maven:
         groupId: "com.example.channels"
         artifactId: "feature-pack"

4. Install feature packs using the --definition and --channel parameters:

   ./jboss-eap-installation-manager.sh install \
     --definition provisioning.xml \
       --channel channels.yaml \
       --dir jboss-eap8
   Installing galleon provisioning definition: provisioning.xml
   Using channels:
   # eap-8.0
     manifest: org.jboss.eap.channels:eap-8.0
     repositories:
       id: mrrc
       url: file:/tmp/jboss/jboss-eap-8.0.0.GA-maven-repository/maven-repository
   #feature-pack-channel
     manifest: com.example.channels:feature-pack
     repositories:
       id: feature-pack-repository
       url: https://repository.example.com/feature-pack
   
   ===============
   END USER LICENSE AGREEMENT RED HAT JBOSS® MIDDLEWARE™
   ===============
   [...]
   ===============
   
   
   Accept the agreement(s) [y/N]y
   
   Feature-packs resolved.
   Packages installed.
   Downloaded artifacts.
   JBoss modules installed.
   Configurations generated.
   JBoss examples installed.
   
   Server created in /tmp/jboss/jboss-eap8
   Operation completed in 16.30 seconds

Procedure

1. Open the terminal emulator and navigate to the directory containing jboss-eap-installation-manager.

2. Install the required feature pack into JBoss EAP and specify the offline repositories by using --repositories parameter:

   $ ./jboss-eap-installation-manager.sh feature-pack add \
     --fpl com.example:feature-pack \
     --layers layer-one,layer-two \
     --repositories file:/path/to/eap8/offline_repo,file:/path/to/feature_pack/offline_repo
     --dir jboss-eap8

Procedure

1. Open the terminal emulator and navigate to the directory containing the downloaded jboss-eap-installation-manager.

2. Investigate the history of all feature packs added to your JBoss EAP server:

   $ ./jboss-eap-installation-manager.sh history --dir jboss-eap-8.0
   [79a553e7] 2023-08-23T13:39:10Z - feature_pack [org.jboss.eap.channels:eap-8.0::1.0.1.GA][com.example.channels:myfaces::1.0.0]
   [744013d2] 2023-08-23T13:38:16Z - config_change
   [928fe586] 2023-08-23T13:22:11Z - install [org.jboss.eap.channels:eap-8.0::1.0.1.GA]

3. Stop JBoss EAP server.

4. Revert your to a previous version.

   $ ./jboss-eap-installation-manager.sh revert perform --revision 744013d2 --dir jboss-eap-8.0
   Reverting server /tmp/jboss/jboss-eap-8.0 to state 744013d2
   
   Feature-packs resolved.
   Packages installed.
   Downloaded artifacts.
   JBoss modules installed.
   Configurations generated.
   JBoss examples installed.
   
   Reverted server prepared, comparing changes
   Changes found:
     org.jboss.eap:eap-myfaces-feature-pack                8.0.0.GA-redhat-20230816 ==>  []
     org.apache.myfaces.core:myfaces-api                   4.0.0                ==>  []
     org.jboss.eap:eap-myfaces-injection                   8.0.0.GA-redhat-20230816 ==>  []
     org.apache.myfaces.core:myfaces-impl                  4.0.0                ==>  []
   Continue with revert [y/N]: y
   Applying changes
   
   Server reverted to state 977f97dd.
   Operation completed in 51.17 seconds.

Procedure

1. Open the terminal emulator and navigate to the directory containing jboss-eap-installation-manager.

2. Create a manifest.yaml file:

   schemaVersion: 1.0.0
   name: MyFaces manifest file
   streams:
     - groupId: org.apache.myfaces.core
       artifactId: myfaces-impl
       version: 4.0.0
     - groupId: org.apache.myfaces.core
       artifactId: myfaces-api
       version: 4.0.0

3. Deploy the manifest to a local repository:

   mvn deploy:deploy-file -Dfile=manifest.yaml \
     -DgroupId=com.example.channels -DartifactId=myfaces \
     -Dclassifier=manifest -Dpackaging=yaml -Dversion=1.0.0 \
     -Durl=file:/path/to/local/repository

4. Subscribe your JBoss EAP server to the new channel:

   $ ./jboss-eap-installation-manager.sh channel add \
     --channel-name myfaces-channel \
     --repositories https://repo1.maven.org/maven2,file:/path/to/local/repository \
       --manifest com.example.channels:myfaces \
     --dir jboss-eap8

Procedure

1. Log in to the Red Hat Customer Portal.
2. Click Downloads
3. Select Red Hat JBoss Enterprise Application Platform from the Product Downloads list.
4. In the Version drop-down list, select 8.0.
5. Find Red Hat JBoss Enterprise Application Platform 8.0.0 in the list and click the Download link.
6. Optional: Move the archive file to the server and location where you want to install JBoss EAP.

7. Depending on your operating system, choose one of the following options:

   • For Red Hat Enterprise Linux, extract the archive file by entering the following command in the management CLI:

     $ unzip jboss-eap-8.0.0.zip

   • For Windows Server, right-click the archive file and select Extract All.

     Note

     EAP_HOME is the top-level directory for the JBoss EAP installation. Create the directory by extracting the archive file.

Procedure

1. Delete the installation directory to uninstall JBoss EAP.
2. Delete any scripts that depend on JBoss EAP being installed on your machine.

Procedure

1. Enter the Red Hat Subscription Manager.

   Important

   To subscribe to the Red Hat Enterprise Linux server base repository and a minor JBoss EAP repository, enter one of the following commands:

2. Replace EAP_MINOR_VERSION with your intended JBoss EAP minor version. For example, 8.0.

   subscription-manager repos --enable=jb-eap-EAP_MINOR_VERSION-for-rhel-RHEL_VERSION-ARCH-rpms

Procedure

1. Install JBoss EAP and JDK 17.

   dnf groupinstall jboss-eap8

2. Install JBoss EAP and JDK 11. JDK 11 is available for Red Hat Enterprise Linux 8 and later:

   • Red Hat Enterprise Linux 8:

     dnf groupinstall jboss-eap8-jdk11

1. Modify the default JDK in either of the following ways:

   • Change system wide configuration by using the alternatives command:

     alternatives --config java

   • Change the JDK that uses JBoss EAP by using the JAVA_HOME property. Your installation is complete. The default EAP_HOME path for the RPM installation is /opt/rh/eap8/root/usr/share/wildfly.

Procedure

1. Unsubscribe from the existing repository and subscribe to the new repository by using the Red Hat Subscription Manager.

   subscription-manager repos --disable=EXISTING_REPOSITORY --enable=NEW_REPOSITORY

Procedure

1. Configure the start-up options in the jboss-eap.conf file by opening the jboss-eap.conf in a text editor and set the options for your JBoss EAP installation.

2. Copy the service initialization and configuration files into the system directories:

   1. Copy the modified service configuration file to the /etc/default directory.

      Note

      The commands in this procedure require root privileges to run. Either run su - to switch to the root user or preface the commands with sudo.

      $ sudo cp EAP_HOME/bin/init.d/jboss-eap.conf /etc/default

   2. Copy the service startup script to the /etc/init.d directory and give it execute permissions:

      $ sudo cp EAP_HOME/bin/init.d/jboss-eap-rhel.sh /etc/init.d
      $ sudo chmod +x /etc/init.d/jboss-eap-rhel.sh
      $ sudo restorecon /etc/init.d/jboss-eap-rhel.sh

3. Add the new jboss-eap-rhel.sh service to the list of automatically started services using the chkconfig service management command:

   $ sudo chkconfig --add jboss-eap-rhel.sh

4. Verify that the service has been installed correctly by using the following command:

   $ sudo service jboss-eap-rhel start

5. Optional: To make the service start automatically when the RHEL server starts, run the following command:

   $ sudo chkconfig jboss-eap-rhel.sh on

Procedure

1. When the service is running, open a terminal and stop the service with one of the following command:

   $ sudo service jboss-eap-rhel.sh stop

   Note

   The commands in this procedure require root privileges to run. Either run su - to switch to the root user or preface the commands with sudo.

2. Remove JBoss EAP from the list of services:

   $ sudo chkconfig --del jboss-eap-rhel.sh

3. Delete the configuration file and startup script:

   $ sudo rm /etc/init.d/jboss-eap-rhel.sh
   $ sudo rm /etc/default/jboss-eap.conf

Procedure

1. Install the JBoss Core Services Jsvc Package.

   If not already configured, download and extract the JBoss Core Services Jsvc package.

   1. Open a browser and log in to the Red Hat Customer Portal JBoss Software Downloads page.
   2. Select Apache Jsvc in the Product drop-down menu.
   3. Select the latest version from the Version drop-down menu.
   4. Find Red Hat JBoss Core Services Apache Jsvc in the list, ensuring that you select the correct platform and architecture for your system, and click the Download link.
   5. Extract the downloaded archive file into the directory containing your JBoss EAP installation directory.

   6. This results in a jbcs-jsvc-<VERSION>` directory at the same level as your JBoss EAP installation directory. For example:

      C:\Program Files
      ├── jboss-eap-8.0
      │   ├── bin
      │   └── ...
      └── jbcs-jsvc-<VERSION>

2. Install the service.

   1. Open a terminal, and change directories to EAP_HOME\bin.

      Below are examples of a basic service.bat install command to create a new service for either a standalone server, or a server in a managed domain. For a list of all possible options, run service.bat without any arguments.

      Important

      If you specify the /jbossuser and /jbosspass parameters, you must ensure that your JBoss EAP user’s password does not contain a hash (#) or a semicolon (;).

3. Adjust the log level for the service as required:

   1. For a standalone server:

      service.bat install /loglevel INFO

   2. For a server in a managed domain:

      Use the /host parameter to specify the name of the JBoss EAP host controller that is managed by the service. To list valid values for the name by executing ls /host in the management CLI.

      Replace EAP_HOST_NAME in the command below with your JBoss EAP host controller name. If you specify the `/host parameter without providing a JBoss EAP host controller name, the name defaults to master.

      service.bat install /host EAP_HOST_NAME /loglevel INFO

      A new Windows service will be created with name JBossEAP8.

4. Verify the new Service in the Services console.

   1. Open the Windows Services console (services.msc) and verify that the service was created.

      If the default service name was used, in the list of Windows services the new service will have the display name: JBossEAP8. From the Services console you can start and stop the service, as well change its settings of how and when it starts.

5. Starting and stopping the JBoss EAP Service from a Terminal.

   1. To start the service from a terminal, use the following command, changing the service name if necessary:

      net start JBossEAP8

   2. To stop the service from a terminal, use the following command, changing the service name if necessary:

      net stop JBossEAP8

Procedure

1. Use the setx command to configure the two environment variables:

   1. Set the path for the JBOSS_HOME variable to the JBoss EAP installation directory.
   2. The jboss-cli.bat script contains the "x%NOPAUSE%" == "x" pause line of code. This code creates a status message when you issue the pause command. To disable these messages, you must specify a value for the NOPAUSE variable. For example, setting the NOPAUSE variable to NOPAUSE=true disables status messages from appearing when a script completes.
2. Use the setx command to create two system environment variables: JBOSS_HOME and NOPAUSE.

Procedure

1. When the service is running, open the command prompt and stop the service by entering the net stop command with the name of the service:

   net stop JBossEAP8

2. At a command prompt, change directories to EAP_HOME\bin and execute the following command:

   service.bat uninstall