Selecting a Web server topology diagram and roadmap

Install and configure Web server plug-ins for WebSphere Application Server to allow the application server to communicate with the Web server. The primary production configuration for a Web server is an application server on one machine and a Web server on a separate machine. This configuration is referred to as a remote configuration. Contrast the remote configuration to the local configuration, where the application server and the Web server are on the same machine.

Overview

• Installs the binary plug-in module on the Web server machine.

• Configures the Web server configuration file on the Web server machine to point to the binary plug-in module and to the XML configuration file for the binary module.

• Installs a temporary XML configuration file for the binary module (plugin-cfg.xml) on the Web server machine in remote scenarios.

• Creates the configuration for a Web server definition on the application server machine. The wizard processes the creation of the Web server definition differently depending on the scenario:

  Web server plug-in installation for stand-alone application server environments

  • Recommended remote stand-alone application server installation:

    Creates a configuration script that you run on the application server machine. Install the Web server and its plug-in on a different machine than the application server. This configuration is recommended for a production environment.

  • Local stand-alone application server installation:

    Detects the default profile on a local application server machine and creates the Web server definition for it directly. Install the Web server and its plug-in on the same machine with the application server. This configuration is for development and test environments.

  Web server plug-in installation for distributed environments (cells)

  • Recommended remote distributed installation:

    Creates a configuration script that you run on the application server machine. Install the Web server and its plug-in on a different machine than the deployment manager or managed node. This configuration is recommended for a production environment.

  • Local distributed installation:

    Creates a configuration script that you run when the deployment manager is running. Install the Web server and its plug-in on the same machine with the deployment manager or a managed node. This configuration is for development and test environments.

Select a link to go to the appropriate steps in the following procedure.

Procedure

• Set up a remote Web server installation for a Standalone node.

  The remote Web server configuration is recommended for production environments.

  The remote installation installs the Web server plug-in on the Web server machine when the application server is on a separate machine, such as shown in the following graphic:
  

  
  

  Remote installation scenario

  Table 1. Installation and configuration

  Step	Machine	Task
  1	A	Install your WebSphere Application Server product.
  2	A	Create an application server profile.
  3	B	If you plan to run IBM HTTP Server on iSeries, it is already installed as product 5722DG1. You can also use a Domino Web server on iSeries. Refer to the Domino documentation for installation instructions. For either scenario, install the Web server Plug-ins component of the WebSphere Application Server product. See Installing Web server plug-ins on i5/OS.
  4	B	Run the manageprofiles Qshell command to create an http profile. The http profiles are V6.x equivalents of 5.0 and 5.1 remote instances. For example, run this command from Qshell: app_server_root/bin/manageprofiles -create -profileName myHttpProfile -templatePath http The myHttpProfile variable is the name of the profile.
  5	B	Configure the IBM HTTP Server with your http profile myHttpProfile. For additional details or information on configuring your Domino HTTP Server, see Configuring an HTTP server instance. If your Web server's name is MyWebServer., an i5/OS qshell script called configureIHS_MyWebServer is created in the myHttpProfile_profile_root/config/IHS_myWebServer directory on machine B. For the default WebSphere Application Server install, themyHttpProfile_profile_root of the profile myHttpProfile is /QIBM/UserData/WebSphere/AppServer/V61/Base/profiles/myHttpProfile. In the remainder of this example, webServerName refers to IHS_myWebServer. If you choose to configure a DOMINO Web server as listed below, then webServerName refers to DOMSRV01. The following steps apply to DOMINO Web servers only: Run the configureOs400WebServerDefinition script on the http profile myHttpProfile. For example: configureOs400WebServerDefinition -profileName myHttpProfile -webserver.name DOMSRV01 -webserver.type DOMINO -webserver.port 80 Using the WRKDOMSVR command to update the notes.ini file of your Domino server, insert the following directive: WebSphereInit=myHttpProfile_profile_root/config/DOMSRV01/plugin-cfg.xml From the Lotus Notes client connected to the Domino server, click the internet protocols tab and then click the HTTP tab. Under DSAPI filter names add the following: /QSYS.LIB/ product_lib.LIB/LIBDOMINO.SRVPGM Save your changes
  6	A	Copy the configurewebServerName script from Machine B to Machine A. The script is found in the myHttpProfile_profile_root/config/webServerName directory described above
  7	A	Place the file you copied from the previous step into the profile_root/bin directory on Machine A, where profile_root is the directory where your application server profile is located.
  8	A	Start the application server and then run the script that you copied in the previous step. For example, run these commands from Qshell: app_server_root/bin/startServer -profileName myProfile cd profile_root/bin ./configurewebServerName [wasAdminUserId] [wasAdminPassword] Note: wasAdminUserId and wasAdminPassword are optional and only needed when the application server of myProfile is running in secure mode.
  9	A	If you use IBM HTTP Server on iSeries, verify that the application server is running. Open the administrative console (ISC) and do the following: Expand Servers > Web servers Select your Web server, in this case it is IHS_MyWebServer, then click Remote web server management Enter the user ID and password used to authenticate to Machine B. The authorities required by this profile are the same as that required to access the HTTP administration GUI. For details, see User profiles and required authorities for HTTP Server in the iSeries Information Center. Save your configuration.
  10	A	Configure a virtual host alias for the Web server machine(B) and Web server port of MyWebServer. For details, see Configuring the virtual host .
  11	A	Stop and restart your application server.
  12	A	In the administrative console (ISC) do the following: Select webServerName and click Generate Plug-in to generate the plugin-cfg.xml file. Select webServerName and click Propagate Plug-in to propagate the plugin-cfg.xml file to machine B.
  13	B	If you use IBM HTTP Server on iSeries, start the Web server. Open the administrative console (ISC) and do the following: Expand Servers > Web servers. Select your Web server, in this case it is IHS_MyWebServer, then click Start. If you use Domino HTTP Server on iSeries, start the Web server from a CL command line: Run the Work with Domino Servers (WRKDOMSVR) command. Specify option 1 next to your Domino server. Press Enter.
  14	B	Run the snoop servlet. Access the following URL in your browser: http://host_name_of_machine_B/snoop If you get an error, retrace your steps. Add a virtual host to Machine A before restarting the application server on Machine A.

  Regeneration of the plugin-cfg.xml file

  The Web server plug-in configuration service regenerates the plugin-cfg.xml file automatically. However, if the service is disabled or if you want to force regeneration, use the administrative console or the GenPluginCfg script. In the administrative console, perform these steps:

  1. Expand Servers > Web servers .

  2. Select the Web server for which you want to regenerate the plugin-cfg.xml file.

  3. Click Generate Plugin.

  Propagation of the plugin-cfg.xml file

  The plugin-cfg.xml file can be propagated manually. Manual propagation of the plugin-cfg.xml file is required for DOMINO Web servers. Copy the plugin-cfg.xml file from the application server machine to the myHttpProfile_profile_root/config/IHS_MyWebServer directory on the Web server machine B. The plugin-cfg.xml file is generated in the directory named profile_root/config/cells/cell_name/nodes/host_name_of_machine_B-node/servers/IHS_myWebServer on the application server machine A.

• Set up a local Web server configuration for a Standalone node.

  The local Web server configuration is recommended for a development or test environment.

  A local installation includes the Web server plug-in, the Web server, and the Application Server on the same machine:
  

  
  

  Local installation scenario

  Table 2. Installation and configuration

  Step	Machine	Task
  1	A	Install your WebSphere Application Server product.
  2	A	Create an application server profile.
  3	A	IBM HTTP Server on iSeries is already installed as product 5722DG1. Alternatively, you can also run Domino Web Server on iSeries. Refer to the Domino documentation for installation instructions.
  4	A	Configure the IBM HTTP Server with your WebSphere Application Server profile. For additional details or information on configuring your Domino HTTP Server, see Configuring an HTTP server instance. The following steps apply to DOMINO Web servers only. For these steps, assume your Web server's name is MyWebServer. Run the configureOs400WebServerDefinition script on the application server profile. For example: configureOs400WebServerDefinition -profileName myAppServerProfile -webserver.name DOMSRV01 -webserver.type DOMINO -webserver.port 80 Configure a virtual host alias for the Web server machine and Web server port of DOMSRV01. For details, see Configuring the virtual host. Using the WRKDOMSVR command to update the notes.ini file of your Domino server, insert the following directive: WebSphereInit=profile_root/config/cells/cell_name/nodes/node_name/ servers/DOMSRV01/plugin-cfg.xml From the Lotus Notes client connected to the Domino server, click the Internet protocols tab, then click the HTTP tab. Under DSAPI filter names add the following: /QSYS.LIB/ product_lib.LIB/LIBDOMINO.SRVPGM Save your changes
  5	A	Stop and restart the application server.
  6	A	If you use IBM HTTP Server on iSeries, open the administrative console (ISC) do the following: Expand Servers > Web servers Select your Web server, in this case it is IHS_MyWebServer, then click Remote web server management. Enter the user ID and password used to authenticate to Machine A. The authorities required by this profile are the same as that required to access the HTTP administration GUI. For details, see User profiles and required authorities for HTTP Server in the iSeries Information Center. Save your changes.
  7	A	In the administrative console (ISC) do the following: Expand Servers > Web servers. If you use IBM HTTP Server on iSeries, Select IHS_MyWebServer and click Generate Plug-in to generate the plugin-cfg.xml file. If you use Domino HTTP Server on iSeries, Select DOMSRV01 and click Generate Plug-in to generate the plugin-cfg.xml file.
  8	A	If you use IBM HTTP Server on iSeries, start the Web server. Open the administrative console (ISC) and do the following: Expand Servers > Web servers. Select your Web server, in this case it is IHS_MyWebServer, then click Start. If you use Domino HTTP Server on iSeries, start the Web server from a CL command line: Run the Work with Domino Servers (WRKDOMSVR) command. Specify option 1 next to your Domino server. Press Enter.
  9	A	Run the snoop servlet. Access the following URL in your browser: http://host_name_of_machine_A/snoop If you get an error, retrace your steps. Add a virtual host to Machine A before restarting the application server on Machine A.

  Regeneration of the plugin-cfg.xml file

  The Web server plug-in configuration service regenerates the plugin-cfg.xml file automatically. However, if the service is disabled or you want to force regeneration, use the administrative console or the GenPluginCfg script. In the administrative console, perform these steps:

  1. Expand Servers > Web servers.

  2. Select the Web server for which you want to regenerate the plugin-cfg.xml file.

  3. Click Generate Plug-in.

  Propagation of the plugin-cfg.xml file

  The local file does not require propagation.

• Set up a remote Web server configuration for a Managed node.

  The remote Web server configuration is recommended for production environments.

  The remote distributed installation installs the Web server plug-in on the Web server machine when the application server is on a separate machine, such as shown in the following graphic:
  

  
  

  Remote distributed installation scenario

  Table 3. Installation and configuration

  Step	Machine	Task
  1	A	Install WebSphere Application Server Network Deployment.
  2	A	Create a deployment manager profile or use the one created during installation.
  3	A	Start the deployment manager. From Qshell, run this command: app_server_root/bin/startManager -profileName name_of_dmgr_profile
  4	B	Install WebSphere Application Server Network Deployment.
  5	B	Create an application server profile or use the one created during installation.
  6	B	Federate the node. From Qshell, run this command: app_server_root/bin/addNode dmgrHost SOAP_port -profileName appProfile -includeapps Variable descriptions: The dmgrHost variable is the host name of the machine where your deployment manager profile exists. The SOAP_port variable is the SOAP port of the dmgr profile. The default SOAP port is 8879. To determine which port your dmgr profile uses, run the following command: app_server_root/bin/dspwasinst -profileName name_of_dmgrProfile The appProfile variable is the name of the application server profile that you want to federate. Map the application modules to servers after this step. See Mapping modules to servers for more information.
  7	C	IBM HTTP Server on iSeries is already installed as product 5722DG1. Alternatively, you can also run Domino Web Server on iSeries. Refer to the Domino documentation for installation instructions. For either scenario, install the Web server Plug-ins component of the WebSphere Application Server product. See Installing Web server plug-ins on i5/OS.
  8	C	Run the manageprofiles Qshell command to create an http profile. The http profiles are V6.x equivalents of 5.0 and 5.1 remote instances. For example, run this command from Qshell: app_server_root/bin/manageprofiles -create -profileName myHttpProfile -templatePath http The myHttpProfile variable is the name of the profile.
  9	C	Configure the IBM HTTP Server with your http profile myHttpProfile. For additional details or information on configuring your Domino HTTP Server, see Configuring an HTTP server instance. Assuming your Web server's name is MyWebServer. an i5/OS qshell script called configureIHS_MyWebServer will be created in the myHttpProfile_profile_root/config/IHS_MyWebServer directory on machine C. For the default WebSphere Application Server install, the myHttpProfile_profile_root of the profile myHttpProfile is /QIBM/UserData/WebSphere/AppServer/V61/Base/profiles/myHttpProfile. In the remainder of this example, webServerName refers to IHS_myWebServer. If you choose to configure a DOMINO Web server as listed below, then webServerName refers to DOMSRV01. The following steps apply to DOMINO Web servers only: Run the configureOs400WebServerDefinition script on the http profile myHttpProfile. For example: configureOs400WebServerDefinition -profileName myHttpProfile -webserver.name DOMSRV01 -webserver.type DOMINO -webserver.port 80 Using the WRKDOMSVR command to update the notes.ini file of your Domino server, insert the following directive: WebSphereInit=myHttpProfile_profile_root/config/DOMSRV01/plugin-cfg.xml From the Lotus Notes client connected to the Domino server, click the Internet protocols tab, then click the HTTP tab. Under DSAPI filter names add the following: /QSYS.LIB/ product_lib.LIB/LIBDOMINO.SRVPGM Save your changes.
  10	C	Copy the configurewebserverName script to Machine A. The script is found in the myHttpProfile_profile_root/config/webServerName directory described above.
  11	A	Place the file you copied from the previous step into the profile_root/bin directory on Machine A, where profile_root is the directory where your deployment manager profile is located.
  12	A/B	Start the node agent and the deployment manager if they are not already running, then run the script that you copied in the previous step. For example, run these commands from Qshell: Machine A: app_server_root/bin/startManager -profileName name_of_dmgr_profile cd profile_root/bin ./configurewebServerName [wasAdminUserId] [wasAdminPassword] wasAdminUserId and wasAdminPassword are optional and only needed when the deployment manager of name_of_dmgr_profile is running in secure mode. Machine B: app_server_root/bin/startNode -profileName appProfile
  13	A	Use the administrative console of the deployment manager on Machine A to start the application server on Machine B. Wait for synchronization to occur and save the new configuration.
  14	A	If you use IBM HTTP Server on iSeries, verify that the deployment manager is running. Open the administrative console (ISC) and do the following: Expand Servers > Web servers Select your Web server, in this case it is IHS_MyWebServer, then click Remote web server management. . Enter the user ID and password used to authenticate to Machine C. The authorities required by this profile are the same as that required to access the HTTP administration GUI. For details, see User profiles and required authorities for HTTP Server in the iSeries information center. Save your configuration.
  15	A	Configure a virtual host alias for the Web server machine(C) and Web server port of MyWebServer. For details, see Configuring the virtual host.
  16	A	In the administrative console (ISC) do the following: Select webServerName and click Generate Plug-in to generate the plugin-cfg.xml file. Select webServerName and click Propagate Plug-in to propagate the plugin-cfg.xml file to machine C.
  17	A	Stop and restart the federated application server.
  18	A/C	If you use IBM HTTP Server on iSeries, start the Web server. Open the administrative console (ISC) on machine A and do the following: Expand Servers > Web servers. Select your Web server, in this case it is IHS_MyWebServer, then click Start. If you use Domino HTTP Server on iSeries, start the Web server, on machine C, from a CL command line: Run the Work with Domino Servers (WRKDOMSVR) command. Specify option 1 next to your Domino server. Press Enter.
  19	C	Run the snoop servlet. Access the following URL in your browser: http://host_name_of_machine_C/snoop If you get an error, retrace your steps.

  Regeneration of the plugin-cfg.xml file

  The Web server plug-in configuration service regenerates the plugin-cfg.xml file automatically. However, if the service is disabled or you want to force regeneration, use the administrative console or the GenPluginCfg script. In the administrative console, perform these steps:

  1. Expand Servers > Web servers.

  2. Select the Web server for which you want to regenerate the plugin-cfg.xml file.

  3. Click Generate Plug-in.

  Propagation of the plugin-cfg.xml file

  The plugin-cfg.xml file can be propagated manually. Manual propagation of the plugin-cfg.xml file is required for DOMINO Web servers. Copy the plugin-cfg.xml file from the application server machine to the myHttpProfile_profile_root/config/IHS_MyWebServer directory on the Web server machine C. The plugin-cfg.xml file is generated in the directory named profile_root/config/cells/cell_name/nodes/node_name/servers/IHS_myWebServer on the application server machine B.

• Set up a local Web server configuration for a Managed node.

  The local Web server configuration is recommended for a development or test environment.

  A local distributed installation includes the Web server plug-in, the Web server, and the managed application server on the same machine:
  

  
  

  Local distributed installation scenario

  Table 4. Installation and configuration

  Step	Machine	Task
  1	A	Install WebSphere Application Server Network Deployment.
  2	A	Create a deployment manager profile or use the one created during installation.
  3	A	Start the deployment manager. From Qshell, run this command: app_server_root/bin/startManager -profileName name_of_dmgr_profile Alternatively, issue the following commands: cd profile_root/bin startManager
  4	B	Install WebSphere Application Server Network Deployment.
  5	B	Create an application server profile or use the one created during the installation. Assume the profile name is appProfile.
  6	B	Federate the node. From Qshell, run the following commands: app_server_root/bin/addNode dmgrHost SOAP_port -profileName appProfile -includeapps Variable descriptions: The dmgrHost variable is the host name of the machine where your deployment manager profile exists. The SOAP_port variable is the SOAP port of the dmgr profile. The default SOAP port is 8879. To determine which port your dmgr profile uses, run the following command: app_server_root/bin/dspwasinst -profileName name_of_dmgrProfile The appProfile variable is the name of the application server profile that you want to federate. Map the application modules to servers after this step. See Mapping modules to servers for more information.
  7	B	IBM HTTP Server on iSeries is already installed as product 5722DG1. Alternatively, you can also run Domino Web Server on iSeries. Refer to the Domino documentation for installation instructions.
  8	B	Configure the IBM HTTP Server with your application server profile appProfile. For additional details or information on configuring your Domino HTTP Server, see Configuring an HTTP server instance. In the remainder of this example, webServerName refers to IHS_MyWebServer. If you choose to configure a DOMINO Web server as listed below, then webServerName refers to DOMSRV01. Also in this example, assume your Web server's name is MyWebServer.
  9	A/B	(Domino only) The following steps apply to the DOMINO Web server on machine B: Run the configureOs400WebServerDefinition script on the deployment manager profile. For example: configureOs400WebServerDefinition -profileName name_of_dmgr_profile -webserver.name DOMSRV01 -webserver.type DOMINO -webserver.node name_of_federated_node -webserver.port 80. In this case, name_of_federated_node is name_of_machine_B_appProfile. Using the administrative console (ISC) on machine A, configure a virtual host alias for the Web server machine and Web server port of DOMSRV01. For details, see Configuring the virtual host. On machine B, Use the WRKDOMSVR command to update the notes.ini file of your Domino server. Insert the following directive: WebSphereInit=appProfile_root/config/cells/cell_name/nodes/node_name/servers/DOMSRV01/plugin-cfg.xml. appProfile is the application server profile name on machine B. On machine B, from the Lotus Notes client connected to the Domino server, click the Internet protocols tab, then click the HTTP tab. Under DSAPI filter names add the following: /QSYS.LIB/ product_lib.LIB/LIBDOMINO.SRVPGM Save your changes.
  10	A	Use the administrative console of the deployment manager on Machine A to start the application server on Machine B.
  11	A	If you use IBM HTTP Server on iSeries, update the user ID and password of your Web server configuration. This step enables your deployment manager to perform remote operations on the Web server: Open the administrative console for your deployment manager profile on Machine A. Expand Servers > Web servers Select your Web server, in this case it is IHS_MyWebServer, then click Remote web server management Enter the user ID and password used to authenticate to Machine B. The authorities required by this profile are the same as that required to access the HTTP administration GUI. For details, see User profiles and required authorities for HTTP Server in the iSeries information center Save your configuration.
  12	A	In the administrative console (ISC), configure a virtual host alias for the Web server machine(B) and Web server port of MyWebServer. For details, see Configuring the virtual host.
  13	A	In the administrative console (ISC) do the following: Select webServerName and click Generate Plug-in to generate the plugin-cfg.xml file. Select webServerName and click Propagate Plug-in to propagate the plugin-cfg.xml file.
  14	A	In the administrative console (ISC), stop and restart the federated application server.
  15	A/B	If you use IBM HTTP Server on iSeries, start the Web server. Open the administrative console (ISC) on machine A and do the following: Expand Servers > Web servers 2. Select your Web server, in this case it is IHS_MyWebServer, then click Start. If you use Domino HTTP Server on iSeries, start the Web server, on machine B, from a CL command line: Run the Work with Domino Servers (WRKDOMSVR) command. . Specify option 1 next to your Domino server. Press Enter. .
  16	B	Run the snoop servlet. Access the following URL in your browser: http://host_name_of_machine_B/snoop If you get an error, retrace your steps.

  Regeneration of the plugin-cfg.xml file

  The Web server plug-in configuration service regenerates the plugin-cfg.xml file automatically. However, if the service is disabled or you want to force regeneration, use the administrative console or the GenPluginCfg script. In the administrative console, perform these steps:

  1. Expand Servers > Web servers.

  2. Select the Web server for which you want to regenerate the plugin-cfg.xml file.

  3. Click Generate Plug-in.

  The plugin-cfg.xml file is generated at the location profile_root/config/cells/cell_name/nodes/node_name/servers/webServerName directory, when the Web server definition is created. In the above table, the proile_root is the root of the deployment manager profile on machine A.

  Regenerate the plugin-cfg.xml file in the Web server definition in the application server whenever the configuration changes. The Web server has immediate access to the file whenever it is regenerated.

  Propagation of the plugin-cfg.xml file

  Node synchronization is used to propagate the plugin-cfg.xml file from Machine A to Machine B.

Results

What to do next

See Editing Web server configuration files for information about how the Plug-ins installation wizard configures supported Web servers.

See Installing Web server plug-ins on i5/OS for information about other installation scenarios for installing Web server plug-ins.