|
|
This document provides instructions for installing and upgrading to BEA Guardian 1.1. Also included are instructions for starting the Guardian User Interface and Guardian Command Line Interface (Guardian Headless Mode). Topics include:
This section describes BEA Guardian 1.1 supported configurations and supported targets. Also provided is a brief overview of installation procedures, and important information for upgrading from Guardian 1.0.x to Guardian 1.1.
This section contains the following information:
BEA Guardian 1.1 requires Java Version 5 (Version 1.5) or above.
The following sections outline the operating systems and Java Runtime Environment versions supported by Guardian 1.1.
BEA Guardian supports the following operating systems:
BEA Guardian 1.1 supports the following Java Runtime Environment (JRE) versions:
Supported Targets are the environments that BEA Guardian can target for evaluations. This is distinct from supported configurations, which are the environments in which the Guardian application can be installed and executed.
Basically, Guardian can target any platform for evaluation that allows it to install and communicate with the Guardian Agent. In addition, the Guardian Agent must have access to a specific set of Java system information properties and methods. The BEA products capable of supporting these operations are based on WebLogic Server Versions 8.1 and above.
The following BEA product versions are supported:
| Note: | For the most current information on Supported BEA product versions, please see the Guardian 1.1 Release Notes. |
There are two basic types of Guardian 1.1 installations:
IMPORTANT: If upgrading from Guardian 1.0.x, you must install Guardian 1.1 in a different location than the previous Guardian 1.0.x installation. Otherwise, the Guardian Registry will not be installed properly and Guardian will not be able to start. In addition, you will not be able to import your previous Workspace data. It is also recommended that you back up your previous 1.0.x installation before proceeding, to ensure that your data is preserved.
Installing Guardian 1.1 involves the following basic tasks:
The following sections provide step-by-step instructions for each of these tasks.
IMPORTANT: If upgrading from Guardian 1.0.x, you must install Guardian 1.1 in a different location than the previous Guardian 1.0.x installation. Otherwise, the Registry will not be installed properly and Guardian will not be able to start. In addition, you will not be able to import your previous data. It is also recommended that you back up your previous 1.0.x installation before proceeding, to ensure that your data is preserved.
To install Guardian 1.1, do the following:
Go to the following URL and click BEA Guardian to go to the BEA Guardian download site:
The wizard proceeds to the Introduction page.
The wizard proceeds to the License Agreement page.
Read the license terms and select I accept the terms of the License Agreement. Then click Next to proceed to the Choose Install Folder page.
Accept the default, or click Choose... to open a file browser from which you can select a location.
| Caution: | If you are upgrading from Guardian 1.0.x to Guardian 1.1, do not accept the default. Be sure to install Guardian 1.1 in a different location than the previous Guardian 1.0.x installation. Otherwise, the Registry will not be installed properly and Guardian will not be able to start. |
This proceeds to the Pre-installation Summary page.
| Note: | If you need to change a setting, click Previous to backtrack to the appropriate page and change your setting. |
The wizard displays the Installing BEA Guardian progress page. When the installation finishes, the Install Complete page displays.
You are now ready to deploy the Guardian Agent in the WebLogic Administration Server. Proceed to the section entitled, Step 2: Deploy the Guardian Agent on page 7.
After installing Guardian 1.1, you must deploy the new Guardian Agent to any WebLogic Server instances you wish to evaluate.
For a single instance, you can use the WebLogic Server Administration Console to uninstall the previous Guardian Agent and then install and deploy the new Agent. The WebLogic Server Administration Console provides a series of Web-based deployment assistants that guide you through the deployment process. For a summary of the steps involved in deploying the Guardian Agent, see Deploy Guardian Agent from WebLogic Server Adminstration Console on page 7 . For complete instructions on deploying applications, see the Administration Console Online Help, and WebLogic Server documentation.
If you want to deploy the Guardian Agent to multiple servers, you can use the WebLogic Scripting Tool to automate this task. For basic instructions, see Deploy Guardian Agent to Multiple Servers on page 9. For complete instructions on using the WebLogic Scripting tool to deploy applications, see the WebLogic Scripting Tool documentation.
| Note: | If you are upgrading from Guardian 1.0.x to Guardian 1.1, after deploying the Agent, you must also install and run the Upgrade Plug-in, as described in Step 3: (Upgrades, Only) Install and Run the Upgrade Plug-in on page 10. |
You can use the WebLogic Server Administration Console to manually deploy the Guardian Agent to the Administration Server. This section provides a summary of the basic steps involved for WebLogic Server versions 9.0 and above. For complete instructions for your specific version of WebLogic Server, please see your WebLogic Server documentation and Administration Console Online Help. Please also refer to the Guardian 1.1 Release Notes for additional important information.
To use the Administration Console to manually deploy the Guardian Agent, do the following:
| Caution: | Make sure that Lock & Edit is selected for each of the following procedures. |
By default, the Guardian Agent is named bea-guardian-agent.
| Note: | For detailed instructions for this procedure, see “Start and stop a deployed Enterprise Application” in the WebLogic Administration Console Online Help. |
| Note: | For detailed instructions for this procedure, see “Delete an Enterprise Application” in the WebLogic Administration Console Online Help. |
The Guardian Agent is a WAR file named bea-guardian-agent.war, and is located in the following directory:
<root>\guardian\plugins\com.bea.guardian.agent.weblogic_<guard-version>\weblogic<wls-version>
<root> is the parent directory for the Guardian installation. For example:C:\\Program Files
<guard-version> is the current (updated) Guardian version.
<wls-version> is the version of WebLogic Server in which you are deploying this Agent.
If you are installing the Agent on WebLogic 8.1.x, install the bea-guardian-agent.war file located in the ..\weblogic8 directory. For WebLogic Server 9.x and 10.x, install the bea-guardian-agent.war file located in the ..\weblogic9 directory.
| WARNING: | Do not change the name of the Guardian Agent when deploying it. Be sure to use the default name, bea-guardian-agent.war. |
| Note: | For detailed instructions for this procedure, see the section entitled, “Install an Enterprise Application” in the Administration Console Online Help. |
| Note: | For detailed instructions for this procedure, see “Start and stop a deployed Enterprise Application” in the WebLogic Administration Console Online Help. |
| Note: | For detailed instructions for this procedure, see “Activate Domain” in the BEA Guardian Online Help. |
If this is a new installation, you can now use Guardian to evaluate the activated domains in your environment. If this is an upgrade installation, proceed to Step 3: (Upgrades, Only) Install and Run the Upgrade Plug-in on page 10.
If you need to deploy the Guardian Agent to multiple servers, you can use the weblogic.Deployer command in the WebLogic Server Command Line Interface to automate this task. You can also use the WebLogic Scripting Tool (WLST) to deploy the Agent. This section provides basic instructions for using the weblogic.Deployer command for this purpose. For instructions on using WLST, please see the WebLogic Scripting Tool documentation.
| WARNING: | Do not change the name of the Guardian Agent when deploying it. Be sure to use the default name, bea-guardian-agent.war. |
At the WebLogic Server CLI prompt, enter the following command line:
java weblogic.Deployer -debug -adminurl http://<admin_url>:<port> -username <username> -password <password> – targets adminserver,<cluster1>,<cluster2> -deploy -sourcerootforupload <dir_path>\bea-guardian-agent.war
| Note: | If this is an upgrade installation, after deploying the Agents, proceed to Step 3: (Upgrades, Only) Install and Run the Upgrade Plug-in on page 10. |
If you are upgrading from Guardian 1.0.x to Guardian 1.1, you must install and run the Upgrade Plug-in to complete the upgrade procedure. The Upgrade Plug-in imports your Guardian 1.0 Workspace into your current Guardian 1.1 workspace, and updates the Guardian 1.1 Registry.
To install and run the Upgrade Plug-in, do the following:
plugins directory in your Guardian 1.1 installation.
Copy the com.bea.guardian.ui.importing_1.0.0.jar file to the following directory:
<Guardian_Root>\guardian\plugins\
<Guardian_Root> is the Guardian installation root directory.
You can start the BEA Guardian User Interface (GUI) from either the Windows Start menu, or by invoking the guardian.exe executable in your Guardian installation directory. For details, see
Start the Guardian User Interface on page 14.
Guardian first displays the initial splash screen while loading, and then displays the Select Workspace dialog box.
IMPORTANT: For this upgrade procedure, do not accept the default location. Also, make sure this directory is not located within the Guardian installation directory, and is in a different location than your original Guardian 1.0.x Workspace.
To use an existing folder: Browse to the folder location and select the folder.
If you do not want to select the Workspace each time you start Guardian, select the checkbox for Use this as the default workspace and do not ask again. This is particularly useful to prevent accidentally accepting the default Workspace, and having to reconstruct or reimport your Workspace data. For the purposes of this upgrade, it is recommended that you select this option until the upgrade is complete. You can change this setting at a later time by selecting Prompt for workspace on startup in the Guardian Preferences configuration page. For instructions, open the Guardian 1.1 Online Help and select Tasks > Workspaces > Select Workspace.
Guardian creates the new Workspace and starts Guardian.
In the Guardian User Interface, do the following:
Guardian proceeds to import the selected Workspace. This may take a few seconds to complete.
Restart Guardian to automatically add the domains from the imported Workspace to the Domain Explorer tree. Until you restart Guardian, the imported data will not be displayed in the Navigation Pane Explorers.
The installation is now complete, and you can use Guardian 1.1 to evaluate your environment.
You can use the Product Configuration page to check the current configuration for a Guardian installation.
To check the current Guardian configuration, do the following:
Check the version numbers for each item.
You can also run the Guardian 1.1 installer in Text Mode, if you do not want to use the Installation Wizard Graphical User Interface. The following sections provide instructions for the following:
On Windows, you can run the Guardian Installer in Text Mode in a Command Prompt window.
To install Guardian 1.1 on Windows using Text Mode, do the following:
Go to the following URL and click BEA Guardian to go to the BEA Guardian download site:
guardian110_win32.exe -i console
The installation script prompts you for your installation information.
| WARNING: | If you are upgrading from Guardian 1.0.x to Guardian 1.1, do not accept the default installation location. You must install Guardian 1.1 in a location separate from the Guardian 1.0.x installation. Otherwise, the Registry will not be installed properly and Guardian will not be able to start. |
When the installation is finished, a success message is displayed. You are now ready to deploy the Guardian Agent in the WebLogic Administration Server. Proceed to the section entitled, Step 2: Deploy the Guardian Agent on page 7.
On Linux, you can run the Guardian Installer in Text Mode using Linux Console Mode.
To install Guardian 1.1 from Linux Console Mode, do the following:
Go to the following URL and click BEA Guardian to go to the BEA Guardian download site:
cd to the directory in which you downloaded the Guardian 1.1 installer, and enter the following command:
./ guardian_installer.bin -i console
The installation script prompts you for your installation information.
| WARNING: | If you are upgrading from Guardian 1.0.x to Guardian 1.1, do not accept the default installation location. You must install Guardian 1.1 in a location separate from the Guardian 1.0.x installation. Otherwise, the Registry will not be installed properly and Guardian will not be able to start. |
When the installation is finished, a success message is displayed. You are now ready to deploy the Guardian Agent in the WebLogic Administration Server. Proceed to the section entitled, Step 2: Deploy the Guardian Agent on page 7.
BEA Guardian has two modes of operation:
The Guardian 1.1 executable is named guardian.exe, and is located in the Guardian installation home directory, as follows:
<Guardian_Root> is the Guardian installation directory.
Each time you start the Guardian User Interface, you are prompted to select a Guardian Workspace. If you do not want to select the Workspace each time you start Guardian, you can specify a default location and select an option to skip this process in the future. Instructions are provided below. For a description of the Guardian Workspace, see “Chapter 1: About Guardian” in the Guardian 1.1 User Guide.
To start Guardian and select a Workspace, do the following:
Select Start > BEA Guardian > Guardian or double-click on guardian.exe in your Guardian installation home folder.
Change directories to the Guardian 1.1 installation directory, and enter the following command:
Guardian first displays the initial splash screen while loading, and then displays the Select Workspace dialog box.
IMPORTANT: Do not place this folder within the Guardian installation directory. Otherwise, when conducting automatic updates of Guardian, your Workspace will be overwritten and the data will be lost. In addition, if you are upgrading from Guardian 1.0.x to Guardian 1.1 and have not yet imported your previous Workspace, do not select the default, as that may overwrite the old contents. Make sure that you select a location that is different than the Workspace used by the previous version.
To use an existing folder: Click Browse to open a directory browser from which you can select the folder.
If you do not want to select the Workspace each time you start Guardian, select the checkbox for Use this as the default workspace and do not ask again.
| Note: | You can change this setting at a later time by selecting Prompt for workspace on startup in the Guardian Preferences configuration page. For instructions, open the Guardian 1.1 Onlind Help and select Tasks > Workspaces > Select Workspace. |
Guardian loads the selected Workspace and completes the startup procedure.
The Guardian Command Line Interface (CLI)—also referred to as Guardian Headless Mode—is a set of Guardian commands that can be issued directly from the operating system command prompt. There is a Guardian CLI command for almost every task available in the Guardian User Interface. For a complete description of these commands and their syntax, see the Guardian 1.1 Online Help and the Guardian 1.1 User Guide.
To start the Guardian Command Line Interface, do the following:
| Note: | Guardian Command Line Interface commands are case sensitive. |
The Command Line Interface uses your specified Guardian Workspace as the location for all CLI operations, unless you specify otherwise in each command. Identifying the Guardian Workspace location is essential for accessing the correct set of active domains, Domain Inventories, and Evaluation Summaries. For instructions on selecting a Guardian Workspace, see the Guardian User Guide — Version 1.1 and Guardian 1.1 Online Help.
The following are some examples of Guardian Headless command lines:
guardianHeadless.cmd -g listActiveDomains guardianHeadless.cmd -g activateDomain -t http://localhost:9116 -u un -p pw -c true -data "D:\MyData\Guardian Data Directories\
Installer-2079" guardianHeadless.cmd -g createShortcut -d Naxos_localhost_9116 -b 2 guardianHeadless.cmd -g deleteShortcut -s "Security Advisories in Naxos" The output of each command is sent to the following output file:
The output file is created in your current directory, and is overwritten each time you run a Guardian Headless Mode command.
For a complete list of Guardian Command Line Interface commands and syntax, see Guardian User Guide — Version 1.1, and Guardian 1.1 Online Help.
|