Installing and Configuring Apache Tomcat

This section contains the procedures you need to install and configure Apache Tomcat.

Determine how Apache Tomcat will be deployed in Oracle Solaris Cluster:

• Determine which version of Apache Tomcat will be deployed.

• Determine how many Apache Tomcat instances will be deployed.

• Determine which Cluster File System will be used by each Apache Tomcat instance.

• Determine the type of the target zone where you will install Apache Tomcat. Valid zone types include the global zone or the failover zone.

To install and configure Apache Tomcat in a global zone configuration, complete the following tasks:

• How to Enable Apache Tomcat to run in a Global Zone Configuration

• How to Install and Configure Apache Tomcat in the Global Zone

To install and configure Apache Tomcat in a failover zone configuration, complete the following tasks:

• How to Enable Apache Tomcat to run in Failover Zone Configuration

• How to Install and Configure Apache Tomcat in a Failover Zone

You will find installation examples for each zone type in:

• Appendix A, Deployment Example: Installing Apache Tomcat in the Global Zone

• Appendix B, Deployment Example: Installing Apache Tomcat in a Failover Zone

How to Enable Apache Tomcat to run in a Global Zone Configuration

1. Become superuser or assume a role that provides solaris.cluster.admin RBAC authorization on one of the nodes in the cluster that will host Apache Tomcat.
2. Register the SUNW.gds and SUNW.HAStoragePlus resource type.

   # clresourcetype register SUNW.gds SUNW.HAStoragePlus

3. Create a failover resource group.

   ---

   Note - Perform this step only if you create a failover data service.

   ---

   # clresourcegroup create Apache Tomcat-failover-resource-group

4. (Optional) Create a resource for the Apache Tomcat Disk Storage.

   ---

   Note - Perform this step only if you create a failover data service.

   ---

   # clresource create   \
   -g Apache-Tomcat-failover-resource-group  \
   -t SUNW.HAStoragePlus  \
   -p FilesystemMountPoints=Apache Tomcat- instance-mount-points Apache-Tomcat-has-resource

5. (Optional) Create a resource for the Apache Tomcat Logical Hostname.

   ---

   Note - Perform this step for a failover data service.

   ---

   # clreslogicalhostname   \
   -g Apache Tomcat-failover-resource-group  \
   -h Apache Tomcat-logical-hostname Apache Tomcat-lh-resource

6. Enable the failover resource group that now includes the Apache Tomcat Disk Storage and Logical Hostname resources.

   ---

   Note - Perform this step for a failover data service.

   ---

   # clresourcegroup online -emM -n current-node Apache Tomcat-failover-resource-group

7. (Optional) Create the resource group for the multiple masters data service.

   ---

   Note - Perform this step only if you create a multiple masters data service.

   ---

   # clresourcegroup create  \
   -p Maximum_primaries=2 \
   -p Desired_primaries=2 Apache-Tomcat-Scalable-resource-group

   If you need more nodes, adjust Maximum_primaries and Desired_primaries to the appropriate value.

8. (Optional) Create a resource for the Apache Tomcat Disk Storage if it is not in the root file system.

   ---

   Note - Perform this step only if you create a multiple masters data service.

   ---

   # clresource create   \
   -g Apache-Tomcat-failover-resource-group  \
   -t SUNW.HAStoragePlus  \
   -p FilesystemMountPoints=Apache Tomcat- instance-mount-points Apache-Tomcat-has-resource

9. Enable the multiple master resource group that now includes the Apache Tomcat Disk Storage and Logical Hostname resources.

   ---

   Note - Perform this step only if you create a multiple masters data service.

   ---

   # clresourcegroup online -emM  Apache Tomcat-failover-resource-group

10. Create a failover resource group for the SharedAddress resource.

    ---

    Note - Perform this step only if you create a scalable data service.

    ---

    # clresourcegroup create Apache-Tomcat-SharedAddress-resource-group

11. Create the SharedAddress resource.

    ---

    Note - Perform this step only if you create a scalable data service.

    ---

    # clressharedaddress create   \
    -g Apache-Tomcat-SharedAddress-resource-group  \
    -h Apache-Tomcat-SharedAddress-hostname \
    Apache-Tomcat-SharedAddress-resource

12. Online the SharedAddress resource group.

    ---

    Note - Perform this step only if you create a scalable data service.

    ---

    # clresourcegroup online -emM  Apache-Tomcat-SharedAddress-resource-group

13. Create the resource group for the scalable service.

    ---

    Note - Perform this step only if you create a scalable data service.

    ---

    # clresourcegroup create \
    -p Maximum_primaries=2 \
    -p Desired_primaries=2 \
    -p RG_dependencies=Apache-Tomcat-SharedAddress-resource-group \
    Apache-Tomcat-Scalable-resource-group

    If you need more nodes, adjust Maximum_primaries and Desired_primaries to the appropriate value.

14. Create a resource for the Apache Tomcat Disk Storage if it is not in the root file system.

    ---

    Note - Perform this step only if you create a scalable data service.

    ---

    # clresource create Apache-Tomcat-has-resource  \
    -g Apache-Tomcat-scalable-group   \
    -t SUNW.HAStoragePlus  \
    -p FilesystemMountPoints=Apache Tomcat- instance-mount-points

15. Enable the failover resource group that now includes the Apache Tomcat Disk Storage and Logical Hostname resources.

    ---

    Note - Perform this step only if you create a scalable data service.

    ---

    # clresourcegroup online -emM  Apache Tomcat-resource-group

How to Install and Configure Apache Tomcat in the Global Zone

1. Determine how Apache Tomcat will be deployed in Oracle Solaris Cluster

   • Determine whether you will use Apache Tomcat as a failover or a multiple master, or a scalable data service.

     For conceptual information on scalable and failover data services, see Oracle Solaris Cluster Concepts Guide.

   • Determine which user name will run Apache Tomcat.

   • Determine how many Apache Tomcat versions and instances will be deployed.

   • If more than one instance of a version will be deployed, determine whether they share the binaries.

   • Determine which Cluster File System will be used by each Apache Tomcat instance.

2. Become superuser or assume a role that provides solaris.cluster.modify and solaris.cluster.admin RBAC authorizations.
3. Create a user and a group if required.

   ---

   Caution - In this scenario, the deployment of the Tomcat group and user needs to occur on every node where Apache Tomcat is hosted.

   ---

   If Apache Tomcat is to run under a non root user, you have to create the appropriate user and the appropriate group. For these tasks, use the following commands.

   1. Create the group.

      # groupadd —g 1000 tomcat

   2. Create the user.

      # useradd —u 1000 —g 1000 —d /global/tomcat —s /bin/ksh tomcat

4. If you are not logged in as root, switch to the appropriate user name.

   # su — user-name

5. Install Apache Tomcat.

   If you deploy Apache Tomcat as a failover data service, install Apache Tomcat onto a shared file system within Oracle Solaris Cluster.

   You should install Apache Tomcat onto shared disks. For a discussion of the advantages and disadvantages of installing the software on a local versus a cluster file system, see Determining the Location of the Application Binaries in Oracle Solaris Cluster Data Services Planning and Administration Guide.

   If you will deploy Apache Tomcat as a failover data service install the Apache Tomcat binaries on the shared storage on one node. If Apache Tomcat will be deployed as a scalable or a multiple master data service, install the Apache Tomcat binaries on the local storage on every node, that will host the Apache Tomcat data service.

   ---

   Note - Refer to http://tomcat.apache.org/index.html for instructions about installing Apache Tomcat.

   ---

   If you deploy Apache Tomcat as a scalable data service for a scalable or a multiple masters configuration, repeat the following step at every node that will host Apache Tomcat.

6. Create the environment script.

   Create a Korn shell or a C shell script (dependent on the login-shell of your Apache Tomcat user name) to set the environment variables for Apache Tomcat. You must set the environment variables in a shell script and not in the user's profile.

   With this mechanism you can install and run multiple Apache Tomcat versions and instances under one user name.

   ---

   Caution - These shell scripts must be available on every node that can host the Apache Tomcat data service. For a failover configuration, store them on the shared storage of the node or in the target zone. For a scalable or a multiple masters configuration, store them on the local file system of every node or on the shared storage. These scripts must be the same on the various nodes.

   ---

Example 1-1 Korn shell script to set the environment variables for Apache Tomcat 6.0.28

# more env.ksh
#!/usr/bin/ksh
#
# Environment for Tomcat
#
JAVA_HOME=/usr/j2se
export JAVA_HOME
CATALINA_HOME=/global/mnt1/jakarta-tomcat-6.0.28
export CATALINA_HOME

Example 1-2 C shell script to set the environment variables for Apache Tomcat

# more env.csh
#!/usr/bin/csh
#
# Environment for Tomcat
#
setenv JAVA_HOME /usr/j2se
setenv CATALINA_HOME /global/mnt1/jakarta-tomcat-6.0.28

The environment variables are version and configuration dependent.

How to Enable Apache Tomcat to run in Failover Zone Configuration

1. Become superuser or assume a role that provides solaris.cluster.admin RBAC authorization on one of the nodes in the cluster that will host Apache Tomcat.
2. As superuser register the SUNW.HAStoragePlus and the SUNW.gds resource types.

   # clresourcetype register SUNW.HAStoragePlus SUNW.gds

3. Create a failover resource group.

   # clresourcegroup create Apache Tomcat-resource-group

4. Create a resource for the Apache Tomcat zone`s disk storage.

   # clresource create -t SUNW.HAStoragePlus \
   -p FileSystemMountPoints=Apache Tomcat-instance-mount-points \
   Apache Tomcat-has-resource

5. (Optional) If you want protection against a total adapter failure for your public network, create a resource for the Apache Tomcat`s logical hostname.

   # clreslogicalhostname create -g Apache Tomcat-resource-group \
   -h logical-hostname Apache Tomcat-logical-hostname-resource-name

6. Place the resource group in the managed state.

   # clresourcegroup online -emM  Apache Tomcat-resource-group

7. Install the zone.

   Install the zone according to the Oracle Solaris Cluster HA for Solaris Zones agent documentation, assuming that the resource name is Apache Tomcat-zone-rs and that the zone name is Apache Tomcat-zone.

8. Verify the zone's installation.

   # zoneadm -z Apache Tomcat-zone boot
   # zoneadm -z Apache Tomcat-zone halt

9. Register the zone's boot component.
   1. Copy the zone resource boot component configuration file.

      # cp /opt/SUNWsczone/sczbt/util/sczbt_config zones-target-configuration-file

   2. Use a text editor to set the following variables:

      RS=Apache Tomcat-zone-rs
      RG=Apache Tomcat-resource-group
      PARAMETERDIR=Apache Tomcat-zone-parameter-directory
      SC_NETWORK=true|false
      SC_LH=Apache Tomcat-logical-hostname-resource-name
      FAILOVER=true|false
      HAS_RS=Apache Tomcat-has-resource
      Zonename=Apache Tomcat-zone
      Zonebootopt=zone-boot-options
      Milestone=zone-boot-milestone
      Mounts=

   3. Create the parameter directory for your zone's resource.

      # mkdir Apache Tomcat-zone-parameter-directory

   4. Execute the Oracle Solaris Cluster HA for Solaris Zone's registration script.

      # /opt/SUNWsczone/sczbt/util/sczbt_register -f zones-target-configuration-file

   5. Enable the Solaris Zone resource.

      # clresource enable Apache Tomcat-zone-rs

10. Enable the resource group.

    # clresourcegroup online -emM Apache Tomcat-resource-group

How to Install and Configure Apache Tomcat in a Failover Zone

1. Determine how Apache Tomcat will be deployed in Oracle Solaris Cluster

   • Determine whether you will use Apache Tomcat as a failover or a multiple master, or a scalable data service.

     For conceptual information on scalable and failover data services, see Oracle Solaris Cluster Concepts Guide.

   • Determine which user name will run Apache Tomcat.

   • Determine how many Apache Tomcat versions and instances will be deployed.

   • If more than one instance of a version will be deployed, determine whether they share the binaries.

   • Determine which Cluster File System will be used by each Apache Tomcat instance.

2. Become superuser or assume a role that provides solaris.cluster.modify and solaris.cluster.admin RBAC authorizations.
3. Create user and group if required.

   If Apache Tomcat is to run under a non root user, you have to create the appropriate user and the appropriate group. For these tasks use the following commands.

   1. Create the group.

      # groupadd —g 1000 tomcat

   2. Create the user.

      # useradd —u 1000 —g 1000 —d /global/tomcat —s /bin/ksh tomcat

4. If you are not logged in as root, switch to the appropriate user name.

   # su — user-name

5. Install Apache Tomcat.

   If you deploy Apache Tomcat as a failover data service, install Apache Tomcat onto a shared file system or in a failover zone within Oracle Solaris Cluster.

   It is recommended that you install Apache Tomcat onto shared disks. For a discussion of the advantages and disadvantages of installing the software on a local versus a cluster file system, see Determining the Location of the Application Binaries in Oracle Solaris Cluster Data Services Planning and Administration Guide.

   If you plan to deploy Apache Tomcat as a failover data service, install the Apache Tomcat binaries on the shared storage on one node or in the failover zone. If Apache Tomcat will be deployed as a multiple master data service, install the Apache Tomcat binaries on the local storage in every target zone that will host the Apache Tomcat data service.

   ---

   Note - Refer to http://tomcat.apache.org/index.html for instructions about installing Apache Tomcat.

   ---

   If you deploy Apache Tomcat as a multiple masters data service, repeat the following step at every node or target zone that will host Apache Tomcat.

6. Create the environment script.

   Create a Korn shell or a C shell script (dependent on the login-shell of your Apache Tomcat user name) to set the environment variables for Apache Tomcat. You must set the environment variables in a shell script and not in the user's profile.

   With this mechanism you can install and run multiple Apache Tomcat versions and instances under one user name.

   ---

   Caution - These shell scripts must be available on every zone that can host the Apache Tomcat data service. For a failover configuration, store them on the shared storage of the node or in the target zone. For a multiple masters configuration, store them on the local file system or on the shared storage of the target zone. These scripts must be the same on the various zones. For an installation in a failover zone, any place where the Tomcat user has access is appropriate.

   ---

Example 1-3 Korn shell script to set the environment variables for Apache Tomcat 6.0.28

# more env.ksh
#!/usr/bin/ksh
#
# Environment for Tomcat
#
JAVA_HOME=/usr/j2se
export JAVA_HOME
CATALINA_HOME=/global/mnt1/jakarta-tomcat-6.0.28
export CATALINA_HOME

Example 1-4 C shell script to set the environment variables for Apache Tomcat 6.0.28

# more env.csh
#!/usr/bin/csh
#
# Environment for Tomcat
#
setenv JAVA_HOME /usr/j2se
setenv CATALINA_HOME /global/mnt1/jakarta-tomcat-6.0.28

The environment variables are version and configuration dependent.