Genesis II Installation Guide
From VCGR Wiki
Contents |
This page describes the host requirements and the basic process of installing and configuring a Genesis II distribution on a personal computer. This page also describes how to uninstall a Genesis II distribution.
It is highly recommended that one read the "Understanding Your Genesis II Distribution" primer prior to using this installation guide. The primer discusses the notion of "roles" that you may wish your distribution to perform, which impact how the distribution is installed and configured.
The following documents also describe installing Genesis II and creating and managing BES containers.
Demonstrations of downloading, installing, and uninstalling in Windows
[XCG/Genesis II Installation on a Windows system]
[XCG/Genesis II Create an Execution Service on your machine]
Requirements
- You must have a machine running a supported operating system. The verified, supported operating systems are listed along with each distribution for download. Although Genesis II is primarily written in Java and may very well likely run just fine on alternative platforms, some features within the distribution contain some native code and may not operate properly. Additionally, some tools and user interfaces are platform-dependent (e.g., the Windows Installable File System) or require a graphical/windowing display.
- You must have an XCG account to do a full container installation. For accessing the XCG and basic job submission, only the client is necessary. If you plan on providing compute resources or sharing local files via the grid, you will need the full Genesis II container install.
Install
- Uninstall. Before installing a newer version on Genesis II, make sure you uninstall the old version.
- Download the Genesis II distribution. Go to the Downloads Section to obtain the newest distribution. Over time, we will release new versions of Genesis II, including alpha, beta, production and patch releases. The installation bundle contains all necessary embedded third party components as well as pre-compiled Genesis II Java binaries (.jars), Genesis II source code, build scripts and documentation (which currently is admittedly very sparse) - all packaged as a single installation script.
- Run the Installer.
- For Windows users, the installer can often be run by double-clicking on the installer file.
- For Linux users (or command line friendly Windows users), issue the command >./<name of installer file> -c
$ ./XCG-installer.sh -c
The installer will allow you to choose where to install Genesis II (we will refer to your chosen location as $GEN_HOME).
In order to run the installed Genesis II features, the installer will install the version of Java that the Genesis II platform uses. (It will not replace the existing Java on your machine.)
Command-line Installation Steps
- Agree to start installation Press enter to start the installation.
- Agree to Terms Continue pressing enter to read the license agreement. You must accept the terms of this agreement before continuing with the installation (it is a standard Apache license).
- Choose installation options. Next you will be able to specify the following options:
- Installation Location - Choose where to install Genesis II. Pressing enter will keep the default value.
- Type of Installation - choose whether to install just the Genesis II client or also a Genesis II container. For accessing the XCG and basic job submission, only the client is necessary. If you plan on providing compute resources or sharing local files via the grid, you will need the full Genesis II container install.
- Shortcut Creation - Choose to create shortcuts via symlinks to the Genesis II client. This option is generally only useful for Windows installations.
- Container Starting - If you chose the full Genesis II Installation, you will need to choose whether to start the Genesis II container.
- Container Port Number - Choose the port number on which the container should listen for incoming messages. The default is 18443.
- Container Ownership Information - When installing a full container, you will need to provide the XCG credentials for the owner of the container. This is your XCG account login and password information.
Unpacking JRE ... Preparing JRE ... Starting Installer ... This will install Genesis II on your computer. OK [o, Enter], Cancel [c]
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION ... END OF TERMS AND CONDITIONS I accept the agreement Yes [1], No [2]
Where should Genesis II be installed? [/home/vanet/GenesisII]
Which type of installation should be performed? XCG Client Install [1, Enter] XCG Full Container Install [2]
Create symlinks? Yes [y, Enter], No [n]
Connecting Grid Client Start XCG Container Service? Yes [y, Enter], No [n]
Port Number By default the XCG container listens for incoming messages on TCP port 18443. You can either keep this default value or change the port number to suit your environment. XCG Container Port Number [18443]
Owner Information In order to start the container, a user must be identified to manage that container. Please provide the RNS path to your user object as well as the login name and password for that account. User RNS Path /users/<login_name>
Login Username <login-name>
Login Password <login-passwd>
GUI Installation Steps
- Begin the installation Press Next to being the installation process.
- Agree to Terms Accept the license agreement (it is a standard Apache license).
- Select Destination Directory Choose directory where you would like to install Genesis II. The default location is C:\Program Files\GenesisII.
- Type of Installation Choose whether to install just the Genesis II client (XCG Client Install) or also a Genesis II container (XCG Full Container Install). For accessing the XCG and basic job submission, only the client is necessary. If you plan on providing compute resources or sharing local files via the grid, you will need the full Genesis II container install.
- Select Start Menu Folder - Choose to place shortcuts in a Start Menu folder.
- Installing - Wait while the selected options are installed.
- Select Additional Tasks - Choose to start the Genesis II container if you are doing a full container install. You will also need to open a port in the firewall so that your installation can communicate with the rest of the grid.
- XCG Container Port Number - Choose the port number on which the container should listen for incoming messages. The default is 18443.
- Ownership Information - When installing a full container, you will need to provide the XCG credentials for the owner of the container. This is your XCG account login and password information in the following format:
- Configure XCG Container - Wait while the XCG Container is configured if you are doing a full install.
- Enter Windows Password - If you are doing a full install, you will need to provide the password for the machine on which the container is being installed so that the XCG Container can be started. If you type the incorrect password, you can change the password and start your container manually as explained under the [this section below].
- Complete Installation - If the installation and configuration was successful, the installation will end at this point. You will be notified if something fails. If during a full installation the XCG container is unable to start, consult the section on [starting your container manually.] Otherwise, you can run the uninstaller and try to restart the installation process.
User RNS Path: /users/<login_name> Login Username: <login-name> Login Password: <login-passwd>
</ul>
Startup
Your XCG distribution - whether you selected just the client or the full container install - automatically connects to the XCG grid. To start interacting with the XCG, run the grid script under the main Genesis II directory. You can then proceed to login, manage job submissions, or share files.
Starting the XCG Container Manually
You can start the XCG container manually. You may want to do this if:
- You chose not to start the container automatically during the install process
- Your container did not start automatically after the install process perhaps due to an incorrect password (Windows only).
- You change the password for the machine on which your container resides. (Windows only)
Under Linux
In your install directory, you will find a script called XCGContainer. To start your container, run
./XCGContainer start
Under Windows
The Services tool is usually located under the Administrative Properties menu in the Control Panels. Find the XCG Container service in the services list. To start the container, right-click. To change the password, double-click and correct the password under the Log On tab.
Uninstall
To uninstall Genesis II, run the uninstall script located under the Genesis II directory. Before you run the installer script, make sure the XCGContainer is not running.
Under Linux
In your install directory, you will find a script called XCGContainer. Check the container status by running
./XCGContainer status
If the container is running, stop it by running
./XCGContainer stop
Under Windows
Open the Services tool, usually located under the Administrative Properties menu in the Control Panels. Find the XCG Container service in the services list. To stop the container, right-click and select the stop option.
Share Your Computer's Idle Cycles: BES Resource Creation
You can add your own personal resources into the grid (such as your desktop computer). You can enable grid jobs to run on your resources when they would otherwise be idle (ie when no one is logged into your machines). Creating a BES Resource
