N1 Grid Service Provisioning System User's Guide and Release Notes for the Sun Java System App Server Plug-In 1.0

Previous: Installing and Using the Sun Java Enterprise System Application Server Environment with the N1 Grid Service Provisioning System 5.0
Next: Managing Sun Java Enterprise System Application Server Instances and Clusters

Creating the Sun Java Enterprise System Application Server Domain Infrastructure

This section describes how to prepare your N1 Grid Service Provisioning System 5.0 installation to take advantage of the featured provided by Sun Java Enterprise System Application Server Plug-In.

How to Install the Sun Java Enterprise System Application Server Software

Steps

Select the Sun Java Enterprise System Application Server icon under the Common Tasks section of the left control panel.

Click the SJSAS 8.1 Install Management: Install or Uninstall link.

Click the Run action next to default: install.

In the Plan Parameters area, select the variable settings for the Install component that you plan to deploy.

The Install component installs the Sun Java Enterprise System Application Server on a Remote Agent. After you have installed the Install component on a Remote Agent, you do not have to reinstall that component again.

When you run the plan to install a new domain or server instance, the provisioning system checks to see if an Install component exists in the installPath directory. If the Install component is already installed, the provisioning system does not reinstall the Install component.
- If the variable settings have been established for this component, select the appropriate settings from the menu.
- If the settings are not available from the menu, click Select From List.
  
  The Select Variable Settings From List window displays.
  - To create a new set of variable settings, select Create Set.
    
    The following list provides commonly-updated variables for the Install component.
    variable set name
    
    Required. A name for the new variable set you create.
    
    installDirectory
    
    Required. The location where the Sun Java Enterprise System Application Server software will be installed.
    
    sourceImage
    Required. The location of the Sun Java Enterprise System Application Server package installer.
    
    Typically this is an NFS-mounted directory containing the extracted Sun Java Enterprise System Application Server installer. For example, if the value of sourceImage is /net/mymachine/nfs/sjsappserver8.1, you would do the following before installing the plug-in:
    
    % mkdir /net/mymachine/nfs/sjsappserver8.1 % cd /net/mymachine/nfs/sjsappserver8.1 % unzip .../sjsas_ee-8_1_01_2005Q1-solaris-sparc.bin
    installId
    
    Required. A unique ID that associates an Install component with installed Application Server domains and clusters.
    
    adminUserId
    
    The user name of the administrator of the domain or cluster.
    
    Typically this will be picked up from the session variables.
    
    adminPassword
    
    The password for the administrator login of the domain or cluster.
    
    Typically this will be picked up from the session variables.
    
    httpLoadBalancerPluginType
    
    If you are using a web server load balancer with the domain or cluster, enter the type of web server here. Valid entries are Sun ONE Web Server or Apache HTTP Server.
    
    The web server must already be installed on the target host.
    
    webserverInstallDirectory
    
    Location of the web server, used when installing the load balancer plug-in. For Sun ONE Web Server, enter the instance directory. For Apache HTTP Server, enter the install directory.
    
    webserverConfigDirectory
    
    The directory where the load balancer configuration file, loadbalancer.xml will be located.
    
    Only set this variable if the load balancing plug-in is already installed on the web server gateway host.
    
    adminPasswordEncryptedFlag
    
    If set to true, the administrator's password will be encrypted. The default is false.
    
    asadminPort
    
    The port on which the Application Server domain administration server listens. The default is 4849.
    
    adminWebPort
    
    The port on which deployed web applications run. The default is 8090.
    
    instanceHTTPSPort
    
    The port on which secure HTTP (HTTPS) applications are run. The default is 1043.
    
    createSamplesDomain
    
    If true, a domain containing Application Server sample applications will be installed on the instance. The default is false.
    
    storeAdminAuth
    
    If true, the administrator's password will be written to a file. The default is false.
    
    tempStateFile
    
    The location of temporary files used during installation.
    
    We recommend that you do not change this variable.
  - To use variable components from another component, click Import Set.
    
    For more information about importing variable sets, see How to Run a Plan in N1 Grid Service Provisioning System 5.0 Operation and Provisioning Guide.

Select the target host.

Install the Application Server software on the Remote Agent.

Deselect the Target Host Set checkbox.

If you want to run a detailed check (preflight) before installing, select Perform Detailed Preflight.

Click Run Plan (includes preflight).

How To Create a Sun Java Enterprise System Application Server Domain Administration Server

The Domain Administration Server manages Application Server domains. It must be installed before you can create individual domains. When you install a Domain Administration Server, you create an initial domain and an administration server that controls that domain.

Before You Begin

To create an Application Server domain, you must belong to a user group that has the Run Component Procedures permission on the folder that contains the component. You must also have the Allow on Host Set permission for the host set on which you plan to deploy the component.

Steps

From the Common Tasks section in the browser interface, click AppServer 8.1.

Under SJSAS 8.1 AppServer infrastructure->SJSAS 8.1 domains click Manage.

Under Component Procedures click the Run action next to default: install.

In the Plan Parameters area, select the variable settings for the Domain Administration Server you want to install.
- If the variable settings have been established for this component, select the appropriate settings from the menu.
- If the settings are not available from the menu, click Select From List.
  
  The Select Variable Settings From List window displays.
  - To create a new set of variable settings, select Create Set.
    
    The following list provides commonly-updated variables for the Install component.
    
    variable set name
    
    Required. A name for the new variable set you create.
    
    installIdentifier
    
    A unique ID to associate a Domain Administration Server with an install image.
    
    domainName
    
    The name of the domain you wish to create.
    
    adminUserId
    
    The user name of the administrator of the domain or cluster.
    
    adminPassword
    
    The password for the administrator login of the domain or cluster.
    
    adminHost
    
    The name of the host on which the Domain Administration Server will be installed.
    
    portRangePrefix
    
    The HTTP port range prefix. For example, a value of 100 means the HTTP port range begin with 10000. The default value is 100.
    
    httpListenerPort
    
    The HTTP listener port, used with portRangePrefix. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 00. If portRangePrefix is set to 100, the HTTP listener port is 10000.
    
    httpsListenerPort
    
    The HTTPS listener port, used with portRangePrefix. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 05. If portRangePrefix is set to 100, the HTTPS listener port is 10005.
    
    instancePort
    
    The default port number for the Domain Administration Server.
    
    iiopListenerPort
    
    The Internet Inter-Orb Protrocol (IIOP) listener port, used with portRangePrefix. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 10. If portRangePrefix is set to 100, the IIOP listener port is 10010.
    
    iiopsslListenerPort
    
    The SSL-enabled Internet Inter-Orb Protrocol (IIOP) listener port, used with portRangePrefix. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 15. If portRangePrefix is set to 100, the secure IIOP listener port is 10015.
    
    iiopsslmutualauthPort
    
    The SSL-enabled Internet Inter-Orb Protrocol (IIOP) listener port for mutual authorization, used with portRangePrefix. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 20. If portRangePrefix is set to 100, the mutual authorization secure IIOP listener port is 10020.
    
    jmsConnectorPort
    
    The port on which the Java Messaging Service (JMS) connector listens. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 25. If portRangePrefix is set to 100, the JMS connector port is 10025.
    
    installDirectory
    
    The location where the Application Server is installed.
  - To use variable components from another component, click Import Set.
    
    For more information about importing variable sets, see “How to Run a Plan” in N1 Grid Service Provisioning System 5.0 Operation and Provisioning Guide.

Select the target host.

Install the Domain Administration Server and the domain on the Remote Agent.

Deselect the Target Host Set checkbox.

If you want to run a detailed check (preflight) before installing, select Perform Detailed Preflight.

Click Run Plan (includes preflight).

How To Create a Sun Java Enterprise System Application Server Instance

You can run multiple Application Server instances in each domain.

Before You Begin

Before you create an Application Server instance, you must do the following:

Create the domain on which the server instance will run.

For information on creating a domain, see
The Domain Administration Server must be running.

To manually start a Domain Administration Server,
You must belong to a user group that has the Run Component Procedures permission on the folder that contains the component. You must also have the Allow on Host Set permission for the host set on which you plan to deploy the component.

Steps

From the Common Tasks section in the browser interface, click Sun Java System AS 8.

Under SJSAS 8.1 AppServer infrastructure->SJSAS 8.1 Managed Server Instances click Manage.

Under Component Procedures click the Run action next to default: install.

In the Plan Parameters area, select the variable settings for the managed server instance you want to install.
- If the variable settings have been established for this component, select the appropriate settings from the menu.
- If the settings are not available from the menu, click Select From List.
  
  The Select Variable Settings From List window displays.
  - To create a new set of variable settings, select Create Set.
    
    The following list provides commonly-updated variables for the Install component.
    
    variable set name
    
    Required. A name for the new variable set you create.
    
    installIdentifier
    
    A unique ID to associate domains, clusters, node agents, and Application Server instances with an Install component.
    
    domainName
    
    The domain name in which this server instance will be located
    
    targetName
    
    The name of the server.
    
    portRangePrefix
    
    The HTTP port range prefix. For example, a value of 100 means the HTTP port range begin with 10000. The default value is 100.
    
    httpListenerPort
    
    The HTTP listener port, used with portRangePrefix. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 00. If portRangePrefix is set to 100, the HTTP listener port is 10000.
    
    httpsListenerPort
    
    The HTTPS listener port, used with portRangePrefix. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 05. If portRangePrefix is set to 100, the HTTPS listener port is 10005.
    
    iiopListenerPort
    
    The Internet Inter-Orb Protocol (IIOP) listener port, used with portRangePrefix. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 10. If portRangePrefix is set to 100, the IIOP listener port is 10010.
    
    iiopsslListenerPort
    
    The SSL-enabled Internet Inter-Orb Protocol (IIOP) listener port, used with portRangePrefix. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 15. If portRangePrefix is set to 100, the secure IIOP listener port is 10015.
    
    iiopsslmutualauthPort
    
    The SSL-enabled Internet Inter-Orb Protocol (IIOP) listener port for mutual authorization, used with portRangePrefix. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 20. If portRangePrefix is set to 100, the mutual authorization secure IIOP listener port is 10020.
    
    jmsConnectorPort
    
    The port on which the Java Messaging Service (JMS) connector listens. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 25. If portRangePrefix is set to 100, the JMS connector port is 10025.
    
    clusterName
    
    The name of the cluster to which this server instance belongs. If no cluster is specified the server instance is a standalone server. By default no cluster is specified.
  - To use variable components from another component, click Import Set.
    
    For more information about importing variable sets, see “How to Run a Plan” in N1 Grid Service Provisioning System 5.0 Operation and Provisioning Guide.

Select the target host.

Install the server instance on the Remote Agent.

Deselect the Target Host Set checkbox.

If you want to run a detailed check (preflight) before installing, select Perform Detailed Preflight.

Click Run Plan (includes preflight).

How To Create a Sun Java Enterprise System Application Server Cluster

A cluster appears to clients as a single Application Server instance. The server instances that constitute a cluster can run on the same machine, or can be located on different machines. Each cluster member in a cluster must run the same version of Application Server.

A cluster provides:

Increase application availability with the server's failover capabilities.
Increase throughput by scaling applications across multiple servers.

Before You Begin

Before you create a cluster, you must create an Application Server domain and an Domain Administration Server.

To create a cluster, you must belong to a user group that has the Run Component Procedures permission on the folder that contains the component. You must also have the Allow on Host Set permission for the host set on which you plan to deploy the component.

Steps

From the Common Tasks section in the browser interface, click Sun Java System AS 8.

Under SJSAS 8.1 AppServer infrastructure->SJSAS 8.1 clusters click Manage.

Under Component Procedures click the Run action next to default: install.

In the Plan Parameters area, select the variable settings for the cluster you want to install.
- If the variable settings have been established for this component, select the appropriate settings from the menu.
- If the settings are not available from the menu, click Select From List.
  
  The Select Variable Settings From List window displays.
  - To create a new set of variable settings, select Create Set.
    
    The following list provides commonly-updated variables for the Install component.
    
    variable set name
    
    Required. A name for the new variable set you create.
    
    installIdentifier
    
    A unique ID to associate domains, clusters, node agents, and Application Server instances with an Install component.
    
    domainName
    
    The domain name in which this cluster will be located
    
    targetName
    
    The name of the cluster.
    
    portRangePrefix
    
    The HTTP port range prefix. For example, a value of 100 means the HTTP port range begin with 10000. The default value is 100.
    
    httpListenerPort
    
    The HTTP listener port, used with portRangePrefix. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 00. If portRangePrefix is set to 100, the HTTP listener port is 10000.
    
    httpsListenerPort
    
    The HTTPS listener port, used with portRangePrefix. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 05. If portRangePrefix is set to 100, the HTTPS listener port is 10005.
    
    iiopListenerPort
    
    The Internet Inter-Orb Protocol (IIOP) listener port, used with portRangePrefix. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 10. If portRangePrefix is set to 100, the IIOP listener port is 10010.
    
    iiopsslListenerPort
    
    The SSL-enabled Internet Inter-Orb Protocol (IIOP) listener port, used with portRangePrefix. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 15. If portRangePrefix is set to 100, the secure IIOP listener port is 10015.
    
    iiopsslmutualauthPort
    
    The SSL-enabled Internet Inter-Orb Protocol (IIOP) listener port for mutual authorization, used with portRangePrefix. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 20. If portRangePrefix is set to 100, the mutual authorization secure IIOP listener port is 10020.
    
    jmsConnectorPort
    
    The port on which the Java Messaging Service (JMS) connector listens. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 25. If portRangePrefix is set to 100, the JMS connector port is 10025.
    
    httpLoadBalancer
    
    If true, applications deployed to this cluster will be load balanced. The default is false.
    
    httpsLoadBalancer
    
    If true, applications responding to HTTPS requests will be load balanced. This variable has no effect if httpLoadBalancer is false. The default is false.
    
    routeCookie
    
    If true, the load balancer will route cookies. This variable has no effect if httpLoadBalancer is false. The default is false.
  - To use variable components from another component, click Import Set.
    
    For more information about importing variable sets, see “How to Run a Plan” in N1 Grid Service Provisioning System 5.0 Operation and Provisioning Guide.

Select the target host.

Install the cluster on the Remote Agent.

Deselect the Target Host Set checkbox.

If you want to run a detailed check (preflight) before installing, select Perform Detailed Preflight.

Click Run Plan (includes preflight).