Chapter 5 Component, Plan, and Host Type Reference Details

This chapter contains information about the variables and values available for use with the plans and components that are provided by the Sun Java System Web Server Plug-In. The chapter contains the following sections:

• Components

• Plans

• Host Types

Components

The Sun Java System Web Server Plug-In provides two components that allow you to control Administration Servers and Web Server instances.

WebAdminServer Component

The WebAdminServer component provides controls that enable you to stop, start, and restart Administration Servers. The component variables and component procedures available for use with the WebAdminServer component are described below. For instructions to control an Administration Server, see Controlling the Sun Java System Web Server 6.1 2005Q1 SP4.

Component Variables

installPath

Path on the target host to install the state file that contains the name/value pairs for the installation of the Administration Server.

exitOnDependency

The value of this variable determines whether the installation will exit if a dependency fails. The default value is no.

logCurrentlyInstalled

The value of this variable determines whether the provisioning system creates a log of Sun Java System Web Server 6.1 2005Q1 SP4 items that are already installed on the target host. Valid values are yes and no.

removeBundledProducts

The value of this variable populates the REMOVE_BUNDLED_PRODUCTS variable in the state file that the provisioning system uses to install the Administration Server. The default value for this variable is blank.

upgradeincompatibleJDK

The value of this variable determines whether the provisioning system will upgrade the JDK^TM software if the version installed on the target host is incompatible with the Sun Java System Web Server 6.1 2005Q1 SP4. Valid values are yes and no.

jesInstallPath

The path in which to install the Administration Server on the target host.

hostName

Host name of the target system.

hostDomain

Domain name of the target system.

ipAddress

IP address of the target system.

jesAdminUser

User ID for all components of the Sun Java Enterprise System. For more information, see CMN_ADMIN_USER in Chapter 4: Configuration Information.

jesSystemUser

User ID under which component processes run.

jesSystemGroup

Group of the jesSystemUser.

If you are installing the Administration Server on a Linux server, set the jesSystemGroup variable to root.

webAdminUser

User ID to use to log into the Adminstration Server.

adminPort

Port to use to access the Administration Server.

webAdminSystemUser

User ID under which the Administration Server processes run.

webInstanceUser

User ID that the default instance of Web Server uses to run on the system.

If you are installing the Administration Server on a Linux server, set the webInstanceUser variable to nobody.

webInstanceGroup

Group ID in which the default instance of Web Server runs.

If you are installing the Administration Server on a Linux server, set the webInstanceGroup variable to nobody.

webInstancePort

Port to use to access the Web Server instance.

docRoot

Path for the Web Server to store content documents.

webAutoStart

The value of this variable determines whether the provisioning server will create a boot script that will start the Administration Server and the Web Server instance upon system boot. Valid values are y and n.

startOnInstall

The value of this variable determines whether the provisioning server will start the Administration Server and the Web Server instance when installation is complete. Valid values are y and n.

JES_Media_Directory

Path to the Sun Java System Web Server 6.1 2005Q1 SP4 installation binary on the target server.

Component Procedures

markOnly:install

Use this procedure to update the N1 Grid Service Provisioning System 5.0 database to include any Administration Servers that you installed manually.

markOnly:uninstall

Use this procedure to update the N1 Grid Service Provisioning System 5.0 database to remove any Administration Servers that you uninstalled manually.

StartWebAdminServer

Use this procedure to start an Administration Server.

RestartWebAdminServer

Use this procedure to stop and then restart an Administration Server.

StopWebAdminServer

Use this procedure to stop an Administration Server.

WebServerInstance Component

The WebServerInstance component provides controls that enable you to stop, start, and restart Web Server instances. The component variables and component procedures available for use with the WebServerInstance component are described below. For instructions explaining how to control a Web Server instance, see Controlling the Sun Java System Web Server 6.1 2005Q1 SP4.

Component Variables

jesInstallPath

Path where the Web Server instance is installed on the target host.

hostName

The value you provided in the Server Identifier field on the Web Server Administration Server page when you created the Web Server instance.

hostDomain

Domain name of the system on which the Web Server instance is installed. If you did not specify a domain name in the Server Identifier field when you created the Web Server instance on the Administration Server, set the hostDomain value to null.

webInstancePort

Port to use to access the Web Server instance.

docRoot

Path for the Web Server to store content documents.

webAutoStart

The value of this variable determines whether the provisioning server will create a boot script that will start the Web Server instance upon system boot. Valid values are y and n.

startOnInstall

The value of this variable determines whether the provisioning server will start the Web Server instance when installation is complete. Valid values are y and n.

installPath

The provisioning system uses the installPath variable to identify the various Web Server instances. The default value of this variable is /tmp/hostName. hostName is the value that you entered for the hostName variable.

When you want to delete a Web Server instance, you must input the value of the installPath variable on the Plan run page in the installPath field.

Component Procedures

StartWebServer

Use this procedure to start a Web Server instance.

RestartWebServer

Use this procedure to stop and then restart a Web Server instance.

StopWebServer

Use this procedure to stop a Web Server instance.

Plans

The Sun Java System Web Server Plug-In includes several plans for you to use to install and uninstall the Web Server product.

InstallWebAdminServer Plan

The InstallWebAdminServer plan installs the Administration Server and the first Web Server instance. For instructions explaining how to use the InstallWebAdminServer plan, see Installing the Sun Java System Web Server 6.1 2005Q1 SP4.

UninstallWebAdminServer Plan

The UninstallWebAdminServer plan uninstalls the Administration Server and all related Web Server instances. Before running the UninstallWebAdminServer plan, you must manually uninstall all applications that are running on all of the Web Server instances.

CreateWebServerInstance Plan

When you use the provisioning system to install the Administration Server, the provisioning system also installs the first Web Server instance. You cannot install any additional Web Server instances using the provisioning system. However, after you have used the Administration Server to manually create an additional Web Server instance, the CreateWebServerInstance plan enables you to update the N1 Grid Service Provisioning System database to include the new Web Server instance. This plan creates a new virtual host in the N1 Grid Service Provisioning System database to account for the new Web Server instance. You can control Web Server instances through the provisioning system by using the component procedures of the WebServerInstance component.

For instructions explaining how to use the CreateWebServerInstance plan, see How to Create Additional Web Server Instances.

DeleteWebServerInstance Plan

After you have used the Administration Server to manually delete a Web Server instance, the DeleteWebServerInstance plan enables you to update the N1 Grid Service Provisioning System database to remove the Web Server instance. This plan removes the virtual host that represented the deleted Web Server instance.

For instructions for using the DeleteWebServerInstance plan, see How to Delete a Web Server Instance.

Host Types

The Sun Java System Web Server Plug-In includes several host types for you to use when deploying the Sun Java System Web Server 6.1 2005Q1 SP4. The host types correspond to the operating system of the target host. Before deploying the Administration Server or Web Server instances, change the host type of the target host to one of the following:

• com.sun.jes6_WS#Sol8-JESWebHost – Use this host type when deploying to a target host running the Solaris 8 OS on a SPARC based system.

• com.sun.jes6_WS#Sol9-JESWebHost – Use this host type when deploying to a target host running the Solaris 9 OS on a SPARC based system.

• com.sun.jes6_WS#Sol9x86-JESWebHost – Use this host type when deploying to a target host running the Solaris 9 OS on an x86 based system.

• com.sun.jes6_WS#Sol10-JESWebHost – Use this host type when deploying to a target host running the Solaris 10 OS on a SPARC based system.

• com.sun.jes6_WS#Sol10x86-JESWebHost– Use this host type when deploying to a target host running the Solaris 10 OS on an x86 based system.

• com.sun.jes6_WS#RedHat-AS21-JESWebHost – Use this host type when deploying to a target host running Red Hat Linux Advanced Server 2.1.

For instructions to change the host type, see How to Define a Host as a Sun Java System Web Server 6.1 2005Q1 SP4 Host.

When the provisioning system installs an Administration Server or a Web Server instance, the provisioning system creates a virtual host for the installed server. The provisioning system assigns one of the following host types to the newly created virtual host:

• com.sun.jes6_WS#WebAdminServerHT – The provisioning system assigns this host type to the virtual host for an Administration Server.

• com.sun.jes6_WS#WebServerInstanceHT – The provisioning system assigns this host type to the virtual host for a Web Server instance.