Custom Installation

[Grid Engine Home|Home] > [Installing] > [Installing the Software With the GUI Installer] >
\\
{excerpt}
h1. !install.png! Custom Installation

The custom installation mode is targeted at the experienced users. It offers more advanced customization of Sun Grid Engine installation than the [express installation|Express Installation]. It provides default values for most of the parameters. You must have a password-less {{ssh}} or {{rsh}} access if planning to install Sun Grid Engine on remote hosts. The following steps assume that the password-less access is configured and describe a cluster installation consisting of:
* Qmaster host with JMX feature enabled
* Three execution hosts on various architectures
* One shadow host
* One administrative host
* Four submit hosts

h3. Using the Custom Installation Mode

The custom installation steps are as follows.

h4. Steps

# *Start the GUI Installer. On the welcome screen, click Next.*
{info:title=Note}
Ensure that you start the GUI installer on the qmaster host.
{info}
As {{root}}, run the {{start_gui_installer}} command in your {{sge-root}} directory. For example:
{code}
qmaster:/sge# ./start_gui_installer
Starting Installer ...
{code}
!cus_welscr1.png|title="Welcome screen",vspace=8,thumbnail!
\\
\\
# *Agree to the terms of the license. Click Next.*
!cus_licscr2.png|title="Licensing agreements accepted",vspace=8,thumbnail!
\\
\\
# *Choose components to install, including a shadow host and the custom installation option, and click Next.*
!cus_comscr3.png|title="Choose component screen",vspace=8,thumbnail!
\\

|Berkeley db host|Selecting it implies a Berkeley db host spooling option. The Sun Grid Engine then spools data to a remote server. Not recommended as default option.|
\\
\\
# *Modify the main configuration details. Click Next.*
!cus_conscr4.png|title="Main configuration screen",vspace=8,thumbnail!
||Option||Description||
|Admin user|Sun Grid Engine processes will be executed under this user name, and certain directories will be owned by this user.|
|Qmaster host|Host that will run qmaster daemon (main component). It can be changed later in the host selection.|
|Grid Engine root directory|Directory where you unpacked the Sun Grid Engine {{tar.gz}} archive or installed a package (for example, {{rpm}}, {{pkg}}). It must not contain an automounter prefix.|
|Cell name|Name of this Sun Grid Engine cell, a value that identifies an instance of a Sun Grid Engine when several instances run simultaneously.|
|Cluster name|Name of this Sun Grid Engine instance used by SMF on Solaris machines. The following naming restrictions apply to this field: The cluster name must start with a letter (\[A-Za-z]), followed by letters, digits (\[0-9]), dashes ("-"), or underscores ("_").|
|Qmaster port|Port that will be used by the qmaster daemon. Default value is 6444.|
|Execd port|Port that will be used by the execution daemon. Default value is 6445.|
|Group id range|Range of additional group IDs. The group IDs in this range must not be used anywhere else. The size of the range determines how many concurrent jobs can run in Sun Grid Engine. Choose a large value.|
|Shell name|Shell to be used while connecting to remote hosts (with {{ssh}} or {{rsh}} syntax). Expected values for this field are {{ssh}} or {{rsh}}.|
|Copy command|Command to be used while copying files to remote hosts (with {{scp}} or {{rcp}} syntax). Expected values for this field are {{scp}} or {{rcp}}.|
|Administrator mail|Email address used by the Sun Grid Engine to report issues to the grid administrator. Default value is none (no emails will be sent).|
|Automatically start service(s) at machine boot|Component (service) will be automatically started at machine boot. By default, this is selected.|
|Use JMX|Triggers installation of a JVM thread in qmaster. Currently only needed when you plan to install Service Domain Manager or SGE Inspect. By default, this is selected.|
|Ignore domain names|Sun Grid Engine will ignore domain names when comparing host names. By default, this is selected.|
|Use CSP product mode|Sun Grid Engine will be installed with certificate security protocol (CSP). Communication between Sun Grid Engine daemons will be protected by an SSL certificate. Has impact on cluster throughput. By default, this is not selected.|
Typically, one would customize the default values and click Next.
\\
\\
# *Modify the JMX configuration details. Click Next.*
!cus_jmxscr5.png|title="JMX configuration screen",vspace=8,thumbnail!
||Option||Description||
|JMX port|Port number to be used by JVM thread in qmaster process.|
|Enable SSL server authentication|Once enabled, SSL certificate configuration will be presented later. The server certificate will be used for authentication and encryption.|
|Enable SSL client authentication|Client authentication will be used.|
|Path to the keystore|Path to Java keystore file that will be created during the qmaster installation.|
|Keystore password|Keystore password. Default value is {{changeit}}.|
|Retype password|Password to retype. Default value is {{changeit}}.|
\\
\\
# *Modify the spooling configuration. Click Next.*
!cus_splscr6.png|title="Spooling configuration screen",vspace=8,thumbnail!
||Option||Description||
|Qmaster spool directory|Directory for qmaster spooling data.|
|Global execd spool directory|Directory for execution daemon spooling directory used by default for all execution hosts. Unless overridden in the host selection screen, each execution host creates a subdirectory in the global {{execd}} spool directory.|
|Classic spooling method|Spooling is done in human readable format.|
|Berkeley db spooling method|Spooling is done to local Berkley db.|
|Berkeley db spooling server spooling method|Spooling is done to Berkley db server.|
|Berkeley db host|Host for Berkeley db server, enabled only when Berkeley db spooling server method is selected.|
|Db directory|Berkeley db spooling directory, either on local host or Berkeley db host, if Berkeley db spooling server method is selected.|
\\
\\
# *(Optional) Provide SSL certificate information. Click Next.*
!cus_sslscr7.png|title="SSL certificate screen",vspace=8,thumbnail!
This screen is displayed only when you have previously selected the JMX or CSP features. An SSL certificate will be generated as part of qmaster installation. This certificate will then be used throughout the Sun Grid Engine.
||Option||Description||
|Country code|Two-character country code. Default value is {{DE}}.|
|State|State. Default value is {{GERMANY}}.|
|Location|Location. Default value is {{Building}}.|
|Organization|Organization. Default value is {{Organisation}}.|
|Organization unit|Organization unit. Default value is {{Organisation_unit}}.|
|Email address|Email address. Default value is {{name@yourdomain.com}}.|
\\
\\
# *Select hosts to be installed and fix reported problems. Click Install to start the installation on the reachable hosts.*
!cus_hosscr8a.png|title="Select hosts screen",vspace=8,thumbnail!
This screen allows you to select the hosts and components that you would like to install. The qmaster host is added based on the qmaster host value from the main configuration screen by default. You can select the hosts in one of two different ways:
1. By a host name, host name pattern, or by an IP address or IP address pattern
2. From a file that you create using the installer's [save|Troubleshooting the GUI Installer#save_hosts] action
\\
The patterns do not support regular expressions. The supported expressions are lists and numeric ranges. For more information, see the following table:
||Description||Input||Resolved Value||
|Host name|{{grid00}}|{{grid00}}|
|IP address|{{192.168.0.1}}|{{192.168.0.1}}|
|List of hosts|{{grid00 grid01 grid05}}|{{grid00 grid01 grid05}}|
|List of IP addresses|{{192.168.0.1 192.168.0.2 192.168.0.5}}|{{192.168.0.1 192.168.0.2 192.168.0.5}}|
|Host ranges|{{grid\[00-10]}}|{{grid00, grid01, ..., grid10}}|
|Range of IP addresses|{{192.\[168-169].0.\[50-60]}}|{{192.168.0.50 ... 192.168.0.60, 192.169.0.50 ... 192.169.0.60}}|
\\
In the following screen sequence, five execution and six submit hosts are added from a file. Two hosts have errors; they are unreachable. See [Understanding Host and Installation States|Understanding Host and Installation States#host_resolving_states] for a complete list of errors and possible solutions. Note that each state has a tooltip that displays a better error message. Hosts can be refreshed or [removed|Troubleshooting the GUI Installer#remove_hosts] using a context menu. In addition, two hosts are added as shadow and administrative hosts. Before actually adding the hosts by clicking the Add button, the default component selection must be changed from execution and submit host to shadow and admin host.
{gallery:include=cus_hosscr8b.png, cus_hosscr8c.png, cus_hosscr8d.png|sort=name}
\\
\\
# *(Optional) Modify the host configuration. Click OK.*
Select a host in the Select hosts screen, right-click on the host and click Configure to modify the host configuration.
!cus_hosscr8f.png|title="Host configuration screen",vspace=8,thumbnail!
||Option||Description||
|Local execd spool directory|Directory for local execd spooling data.|
|JVM library path|Path to the JVM library on the qmaster and/or shadow hosts.|
|Additional JVM args|Additional arguments to be used when starting the JVM in qmaster.|
|Connect user|The user which will be used to connect to the remote host using ssh or scp.|
|Resolve timeout(sec)|Timeout value for any resolving task.|
|Install timeout (sec)|Timeout value for any installation task.|
\\
\\
# *(Optional) Fix problems reported during pre-install validation. Click Install.*
!cus_hosscr8d.png|title="Pre-install host validation screen",vspace=8,thumbnail!
When you click the Install button as described in Step 8, the installation does not started immediately. First, the installer executes a series of advanced checks for each host to verify that there is no misconfiguration. If the validation fails, host states are updated and you may return to the host selection or continue with the installation.
{info:title=Note}
Continuing the installation after the installer reports errors will likely result in a failed installation. Before restarting the installation, you should return to the host selection and either resolve the reported problems or remove the hosts that have configuration errors.
{info}
See [Understanding Host and Installation States|Understanding Host and Installation States#host_validation_states] for a complete list of errors and possible solutions. An example of a pre-install validation with errors can be found in [Express Installation|Express Installation#validation_errors].
\\
\\
# *Monitor the progress of the installation, then click Next.*
{gallery:include=cus_monscr10a.png, cus_monscr10b.png|sort=name}
\\
If there were any failures during the installation, see [Understanding Host and Installation States|Understanding Host and Installation States#installation_states] for a complete list of installation states. Click the Log for each failed installation for more information as shown in this [example|Express Installation^7f_install.png].
\\
\\
# *Review the overview information, then click Done.*
!cus_finscr11.png|title="Result screen",vspace=8,thumbnail!
\\
Optionally, print or save the information about the Sun Grid Engine configuration for future reference. The page is also automatically saved to the {{$SGE_ROOT/$SGE_CELL/Readme_TIMESTAMP.html}} file. If the page could not be saved there, due to root being mapped to nobody on NFS shared file system, it is saved to {{/tmp/Readme_TIMESTAMP.html}}.
\\
To repeat the installation or to install more hosts, click Continue.
\\
\\
To verify the installation, go to [Verifying the Installation].
{excerpt}

{section}
{column:width=50%}
{panel:borderStyle=solid|borderColor=#5382a1|titleBGColor=#5382a1|bgColor=#ffffff}
*Participate*
Have a best practice to share? Questions? Suggestions? Comments?
* [Add a page] to the Expert Advice section
* [Ask the community] a question
* Send the writing team an [email|mailto:gridengine-writers@sun.com]
* Leave a comment below
{panel}
{column}

{column:width=50%}
{panel:borderStyle=solid|borderColor=#5382a1|titleBGColor=#5382a1|bgColor=#ffffff}
*Learn More*
For more on this topic, check out the following resources:
* Expert Advice -- [Video: Introduction to Grid Engine|http://www.youtube.com/watch?v=0JBsMitNnQ8]
* Expert Advice -- [White Paper: Beginner's Guide to Sun Grid Engine|http://www.sun.com/offers/details/Sun_Grid_Engine_62_install_and_config.html]
(If you are not already registered with sun.com, you must fill out a
quick registration form to gain access to this white paper.)
* Expert Advice -- [Podcast: Towards Cloud Computing with Sun Grid Engine 6.2|http://blogs.sun.com/HPC/entry/podcast_towards_cloud_computing_with]
{panel}
{column}
{section}