Download as pdf or txt
Download as pdf or txt
You are on page 1of 11

EAA FM Solution 12.

0
Install Guide
Contents

Contents

Notices 3

Important Information 4

Deploying Common Configuration 5

FM Platform Installation 6

Configuring Environment Variables 8


Customizing NetExpert Configuration 8

Preparing Configuration 10

EAA FM Solution 12.0 Install Guide 2


Notices

Notices
Warranty
©2018 MYCOM OSI All Rights The material contained in this document
Reserved. is provided “as is,” and is subject to
being changed, without notice, in future
No part of this manual may
editions. Further, to the maximum
be reproduced in any form
extent permitted by applicable law,
or by any means (including
MYCOM OSI disclaims all warranties,
electronic storage and retrieval
either express or implied, with regard
or translation into a foreign
to this manual and any information
language) without prior
contained herein, including but not
agreement and written consent
limited to the implied warranties
from MYCOM OSI as governed
of merchantability and fitness for a
by international copyright laws.
particular purpose. MYCOM OSI shall
not be liable for errors or for incidental
or consequential damages in connection
with the furnishing, use, or performance
of this document or of any information
contained herein. Should MYCOM OSI
and the user have a separate written
agreement with warranty terms covering
the material in this document that
conflict with these terms, the warranty
terms in the separate agreement shall
control.

Technology Licenses Safety Notices

The software described in this document is CAUTION:


furnished under a license and may be used or
copied only in accordance with the terms of such
A Caution notice denotes a hazard. It calls attention to an
license.
operating procedure, practice, or the like that, if not correctly
NIMS, PrOptima, NIMSPrOptima, ProAssure, performed or adhered to, could result in damage to the product
SPM, NetExpert, ProActor, and ProInsight are all or loss of important data. Do not proceed beyond a CAUTION
trademarks of MYCOM OSI. notice until the indicated conditions are fully understood and
met.

EAA FM Solution 12.0 Install Guide 3


Important Information

Important Information
MYCOM OSI guides use the following conventions.

Table 1: Document Conventions Used

Conventions Description
Italic Italic indicates document titles and variables, such as filename, in computer input and
output. It also indicates links to glossary terms.
Bold Bold identifies important words.
Sans serif Sans serif shows call outs, file names, UNIX paths, and environment variables.
Courier Courier denotes computer input and output.
[abc] Square brackets enclose optional syntax for computer input.
<TAB> Angle brackets indicate actual keyboard keys, such as <ENTER> or <SPACE>.

File | Save A vertical bar separates menu options.


Ctrl+X Ctrl+X means to press and hold the <CTRL> key while you press the <X> key.
Alt+Y Alt+Y means to press and hold the <ALT> key while you press the <Y> key.

Note: A note gives readers special information about the product or procedure that is apart from
the general discussion.

EAA FM Solution 12.0 Install Guide 4


Deploying Common Configuration

Deploying Common Configuration


Refer to the EAA Common Configurations Deployment Guide to configure the installation prerequisites.

EAA FM Solution 12.0 Install Guide 5


FM Platform Installation

FM Platform Installation
Prerequisites
• Oracle instance must have been created, and its hostname, port and SID must have been updated in the eaa-cm
config map (see Create config map above). The minimum mandatory parameter is: NX_DB_HOST
• Administration credentials for this instance must be filled in config/eaa-nx-install.env Both parameters are
mandatory: NX_DB_SYSUSER= NX_DB_SYSPASSWORD=
• Before proceeding to the installation and upgrade you must clone the contents of the Project GIT repository
containing the deployment and upgrade templates on the workstation:
git@gitlab.mycom-osi.com:eaa/eaa-deploy.git
git@gitlab.mycom-osi.com:eaa/eaa-netexpert.git
You should now have the following folder on your workstation:
• <root_git_dir>/eaa-deploy
• <root_git_dir>/eaa-netexpert
Prerequisites for Upgrade
Before upgrading NetExpert, perform the following steps:
1. Run the 201805-eaa-21-to-22-upgrade.sh script in the eaa-deploy/shell/upgrade directory to
for platform upgrade.
./eaa-deploy/shell/upgrade/201805-eaa-21-to-22-upgrade.sh
The platform upgrade is complete. The following tasks are performed by the above script:
• Remove old spark components that are not used.
• Remove the old CM spark-master-cm if it exists.
• Remove old zookeeper DC.
• Update for the Guacamole name change.
Configuration Preparation
Refer to Preparing Configuration on page 10 using the following dryrun cmd:
./eaa-netexpert/shell/deploy-netexpert.sh --dryrun

Procedure
Go to <root_git_dir> directory in terminal and execute the following commands
./eaa-netexpert/shell/deploy-netexpert.sh --proceed
This script will deploy all NetExpert components which includes
• NetExpert Platform installation
• Netexpert UIs installation
• Netexpert Gateway Agent (GWA) Installation (for SNMP)
• Netexpert CORBA Gateway Installation
• Netexpert Reporting (Alert Manager) Installation
• DMP Server and Application Deployment
• CleanDB Deployment
• Netexpert TT Handler Deployment
• Alert History Viewer Deployment

Checks

EAA FM Solution 12.0 Install Guide 6


FM Platform Installation

Wait for all deployments finish :


./eaa-deploy/shell/waitEndOfDeployment.sh
When finished, check status:
python ./eaa-deploy/shell/check-deployment-status.py

Note: Refer to section CleanDB Updation to update CleanDB for an existing user.
Updating CleanDB
This section describes the procedure to update CleanDB on OpenShift cluster for an existing user.
Procedure
Update the CleanDB template as follows:
• Run the following command:
oc import-image eaa-nx-nxdbadmin:<tag>
• It will deploy the new pods with new image pulled in the command.
• Go to pods
eaa-nx-nxdbadmin

Example: oc rsh a-nx-nxdbadmin-8-2qxjw


• Run the following script:
$OSI_HOME/Install/Database/install_cleandb.pl $OSI_DB_USER/$OSI_DB_PASSWORD@
$ORACLE_SID
• The CleanDB is updated.

EAA FM Solution 12.0 Install Guide 7


Configuring Environment Variables

Configuring Environment Variables


After installing a component template, you may need to modify some environment variables to make the different
components work in the target environment. The configuration is saved in the template (YAML) files deployed in
the target environment. For making changes to configuration settings for a component, you must make changes to the
corresponding YAML file and redeploy it. The generic procedure to make any configuration change to a template is
as follows:
1. Open the specific YAML file from the corresponding deployment repository. For example open the tpl-eaa-
nx-history-viewer.yaml file from the eaa-netexpert repository if you need to make configuration
changes to Alert History Viewer.
2. In the YAML file, locate the variable name to be changed in the env: section. For example, updating the value
for the following property changes the ALERT_SOURCE setting.
name: ALERT_SOURCE
value: NX-FM
3. Save and close the file.
4. Redeploy the template.

Customizing NetExpert Configuration


This section describes the changes that you may need to make to the YAML files corresponding to NetExpert
components. See Configuring Environment Variables on page 8 for the procedure to customize environment
variables in a template. The customizable variables for NetExpert are described in the table below:

Table 2: NetExpert Environment Variables

Variable Name Description Example/ Default Value


Alert-History-Viewer Variables
EAA_NX_HISTORY_VIEWER_RELEASE_VERSION NetExpert Release 12.0
Version
ELASTIC_RESPONSE_LIMIT Elastic response limit 500
ALERT_SOURCE Alert source name NX-FM
FM_QUERY_CLIENT_KEY FM Query client key f//
TqTXsS6NK9ZiRm8coUg==
OAUTH_ROOT_PATH Oauth root path http://oauth2-pm-eaa-
staging.apps.ocp.mycom-
osi.com/eaanims- oauth2
Alert-Manager Variables
EAA_NX_VERSION NetExpert Release 12.0
Version
EAA_RELEASE_VERSION EAA Release Version 1.5-eaa-12
EAA_AM_VERSION EAA Alert Manager 12.1.5
Version

Note: Before you start alert manager deployment, you need to update the value of the variable
(EAA_AM_VERSION) to the alert manager version which you want to deploy.

EAA FM Solution 12.0 Install Guide 8


Configuring Environment Variables

If you want to deploy Alert Manager 12.1.5 the value of the variable must be
EAA_AM_VERSION=12.1.5

EAA FM Solution 12.0 Install Guide 9


Preparing Configuration

Preparing Configuration
Target: For a given product, ensure all customization is entered into configuration files and that all expected PVs are
created.
• Populate Configuration:
Run iterations of deployment script in dryrun, each time it fails with a missing parameter, ensure it is added eg:
./deploy-netexpert.sh --dryrun
• Create PVs :
Once the deployment has been run successfully in dry-run mode, execute:
./eaa-deploy/shell/check-pvs.sh

EAA FM Solution 12.0 Install Guide 10


© 2007–2018 MYCOM OSI All Rights Reserved.

You might also like