TIBCO Silver Fabric WebSphere Enabler Guide

Transcription

1 TIBCO Silver Fabric WebSphere Enabler Guide Software Release September 2013 Two-Second Advantage

2 Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE. USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE LICENSE FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME. This document contains confidential information that is subject to U.S. and international copyright laws and treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO Software Inc. TIBCO, TIBCO Silver, Two-Second Advantage, FabricServer, GridClient, GridBroker, FabricBroker, LiveCluster, VersaUtility, VersaVision, SpeedLink, Federator, and RTI Design are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries. EJB, Java EE, J2EE, and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries. TIBCO products may include some or all of the following: Software developed by Terence Parr. Software developed by the Apache Software Foundation ( This product uses c3p0. c3p0 is distributed pursuant to the terms of the Lesser General Public License. The source code for c3p0 may be obtained from For a period of time not to exceed three years from the Purchase Date, TIBCO also offers to provide Customer, upon written request of Customer, a copy of the source code for c3p0. Software developed by MetaStuff, Ltd.

3 Software licensed under the Eclipse Public License. The source code for such software licensed under the Eclipse Public License is available upon request to TIBCO and additionally may be obtained from Software developed by Info-ZIP. This product includes Javassist licensed under the Mozilla Public License, v1.1. You may obtain a copy of the source code from This product includes software licensed under the Common Development and Distribution License (CDDL) version 1.0. The source code for such software licensed under the Common Development and Distribution License (CDDL) version 1.0 is available upon request to TIBCO. Software developed by Jason Hunter & Brett McLaughlin. Software developed by JSON.org. Software developed by QOS.ch. Software developed by the OpenSymphony Group ( This product includes WSDL4J software which is licensed under the Common Public License, v1.0. The source code for this software may be obtained from TIBCO s software distribution site. Software developed by the Indiana University Extreme! Lab ( Software developed by Jean-loup Gailly and Mark Adler. All other product and company names and marks mentioned in this document are the property of their respective owners and are mentioned for identification purposes only. THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM. THIS DOCUMENT IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.

4 THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME. THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES. This Product is covered by U.S. Patent No. 6,757,730, 7,093,004, 7,093,004, and patents pending. Copyright TIBCO Software Inc. ALL RIGHTS RESERVED. TIBCO Software Inc. Confidential Information

5 v Contents Preface vii Related Documentation viii TIBCO Silver Fabric Documentation viii Other Documentation and Help viii Typographical Conventions x Connecting with TIBCO Resources xiii How to Join TIBCOmmunity xiii How to Access All TIBCO Documentation xiii How to Contact TIBCO Support xiii Chapter 1 Introduction Architecture Before Beginning Requirements Chapter 2 Installation Requirements Creating a Distribution Grid Library System Requirements for WebSphere Enablers Enabler Java SDK Requirements Enabler Upgrade Notes Installing the WebSphere Enabler Chapter 3 Configuration Before Beginning Running WebSphere Application Server as part of Network Deployment Cell with an external Deployment Manager Network Environment Prerequisites Task 1: Configuring WebSphere Network Deployment Cell Task 2: Deploy Your Application Task 3: Define the Component in Silver Fabric Task 4: Publish the Component Task 5: Create a Stack Running WebSphere Application Server as part of Network Deployment Cell with a Silver Fabric Deployment Manager Enabler

6 vi Task 1: Create a Component for the Deployment Manager Task 2: Create a Component for the Managed Application Server Task 3: Publish the Components Task 4: Create a Stack Configuring SSL Configuring External Deployment Manager to Enable Security Configuring Silver Fabric-Controlled Deployment Manager to Enable Security Configuring the Silver Fabric Component to Enable Security Running Multiple Deployment Manager Cells Archive Management Chapter 4 Running Your Component Verifying Your Component Configuration Load Balancing VirtualRouter WebSphere Web Server Plug-in Chapter 5 Statistics and Variables Statistics Runtime Context Variables Chapter 6 Distribution Grid-library.xml Files About Distribution Grid Libraries Sample Grid-library.xml Files WebSphere WebSphere WebSphere

7 vii Preface TIBCO Silver Fabric combines the flexibility and scalability of the public cloud with the security and control of your own data center. It brings the elasticity of cloud computing to your organization supporting existing solutions within your current infrastructure while automatically scaling resources to meet demand. Topics Related Documentation, page viii Typographical Conventions, page x Connecting with TIBCO Resources, page xiii

8 viii Related Documentation This section lists documentation resources you may find useful. TIBCO Silver Fabric Documentation The following documentation is included with Silver Fabric in Adobe Acrobat (PDF) format. To view the guides, log in to the Administration Tool and go to Admin > Documentation. The PDF files are also on the Broker at livecluster/admin/docs. The following documents form the Silver Fabric documentation set: Introducing Silver Fabric Contains an introduction to Silver Fabric, including definitions of key concepts and terms, such as Enablers, Stacks, Components, Engines, and Brokers. Read this first if you are new to Silver Fabric. Silver Fabric Installation Guide Covers installation of Silver Fabric for Windows and Unix, including Brokers, Engines, and pre-installation planning. Silver Fabric Cloud Administration Guide Covers Silver Fabric cloud administration, configuration of Engines, Enablers, and Components, and configuration and use of Skyway. Also covers security, general maintenance, performance tuning, and database administration. Silver Fabric Developer s Guide Developer-related topics such as logging and debugging, using the Admin API, and the Enabler SDK. Silver Fabric User s Guide Covers Silver Fabric use and operation, including management of Engines, Enablers, Components, and Stacks. Silver Fabric Skyway User s Guide Covers usage of Skyway, which enables users to quickly and easily provision and manage their Silver Fabric Stacks. Silver Fabric Tomcat Enabler Guide Covers installation and configuration of applications run on the Tomcat Enabler. Silver Fabric Command Line Enabler Guide Covers installation and configuration of applications run on the Command Line Enabler. Other Documentation and Help Additional help and information is available from the following sources: Silver Fabric Administration Tool Help Context-sensitive help is provided throughout the Silver Fabric Administration Tool by clicking the Page Help button located on any page.

9 ix API Reference Silver Fabric API reference information is available in the Silver Fabric SDK in the api directory in JavaDoc format. You can also view and search them from the Silver Fabric Administration Tool; log in to the Administration Tool and go to Admin > Documentation.

10 x Typographical Conventions The following typographical conventions are used in this manual. Table 1 General Typographical Conventions Convention TIBCO_HOME SF_HOME code font Use Many TIBCO products must be installed within the same home directory. This directory is referenced in documentation as TIBCO_HOME. The default value of TIBCO_HOME depends on the operating system. For example, on Windows systems, the default value is C:\tibco. TIBCO Silver Fabric installs into a directory within TIBCO_HOME. This directory is referenced in documentation as SF_HOME. The default value of SF_HOME depends on the operating system. For example on Windows systems, the default value is C:\tibco\fabric. Code font identifies commands, code examples, filenames, pathnames, and output displayed in a command window. For example: Use MyCommand to start the foo process. bold code font Bold code font is used in the following ways: In procedures, to indicate what a user types. For example: Type admin. In large code samples, to indicate the parts of the sample that are of particular interest. In command syntax, to indicate the default parameter for a command. For example, if no parameter is specified, MyCommand is enabled: MyCommand [enable disable] italic font Italic font is used in the following ways: To indicate a document title. For example: See TIBCO ActiveMatrix BusinessWorks Concepts. To introduce new terms. For example: A portal page may contain several portlets. Portlets are mini-applications that run in a portal. To indicate a variable in a command or code syntax that you must replace. For example: MyCommand PathName

11 xi Table 1 General Typographical Conventions (Continued) Convention Key combinations Use Key names separated by a plus sign indicates keys pressed simultaneously. For example: Ctrl+C. Key names separated by a comma and space indicate keys pressed one after the other. For example: Esc, Ctrl+Q. The note icon indicates information that is of special interest or importance, for example, an additional action required only in certain circumstances. The tip icon indicates an idea that could be useful, for example, a way to apply the information provided in the current section to achieve a specific result. The warning icon indicates the potential for a damaging situation, for example, data loss or corruption if certain steps are taken or not taken. Table 2 Syntax Typographical Conventions Convention Use [ ] An optional item in a command or code syntax. For example: MyCommand [optional_parameter] required_parameter A logical OR that separates multiple items of which only one may be chosen. For example, you can select only one of the following parameters: MyCommand param1 param2 param3

12 xii Table 2 Syntax Typographical Conventions (Continued) Convention Use { } A logical group of items in a command. Other syntax notations may appear within each logical group. For example, the following command requires two parameters, which can be either the pair param1 and param2, or the pair param3 and param4. MyCommand {param1 param2} {param3 param4} In the next example, the command requires two parameters. The first parameter can be either param1 or param2 and the second can be either param3 or param4: MyCommand {param1 param2} {param3 param4} In the next example, the command can accept either two or three parameters. The first parameter must be param1. You can optionally include param2 as the second parameter. And the last parameter is either param3 or param4. MyCommand param1 [param2] {param3 param4}

13 xiii Connecting with TIBCO Resources How to Join TIBCOmmunity TIBCOmmunity is an online destination for TIBCO customers, partners, and resident experts, a place to share and access the collective experience of the TIBCO community. TIBCOmmunity offers forums, blogs, and access to a variety of resources. To register, go to How to Access All TIBCO Documentation After you join TIBCOmmunity, you can access the documentation for all supported product versions here: How to Contact TIBCO Support For comments or problems with this manual or the software it addresses, please contact TIBCO Support as follows. For an overview of TIBCO Support, and information about getting started with TIBCO Support, visit this site: If you already have a valid maintenance or support contract, visit this site: Entry to this site requires a user name and password. If you do not have a user name, you can request one.

14 xiv

15 1 Chapter 1 Introduction Silver Fabric Enablers allow external applications or application platforms, such as J2EE application servers to run in a TIBCO Silver Fabric software environment. The WebSphere Enabler for Silver Fabric provides integration between Silver Fabric and IBM WebSphere Server. When managed through Silver Fabric, the WebSphere environment is dynamic, centralized, and largely automated. The Enabler automatically provisions, controls, and manages a WebSphere clustered environment. WebSphere Server instances and WebSphere node agents are distributed and run on Silver Fabric Engines as managed servers of a cluster. This centralized management adapts the WebSphere environment so that the life cycle and process state of WebSphere Deployment Managers, managed application servers and node agents is defined through Silver Fabric Policies that are directed by business objectives associated with the target applications. Topics Architecture, page 2 Before Beginning, page 3

16 2 Architecture Silver Fabric Engines manage WebSphere Deployment Managers, WebSphere managed server instances and a WebSphere node agent per node. The Silver Fabric Broker and the Silver Fabric Engine instance collaborate to perform the following actions: Automatically provision all WebSphere Application Server related and IBM-specific Java JDK software to a machine with Silver Fabric Engine. The automatically provisioned software is contained in archive libraries (zip files) and distributed to computers running Silver Fabric Engines. A Silver Fabric Engine provisioned with the required WebSphere Application Server-related software along with JDK software can act as a WebSphere node. Automatically define a custom managed-node profile and federate the node to a WebSphere Network Deployment Cell. Automatically start and stop a WebSphere nodeagent process on a node. Automatically start and stop WebSphere application servers on a node, as required by Policies specified in the Silver Fabric Broker. Automatically remove and cleanup configuration related to WebSphere Server and node from a WebSphere Network Deployment cell, when they are deemed not required as dictated by Policies specified in the Silver Fabric Broker. Monitor the health of the WebSphere Server and nodeagent running on a node and retrieve various performance statistics. Optionally, start and manage an instance of a WebSphere Deployment Manager to support a Network Deployment Cell environment.

17 3 Before Beginning This guide provides the instructions for installing and configuring the WebSphere Enabler and WebSphere Deployment Manager Enabler for Silver Fabric. This guide assumes a Silver Fabric Broker is running with at least one Engine installed, and that you have the Broker s hostname, a username, and password for the Silver Fabric Administration Tool. If this isn t true, see the Silver Fabric Installation Guide, or contact your administrator. This guide presumes a strong familiarity with your particular version of WebSphere. WebSphere Enablers for Silver Fabric support several WebSphere versions, and the instructions provided for accomplishing tasks in the WebSphere user interface are not version-specific. If you are uncertain of how to achieve a particular task, consult your version-specific WebSphere documentation. Requirements Please see the included Silver Fabric Readme for the latest prerequisites required for this Enabler.

18 4

19 5 Chapter 2 Installation This chapter provides information on installation of the WebSphere Enabler. Topics Requirements, page 6 System Requirements for WebSphere Enablers, page 8 Installing the WebSphere Enabler, page 9

20 6 Requirements The WebSphere Enabler consists of an Enabler Runtime Grid Library, at least one Distribution Grid Library, and at least one IBM JDK Grid Library. The Enabler Runtime contains information specific to a Silver Fabric version that is used to integrate the Enabler; and the Distribution contains the application server or program used for the Enabler. The required Grid Libraries for each version of the WebSphere Enabler are listed below. Enabler Version Required Grid Libraries 7.0 TIB_silver_fabric_5.5.0_websphere_7.0_platform-distribution-gridlib.zip TIB_silver_fabric_5.5.0_websphere_7.0_enabler.tar.gz TIB_silver_fabric_5.5.0_websphere_dm_7.0_enabler.tar.gz (optional Deployment Manager) ibm-j2sdk-<platform>-1_6_0-gridlib.zip 8.0 TIB_silver_fabric_5.5.0_websphere_8.0_platform-distribution-gridlib.zip TIB_silver_fabric_5.5.0_websphere_8.0_enabler.tar.gz TIB_silver_fabric_5.5.0_websphere_dm_8.0_enabler.tar.gz (optional Deployment Manager) ibm-j2sdk-<platform>-1_6_0-gridlib.zip 8.5 TIB_silver_fabric_5.5.0_websphere_8.5_platform-distribution-gridlib.zip TIB_silver_fabric_5.5.0_websphere_8.5_enabler.tar.gz TIB_silver_fabric_5.5.0_websphere_dm_8.5_enabler.tar.gz (optional Deployment Manager) ibm-j2sdk-<platform>-1_6_0-gridlib.zip platform is the platform on which Silver Fabric Engines run WebSphere Enabler Components. To run the Enabler on multiple platforms, you must deploy multiple JDK Grid Libraries, and corresponding Distribution Grid Libraries, one for each platform.

21 7 Creating a Distribution Grid Library Distribution Grid Libraries are not provided by TIBCO. For information on how to create them, see.chapter 6, Distribution Grid-library.xml Files, on page 43

22 8 System Requirements for WebSphere Enablers This section describes the system requirements and upgrade requirements for WebSphere Enablers on Silver Fabric. Enabler Java SDK Requirements These are the Java version requirements for the WebSphere Enabler: Enabler IBM 1.5 Java SDK IBM 1.6 Java SDK WebSphere 7.0 No Yes No WebSphere 8.0 No Yes No WebSphere 8.5 No Yes Yes IBM 1.7 Java SDK To use Java version 1.7, you must set the JDK_VERSION runtime variable first. Note that the IBM 1.7 Java SDK is not available for every platform supported by Silver Fabric. Refer to IBM s web site for availability. Enabler Upgrade Notes WebSphere packages Jython 2.1 which does not initially run on Windows 2003 or later. To make Jython 2.1 run on these systems, the OS name, such as Windows 2003, Windows Server 2003, Windows 7, and so on, is added to the _ostypemap in the javaos.py file found in Jython Lib library module directory included in the optionallibraries/jython directory under the WebSphere installation directory. Additional OS names may be added to this list using "Edit the configuration file" link when editing the Enabler using Silver Fabric Administration Tool.

23 9 Installing the WebSphere Enabler To install the WebSphere Enabler: 1. Copy the desired WebSphere Enabler version Grid Library files to the SF_HOME/webapps/livecluster/deploy/resources/gridlib directory in the following order: Distribution IBM JDK Grid Library Enabler Runtime Copying the Grid Library files to this directory also extracts them to the expanded directory: SF_HOME/webapps/livecluster/deploy/expanded/staging/domain. This overwrites any changes to the existing Grid Library in the staging directory. You cannot upgrade or remove Grid Libraries while the respective Component and Enabler are part of the effective Policy. If Engines used to run WebSphere server instances are configured to use a shared Grid Libraries directory, that directory will need to have a sibling directory named temp_jars and the Engines in question will need to be able to write to that directory. For more about the use of a shared directory for Grid Libraries, see Resource Synchronization in the Silver Fabric Installation Guide. 2. Verify successful installation by selecting Stacks > Enablers in the Silver Fabric Administration tool and ensuring that the Enabler appears in the list.

24 10

25 11 Chapter 3 Configuration This chapter provides information on configuring the WebSphere Enabler. Topics Before Beginning, page 12 Running WebSphere Application Server as part of Network Deployment Cell with an external Deployment Manager, page 13 Running WebSphere Application Server as part of Network Deployment Cell with a Silver Fabric Deployment Manager Enabler, page 18 Configuring SSL, page 22 Running Multiple Deployment Manager Cells, page 26 Archive Management, page 27

26 12 Before Beginning These instructions presume a strong familiarity with your particular version of WebSphere. The instructions provided for accomplishing tasks in the WebSphere user interface are not version-specific. If you are uncertain of how to achieve a particular task, consult your version-specific WebSphere documentation.

27 13 Running WebSphere Application Server as part of Network Deployment Cell with an external Deployment Manager The following section describes how to run a clustered WebSphere application with a Silver Fabric Engine running a managed WebSphere Application Server and Node Agent as part of WebSphere Network Deployment Cell. The Deployment Manager runs external to Silver Fabric environment (a Deployment Manager is a central point of administrative control for all elements in a WebSphere Application Server distributed cell). Silver Fabric Engine starts one node agent server per node, and each Engine instance on that host can run one instance of a managed WebSphere Application Server. Network Environment Prerequisites All network computers that are running Silver Fabric Engines and hosting WebSphere Enablers require the following: All such computers must have their clocks synchronized within five minutes of each other and with the WebSphere Deployment Manager computer (based on GMT time). The machines can be in different time zones. All such computers must be able to resolve each other's host name, either through DNS or their file based host tables. Task 1: Configuring WebSphere Network Deployment Cell The following is a once-only set-up for the WebSphere Network Deployment Cell: 1. Create a custom managed server profile on the same host as WebSphere Deployment Manager. You can create a profile using the manageprofiles script available with the Deployment Manager WebSphere Application Server installation. It uses a profile template called managed, which is also included in the WebSphere Application Server installation. 2. Create a dummy node in the managed server profile you created in the previous step, and add it to the WebSphere Cell. The node created never runs a Node Agent. You can create a node using the addnode script in the WebSphere Application Server installation. Add a -noagent argument to the addnode command so it does not launch the node agent process for the new node. 3. Create as many clusters as required in the Deployment Manager admin console, each with a relevant cluster name.

28 14 4. Define a dummy cluster member (one per cluster for every cluster you defined), using the previously defined dummy node. Before creating the cluster member, ensure that the application server template for the cluster member application server is configured to disable auto restart. To do this, edit the server.xml in the template file you re using to create the cluster member. By default, this file is located under the relevant Deployment Manager profile, under the directory: config/templates/servertypes/application_server/servers/default. You must update the monitoringpolicy entity, and set the autorestart attribute to false. This dummy cluster member, one per cluster, acts as the template for creating all application servers dynamically within the cluster. Employing a naming convention such as: dummy_<cluster name>, where cluster name is the name of the previously defined cluster, is recommended. Additional configuration settings for the cluster members: Use the first cluster member you just created to create a template based on it. Customize the new template as needed. To ensure that all future members are created using this new template: Delete the first cluster member created in step 4, then recreate the first cluster member based on the new template you just customized. 5. Add the following host aliases to the default_host Virtual Hosts Environment entry on Deployment Manager: *:9080, *:9081,, *:908x and *:9443, *:9444,, *:945x assuming a maximum of x Engine instances per node. Adjust according to your requirement for the maximum number of application servers (Engines) per node. 6. Deploy WebSphere performance servlet (PerfServletApp.ear) on the Deployment Manager. It is available on the Deployment Manager under installable applications. Target the servlet to the clusters you defined in step 3. This Performance Servlet lets the WebSphere Enabler collect and report various performance metrics or statistics specific to each running WebSphere Application Server instance. Task 2: Deploy Your Application Do the following: 1. Log in to your WebSphere Deployment Manager Administration console. 2. Access the area where you install and manage new applications. 3. Select and upload your.ear or.war/.jar archives.

29 15 4. When prompted to Map modules to servers, select all the relevant clusters you defined in Task 1: Configuring WebSphere Network Deployment Cell as deployment targets for the application and apply the changes with the application selected. 5. Review and save the changes to the application installation configuration to the master configuration repository of the Deployment Manager. Task 3: Define the Component in Silver Fabric Do the following: 1. Enter your Silver Fabric host and port in your browser and log in to the Silver Fabric Administration Tool. 2. Select Stacks > Components. 3. Select Create New J2EE Component from the Global Actions list. 4. If prompted, select the WebSphere Enabler and desired Enabler Version from the available Enablers. 5. Enter the Component name in the Name field. 6. Click Next. The Configure Component features screen appears. HTTP Support and Application Logging Support are the features added by default. 7. Select Clustering Support from the Add Feature list. The Enter feature values screen appears. 8. Enter the values you are prompted for on the Clustering Support feature screen. 9. Click OK. 10. Click Next. The Configure Component Options screen appears. Make changes as needed. 11. Click Next until the URL Patterns page appears. VirtualRouter uses these URLs to map incoming requests to a Component, and to a particular Engine running that Component. 12. Keep clicking Next and provide information as needed by each page, where necessary. Note that you can provide values specific to this Component on the Add/override/edit Enabler and Component-specific runtime context variables screen by overriding any of the Runtime Context variables defined in the WebSphere Enabler. Alternatively, you can view and edit values for all the Enabler-specific Runtime Context variables through the Enabler Wizard.

30 Click Finish. When running many instances of WebSphere Enabler, if some Components fail to activate within the default timeout period, increase the default values of the Minimum and Maximum Activation Time parameters on the Add/edit Component options screen, and increase the following variables on the Add/override/edit Enabler and Component-specific runtime context variables screen: GLOBAL_LOCK_EXPIRATION_TIME GLOBAL_LOCK_ACQUISITION_TIMEOUT NODE_ACTIVATION_LOCK_TIMEOUT Task 4: Publish the Component Do the following: 1. Select Stacks > Components in the Silver Fabric Administration Tool. 2. Select Publish Component from the corresponding Actions list of the Component you created in Task 3: Define the Component in Silver Fabric. Task 5: Create a Stack Do the following: 1. Select Stacks > Stacks in the Silver Fabric Administration Tool. 2. Select Create New Stack from the Global Actions list. 3. Enter the Stack name in the Name field, and optionally a Description. 4. Click the [+] next to the Components label. In the Component chooser it reveals, select the Component or Components you want in the Available Components list, then click [>>] to transfer them to the Selected Components list. 5. Optionally set the minimum, maximum, priority and rules of your Components in the Policies section. 6. Click Save. 7. Select Publish Stack from the Actions list for the Stack you just created.

31 17 Your clustered WebSphere Application is now ready. To run the Application, you must activate the Stack you created in Task 5: Create a Stack. You can do this manually by selecting Stacks > Stacks > Run Stack in Manual Mode from the new Stack s Actions list, or automatically through a schedule-based Policy change. For more information on creating and using Policy Schedules, see the Silver Fabric Cloud Administration Guide.

32 18 Running WebSphere Application Server as part of Network Deployment Cell with a Silver Fabric Deployment Manager Enabler The following section describes how to run all the components of a WebSphere Network Deployment Cell under Silver Fabric environment. A Deployment Manager, a managed Application Server and Node Agent all runs on Silver Fabric Engines forming a complete WebSphere Network Deployment Cell (a Deployment Manager is a central point of administrative control for all elements in a WebSphere Application Server distributed cell). In this mode, two Silver Fabric Components are configured and run. One based on WebSphere Deployment Manager Enabler that represents Deployment Manager. The other Component based on WebSphere Enabler that represents managed server and node agent that connect to the Deployment Manager. A Silver Fabric Engine starts a Deployment Manager, then, one node agent server per node, and each available Engine instance can run one instance of a managed Application Server. Task 1: Create a Component for the Deployment Manager Do the following: 1. Enter your Silver Fabric host and port in your browser and log in to the Silver Fabric Administration Tool. 2. Select Stacks > Components. 3. Select Create New J2EE Component from the Global Actions list. 4. If prompted, select the WebSphere Enabler and desired Enabler Version from the available Enablers. 5. Enter a Component name in the Name field. 6. Click Next. The Configure Component features screen appears. HTTP Support, Application Logging Support and Archive Support are added to the feature list by default. 7. Select Capture Support from the Add Feature list to add it to the Component. The Enter Feature Values screen appears. 8. Click OK. You can further customize Component features as needed by selecting the feature and clicking Edit. 9. Click Next. The Configure Component Options screen appears. Make changes as needed. 10. Click Next until the Add/Remove Archive Files screen appears.

33 Click Add and upload the J2EE archives that you want to deploy and run on the WebSphere cluster. You may skip this step and install your J2EE applications directly using Deployment Manager console. Alternatively, you can deploy applications directly to Engines running WebSphere servers using Silver Fabric APIs. For more information, refer to Archive Management on page Configure the options on the remaining screens as needed. Additional options are also configurable through context variables. 13. Click Finish. Task 2: Create a Component for the Managed Application Server Do the following: 1. Enter your Silver Fabric host and port in your browser and log in to the Silver Fabric Administration Tool. 2. Select Stacks > Components. 3. Select Create New J2EE Component from the Global Actions list. 4. If prompted, select the WebSphere Enabler and desired Enabler Version from the available Enablers. 5. Enter a Component name in the Name field. 6. Click Next. The Configure Component features screen appears. 7. Select Clustering Support from the Add feature list. The Enter feature values screen appears. 8. Enter information based on the Engine on which Engine will run the Administration Server Component. Specify placeholder values ${EXPORTED_CLUSTER_NAME}, ${EXPORTED_DEPLOYMENT_MANAGER_SOAP_PORT}, ${EXPORTED_DEPLOYMENT_MANAGER_CELL_NAME} and ${EXPORTED_DEPLOYMENT_MANAGER_HOST_NAME} if you have added a Component Dependency Rule such that this Component depends on the Deployment Manager Component. These placeholders will be automatically substituted with correct value based on which Engine runs the Deployment Manager Component. Also, enable the Ordered Shutdown flag of the Component Dependency Rule so that the Deployment Manager is shut down only after all the managed nodes have successfully shut down and removed their configuration from the Deployment Manager and deleted their runtime work directory. 9. Click OK.

34 Click Next. The Configure Component Options screen appears. Make changes as needed. 11. Keep clicking Next and provide information as needed by each page, where necessary. 12. Click Finish. Task 3: Publish the Components Do the following: 1. Select Stacks > Components in the Silver Fabric Administration Tool. 2. Select Publish Component from the corresponding Actions lists of the two Components you created in Tasks 1 and 2. Task 4: Create a Stack Do the following: 1. Select Stacks > Stacks in the Silver Fabric Administration Tool. 2. Select Create New Stack from the Global Actions list. 3. Enter the Stack name in the Name field, and optionally a Description. 4. Click the [+] next to the Components label. In the Component chooser it reveals, select the Components you created in Task 1 and Task 2 in the Available Components list, then click [>>] to transfer them to the Selected Components list. 5. Optionally set the minimum, maximum, priority and rules of your Components in the Policies section. 6. Add Component Dependency Rule to the managed Application Server Component in the Policies section such that the managed Application Server Component depends on the Deployment Manager Component. This ensures the Deployment Manager Component will activate before the managed Application Server Component. 7. Click Save. 8. Select Publish Stack from the Actions list for the Stack you just created.

35 21 Your clustered WebSphere Application is now ready. To run the Application, you must activate the Stack you created in Task 4: Create a Stack. You can do this manually by selecting Stacks > Stacks > Run Stack in Manual Mode from the new Stack s Actions list, or automatically through a schedule-based Policy change. For more information on creating and using Policy Schedules, see the Silver Fabric Administration Guide.

36 22 Configuring SSL Your Deployment Manager and Silver Fabric environment both needs to be configured properly to enable end-to-end security. Configuring External Deployment Manager to Enable Security You can enable and configure various aspects of security through the WebSphere Deployment Manager administration console s SSL certificate and key management area. Refer to your WebSphere Application Server documentation for detailed information on configuring security. Configuring Silver Fabric-Controlled Deployment Manager to Enable Security Do the following: 1. Access the administration console of WebSphere Deployment Manager running on an Engine, then you can enable and configure various aspects of security through the console's SSL certificate and key management area. Refer to your WebSphere Application Server documentation for detailed information on configuring security. 2. Select Stacks > Components in the Silver Fabric Administration Tool. 3. Select Edit Component and enable HTTPS in the HTTP Support feature.

37 23 4. Select Add/override/edit Enabler and Component Specific Runtime Context Variables and configure the following Runtime Context variables as necessary: KEY_STORE_TYPE - the type of key store, generally PKCS12 TRUST_STORE_TYPE - the type of trust store, generally PKCS12 SERVER_KEY_ALIAS - alias of the server key in the keystore CLIENT_KEY_ALIAS - alias of the client key in the keystore SERVER_KEY_STORE_FILE - the filename of the server keystore file SERVER_TRUST_STORE_FILE - the filename of the server truststore file SERVER_KEY_STORE_PASSWORD - the password for the server keystore SERVER_TRUST_STORE_PASSWORD - the password for the server truststore APP_SECURITY_ENABLED (true/false) - whether or not to enable application security JAVA2_SECURITY_ENABLED (true/false) - whether or not to enable Java 2 security ACTIVE_AUTH_MECHANISM (KRB5 or LTPA) - the auth mechanism to use ACTIVE_USER_REGISTRY (LocalOSUserRegistry, CustomUserRegistry, LDAPUserRegistry, or WIMUserRegistry) - the user registry to use CUPRIMARY_ID - for use with CustomUserRegistry CUSERVER_ID - for use with CustomUserRegistry CUSERVER_PASSWORD - for use with CustomUserRegistry CUSERVER_CLASS - for use with CustomUserRegistry KEY_STORE_NAME - the logical name of the keystore TRUST_STORE_NAME - the logical name of the truststore 5. Select Add/override/customize Enabler and Component-specific content files and add the required key store files with the keystores/relative path. 6. Select Publish Component from the Actions list adjacent to your Component after capture successfully finishes. Status column on System > Engine Admin indicates if Engine is currently capturing a Component. 7. Deployment Manger will start with security enabled when the deployed Component activates on an Engine.

38 24 IMPORTANT: Enable the All Authenticated option for the performance servlet to ensure that Security role to user/group mapping for PerfServletApp is such that all valid authenticated users in the associated user registry can access resources that are protected by the role associated with the performance servlet application. Refer to your WebSphere Application Server documentation for detailed information on configuring security. Configuring the Silver Fabric Component to Enable Security Do the following to configure SSL for managed Application Server Components: 1. Select Stacks > Components in the Silver Fabric Administration Tool. 2. Select Edit Component from the Actions list adjacent to your Component. 3. Select Add/Edit Component Features. 4. Select the HTTP Support feature and click Edit. 5. Select the HTTPS Enabled option. 6. Click OK. 7. Select Add/override/edit Enabler and Component Specific Runtime Context Variables and configure the following Runtime Context variables as necessary: USERNAME - the username for authentication if security is enabled in the server. PASSWORD - the password for authentication if security is enabled in the server. KEY_STORE_TYPE - the type of key store, generally PKCS12 TRUST_STORE_TYPE - the type of trust store, generally PKCS12. KEY_STORE_LOCATION - the directory containing the key store files. (Default [Profile directory]/etc.) SERVER_KEY_STORE_FILE - the filename of the server key store file. (For example: key.12) SERVER_TRUST_STORE_FILE - the filename of the server trust store file (For example: trust.12) SERVER_KEY_STORE_PASSWORD - the password for the server key store. SERVER_TRUST_STORE_PASSWORD - the password for the server trust store. 8. Select Add/override/customize Enabler and Component-specific content files and add the required key store files with the keystores/ relative path.

39 25 Key store files added here will be automatically copied to the location specified by the KEY_STORE_LOCATION runtime variable. 9. Click Finish.

40 26 Running Multiple Deployment Manager Cells You can run multiple Deployment Manager Cells simultaneously under Silver Fabric environment for reasons like independent cell level administration, isolation of hardware or software failure, etc. An Engine host corresponds to a Node in single Deployment Manager environment. But, supporting multiple Cells requires a capability for an Engine host to host more than one Node. One node agent server will be started per Node. Each node agent and managed server will use distinct set of ports to avoid conflicts. You can configure the base value for the ports using relevant Runtime Context Variables in WebSphere Enabler. Override the WAS_PARENT_WORK_DIR Variable in your managed Application Server Components to specify unique runtime directory per Node, such that, when multiple Nodes are configured and active on the same host they use distinct runtime directory.

41 27 Archive Management The WebSphere Enabler can dynamically manage the set of application archives that are deployed and running on WebSphere servers. This consists of archive detection, context URL detection, and continuous deployment operations. Archive Detection The WebSphere Enabler regularly detects the current set of archives that are deployed and running on WebSphere server. On the Broker, this list is reflected in the ActivationInfo associated with the Engines running managed WebSphere application servers. Note that the ARCHIVE_DETECTION_ENABLED and ARCHIVE_DETECTION_FREQUENCY runtime context variables can be modified, respectively, to control whether or not polling of archives is performed, and how often this detection happens. Context URL Detection The WebSphere JMX server is queried for the current set of context URLs associated with running web applications. This set of URLs is reported to the Broker and updated in VirtualRouter. Continuous Deployment Users can deploy, start, stop, and undeploy application archives to WebSphere by using the archive level API operations provided by the Silver Fabric Broker through REST, Ant, and the Command Line Interface (CLI). See the Silver Fabric Administration Guide for more details on using these tools to manage archives. Note that for the WebSphere Enabler, archive operations must be targeted to a managed server component instance. The archive operations are always performed at the cluster level, so performing the archive operation on any one of the cluster members will take effect for all members of the cluster to which that application server belongs. For convenience, the ActivationInfo property ClusterName can be used in a continuous deployment deployment criteria file to target an application to a member of that cluster.

42 28

43 29 Chapter 4 Running Your Component After configuring and activating your Silver Fabric WebSphere Component, you can access the applications running on the WebSphere Servers as you would normally. To further verify a successful Component configuration, you can access the Web application through the VirtualRouter Status page as described below. Topics Verifying Your Component Configuration, page 30 Load Balancing, page 31

44 30 Verifying Your Component Configuration Do the following: 1. Select Engines > Engines in the Silver Fabric Administration Tool and ensure that at least one instance of your Component is running on an Engine. 2. Go to Admin > VirtualRouter. The VirtualRouter page contains a table for each VirtualRouter client that is currently running. Select the VirtualRouter Properties action next to each client to show the Component each host is running. 3. When you find the client running your Component, select the Status Page action. The VirtualRouter Status page is shown: 4. In the Relative URLs column, entries for each context root are listed. Click a URL to connect to the web application. HTTP requests made when the URL is clicked in the Component-level Relative URLs column, are sent to VirtualRouter, which forwards the request to an Engine running the Component. HTTP requests made when the URL is clicked on the Engine-level Relative URLs column are sent directly to that Engine. Alternatively, you can mimic the behavior of the VirtualRouter Status page by directing your browser to the address/port of your Silver Fabric Broker with a relative URL from your Component, such as (where myapp is one of the deployed J2EE application). If you cannot access your Web application, re-verify your Component configuration based on the steps in Chapter 3, Configuration, on page 11. For testing purposes, you can also directly access WebSphere servers running on Silver Fabric Engines. The listen port of a server is the value of WC_defaulthost or WC_defaulthost_secure for the running WebSphere Application Server for the Component under consideration. This port information can be found from the Deployment Manager administration console's Ports section of the server.

45 31 Load Balancing Load balancing is recommended for proxying requests from clients and routing them to Engines running the appropriate Component. Load balancing is achieved through mappings between relative URLs and Components. VirtualRouter VirtualRouter is Silver Fabric s load balancer for HTTP enabled Components. An instance of VirtualRouter runs by default on each Silver Fabric Broker, and can also run externally. Additionally, VirtualRouter maintains HTTP Session mappings between clients and WebSphere servers by examining the standard JSESSIONID cookie. For more information about using VirtualRouter, see the Silver Fabric Cloud Administration Guide. WebSphere Web Server Plug-in You can use WebSphere Application Server s Web Server Plug-in with Silver Fabric. Refer to your version specific WebSphere documentation for installation and setup of the Web Server plug-in, and to automatically propagate the Plug-in configuration.