Teradata Viewpoint Installation, Configuration, and Upgrade Guide

Transcription

What would you do if you knew?™
Teradata Viewpoint
Installation, Configuration, and Upgrade Guide
for Customers
Release 15.11
B035-2207-105K
August 2016
The product or products described in this book are licensed products of Teradata Corporation or its affiliates.
Teradata, Active Data Warehousing, Active Enterprise Intelligence, Applications-Within, Aprimo Marketing Studio, Aster, BYNET, Claraview,
DecisionCast, Gridscale, MyCommerce, QueryGrid, SQL-MapReduce, Teradata Decision Experts, "Teradata Labs" logo, Teradata
ServiceConnect, Teradata Source Experts, WebAnalyst, and Xkoto are trademarks or registered trademarks of Teradata Corporation or its
affiliates in the United States and other countries.
Adaptec and SCSISelect are trademarks or registered trademarks of Adaptec, Inc.
AMD Opteron and Opteron are trademarks of Advanced Micro Devices, Inc.
Apache, Apache Avro, Apache Hadoop, Apache Hive, Hadoop, and the yellow elephant logo are either registered trademarks or trademarks of the
Apache Software Foundation in the United States and/or other countries.
Apple, Mac, and OS X all are registered trademarks of Apple Inc.
Axeda is a registered trademark of Axeda Corporation. Axeda Agents, Axeda Applications, Axeda Policy Manager, Axeda Enterprise, Axeda
Access, Axeda Software Management, Axeda Service, Axeda ServiceLink, and Firewall-Friendly are trademarks and Maximum Results and
Maximum Support are servicemarks of Axeda Corporation.
Data Domain, EMC, PowerPath, SRDF, and Symmetrix are registered trademarks of EMC Corporation.
GoldenGate is a trademark of Oracle.
Hewlett-Packard and HP are registered trademarks of Hewlett-Packard Company.
Hortonworks, the Hortonworks logo and other Hortonworks trademarks are trademarks of Hortonworks Inc. in the United States and other
countries.
Intel, Pentium, and XEON are registered trademarks of Intel Corporation.
IBM, CICS, RACF, Tivoli, and z/OS are registered trademarks of International Business Machines Corporation.
Linux is a registered trademark of Linus Torvalds.
LSI is a registered trademark of LSI Corporation.
Microsoft, Active Directory, Windows, Windows NT, and Windows Server are registered trademarks of Microsoft Corporation in the United
States and other countries.
NetVault is a trademark or registered trademark of Dell Inc. in the United States and/or other countries.
Novell and SUSE are registered trademarks of Novell, Inc., in the United States and other countries.
Oracle, Java, and Solaris are registered trademarks of Oracle and/or its affiliates.
QLogic and SANbox are trademarks or registered trademarks of QLogic Corporation.
Quantum and the Quantum logo are trademarks of Quantum Corporation, registered in the U.S.A. and other countries.
Red Hat is a trademark of Red Hat, Inc., registered in the U.S. and other countries. Used under license.
SAP is the trademark or registered trademark of SAP AG in Germany and in several other countries.
SAS and SAS/C are trademarks or registered trademarks of SAS Institute Inc.
Simba, the Simba logo, SimbaEngine, SimbaEngine C/S, SimbaExpress and SimbaLib are registered trademarks of Simba Technologies Inc.
SPARC is a registered trademark of SPARC International, Inc.
Symantec, NetBackup, and VERITAS are trademarks or registered trademarks of Symantec Corporation or its affiliates in the United States and
other countries.
Unicode is a registered trademark of Unicode, Inc. in the United States and other countries.
UNIX is a registered trademark of The Open Group in the United States and other countries.
Other product and company names mentioned herein may be the trademarks of their respective owners.
The information contained in this document is provided on an "as-is" basis, without warranty of any kind, either express or implied,
including the implied warranties of merchantability, fitness for a particular purpose, or non-infringement. Some jurisdictions do not allow
the exclusion of implied warranties, so the above exclusion may not apply to you. In no event will Teradata Corporation be liable for any
indirect, direct, special, incidental, or consequential damages, including lost profits or lost savings, even if expressly advised of the
possibility of such damages.
The information contained in this document may contain references or cross-references to features, functions, products, or services that are not
announced or available in your country. Such references do not imply that Teradata Corporation intends to announce such features, functions,
products, or services in your country. Please consult your local Teradata Corporation representative for those features, functions, products, or
services available in your country.
Information contained in this document may contain technical inaccuracies or typographical errors. Information may be changed or updated
without notice. Teradata Corporation may also make improvements or changes in the products or services described in this information at any
time without notice.
To maintain the quality of our products and services, we would like your comments on the accuracy, clarity, organization, and value of this
document. Please e-mail: [email protected]
Any comments or materials (collectively referred to as "Feedback") sent to Teradata Corporation will be deemed non-confidential. Teradata
Corporation will have no obligation of any kind with respect to Feedback and will be free to use, reproduce, disclose, exhibit, display, transform,
create derivative works of, and distribute the Feedback and derivative works thereof without limitation on a royalty-free basis. Further, Teradata
Corporation will be free to use any ideas, concepts, know-how, or techniques contained in such Feedback for any purpose whatsoever, including
developing, manufacturing, or marketing products or services incorporating Feedback.
Copyright © 2008 - 2016 by Teradata. All Rights Reserved.
Table of Contents
Preface.............................................................................................................................................................9
Purpose.................................................................................................................................................................. 9
Audience................................................................................................................................................................ 9
Revision History................................................................................................................................................... 9
Additional Information..................................................................................................................................... 10
Related Links................................................................................................................................................10
Related Documentation..............................................................................................................................10
Customer Education................................................................................................................................... 10
Product Safety Information...............................................................................................................................10
Chapter 1:
Overview..................................................................................................................................................... 11
Dependencies...................................................................................................................................................... 11
Supported Web Browsers for Viewpoint Portal.......................................................................................11
Supported Web Browsers for Viewpoint Mobile..................................................................................... 11
Recommended Hardware...........................................................................................................................11
Supported Teradata Viewpoint Appliances.............................................................................................. 11
Supported Teradata Database Versions.................................................................................................... 11
Ports Used by Teradata Viewpoint............................................................................................................ 12
Teradata Manager Feature Equivalence...........................................................................................................12
Teradata Viewpoint Services............................................................................................................................. 12
Starting and Stopping Teradata Viewpoint Services...................................................................................... 13
Interaction between Teradata Alerts and Teradata Database.......................................................................14
Notification Server Requirements....................................................................................................................14
Linux Server Requirements........................................................................................................................14
Windows Server Requirements..................................................................................................................15
Starting and Stopping the Teradata Notification Service (Windows)..........................................................15
Starting and Stopping the Teradata Notification Service (Linux)................................................................16
Chapter 2:
Upgrading Viewpoint Software............................................................................................ 17
Viewpoint Software Upgrades...........................................................................................................................17
Teradata Viewpoint Installation, Configuration, and Upgrade Guide for Customers, Release 15.11
3
Table of Contents
Upgrading from Teradata Viewpoint 14.00.xx.xx or Earlier...................................................................17
Upgrading Teradata Viewpoint 14.01.00.00 or Later............................................................................... 17
Creating an Incident............................................................................................................................................17
Finding the PUT Version Running on the System.......................................................................................... 18
Determining the Latest PUT Release................................................................................................................18
Downloading New PUT Packages.....................................................................................................................18
Installing and Upgrading PUT...........................................................................................................................20
Installing PUT...............................................................................................................................................20
Upgrading PUT............................................................................................................................................ 20
Checking for Space on the Node....................................................................................................................... 21
Creating a Target Directory................................................................................................................................21
Software Package Downloads.............................................................................................................................21
Downloading Software Packages................................................................................................................21
Verifying the Previous Database Backup..........................................................................................................23
Upgrading a Teradata Viewpoint Server...........................................................................................................23
Creating a Teradata User for Data Collection..................................................................................................24
Upgrading a Teradata Viewpoint Cluster......................................................................................................... 25
Troubleshooting a Failed Upgrade.................................................................................................................... 25
Chapter 3:
Installing Notification Services.............................................................................................27
Downloading the Teradata Alerts Notification Software...............................................................................27
Installing Teradata Notification Service for Windows....................................................................................27
Preparing for Installation of Notification Service.................................................................................... 27
Installing Notification Service Software on a Windows Server..............................................................28
Configuring the Teradata Viewpoint Server Location.............................................................................29
Setting Up the BTEQ Scripts and Run Program Executables.................................................................29
Installing Teradata Notification Service for Linux..........................................................................................30
Preparing for Installation of Notification Service for Linux...................................................................30
Installing Software on a Linux Server........................................................................................................ 30
Installing Teradata Notification Service Interactively............................................................................. 31
Service User............................................................................................................................................31
Configuring the Teradata Viewpoint Server Location.............................................................................32
Setting Up the BTEQ Scripts and Run Program Executables.................................................................32
Uninstalling the Teradata Notification Service................................................................................................33
Chapter 4:
Administrative Tasks....................................................................................................................... 35
4
Table of Contents
Configuring NTP Time Synchronization........................................................................................................ 35
Configuring LDAP for Teradata Viewpoint.................................................................................................... 35
Prerequisites................................................................................................................................................. 36
Definitions....................................................................................................................................................36
Before You Begin LDAP Configuration................................................................................................... 37
Determining LDAP Configuration Mode................................................................................................37
Is the Username in DN?...................................................................................................................... 38
Determining the Number of Bind Patterns...................................................................................... 39
LDAP Servers...................................................................................................................................................... 39
Auto-Provisioning and Role Mapping......................................................................................................40
Adding an LDAP Server............................................................................................................................. 40
LDAP Configuration Options....................................................................................................................41
Basic Configuration............................................................................................................................. 41
DN Pattern Bind...................................................................................................................................42
User Search............................................................................................................................................42
Key User Information.......................................................................................................................... 42
Auto-Provisioning................................................................................................................................43
Role Mapping Global Settings............................................................................................................ 43
Role Mapping Individual Settings......................................................................................................43
Changing a Teradata Viewpoint System Name...............................................................................................43
Resetting the Admin User Password................................................................................................................44
Changing the PostgreSQL Passwords.............................................................................................................. 44
Portlets Enabled Under Special Circumstances............................................................................................. 44
Configuring Teradata Viewpoint to Monitor a Managed System................................................................ 45
Creating a Teradata Database Logon for Stats Manager............................................................................... 45
Configuring Stats Manager............................................................................................................................... 45
Configuring Teradata Database to Collect and Analyze Statistics...............................................................46
Collecting Statistics..................................................................................................................................... 46
Analyzing Statistics..................................................................................................................................... 47
Cleaning Up the TDStats Database...........................................................................................................47
Working with Teradata Alerts...........................................................................................................................47
Backing Down to a Previous Teradata Alerts Version............................................................................47
Manually Uninstalling Teradata Alerts Packages....................................................................................49
Working with Teradata Data Labs....................................................................................................................49
Installing Teradata Data Lab......................................................................................................................49
Configuring Teradata Data Lab Email Notifications..............................................................................50
Migrating Teradata Data Labs to a New Teradata System..................................................................... 50
Uninstalling a Teradata Data Lab Package Manually............................................................................. 51
Uninstalling Teradata Manager........................................................................................................................ 51
5
Table of Contents
Chapter 5:
Teradata Viewpoint Server Clustering........................................................................... 53
Teradata Viewpoint Server Clustering Configurations...................................................................................53
High Availability Configuration: Two Teradata Viewpoint Servers...................................................... 53
High Usage Configuration: Three or More Teradata Viewpoint Servers.............................................. 54
Advanced Configuration: Three or More Teradata Viewpoint Servers With Dedicated Cache
Database Server..................................................................................................................................... 54
Teradata Alerts Cluster Configurations.....................................................................................................55
Failure Scenarios...........................................................................................................................................56
Teradata Viewpoint Failure Scenarios................................................................................................ 56
Data Collection Server Failure.............................................................................................. 56
Cache Database Failure.......................................................................................................... 56
Active Teradata Viewpoint Server Failure............................................................................57
Teradata Alerts Failure Scenarios........................................................................................................58
Alert Service Failure............................................................................................................... 58
Messaging Service Failure......................................................................................................58
DCS Failure..............................................................................................................................59
Cache Database Failure.......................................................................................................... 59
Server Failure...........................................................................................................................60
Clustering Considerations...........................................................................................................................61
LAN or WAN......................................................................................................................................... 61
Load Balancing...................................................................................................................................... 61
Setting Disk Capacity for the Standby Cache Database...................................................................61
Setting Up Notifications of Failures and Promotions.......................................................................61
Creating a Teradata Viewpoint Cluster......................................................................................................62
Adding Teradata Viewpoint Servers to a Cluster..................................................................................... 63
Configuring Automatic Promotions.......................................................................................................... 63
Disabling a Teradata Viewpoint Cluster.................................................................................................... 64
Promoting the Standby Cache Database to Active.................................................................................. 64
Recreating a Standby Cache Database After a Promotion......................................................................64
Teradata Notification Service Cluster Configuration..................................................................................... 65
Cluster Enabling........................................................................................................................................... 65
Cluster Disabling.......................................................................................................................................... 65
Viewpoint Server Replacement...................................................................................................................66
Chapter 6:
Backup and Restore.......................................................................................................................... 67
Backup for Teradata Viewpoint Databases.......................................................................................................67
6
Table of Contents
Backup...........................................................................................................................................................67
Backup Errors.............................................................................................................................................. 67
Scheduling Viewpoint Backups..................................................................................................................67
Backing Up Third-Party Applications...................................................................................................... 68
Teradata Viewpoint Database Restoration Options.......................................................................................69
Restoring a Teradata Viewpoint Database............................................................................................... 69
Migrating Teradata Viewpoint to a New Server............................................................................................. 70
Backing Down to a Previous Teradata Viewpoint Version............................................................................70
7
Table of Contents
8
Preface
Purpose
This guide provides customer information and procedures for configuring and maintaining
the Teradata Viewpoint server, as well as upgrading from and backing down to a previous
Teradata Viewpoint software version.
Audience
This guide is intended for use by:
• System administrators
• Database administrators and relational database developers
• Customers
• Teradata Customer Support
Revision History
Date
Release
Description
August 2016
15.11
Updated Windows and Linux Notification Server requirements
to support Java Runtime Environment 7 only.
February 2016
15.11
•
•
Updated software dependencies for Linux server
requirements.
Removed unsupported Teradata Viewpoint appliance.
December 2015
15.11
Added content to support changing the PostgreSQL passwords.
October 2015
15.11
Initial release.
• Added content to support migrating Teradata data labs to a
new Teradata system.
9
Preface
Additional Information
Additional Information
Related Links
URL
Description
https://tays.teradata.com
Use Teradata At Your Service to access Orange Books, technical
alerts, and knowledge repositories, view and join forums, and
download software packages.
www.teradata.com
External site for product, service, resource, support, and other
customer information.
Related Documentation
Documents are located at http://www.info.teradata.com.
Title
Publication ID
Parallel Upgrade Tool (PUT) Reference
B035-5716
Describes how to install application software using PUT.
Teradata Viewpoint User Guide
B035-2206
Describes the Teradata Viewpoint portal, portlets, and system administration
features.
Electronic Software Distribution Guide
BCD0-0718-0000
Customer Education
Teradata Customer Education delivers training for your global workforce, including
scheduled public courses, customized on-site training, and web-based training. For
information about the classes, schedules, and the Teradata Certification Program, go to
www.teradata.com/TEN/.
Product Safety Information
This document may contain information addressing product safety practices related to data
or property damage, identified by the word Notice. A notice indicates a situation which, if not
avoided, could result in damage to property, such as equipment or data, but not related to
personal injury.
Example
Notice: Improper use of the Reconfiguration utility can result in data loss.
10
CHAPTER 1
Overview
Dependencies
Supported Web Browsers for Viewpoint Portal
Browser
Version
Mozilla Firefox
41
Internet Explorer
10 or 11
Google Chrome
45
Safari
8
Supported Web Browsers for Viewpoint Mobile
Browser
Version
Google Chrome for Android
45
Safari for iOS
8
Recommended Hardware
• At least 1.8 GHz Pentium M, 3 GHz Pentium 4, or equivalent CPU
• At least 1 GB of RAM
• Monitor or display supporting at least 1024x768 resolution
Supported Teradata Viewpoint Appliances
Teradata Viewpoint Appliance
Model Number
Description
Storage Capacity
617
Dell R710
4 x 450 GB drives (RAID 5)
819
Dell R720
6 x 900 GB drives (RAID 10)
Supported Teradata Database Versions
• 13.10
• 14.0
• 14.10
11
Chapter 1 Overview
Teradata Manager Feature Equivalence
• 15.0
• 15.10
Ports Used by Teradata Viewpoint
Following is a list of ports used by Teradata Viewpoint and Alerts. Additional ports are
required for Teradata Viewpoint Clustering.
Incoming
•
•
•
•
•
•
22 (SSH)
80 (HTTP)
443 (HTTPS)
5432 (Cache Database)
8888 (Optional for monitoring Teradata Viewpoint server - tmsmonitor)
61616 (Teradata Alerting)
Outgoing
•
•
•
•
•
•
•
•
22 (SSH) For clustering and Elastic Performance uploads
80 (HTTP) For monitoring Teradata Aster systems
389 Optional for LDAP authentication
636 Optional for LDAPS authentication
1025 (JDBC)
5432 (Cache Database) When clustering is enabled
8081(HTTP) for monitoring Teradata Hadoop systems
8888 Optional for monitoring Teradata Viewpoint servers - tmsmonitor
Alerts
• 25 SMTP (default)*
• 465 SMPT over SSL (default)*
• 162 SNMP Trap
*You can change the outgoing Teradata Alerts SMTP ports by selecting Delivery Settings >
Email in the Alert Setup portlet.
Teradata Manager Feature Equivalence
Teradata Viewpoint supports all features of Teradata Manager except the following.
Teradata Manager Feature
Option
Scheduling
Most operating systems provide scheduling features. In Microsoft
Windows, use the Microsoft Task Scheduler.
Priority Scheduler
Administrator
You can use the Workload Designer portlet instead.
Teradata Viewpoint Services
Teradata Viewpoint includes the following separate services.
12
Chapter 1 Overview
Starting and Stopping Teradata Viewpoint Services
Service
Description
camalert
Teradata Alert Service that processes events and alerts
dcs
Data Collection Service that monitors and collects data from Teradata
systems
postgresql
Internal database used to store all Viewpoint configuration and collected
data
tdnotification
Teradata Notification Service used to run BTEQ and Run Program alert
actions.
tdactivemq
Messaging service that allows message exchanges between the Teradata
Alerts components
tmsmonitor
Service that monitors performance of the Teradata Viewpoint server
viewpoint
Teradata Viewpoint portal that provides web browser access
Starting and Stopping Teradata Viewpoint
Services
The /etc/init.d directory on the Teradata Viewpoint server contains scripts that allow
you to manage Teradata Viewpoint services using the following commands.
Command
Description
start
Starts the service. If the service is already running, a new instance is not started.
stop
Stops the service. The script completes successfully even when the service is not
running.
restart
Stops and starts the service.
status
Checks if the service is running.
The Teradata Viewpoint services that can use these commands are:
• camalert
• dcs
• postgresql
• tdactivemq
• tmsmonitor
• viewpoint
The following are examples of using the commands.
Action
Example
Starting the Teradata Alert service
/etc/init.d/camalert start
Stopping the Teradata Viewpoint service
/etc/init.d/viewpoint stop
Restarting the PostgreSQL service
/etc/init.d/postgresql restart
13
Chapter 1 Overview
Interaction between Teradata Alerts and Teradata Database
Action
Example
Checking the Teradata Viewpoint server monitor
status
/etc/init.d/tmsmonitor status
The vp-control.sh script, located in the same directory, allows you to run the start, stop,
restart and status commands. When running start, stop, or restart, the script performs the
specified action on the tdactivemq, camalert, tmsmonitor, dcs, and viewpoint services. When
running status, you receive the status of all commands for all the services including
postgresql.
/opt/teradata/viewpoint/bin/vp-control.sh command
Where command is the command you want to perform using the script.
This script supports the same command arguments as the individual init.d scripts.
Interaction between Teradata Alerts and
Teradata Database
Teradata Alerts has limited interaction with Teradata Database. The three components that
interact with the Teradata Database are:
• BTEQ alert actions
• SQL alert actions
• Alerts processed by the Teradata Viewpoint alert request data collector
Teradata Notification Service for Windows and Teradata Notification Service for Linux can
execute BTEQ scripts. The version of BTEQ that is installed on the Windows Server or Linux
Server must be compatible with the version of the Teradata Database that the BTEQ scripts
are executing against.
Teradata Alerts running on the Viewpoint Server executes SQL alert actions using the
Teradata JDBC driver. The queries entered by the administrator must be compatible with the
Teradata Database where the queries will be executed.
Teradata Viewpoint alert request data collector monitors the dbcmngr.alertrequest and
dbcmngr.monitorrequest tables for alert requests. Teradata Alerts supports the same versions
of the Teradata Database that Viewpoint monitoring supports.
Notification Server Requirements
Linux Server Requirements
Teradata Notification Service for Linux is needed to run the BTEQ scripts and executable
programs on a Linux server and must be installed on a customer provided Linux server. If the
BTEQ and Run Program alert actions are not needed on Linux, Teradata Notification Service
for Linux is not required.
14
Chapter 1 Overview
Starting and Stopping the Teradata Notification Service (Windows)
Software Dependencies
One of the following SuSE Linux Enterprise operating systems:
• SuSE Linux Enterprise 10, Service Pack 3
• SuSE Linux Enterprise 11, Service Pack 1 or Service Pack 3
The following Java SE Runtime Environment:
• 64-bit Java SE Runtime Environment 7
BTEQ and related dependencies:
• TTU versions are dependent on the targeted Teradata
Database and should be installed using the TTU Client Main
Install so all required dependencies are installed.
Other Requirements
The Linux system clock must be synchronized with the clock on
the Viewpoint server.
Windows Server Requirements
Teradata Notification Service for Windows is needed to run the BTEQ scripts and executable
programs on a Windows server, and must be installed on the Windows Server. If the BTEQ
and Run Program alert actions are not needed on Windows, Teradata Notification Service
for Windows is not required.
Software Dependencies
One of the following Microsoft Windows operating systems:
• Windows XP
• Windows Server 2003
• Windows Vista
• Windows Server 2008
• Windows Server 2008 R2
• Windows 7
The following Java SE Runtime Environment:
• 32-bit Java SE Runtime Environment 7
BTEQ and related dependencies:
• TTU versions are dependent on the targeted Teradata
Database and should be installed using the TTU Client Main
Install so all required dependencies are installed.
Other Requirements
The Windows system clock must be synchronized with the clock
on the Viewpoint server.
Starting and Stopping the Teradata Notification
Service (Windows)
The Teradata Notification Service is installed as a Windows Service named Teradata
Notification Service. The default installation procedure configures the service to
automatically start when the system reboots.
You can start, stop, pause, resume, or restart a service using the Services Administration tool
in Windows, which can be opened from a command prompt window by typing
services.msc.
15
Chapter 1 Overview
Starting and Stopping the Teradata Notification Service (Linux)
Starting and Stopping the Teradata Notification
Service (Linux)
The Teradata Notification Service is installed as a Linux service named tdnotification. The
default installation procedure configures the service to automatically start when the system
reboots.
The Teradata Notification Service for Linux has an init script called tdnotification, located
in the /etc/init.d directory. The init script supports the following commands.
Command Description
Example
start
To start the tdnotification service, type:
stop
Starts the service. If the
service is already running, a
new instance is not started.
Stops the service.
/etc/init.d/tdnotification start
To stop the tdnotification service, type:
/etc/init.d/tdnotification stop
restart
Stops and restarts the service. To restart the tdnotification service, type:
/etc/init.d/tdnotification restart
status
16
Checks if the service is
currently running.
To check if the tdnotification service is running, type:
/etc/init.d/tdnotification status
CHAPTER 2
Upgrading Viewpoint Software
Viewpoint Software Upgrades
Depending on your currently installed release, you might have to perform incremental
upgrades to upgrade to the latest release.
Upgrading from Teradata Viewpoint 14.00.xx.xx or Earlier
When upgrading from a release earlier than 14.01.00.00, first upgrade to 14.01.00.04, and
then upgrade from 14.01.00.04 to 15.11.xx.xx.
Upgrading Teradata Viewpoint 14.01.00.00 or Later
1 Verify the previous database backup.
2 Upgrade the software based on your configuration:
• Teradata Viewpoint Server
• Teradata Viewpoint Cluster
Creating an Incident
You must obtain an Incident number from Teradata at Your Service prior to performing any
software upgrades.
1 On your Windows PC, open a web browser and go to Teradata At Your Service at https://
tays.teradata.com and log in.
2 Under the Product banner click Incident.
3 Click the Create tab.
4 Make the following selections as appropriate:
Note: Click the green arrows to move forward or back in the selection screens.
Option
Description
Site
The site where the activity will be performed.
Priority
The Priority of the issue.
17
Chapter 2 Upgrading Viewpoint Software
Finding the PUT Version Running on the System
Option
Description
Product Area The area of the system where the issue is located or where work will be
performed.
Problem Type A list of Problem Types.
Synopsis
A short Synopsis of the activity being performed.
Description
A short description of the activity being performed.
5 Click Submit the Incident.
6 Click OK to confirm the submission of the incident.
The incident is added to the list of Incidents. The Status shows Pending (a blue circle)
until Customer Services accepts the incident, at which time the Status becomes Active (a
green circle).
Finding the PUT Version Running on the System
1 From your PC, open a communication window to any server in the system.
2 Issue the following command on all nodes:
rpm -qa TDput
3 Record the latest PUT version number.
Determining the Latest PUT Release
PUT is updated periodically. You must always use the latest version of PUT.
1 Check for the latest version of PUT in the Certification List section of Teradata At Your
Service at https://tays.teradata.com.
Downloading New PUT Packages
This task needs to be performed only if your version of PUT needs to be updated.
1 On your Windows PC, open a web browser and go to Teradata At Your Service at https://
tays.teradata.com and log in.
2 Click Software Downloads > Certified Configs.
3 On the Certified Configuration Help screen, click Parallel Upgrade Tool (PUT) under
Software Patches in the left pane.
4 In the Specify the type for PUT Packages section, select the following:
18
Downloading New PUT Packages
Field
Selection
Platform
The operating system
Current
Current
5 Click Submit.
6 On the Teradata PUT screen, select PUTSRC, PUTTools, and TDput for download and
write the version number in the following space:
TDput ______________________________________
PUTSRC____________________________________
PUTTools_(Version not required; download is)______
7 Complete the download request with the following choices:
Field
Selection/Entry
Download Type
Windows
Download Readme Files?
No
User Name
The name on your account
E-Mail
The e-mail address on your account
Site ID
The site ID for your site
Change Control Number
The Change Control Number previously
obtained
Note: The Change Control Number entered
must be valid for your site ID.
8 Click Submit.
9 Click Download.
10 Save the downloaded files and transfer them to the PUT Master Node:
a When asked to click the button to download, click Download.
b In the File Download dialog box, click Save.
c In the Save As dialog box, go to the target directory for the downloaded packages and
click Save.
The package files are compressed into a single Windows .zip file.
d Extract or unzip the downloaded .zip file.
Notice: The unzipped files are Linux files in the .gz or .rpm format. Never uncompress a
Linux .gz file on a Windows computer. Windows might corrupt the file.
e Use the Secure File Transfer Protocol (SFTP) utility to transfer the .gz or .rpm files to
the Master Node download directory and then uncompress the .rpm files (the .gz files
do not need to be uncompressed).
Note: Make sure you transfer the files using the binary mode, not the ASCII mode.
19
Installing and Upgrading PUT
The .zip files are not needed on the Master Node and can be deleted from the
Windows system after the upgrade.
Installing and Upgrading PUT
If PUT is not installed on your system, use the instructions for Installing PUT. If you are
upgrading an existing version of PUT, use the instructions for Upgrading PUT.
Installing PUT
1 To install PUT, follow the instructions in the Parallel Upgrade Tool (PUT) Reference.
Note: Make sure the version of PUT is the same on all nodes, including managed servers.
Always use the latest version of PUT.
Upgrading PUT
This procedure copies PUT from the Master Node to all other nodes that need a new version
of PUT installed.
Notice: Do not choose any PUT operation other than the operation specified. Choosing any of the
PUT operations that are not specified in your task could result in severe damage to user data.
1 Start PUT on the Master Node (if it is not already started).
2 In the main screen, select Install/Upgrade PUT and click Next.
3 In the Network Subnet Selection screen, select byn1 and click Next.
4 In the Select Nodes screen:
a Verify that all the nodes in the system are listed.
If any nodes are missing, you will not be able to continue with this upgrade and
should open an incident.
b Select and move the applicable nodes from the Available column to the Selected
column using the >> button.
c Click Next.
5 In the Choose Software Location screen, enter the source directory for the downloaded
PUT package and click Next.
PUT proceeds through the Gather PUT Package Info, Spool & Distribute PUT
Package, and Upgrade PUT Package screens which may take several minutes. No user
interaction is required here. When PUT reaches the Overall Package Install Results
screen, the package name and installation results are displayed.
6 Check the results of the installation and report any failures.
7 Click Next.
20
Checking for Space on the Node
8 In the Finished! screen, click Finish.
PUT will complete the operation and return you to the main screen.
Checking for Space on the Node
1 Prior to downloading any software packages, check the nodes in your system to make
sure you have enough space:
df -k
Example output:
Filesystem
/dev/sda2
udev
/dev/sda5
/dev/sda7
1K-blocks
9076396
4123416
2016016
37293996
Used
8580828
2528
312628
4112908
Available
34504
4020888
1600976
1286628
Use%
100%
1%
17%
12%
Mounted on
/
/dev
/var
/var/opt/teradata
In this example, the / drive has no available space. Contact your system administrator to
remove old files and free up space for the new packages. Teradata recommends that you
double the total the space required by the packages you are downloading.
Creating a Target Directory
1 Set up a target directory on the server to hold the downloaded packages with the
following command:
mkdir -p /var/opt/teradata/ccnumber/pkgs
where the ccnumber is the Teradata Change Control Number, as shown in the following
example:
/var/opt/teradata/VECD2RQ9B/pkgs
Software Package Downloads
Software packages must be downloaded from Teradata At Your Service at https://
tays.teradata.com.
Downloading Software Packages
1 Navigate to the software repository in one of the following ways:
Option
Description
Customer access: https://tays.teradata.com
a. Click Software Downloads.
b. Click Certified Configs.
21
Software Package Downloads
Option
Description
Teradata internal access: http://tssprod.teradata.com:
8080/TSFS/
a. Click Teradata.
b. Click Combined Certification List.
2 In the Certification List section of the left pane, click Current List.
3 In the Certification List area, make the appropriate selections as follows:
Field
Selection/Entry
Node Type
The application package to be installed.
Target OSs
The operating system on the node.
Application Version
The release number for the application.
Teradata Releases
N/A
BusType
SM3G
Would you like to compare lists?
Select Yes or No
If two additional fields appear, make the appropriate selections as follows:
Field
Selection/Entry
External Storage Type
The type of external storage if any exists.
TESA Type
The type of Teradata Enterprise Service
Architecture (TESA) that applies to the Node
Type selected. The TESA type identifies CMIC
and node components for Server Management.
4 Click Submit.
5 Select all packages.
6 Complete the download request with the following choices:
Field
Selection/Entry
Download Type
Windows
Download Readme Files?
No
User Name
The name on your account
E-Mail
The e-mail address on your account
Site ID
The site ID for your site
Change Control Number
The Change Control Number previously
obtained
Note: The Change Control Number entered
must be valid for your site ID.
7 Click Submit.
22
Verifying the Previous Database Backup
8 When the .zip package is ready to download, click the Download button.
Optionally, you can save the patch for future use by selecting the Save the Patch for
future use box.
9 In the File Download dialog, click Save, navigate to the target directory, and click Save
again.
10 Extract or unzip the file in the target directory.
Verifying the Previous Database Backup
If providing a back down procedure is a concern, verify that a current database backup has
completed successfully. Backups are automatically performed during upgrades from versions
14.00.xx.xx and earlier to 14.01.xx.xx or later as part of the PostgreSQL 9.1 upgrade
procedure. Using Version Migration and Fallback (VM&F) for these upgrades is
recommended because booting to an alternate boot environment is the only supported back
down procedure.
1 From the Teradata Viewpoint portal page, click
.
2 Do one of the following to access the Backup portlet:
• Select Backup from the Viewpoint Administration menu.
• Select the Backup portlet on the page.
3 Review the details of the last backup, including the time it was completed and whether or
not it was successful.
Upgrading a Teradata Viewpoint Server
Note: If a backdown procedure is required, see Verify the Previous Database Backup.
1 Start PUT.
2 In the main screen, select Install/Upgrade Software and click Next.
3 In the System Information Warning screen, click Next.
4 If the System Check Found Problems screen appears, verify that there are no issues that
need attention (or correct any issues that need correcting), and click Ignore.
5 Accept the default selection in the Select Spool Area for Linux Nodes screen and click
Next.
6 In the Enter Source for New Packages screen, enter or select the path /var/opt/
teradata/packages/Viewpoint/Linux and click Next.
7 In the Media Source Confirmation screen, accept the default selections and click Next.
8 In the Group Nodes screen verify that the node displayed in the right panel has the
following settings and click Next:
23
Creating a Teradata User for Data Collection
• System - System0
• Group - Group0
• Node Type - VP
If these settings need to be changed, do the following:
a.
b.
c.
d.
e.
Select the item listed in the right panel.
Click Modify Group.
Make the necessary changes.
Click Submit Changes
Click Next.
9 Accept the default options for all subsequent steps.
10 In Select Teradata Startup Option, select Automatically Start Teradata after a system
reboot and click Next to finish the installation.
Creating a Teradata User for Data Collection
To monitor a Teradata Database system, Teradata Viewpoint requires a Teradata Database
system user account with specific permissions. You can use SQL commands to create a user
account and grant permissions, or the user can be an existing user with specific permission.
The Teradata Viewpoint user account must have sufficient spool space to allow Teradata
Viewpoint to issue monitoring queries. Also, permanent (perm) space is required by the Lock
Info collector that is used by the Lock Viewer portlet.
1 Determine the amount of perm space and spool space to allocate to the Teradata user.
These values vary based on several factors, including the size of the Teradata Database
system, the level of activity on the Teradata Database system, and the amount of data
retained in the data dictionary tables queried by Teradata Viewpoint. For Teradata
systems of 50 nodes or fewer, the suggested allocations are 2 GB of perm space and 500
GB of spool space. For Teradata Database systems larger than 50 nodes, additional perm
and spool space might be required.
2 Type the following command, where perm space and spool space are the perm space and
spool space to allocate to the user:
create user username as perm=perm space, spool=spool space
password=user password;
3 If the console user does not exist on the target Teradata Database system, run the
following command to create the user:
create user console as perm=50000, spool=50000, account='$H-remoteconsole-user', password=console, fallback;
24
Upgrading a Teradata Viewpoint Cluster
Upgrading a Teradata Viewpoint Cluster
1 Identify the primary cache database server by opening the following file from any
server: /etc/opt/teradata/viewpoint/distributed.cluster.properties
The IP address or server name of the primary cache database is listed after the
active.database.host key.
2 Stop the Teradata Viewpoint services on all of the servers except the primary server:
/opt/teradata/viewpoint/bin/vp-control.sh stop
If there are more than two Teradata Viewpoint servers in the cluster, the order in which
you stop the servers does not matter.
3 Upgrade the primary server.
4 Upgrade the remaining servers in the cluster.
5 If you upgraded from a version earlier than 14.01.00.00, use the cluster setup tool from
the primary server to re-establish the cluster by following the instructions in Creating a
Teradata Viewpoint Cluster.
Troubleshooting a Failed Upgrade
During a Teradata Viewpoint upgrade, modifications might be made to PostgreSQL database
tables and data. The modifications are necessary to ensure that the database is synchronized
with the version of the software you are upgrading.
1 When installing Teradata Viewpoint, read the reports from TDPut to ensure that the
upgrade was successful.
2 If there are errors, contact your Customer Support Representative.
3 After you resolve the problem, run the TDPut operation again.
This ensures that the software and PostgreSQL database are successfully upgraded.
25
Troubleshooting a Failed Upgrade
26
CHAPTER 3
Installing Notification Services
Downloading the Teradata Alerts Notification
Software
1 Access the Teradata Software Server:
https://tays.teradata.com
2 Select Certified Configs.
3 On the menu on the left, select Software Patches > Teradata Applications.
4 At Sub Category, select Common Alerting Mechanism.
5 At Release, select 15.10.
6 Click Submit.
7 Select the Notification Service package for Windows or Linux as needed.
8 At please enter the following information to download, enter your user name, email
address, site ID, and the change control number.
9 Click Submit.
10 Click Download.
11 Extract the files from the downloaded archive.
12 Copy the files to the servers where the installation or upgrade is to be performed.
Installing Teradata Notification Service for
Windows
To use BTEQ and Run Program alert actions on Windows, first install the Teradata
Notification Service. Install the service on a Windows server and configure the software with
information specific to your Teradata Viewpoint server.
Preparing for Installation of Notification Service
Before installing Teradata Notification Service, ensure the following:
• Teradata Viewpoint server is set up and running.
• Alert Services are running on the Viewpoint Server.
27
Chapter 3 Installing Notification Services
Installing Teradata Notification Service for Windows
• You have the hostname or IP address of the Teradata Viewpoint server.
• You have installed a 32-bit Java Runtime Environment 7.
• The JAVA_HOME environment variable is defined at the System (not at the User) level.
This is important because the Teradata Notification Service runs as a service. The process
varies depending on the Windows operating system. You must log on as an administrator
to change System-level environment variables.
1 Depending on your version of the Windows operating system, do the following:
Option
Description
Windows operating systems a.
prior to Windows 7
From Control Panel, double-click the System icon to view
and change system settings.
b. Select the Advanced tab.
Windows 7 operating
system
a. From Control Panel, select System and Security.
b. Select System.
c. Select Advanced system settings.
2 Click Environment Variables.
3 Click New, located under System variables, to set the JAVA_HOME environment
variable.
Installing Notification Service Software on a Windows Server
The following steps describe how to install or upgrade the Teradata Notification Service on a
Windows Server. Note that xx represents the version of the software you are installing or
upgrading.
1 Download the software from the Teradata Software Server, as explained in Downloading
the Teradata Alerts Notification Software.
2 Copy the zip file teradatacam__Windows_i386.15.10.00.xx.zip to the server
where the installation or upgrade will be performed.
3 Navigate to the directory and folder containing the zip file.
4 Extract the zip file.
This creates a folder called teradatacam__Windows_i386.15.10.00.xx in the
current directory.
5 Navigate to the teradatacam__Windows_i386.15.10.00.xx\DISK1 folder.
6 Click setup.exe.
7 Select the setup language, and click OK.
8 Follow the Install Shield wizard instructions and do the following:
a Accept the license agreement.
b [Optional] Change the destination folder.
28
Installing Teradata Notification Service for Windows
c Specify the system name of the Teradata Viewpoint server.
This can be the hostname defined by DNS or an IP address.
d Click Install.
e Select Start the Teradata Notification Service now.
f
Click Finish.
The software is installed at drive:\Program Files (x86)\Teradata\Client
\15.10\Teradata Notification Service
Configuring the Teradata Viewpoint Server Location
The previous installation procedure requested that you enter the name of the Teradata
Viewpoint server. If you did not complete this step, manually configure the Teradata
Notification Service to include the location of the Viewpoint server where Teradata Alerts is
installed.
1 Create the following folder in the installation partition:
drive:\etc\opt\teradata\cam
2 Change the directory to the installation folder to:
drive:\Program Files (x86)\Teradata\Client\15.10\Teradata
Notification Service
3 Copy config\cam.properties.template to
drive:\etc\opt\teradata\cam\cam.properties
4 Edit cam.properties and locate the entry for cam.activemq.host:
#cam.activemq.host=localhost
5 Remove the comment sign and assign cam.activemq.host to the Viewpoint server
where you installed the Teradata Alerts packages:
cam.activemq.host=serverName
6 Save and close the file.
7 Restart the Teradata Notification Service.
Setting Up the BTEQ Scripts and Run Program Executables
The Teradata Notification Service executes the BTEQ and Run Program alert actions. The
BTEQ scripts and program executables must be located in the specified folders.
The directories where you placed the BTEQ scripts and programs are scanned periodically
by the Teradata Notification Service while the service is running. If changes are detected to
the directories, the updated directory contents are relayed to the alert service, which updates
the Teradata Alerts repository on the Viewpoint server. The alert service must be running on
the Viewpoint server in order for updates to be visible on the Viewpoint server.
29
Installing Teradata Notification Service for Linux
1 Place the BTEQ scripts in the following folder relative to the installation location:
InstallFolder\Teradata\Client\15.11\Teradata Notification Service
\sql
2 Place the programs you want to run in the following folder relative to the installation
location:
InstallFolder\Teradata\Client\15.11\Teradata Notification Service
\usrcmd
Preparing for Installation of Notification Service for Linux
Before installing Teradata Notification Service, ensure the following:
• Teradata Viewpoint server is set up and running.
• Alert Services are running on the Viewpoint Server.
• You have the hostname or IP address of the Teradata Viewpoint server.
• You have installed a 64-bit Java Runtime Environment 7.
• The JAVA_HOME environment variable is defined in the default profile so that once the
software is installed, the service is able to locate the Java Runtime Environment.
Perform the steps below the change this system setting.
1 Log in as root.
2 Edit /etc/profile.local by adding a line to define JAVA_HOME where you have
installed the JRE.
For example, if you have installed the Java Runtime Environment in /home/jre7 type:
export JAVA_HOME=/home/jre7
3 Source the updated file to pick up the JAVA_HOME definition.
. /etc/profile.local
Installing Software on a Linux Server
Teradata Notification service for Linux can be installed using PUT. These instructions
assume that the reader is familiar with the PUT installation process, and that the TDPut
software is installed and available on the Linux server.
1 Download the software from the Teradata Software Server, as explained in Downloading
the Teradata Alerts Notification Software.
2 Launch TDPut on the Linux server and install the tdnotification1500 package onto the
server.
3 After the installation, manually configure the software with the location of the Viewpoint
server.
30
Installing Teradata Notification Service Interactively
Use these steps to perform an interactive installation or upgrade of Teradata Notification
Service on a Linux server. This procedure is only used when PUT is not available. Note that
xx represents the version of the software you are installing or upgrading.
1 Download the software from the Teradata Software Server: https://tays.teradata.com.
2 Copy the rpm file
tdnotification1510__SLES10-11_x8664.15.10.00.xx-1.rpm to the server
where the installation or upgrade is to be performed.
3 Log on to your Linux server as the root user.
4 Change to the directory containing the rpm file.
5 Verify that JAVA_HOME is defined:
echo $JAVA_HOME
6 Set the CAM_INTERACTIVE_INSTALL environment variable to indicate the
installation is interactive:
export CAM_INTERACTIVE_INSTALL=1
7 Install the rpm:
rpm -Uvh tdnotification1510__SLES10-11_x8664.15.10.00.xx-1.rpm.
8 When prompted, enter the name of the Viewpoint server.
9 When prompted, enter the name of the service user, or accept the default of camuser.
The service runs with the user id of the service user account. See Service User for more
information.
The software is installed in the following location:
/opt/teradata/client/15.10/cam/tdnotification
A symbolic link is created to the installation directory:
/opt/teradata/client/cam/tdnotification -> /opt/teradata/client/
15.10/cam/tdnotification
If you provided the name of the Viewpoint server, the software is now configured and
ready to start:
Service User
The tdnotification installation process creates a new user which, as of release 14.10, can be
custom-defined during installation. If no user is defined, the system creates a default user
called camuser, with a default home account of /home/camuser. If the new user account
cannot be created with a home account, it is created without one. The camuser account is a
non-login account. The tdnotification service runs with the user ID--either custom-defined
or camuser-- instead of running as the root user.
31
Configuring the Teradata Viewpoint Server Location
The previous installation procedure requested that you enter the name of the Teradata
Viewpoint server. If you did not complete this step or you performed the installation with
PUT, manually configure the Teradata Notification Service for Linux to include the location
of the Viewpoint server where Teradata Alerts is installed.
1 Create the following directory if it does not already exist:
mkdir -p /etc/opt/teradata/cam
2 Change the permissions on the directory:
chmod 755 /etc/opt/teradata
chmod 755 /etc/opt/teradata/cam
3 Change directory:
cd /opt/teradata/client/cam/tdnotification/config
4 Copy the cam.properties.template file to the configuration location:
cp cam.properties.template /etc/opt/teradata/cam/cam.properties
5 Edit cam.properties and locate the entry for cam.activemq.host:
#cam.activemq.host=localhost
6 Remove the comment sign and assign cam.activemq.host to the Viewpoint server
where you installed the Teradata Alerts packages:
cam.activemq.host=serverName
7 Save and close the file.
8 Change the file owner, replacing camuser with the custom service user as needed:
chown camuser: cam.properties
9 Change the file permissions:
chmod 744 cam.properties
10 Restart the tdnotification service:
/etc/init.d/tdnotification restart
Setting Up the BTEQ Scripts and Run Program Executables
The Teradata Notification Service for Linux executes the BTEQ and Run Program alert
actions. The BTEQ scripts and program executables must be located in specified directories.
The directories where you placed the BTEQ scripts and programs are scanned periodically by
the Teradata Notification Service while the service is running. If changes are detected to the
directories, the updated directory contents are relayed to the alert service, which updates the
Teradata Alerts repository on the Viewpoint server. The alert service must be running on the
Viewpoint server in order for updates to be visible on the Viewpoint server.
The following directories are created during the installation and preserved during upgrades.
The system administrator should ensure that these directories have the appropriate
permissions set for the service user (default is “camuser”) effective user ID for the
tdnotification service.
32
Uninstalling the Teradata Notification Service
/opt/teradata/client/cam/sql
/opt/teradata/client/cam/usrcmd
During the installation, the following symbolic links are created:
• /opt/teradata/client/15.10/cam/tdnotification/sql -> /opt/teradata/
client/cam/sql
• /opt/teradata/client/15.10/cam/tdnotification/usrcmd -> /opt/
teradata/client/cam/usrcmd
1 Log in to the server as the root user.
2 Place the BTEQ scripts in:
/opt/teradata/client/cam/tdnotification/sql
3 Ensure BTEQ scripts have at least 744 file permissions and are owned by the service user
account.
4 Place the programs you want to run in:
/opt/teradata/client/cam/tdnotification/usrcmd
5 Ensure the programs have at least 755 file permissions and are owned by the service user
account.
1 Uninstall the Teradata Notification Service:
Operating System Description
Windows
Use Windows Control Panel to uninstall the Teradata Notification Service.
Linux
Use the following command: rpm -e tdnotification1500
If multiple versions of the Teradata Notification Service Package are installed in a Linux
environment, removing the primary version reverts all soft links to the next greatest
version installed. To uninstall all packages, use the command on each installed
tdnotification package.
33
34
CHAPTER 4
Administrative Tasks
Configuring NTP Time Synchronization
To ensure that the time on the Teradata Viewpoint server is always accurate, configure NTP
time synchronization. This is especially important if setting up a Teradata Viewpoint cluster,
because the time on the servers needs to be synchronized.
This setup assumes that a time server is available on the LAN. If no time server is available,
time is synchronized only among the Teradata Viewpoint servers in a cluster and not a
master time source.
Use the following procedure for each Teradata Viewpoint server.
1 Enable the NTP service by typing chkconfig ntp on.
2 If there is a time server:
a Open and edit /etc/ntp.conf.
b Add the following line to the end of the file, where host is the host name of the time
server:
server host
3 If Teradata Viewpoint is configured in a cluster:
a Open and edit /etc/ntp.conf.
b Add the following line to the end of the file for each Teradata Viewpoint server in the
cluster, excluding the current host, where address is the IP address of another
Teradata Viewpoint server:
peer address
4 Start the NTP service by typing /etc/init.d/ntp start.
Configuring LDAP for Teradata Viewpoint
When using LDAP with Teradata Viewpoint, use one of the following methods to add user
accounts:
• Manually entered without LDAP authentication
• Manually entered with LDAP authentication
• Auto-provisioned with LDAP authentication
35
Chapter 4 Administrative Tasks
When users are auto-provisioned, the administrator does not need to enter their account into
Teradata Viewpoint. LDAP validation works in conjunction with the Externally
Authenticated? flag on the Add User and Modify User dialog boxes in the User Manager
portlet. If the Externally Authenticated? check box is selected, the user is authenticated
through LDAP when logging in. The Externally Authenticated? check box is automatically
selected when a user is created using auto-provisioning. The first time these users log in to
Teradata Viewpoint, they are validated against the LDAP directory. If their credentials are
valid, a Teradata Viewpoint account is created for them.
Use the LDAP Servers portlet to:
• Add and delete an LDAP configuration in Teradata Viewpoint
• Enable and disable the LDAP after it has been added
• Use the auto-provisioning feature to automatically add users to Teradata Viewpoint on
first login
• Use the role mapping feature to position the new user in Teradata Viewpoint
Prerequisites
• A basic understanding of LDAP
• The URL of the LDAP server, for example, ldap://ldap.acme.com:389
• The username and password of a user or availability of that user to test the configuration
Definitions
Lightweight Directory Access Protocol (LDAP)
Technically an application-protocol, LDAP is frequently used to refer to a directory
server such as Microsoft Active Directory or OpenLDAP.
LDAP Data Interchange Format (LDIF)
A standard, plain-text data interchange format for representing LDAP directory
content and update requests.
Distinguished Name (DN)
The full "path" to a user-entry in LDAP. Every user's DN is, by definition, unique. The
DN consists of its Relative Distinguished Name (RDN) constructed from some
attributes in the entry, followed by the parent entry's DN. Think of the DN as a full
file name and the RDN as a relative filename in a folder. In the following example,
the DN is the entire string.
cn=joec,OU=NorthAmerica,OU=User
Accounts,DC=td,DC=acme,DC=com
Relatively Distinguished Name (RDN)
The part of a DN that distinguishes an entry from others at the same level in the tree.
Common Name (CN)
An attribute of a user-entry that is typically part of the user's DN and very often, but
not always, the same value as the user's corporate username. In the following
example, the CN is joec.
36
cn=joec,OU=NorthAmerica,OU=User
Accounts,DC=td,DC=acme,DC=com
Bind
Used for LDAP authentication, binding is an LDAP operation that authenticates a
username and a password.
Service Account
An LDAP service account is an account (username and password) not associated
with a user, but existing for the purposes of binding to LDAP to perform a search of
the directory. Typically, a service account is required when the DN of an
authenticating-user is unknown, and an LDAP search (based on some other attribute
of the user-entry such as sAMAccountName) must first be performed to determine
the user's DN. After the user's DN has been determined, a normal bind using the
user's DN and password is run.
Viewpoint Authenticator
Also referred to simply as the Authenticator, this component of Teradata Viewpoint
runs the authentication process against LDAP, among other actions.
Before You Begin LDAP Configuration
1 Ask the LDAP administrator for the following information:
• The user-entry details for the user in LDAP Data Interchange Format (LDIF) form.
The following LDIF snippet is an example:
dn: cn=joec,dc=User Accounts,dc=acme,dc=com
cn: joec
givenName: Joe
sn: Customer
telephoneNumber: +1 888 555 6789
mail: [joe.customer@acme|mailto:joe.customer@acme].com
sAMAccountName: customerjoe
objectClass: inetOrgPerson
memberOf: cn=Sales,ou=Groups,dc=acme,dc=com
memberOf: cn=DBA,ou=Groups,dc=acme,dc=com
...
• At least one other future Teradata Viewpoint user, preferably in a different region or
country.
Determining LDAP Configuration Mode
1 You can use the following figure to help you determine which Teradata Viewpoint
authentication configuration mode to use:
• DN pattern bind
• User search with bind
37
Is the Username in DN?
To bind to LDAP, Teradata Viewpoint authentication must know the DN of Joe Customer.
When logging in, Joe presents a corporate username, which is usually part of the DN. Using
the following DN as an example:
cn=<<USERNAME>>,dc=User Accounts,dc=acme,dc=com
1 If the corporate username for Joe is joec and the username is in the DN, perform a DN
pattern bind.
2 If the corporate username for Joe is customerjoe, which is the sAMAccountName
attribute from the LDIF snippet below, the username is not in the DN.
dn: cn=joec,dc=User Accounts,dc=acme,dc=com
cn: joec
givenName: Joe
sn: Customer
mail: [joe.customer@acme|mailto:joe.customer@acme].com
sAMAccountName: customerjoe
objectClass: inetOrgPerson
38
LDAP Servers
memberOf: cn=Sales,ou=Groups,dc=acme,dc=com
memberOf: cn=DBA,ou=Groups,dc=acme,dc=com
...
3 Search the LDAP tree for a user entry where the attribute matches the username value
presented by Joe Customer.
Proceed to the Number of Pattern Binds section.
Determining the Number of Bind Patterns
After establishing Joe's DN and verifying that the username for Joe is part of the DN string,
bind to LDAP using the DN and password for Joe. As a reminder, following is the DN for
Joe:
cn=joec,dc=User Accounts,dc=acme,dc=com
1 Are all users in Joe's company located at the same Base DN in LDAP?
That is, do all user DNs have the following pattern?
cn=<<USERNAME>>,dc=User Accounts,dc=acme,dc=com
If yes, the number of bind patterns is 1.
2 If users are located at multiple Base DNs, you need to get this information from the
company's LDAP administrator.
For example, at Joe's company, there might be the following users:
cn=joec,dc=User Accounts,dc=acme,dc=com
cn=janedoe,dc=Contractors,dc=User Accounts,dc=acme,dc=com
cn=kaizers,dc=Europe,dc=User Accounts,dc=acme,dc=com
If there are multiple DN patterns, the Teradata Viewpoint Authenticator iterates over
each of the patterns until it finds one that matches the username presented. If the
authenticator does not find a match, it fails to authenticate.
Note: If the number of patterns grows to seven or more, it might be faster to perform a
user search.
3 Select one of the following options in the LDAP Servers portlet:
• If there are fewer than seven DN patterns, select the DN Pattern Bind option.
• If there are seven or more DN patterns, select the User Search option.
LDAP Servers
The LDAP Servers portlet allows you to configure LDAP (Lightweight Directory Access
Protocol) servers to authenticate users and assign user roles in Teradata Viewpoint. The
LDAP Servers portlet displays the names of currently configured LDAP servers or is empty
if an LDAP server is not configured.
39
LDAP Servers
Auto-Provisioning and Role Mapping
In Teradata Viewpoint, users are assigned roles to organize and control their access to
portlets, metrics, and features. You can use the Roles Manager portlet to assign permissions
to the roles. During the process of adding an LDAP configuration to Teradata Viewpoint, you
can automatically assign Viewpoint roles through auto-provisioning or role mapping.
Auto-provisioning assigns the same roles to all users the first time they access Teradata
Viewpoint. You cannot use auto-provisioning to add or remove roles on subsequent logins.
Role mapping assigns roles to each user based on the user's LDAP group membership or
LDAP attributes. Use role mapping to do the following:
• Assign roles for a new user
• Add roles that were assigned to the user since the last user login
• Remove roles that were removed since the last user login
Only roles already defined using the Roles Manager portlet can be mapped. The Teradata
Viewpoint Administrator can change a role at any time using the Roles Manager portlet.
Adding an LDAP Server
.
2 Open the LDAP Servers portlet.
3 Click
next to Servers.
4 Enter a server nickname for the LDAP server, up to 8 characters.
5 [Optional] Select the Enable server check box to activate LDAP upon successfully adding
the LDAP server to Teradata Viewpoint.
6 Enter the URL address of at least one LDAP server.
7 [Optional] Use
to delete, add, and change the order of multiple URLs.
The order of the URLs determines the order in which LDAP servers are accessed for
authentication.
8 From Name Matching, choose a method from the following options:
• Select DN Pattern Bind and specify one or more patterns that represent a
distinguished name (DN) in the LDAP directory.
Example: cn={0},ou=Users,dc=teradata,dc=com, where {0} is replaced by the
username the user enters when logging in to Teradata Viewpoint.
• Select User Search.
9 If you selected User Search, configure the search options:
a [Optional] To search using a specific account, enter a valid service account DN and
password.
If these fields are empty, the Viewpoint portal connects to the LDAP server
anonymously.
40
LDAP Servers
b Enter a search pattern.
Example: cn={0}, where {0} is replaced by the username the user enters when
logging in to Teradata Viewpoint.
c Enter a search base to specify a base directory for the search pattern.
Example: ou=Users,dc=teradata,dc=com
d [Optional] For Search Extent, select the Recursive scan check box to include
subdirectories of the base directory in the search.
If the check box is not selected, the search is limited to the specified base directory.
10 Under Key User Information, enter the LDAP attribute names for the user attributes:
Attribute
Example User Attribute Name
LDAP First Name Attribute
givenName
LDAP Last Name Attribute
surname
LDAP Email Attribute
mail
11 [Optional] Under Settings Test you can test whether your settings are correct.
a Enter a username and password.
b Click Test.
If the operation is successful,
appears. If the operation fails,
appears.
If the test is successful, you receive the full DN and key user information for the user,
and if the test fails, you receive the error message returned from the LDAP server.
12 Click Apply.
The LDAP Servers view remains open if you want to use the Advanced Options.
LDAP Configuration Options
Teradata Viewpoint authentication is configured in the LDAP Servers portlet menu.
Basic Configuration
Attribute
Description
Server Nickname
Short name by which this LDAP configuration is referred to in the
LDAP Servers portlet. This name must be 8 characters or less.
Enable server
When selected, enables this LDAP configuration as part of the Teradata
Viewpoint authentication process.
Cleared, disables this LDAP configuration as part of the Teradata
Viewpoint authentication process.
URL
One or more URLs for this LDAP configuration. The URL must include
the appropriate protocol (ldap:// or ldaps://) as well as the port, for
example, ldap://ldap.acme.com:389. Enter more than one URL
41
LDAP Servers
Attribute
Description
only if all of the URLs point to a similarly configured LDAP server. This
might be the case if you have replicated LDAP servers or a failover
LDAP server that should be used if the primary one is unreachable.
DN Pattern Bind
Attribute
Description
Pattern
DN patterns used to perform the LDAP user bind attempt. The patterns
are invoked in the order specified, so it is recommended that you put the
patterns that match the most users before those that match fewer users.
For example:
cn={0},OU=User Accounts,DC=acme,DC=com
User Search
Attribute
Description
Service Account DN
DN of the LDAP service account. The DN must not be surrounded by
parentheses.
Service Account
Password
Password of the LDAP service account.
Search Pattern
LDAP attribute to match against the username when searching for a user
entry.
If the cn attribute is the username, set to (cn={0}).
If the sAMAccountName attribute is the username, set to
(sAMAccountName={0}).
Search Base
Entry that is the base of the subtree containing users. If not specified, the
search base is the top-level context. For example:
OU=User Accounts,DC=acme,DC=com
Search Extent
When the Recursive scan check box is selected, searches the entire
subtree rooted at the search base entry. When cleared, requests a singlelevel search including only the top level.
Key User Information
42
Attribute
Description
LDAP First Name
Attribute
Name of the attribute on the LDAP user entry that specifies the first
name of the user (given name).
LDAP Last Name
Attribute
Name of the attribute on the LDAP user entry that specifies the last
name of the user (surname).
LDAP Email Attribute
Name of the attribute on the user object that specifies the email address
of the user.
Changing a Teradata Viewpoint System Name
Auto-Provisioning
Attribute
Description
Turn on autoprovisioning
Select to turn on auto-provisioning
Automatically assign
these roles
When auto-provisioning is enabled, the newly provisioned user is
automatically added to these roles. This attribute is often set to User.
Role Mapping Global Settings
Attribute
Description
Group Search Base
Entry that is the base of the subtree containing groups. This field needs
to be specified only if role mappings of type Group are used.
Group Attribute Name
Name of the attribute on the LDAP group entry that contains the DNs
of the users in the group.
Group Search Extent
When the Search subtree check box is selected, searches the entire
subtree rooted at the Group search base entry.
When cleared, requests a single-level search including only the top
level. This field needs to be specified only if role mappings of type
Group are used.
Role Mapping Individual Settings
Attribute
Description
Type
Set to Attribute to perform a mapping from an LDAP user's entry
value to a Teradata Viewpoint role.
Set to Group to perform a mapping from an LDAP group to a Teradata
Viewpoint role.
Attribute Name
Name of an LDAP attribute in the user's entry that specifies LDAP
group and role membership for mapping to Teradata Viewpoint roles.
This setting is applicable only to mappings of type Attribute.
LDAP Value
Value of the attribute specified in the Attribute name field that should
be mapped to the role specified in the Viewpoint role field.
Viewpoint Role
Role in Teradata Viewpoint to which users are mapped.
Related Topics
Auto-Provisioning and Role Mapping, on page 40
Changing a Teradata Viewpoint System Name
You can change the name of a system. For example, you might want to do this if the current
name for the system is no longer appropriate.
1 Stop the Teradata Viewpoint services for all nodes in the Viewpoint cluster:
43
Resetting the Admin User Password
2 Run the dcsadmin command on the primary server:
/opt/teradata/viewpoint/dcs/bin/dcsadmin.sh
3 Type renamesystem on the primary server and press Enter.
4 Enter the number of the system to rename on the primary server and press Enter.
5 Enter the new name on the primary server and press Enter.
• If the name is correct, type Y and press Enter to confirm.
The new system name is applied.
• If the name is incorrect, type N to cancel and then re-enter the name.
6 To exit the dcsadmin shell, type quit on the primary server and press Enter.
7 Restart the Teradata Viewpoint services for all nodes in the Viewpoint cluster:
/opt/teradata/viewpoint/bin/vp-control.sh start
Resetting the Admin User Password
1 Run the following command:
/opt/teradata/viewpoint/portal/bin/vpadmin.sh -R
Changing the PostgreSQL Passwords
Teradata Viewpoint connects to its internal PostgreSQL database using a few different users.
The passwords for each of these users are the same on every Viewpoint installation by default.
To comply with security best practices, Teradata Viewpoint provides a script that changes
these passwords to a random 26-character string and stores the encrypted passwords into a
protected file.
1 Run the following command on the primary Viewpoint server:
/opt/teradata/viewpoint/bin/changedbpasswd.sh
All Teradata Viewpoint services in the Viewpoint cluster are restarted by this script.
Portlets Enabled Under Special Circumstances
Most portlets are enabled by default when Teradata Viewpoint opens. Those portlets not
enabled by default include the following:
• Elastic Performance
• Stats Manager
• TVS Monitor
44
Configuring Teradata Viewpoint to Monitor a Managed System
Configuring Teradata Viewpoint to Monitor a
Managed System
Teradata Viewpoint can be configured to monitor certain system-level metrics for managed
systems, including Teradata Viewpoint itself. These metrics include data on CPU usage,
memory usage, system load, swap space usage, and I/O activity. Data that is collected from
different managed systems can be viewed using the Viewpoint Monitoring portlet.
On Teradata Viewpoint 13.10 or later staged systems, the tmsmonitor and teradatajdk7 packages are already installed. To set up monitoring of a managed system, install the
tmsmonitor and teradata-jdk7 RPMs on the non-Viewpoint system you want to
monitor.
1 Download the tmsmonitor and teradata-jdk7 packages.
2 Install the packages.
3 Start the tmsmonitor service on the non-Viewpoint system:
/etc/init.d/tmsmonitor start
4 Open the Monitored Systems portlet from the Viewpoint system and add a new
managed system.
Creating a Teradata Database Logon for Stats
Manager
The Stats Manager data collector is needed to enable the Stats Manager portlet for a system.
When enabling the data collector, you are required to enter a logon different from any other
logon used for Viewpoint. The logon does not require any PERM space, but it should be
allocated at least 500 GB of spool space. Each concurrent Stats Manager job shares the same
SPOOL limit, so the more concurrent jobs you have running, the more spool space you will
need.
1 Run the following command to create a logon for Stats Manager:
create user statsmanager as perm=<perm space>, spool=<spool space>
password=statsmanager;
Configuring Stats Manager
Prerequisite: You must ensure the Teradata Database version information has been collected
before you configure the Stats Manager data collector. The Stats Manager data collector will
not display in the list of collectors until the Teradata Database version information is
collected.
The Stats Manager data collector can be enabled to collect statistics data for the Stats
Manager portlet.
45
Configuring Teradata Database to Collect and Analyze Statistics
The Stats Manager portlet and data collector are available for systems running Teradata
Database 14.10 or later.
1 Run the TDStats DIP script so that the TDStats database is created and populated.
.
3 Open the Monitored Systems portlet.
4 From the Systems list, click the name of the system you want to update.
5 From the Setup list, click Data Collectors.
6 Click the Stats Manager data collector.
7 Enter a login name and password.
The login name must be unique from the other logins already configured for the system
to allow overhead of statistics collection and analysis to be measured separately from
other Teradata Viewpoint monitoring overhead.
You also have the option to specify an account string and authentication mechanism.
8 [Optional] Click Test to verify that the login settings are correct.
If the operation is successful, appears. If the operation fails, appears. If you receive
an error, verify that the login credentials are valid and the host can be reached.
9 [Optional] Click Grant to provide Viewpoint data collectors with access to Teradata
Database system resources.
10 Click Apply.
If the operation is successful, appears. If the operation fails,
an error, verify that the settings are correct and try again.
appears. If you receive
Configuring Teradata Database to Collect and
Analyze Statistics
Collecting Statistics
When a Stats Manager collect job runs, statistics are collected by TDStats.RunCollect
XSP. If the TDStats database does not have permission to collect statistics as an object in the
scope of a collect job, the statistics are not collected and an error is reported. Follow this step
to prevent these errors.
1 To grant TDStats permission to collect statistics on any databases you associate with a
collect job enter the following:
GRANT STATISTICS ON DATABASE TO TDStats;
46
Working with Teradata Alerts
Analyzing Statistics
Some analyze job options require that Teradata Database query logging (DBQL) features be
enabled. For the analyze job options that you plan to use, you must enable the associated
database feature prior to running the job.
1 Depending on which method you choose to evaluate statistics, select one of these
procedures:
Method
Procedure
Evaluate stat usage and
staleness and find missing
stats to collect
Enable query logging with the XMLPLAN, STATSUSAGE, and
USECOUNT options for the objects being analyzed.
and
Note: The query logging features should be enabled for at least
one week prior to running the analyze job.
Use DBQL
Evaluate stats to determine Enable query logging with the USECOUNT option for the objects
if they should be collected being analyzed.
or deactivated
Note: The query logging feature should be enabled, prior to
running the analyze job, for a period of time that is equal to the
period specified in the Recommend stats for deactivation when
inactive for option.
Cleaning Up the TDStats Database
The TDStats database contains a history of all collect and analyze job reports, so you may
need to increase the PERM space available to the TDStats database so that it can hold all of
the information required to run Stats Manager jobs. For information on how to do this, see
the Viewpoint online help.
Backing Down to a Previous Teradata Alerts Version
If an upgrade of Teradata Alerts does not completely successfully, the following steps allow
you to back the system down to the previously installed version. Note that xx represents the
specific version of the software.
This procedure is only for backing down from Teradata Alerts 15.10.00.xx to release
14.10.00.xx or 14.01.00.xx.
Notice: If backing down to an earlier version of Teradata Alerts, ensure that any applications that
require the version being removed are also backed down.
1 If the Teradata Notification Service is running on a Windows Server, stop the service.
47
2 If the Teradata Notification Service is running on a Linux Server, stop the tdnotification
service:
/etc/init.d/tdnotification stop
3 Stop all of the Teradata Alerts services on all Teradata Viewpoint servers. Also stop the
Teradata Viewpoint services:
• /etc/init.d/dcs stop
• /etc/init.d/tmsmonitor stop
• /etc/init.d/viewpoint stop
• /etc/init.d/camalert stop
• /etc/init.d/tdactivemq stop
4 Restore the last successful backup of the previous version of the Teradata Alerts database.
See Restoring a Teradata Viewpoint Database.
The duration of this process varies and is based on the size of the database. If you have a
clustered environment, perform the restore against the primary database server.
5 If the Teradata Notification Service is running on a Windows Server, uninstall the
Teradata Notification Service.
6 If the Teradata Notification Service for Linux is running on a Linux Server, uninstall the
tdnotification1500 package.
7 Uninstall the Teradata Alerts RPMs on all Teradata Viewpoint servers.
See Manually Uninstalling Teradata Alerts Packages.
8 Reinstall the previous version of Teradata Alerts RPMs on all Teradata Viewpoint servers.
9 If the Teradata Notification Service was installed on a Windows Server, install and
configure the previous version of the Teradata Notification Service for Windows.
a Move the programs from the usrcmd folder of the current version to the usrcmd
folder of the previous version.
The current usrcmd folder is located at:
installation folder\Teradata\Client\version\Teradata
Notification Service\usrcmd
b Move the BTEQ scripts from the sql folder of the current version to the sql folder of
the previous version.
The sql folder is located at:
installation folder\Teradata\Client\version\Teradata
Notification Service\sql
c Start the previous version of the Teradata Notification Service on the Windows Server.
10 If the Teradata Notification Service for Linux was installed on a Linux Server, install the
previous version of the Teradata Notification Service for Linux.
a If tdnotification1410 or tdnotification1400 is already installed, it is now the current
package. If it is not installed, install the prior version manually.
48
Working with Teradata Data Labs
b Start the previous version of the Teradata Notification Service on the Linux Server:
11 Start the previous version of the Teradata Alerts services on all Teradata Viewpoint
servers. Also start the Teradata Viewpoint services:
• /etc/init.d/tdactivemq start
• /etc/init.d/camalert start
• /etc/init.d/dcs start
• /etc/init.d/tmsmonitor start
• /etc/init.d/viewpoint start
Manually Uninstalling Teradata Alerts Packages
If necessary, you can uninstall the Teradata Alerts packages manually.
1 Use the rpm –e command to uninstall each package.
For example, to uninstall the camportlets package, run the following command:
rpm -e camportlets
2 Uninstall the packages in the following order:
• camportlets
• camalert
• tdactivemq
Installing Teradata Data Lab
Installing Teradata Data Lab is optional.
Teradata Viewpoint release 15.10 requires that your Data Lab installation (if you have one)
be at least release 15.10.
1 Start PUT.
2 In the main screen, select Install/Upgrade Software and click Next.
3 In the System Information Warning screen, click Next.
4 In Select Nodes, verify that the node name in the Selected list is localhost (LINUX),
and click Next.
If a warning message appears, click Ignore.
5 Accept the default selection in the Select Spool Area for Linux Nodes screen and click
Next.
6 In the Enter Source for New Packages screen, enter or select the path /var/opt/
teradata/ccnumber/pkgs and click Next.
49
7 In the Media Source Confirmation screen, enter or select the source for the new package
and click Next.
8 In the Group Nodes screen, verify that the node displayed in the right panel has the
following settings and click Next:
• System - System0
• Group - Group0
• Node Type - Viewpoint
9 Accept the default options for the remaining steps.
Configuring Teradata Data Lab Email Notifications
In order to send email notifications, Teradata Data Lab requires that version 14.01 or higher
of Teradata Alerts be installed and running on the Teradata Viewpoint server. Additionally,
the Alert Setup portlet must be used to configure the SMTP delivery settings for e-mail.
Teradata Data Lab email notifications for a Teradata Viewpoint user are sent to the email
address set for the user in the Profile portlet or the User Manager portlet.
Migrating Teradata Data Labs to a New Teradata System
When you have a new Teradata system, you must migrate the data labs metadata associated
with the original Teradata system to the new Teradata system. After completing this
procedure, all existing lab groups for the original system appear under the new system in the
Data Labs portlet, and all currently pending requests and future requests are performed
against the new system. The lab groups that are migrated will no longer appear in the Data
Labs portlet for the original system.
1 Transfer data from the old Teradata system to the new Teradata system, including lab
group users, lab databases, and lab group roles.
2 From the Monitored Systems portlet, do the following:
a Verify both the old and new Teradata systems are present in the Monitored Systems
portlet.
b Verify both systems are enabled.
c Verify the Dictionary collector is enabled for both systems.
3 Type the following command to shut down the DCS from the active cache database
server:
/etc/init.d/dcs stop
4 Run the dcsadmin command from the active cache database server:
/opt/teradata/viewpoint/dcs/bin/dcsadmin.sh
5 Type help to verify the migratedatalabssystem command is available.
6 Run the migratedatalabssystem command.
50
Uninstalling Teradata Manager
7 Select a source system (original system).
8 Select a target system (new system).
9 Verify output to ensure the migration was successful.
10 Type the following command to start the DCS from the active cache database server:
/etc/init.d/dcs start
The migration is ready to be validated.
11 From the Data Labs portlet, ensure the migration completed successfully by doing the
following:
a Verify the new system has all the data labs data that was on the original system. Also
verify any pending Data Lab approvals migrated successfully.
b Verify the original system does not have any data labs configured.
Uninstalling a Teradata Data Lab Package Manually
If necessary, you can uninstall the Teradata Data Lab package manually.
1 Run the rpm -e command.
For example, to uninstall the 14.01.00.00 version of the tddatalabsportlets package, run
the following command:
rpm -e tddatalabsportlets-14.01.00.00-1
Use this procedure to uninstall Teradata Manager and to clean up directories, tables, and
other files you no longer need.
1 On your computer, click Start > Control Panel > Add and Remove Programs.
2 Select Teradata Manager from the list and click Remove.
51
52
CHAPTER 5
Teradata Viewpoint Server Clustering
Teradata Viewpoint Server Clustering
Configurations
Teradata Viewpoint servers can be clustered to ensure high availability and scalability. A
high availability configuration maintains availability during planned and unplanned
outages. This configuration requires at least two Viewpoint servers; one active and one
standby. The servers form a cluster.
Each Teradata Viewpoint server in a cluster shares the same users, roles, permissions,
preferences, and collected data from monitored systems.
Teradata Viewpoint provides automatic failover to a standby Viewpoint server during most
failure situations. This means that the monitoring and control capabilities are still available.
There are different cluster configurations, all providing high availability. You can add
additional Teradata Viewpoint servers to support a large number of users, or to enhance
cache database performance.
High Availability Configuration: Two Teradata Viewpoint Servers
The most basic Teradata Viewpoint cluster provides high availability by including two
Teradata Viewpoint servers, one active and one standby.
53
Chapter 5 Teradata Viewpoint Server Clustering
Teradata Viewpoint Server Clustering Configurations
Both Teradata Viewpoint instances point at the same a cache database on the active server.
The standby cache database is kept up-to-date with the last minute of data. The DCS service
runs on the active server, with a standby DCS service available on the standby server. Both
servers share a distributed cache to ensure that the state between the Teradata Viewpoint
portals remains consistent.
High Usage Configuration: Three or More Teradata Viewpoint Servers
A High Usage configuration extends the High Availability configuration by adding Teradata
Viewpoint servers to the cluster. This allows Teradata Viewpoint to scale to thousands of
concurrent users.
The additional Teradata Viewpoint servers run only the Teradata Viewpoint portal and not
the DCS or cache database. Instead, they point to the cluster-wide cache database to access
users, permissions, preferences, and collected data.
The two additional Teradata Viewpoint servers are optional and are not required for high
availability. Even though these additional servers run only the Teradata Viewpoint portal,
they are staged the same as any Teradata Viewpoint server and have the DCS and cache
database installed, but not enabled.
Advanced Configuration: Three or More Teradata Viewpoint Servers With
Dedicated Cache Database Server
The Advanced configuration provides enhanced cache database performance. This is useful
when a system needs to support high usage.
In this configuration, the Teradata Viewpoint portal does not run on the same machine as the
active cache database. This provides the cache database with additional system resources.
54
Teradata Alerts Cluster Configurations
In a Teradata Alerts cluster configuration:
• Two Teradata Viewpoint servers are configured
• Active messaging services run on both servers using a networked configuration
• Active alert services run on both servers in the cluster
• The secondary alert service and messaging service automatically take over if the active
counterpart fails
Note: For ease of understanding, the Teradata Viewpoint components of the Teradata
Viewpoint server are omitted from the Teradata Alerts cluster diagrams.
55
Failure Scenarios
Teradata Viewpoint Failure Scenarios
The Teradata Viewpoint failure scenarios describe what can happen during a failure and any
actions you need to take.
Data Collection Server Failure
If the active data collection server (DCS) fails, the standby DCS automatically assumes data
collection, logs an error to TVI, and optionally sends out an email. When the standby DCS
detects that the active DCS is back online, it stops data collection and continues to operate in
standby mode.
Cache Database Failure
If the DCS detects that the active cache database has failed, the DCS logs an error to TVI and
optionally sends out an email. The System Administrator can promote the standby cache
database, to become the active cache database and redirect all Teradata Viewpoint servers to
the new active cache database. After the standby server is promoted, the System
Administrator must set up a new standby cache database.
If the cluster is set up using the advanced configuration, stop the Teradata Viewpoint portal
on the new active cache database server so that it continues to run on a dedicated server.
56
Active Teradata Viewpoint Server Failure
If the active Teradata Viewpoint server fails, the standby DCS detects that the active DCS
and cache database are both down and logs an error to TVI and optionally sends out an
email alert. The System Administrator can promote the standby cache database to the active
cache database and send a notification to all Teradata Viewpoint portals so that they are
automatically redirected to the new active cache database.
After the standby cache database is promoted, the System Administrator needs to set up a
new standby cache database.
If the cluster is set up using the advanced configuration, stop the Teradata Viewpoint portal
on the new active cache database server so that it continues to run on a dedicated machine.
57
Teradata Alerts Failure Scenarios
The Teradata Alerts failure scenarios describe what can happen during a failure and any
actions you need to take.
Alert Service Failure
If an alert service fails, the secondary alert service does the following:
• Automatically processes messages sent to the remote messaging service
• Generates an alert exception indicating the alert service has failed
When the failed alert service is restored, the alert service does the following:
• Relinquishes message processing when it detects the remote alert service is back online
• Generates an alert exception indicating the alert service has been restored
Messaging Service Failure
If a messaging services fails, the following occur:
• Clients sending messages to the messaging service are automatically redirected to the
secondary messaging service.
• The alert service generates an alert exception indicating the connection to the messaging
service has failed.
When the messaging service has been restored the following occur:
• Clients are automatically redirected to the restored messaging service.
• The alert service generates an alert exception indicating the connection to the messaging
service has been restored.
58
DCS Failure
If the active DCS fails, the standby DCS automatically takes control and establishes a
connection with the local messaging service. The alert service on the standby server
processes messages sent by the DCS to the local messaging service.
Cache Database Failure
If the active cache database goes down, and a promotion of the standby cache database
occurs, the alert service is automatically redirected to the new active database cache.
59
Server Failure
This failover scenario is a combination of all the scenarios discussed previously. All
components are redirected to the secondary messaging service. The alert service
automatically continues to process alerts.
Note: The following diagram assumes the standby cache database has been promoted.
60
Clustering Considerations
LAN or WAN
Although using a LAN is recommended, Teradata Viewpoint clusters can be set up over a
WAN. All the data collected by the active Teradata Viewpoint server is sent asynchronously
to the standby Teradata Viewpoint server. Depending on the number and activity of the
Teradata systems being monitored, the amount of data transferred has the potential of
approaching 1 GB an hour. Consider setting up a Teradata Viewpoint cluster spanning a
WAN only if there is adequate bandwidth available.
Load Balancing
To make all Teradata Viewpoint portals in a cluster appear as a single host and to protect
users from a single host failure, you can set up a third-party load balancer to split traffic
between the running Teradata Viewpoint portals.
Configuration of a third-party load balancer is outside the scope of this guide.
Setting Disk Capacity for the Standby Cache Database
The disk capacity available to different generations of Teradata Viewpoint servers might be
different. When clustering, if the active cache database has more disk capacity than the
standby cache database, set a disk quota so that the active cache database does not use up
more space than is available on the standby cache database.
1 To ensure that enough disk capacity is available to the cache database, run df -h /data.
2 If the capacity on the active cache database is greater than on the standby cache
database, run the following command on the active cache database server to limit the
capacity used (replace number of GBs with the limit, in Gigabytes, for the drive):
setquota -u postgres 0 <number of GBs>000000 0 0 /data
Setting Up Notifications of Failures and Promotions
When Teradata Viewpoint detects a situation that requires the attention of a Teradata
Viewpoint Administrator, an email can be sent to a configured list of recipients. Emails are
sent for the following conditions:
• Active DCS is down
• Active DCS is restored
• Active cache database is down
• Active cache database is restored
• Cache database replication is not working
• Standby cache database is promoted
The list of email recipients can be configured at the time the cluster is created or modified at
a later time by selecting option 5 in the cluster setup tool. Email alerts are sent using the
configuration specified in the Alert Setup portlet.
You can test if the notifications are working by triggering an alert.
1 Stop the active DCS.
2 After 3 minutes, restart the DCS.
61
An email is sent for the active DCS that is failing and another one for the active DCS that
is recovering. The standby DCS must be up and running for the alerts to be sent.
Creating a Teradata Viewpoint Cluster
Prerequisite:
Ensure that all of the following conditions are met:
• You have at least two Teradata Viewpoint servers.
• All servers have the same patch version of Teradata Viewpoint installed.
• All servers have the same time and timezone, with an accuracy within a few minutes.
Determine which server is going to host the active cache database and which is going to host
the standby cache database. The server that is going to host the active cache database can
already have existing users, roles, permissions, settings, and collected data from monitored
Teradata systems that is shared by all Teradata Viewpoint servers in the cluster.
Notice: Any data on the server hosting the standby cache database is lost.
See:
Clustering Considerations, on page 61
Note: The cluster setup script used here clusters both Teradata Viewpoint and Teradata Alerts
servers.
1 Run the cluster setup script on the server that will host the active cache database:
/opt/teradata/viewpoint/bin/clustersetup.sh
2 Select option 1.
The cluster setup tool performs the following actions:
• Asks a few simple questions about what hosts to add to the cluster and a list of email
addresses that receive alerts
• Verifies that the software versions and times on the new servers match
• Stops all the Teradata Viewpoint services in the cluster
• Configures Teradata Viewpoint and Teradata Alerts with information about the new
servers
• Restarts all Teradata Viewpoint services in the cluster
3 Follow the instructions on the screen.
After the cluster setup script completes, the Notification Banner within the Teradata
Viewpoint portal appears, and the setup of the standby cache database is handled
automatically in the background. The server is added to the cluster, and all Teradata
Viewpoint services are restarted.
Related Topics
Adding Teradata Viewpoint Servers to a Cluster, on page 63
Configuring NTP Time Synchronization, on page 35
62
Adding Teradata Viewpoint Servers to a Cluster
You can add additional servers to a cluster to support more end users.
1 Run the following command on the server that is currently hosting the active cache
database:
2 Select option 2 to add a server to the cluster.
The cluster setup tool performs the following actions:
• Asks a few simple questions about what hosts to add to the cluster
• Verifies that the software versions and times on the new servers match
• Stops all the Teradata Viewpoint services in the cluster
• Configures Teradata Viewpoint and Teradata Alerts with information about the new
servers
• Restarts all Teradata Viewpoint services in the cluster
The server is added when the script completes, and you are prompted to configure the
new server for clustering.
Configuring Automatic Promotions
You can configure the standby cache database to be promoted automatically to become the
active cache database when the active cache database becomes unavailable. A server colocated with the Teradata Viewpoint server hosting the active cache database prevents
automatic promotions occurring as the result of temporary network outages. If the active
and standby Viewpoint servers are separated by a WAN, a third server that is co-located with
the active Teradata Viewpoint server is required.
1 Download the vpclustermonitor package.
2 Install the package on a co-located server:
rpm -ivh vpclustermonitor-15.10.xx.xx.rpm
3 Run the vpclustermonitor setup script:
/opt/teradata/viewpoint/vpclustermonitor/bin/vpclustermonitorsetup.sh
4 Answer the questions about which server is hosting the active cache database and which
server is hosting the standby cache database.
5 When the setup script completes, you can tail the vpclustermonitor log file to ensure that
it begins monitoring the active cache database:
/opt/teradata/viewpoint/vpclustermonitor/logs/
vpclustermonitor.log
6 [Optional] Configure email alerts to provide notification when an automatic promotion
occurs.
Related Topics
Setting Up Notifications of Failures and Promotions, on page 61
63
Disabling a Teradata Viewpoint Cluster
1 Run the following command on the server that is currently hosting the active cache
database:
2 Select option 1 to disable a cluster.
The cluster is disabled and each Viewpoint server points to its own local cache database
and performs its own data collection.
Promoting the Standby Cache Database to Active
If the active cache database fails, you can promote the standby cache database to become the
active cache database. The Teradata Viewpoint software in the cluster will automatically begin
using the newly promoted cache database. No restarts are required.
After the promotion, there is no longer a standby cache database in the cluster. You must
recreate the standby cache database.
1 Log in to the Teradata Viewpoint server hosting the standby cache database.
2 Type the following command to promote the standby cache database:
/opt//teradata/viewpoint/bin/promote.sh
When the script completes, Teradata Viewpoint is available again.
3 Recreate a standby cache database.
Recreating a Standby Cache Database After a Promotion
When an active cache database has failed and the standby cache database has been promoted
to active, you will need to create another cache database to act as the standby. The new cache
database can be created on the Viewpoint server that failed or on another server.
1 Log in to the Teradata Viewpoint server hosting the active cache database.
2 Run the cluster setup script and select the Configure standby server option to
create a cache database on a standby server:
The clustersetup script ends with a statement that the status of the operation can be
viewed in the Viewpoint Portal notification area. Do not perform further activities until
you have seen the message that the operation has completed successfully.
3 [Optional] If you want to make the new cache database the active one:
a Log in to the Teradata Viewpoint server hosting the newly created cache database.
b Type the following command to promote the newly created cache database to active:
/opt/teradata/viewpoint/bin/promote.sh
c Create a new standby cache database on any server in the cluster:
64
Teradata Notification Service Cluster Configuration
All Viewpoint services in the cluster will be restarted automatically, resulting in a short
outage of the Teradata Viewpoint portal.
Teradata Notification Service Cluster
Configuration
To use BTEQ and Run Program alert actions on Windows, Teradata Notification Service
must be installed on a Windows Server. Only one Teradata Notification Service for Windows
can run within a Teradata Alerts cluster.
To use BTEQ and Run Program alert actions on Linux, Teradata Notification Service must
be installed on a Linux Server. Only one Teradata Notification Service for Linux can run
within a Teradata Alerts cluster.
Teradata Notification Service connects to the active database cache on the Viewpoint server.
When the active cache database is promoted, the service automatically connects to the new
active database.
Teradata Notification Service connects to the messaging service on the Viewpoint server.
When a Teradata Alerts messaging service failure occurs, the Teradata Notification Service is
automatically reconnected to the secondary messaging service. When the messaging service
is restored, the Teradata Notification Service reconnects to the original messaging service.
The sections below describe the steps required when enabling or disabling a cluster
configuration.
Cluster Enabling
The Teradata Notification Service may be running when a Viewpoint cluster is configured.
The service should initially be configured as the notification service for the server that is to
become the primary Viewpoint server.
After configuring the Viewpoint cluster, the Teradata Alerts components running on the
Viewpoint server are restarted in the new clustered configuration. The Teradata Notification
Service automatically detects the configuration change within five minutes and reconfigures
the service to operate in a clustered configuration.
Cluster Disabling
The Teradata Notification Service is aware of the two Viewpoint servers that are part of the
cluster configuration. The initial state of the primary and secondary Viewpoint servers is
maintained by the service.
After disabling the Viewpoint clustering, the Teradata Alerts components running on the
Viewpoint servers are restarted as two standalone Viewpoint servers. The Teradata
Notification Service automatically detects the configuration change within five minutes and
reconfigures the service as the Teradata Notification Service for the initial primary
65
Teradata Notification Service Cluster Configuration
Viewpoint server. If this is not the appropriate Teradata Alerts configuration, the service
should be manually configured with the location of the Viewpoint server.
Viewpoint Server Replacement
The Teradata Notification Service is aware of the two Viewpoint servers that are part of the
cluster configuration. The initial state of the primary and secondary Viewpoint servers is
maintained by the service. If one of the Viewpoint servers is being replaced, it is
recommended that the Teradata Notification Service be manually reconfigured to connect to
the server that will remain in the cluster.
After the Viewpoint cluster is reconfigured, the Teradata Notification Service reconfigures
itself.
66
CHAPTER 6
Backup and Restore
Backup for Teradata Viewpoint Databases
Backup
The Backup portlet allows you to enable and disable automatic Teradata Viewpoint system
backups and to select the daily backup time as well. You can select whether to store the
backup files on the local system or at a network location and set the number of days the
backups are stored. The Teradata Alerts (cam) database is backed up at the same time.
The Backup portlet displays the backup process icon with either a successful completion or
an error for the last attempt and lists the last successful backup date and time.
Backup Errors
The Backup dialog box displays if an error occurs during the backup process. To
investigate the error, you can view the backup log file: /opt/teradata/viewpoint/dcs/
logs/backup.log.
Scheduling Viewpoint Backups
You can configure automatic backups, set a data retention length, and enable or disable the
backup process at any time.
From the Backup view, a status displays. If the last backup was successful, the date and time
display, as well as the size of the data that was backed up, using a 1024 byte kilobyte as the
base.
.
2 Open the Backup portlet.
3 [Optional] From the Backup view, do one of the following:
• Select the Enable backup check box to activate the backup process.
• Clear the Enable backup check box to disable the automatic-backup process.
4 From the Daily Backup Time list, select the daily start time of the backup operation.
5 From the Keep Backups For list, select the number of days to retain the backup data.
6 Under Location, select one of the following options to set the location of the backup
files:
67
Chapter 6 Backup and Restore
Backup for Teradata Viewpoint Databases
Option
Description
Local
Backs up Teradata Viewpoint databases to the local server.
Network Backs up Teradata Viewpoint databases to a networked file server to prevent data loss
in the event of a catastrophic failure.
If a postgres user has not been created on the NFS server with write access to the
specified backup path, contact the Teradata System Administrator.
b. Enter a Host to specify the host system name.
a.
c.
The host is the IP address or DNS name of the networked file server.
Enter a Path to specify the absolute path name where the backups are stored on
the host system.
For example, if you are running the command on Linux, it would look something
like this: mount <host>:<path>/path/to/local/mount/point
d. [Optional] Click Test to verify that the login settings are correct.
If the operation is successful, appears. If the operation fails,
the settings are correct and try again.
Note: You can click
appears. Verify
to view the result of the test.
7 Click Apply.
The changes are saved and backup files are deleted when they are older than the
configured number of days.
Backing Up Third-Party Applications
You can schedule third-party applications to back up the Teradata Viewpoint backup files.
See the vendor-specific documentation for instructions on how to install the client and
configure and run backup jobs. Teradata Viewpoint supports the following third-party
applications for backup:
• Symantec NetBackup
• IBM Tivoli Storage Manager
• Quest NetVault
1 The third-party application's client software must be installed on the server where the
Teradata Viewpoint backup files reside:
a From the Teradata Viewpoint portal page, click
check the configured backup location.
and click Backup on the page to
b Install the backup application's client software in the following location, depending on
which location is selected in Backup:
• Local: Viewpoint server
• Network: Networked file server
2 Check the Backup portlet for the time of day that the last successful backup completed.
3 Schedule the third-party backup jobs after the Teradata Viewpoint database backup is
completed.
68
Teradata Viewpoint Database Restoration Options
This ensures that you get the latest backed up data set and avoid resource contention.
Teradata Viewpoint Database Restoration
Options
When restoring a backup in a clustered environment, perform the restoration steps on only
the primary server.
A short outage is required while the configuration data is being restored. Once the
configuration data is restored, the system comes back online and the historical monitoring
data is restored.
You can choose one of the following options.
Restore Option
Description
Configuration Data
only
Restores only the configuration data. Existing historical data is retained and
is not restored from backup.
Configuration Data
only (into a clean
database)
Restores the configuration data. Existing historical monitoring data is not
kept and is not restored from backup. A new Viewpoint database is created
and the old database is removed.
Full Restore
Restores both the configuration and historical monitoring data. A new
Viewpoint database is created and the old database is removed.
Restoring a Teradata Viewpoint Database
1 If the Teradata Notification Service is running on a Windows server, stop this service.
2 If the backup files are located on network storage or on a third-party application backup
server, do the following:
a Copy the backup files to /data/backup on the Viewpoint server being restored.
b Ensure that the directory and file permissions within /data/restore are readable
by the postgres Linux user.
3 Run the /opt/teradata/viewpoint/bin/restore.sh script.
4 Validate that the script completed successfully by looking for the message: Restore or
migration performed successfully. If historical data is also
being restored or migrated, progress of this operation can be
viewed in the portal's notification bar.
If the restoration process failed, an error message is displayed instead of the success
message.
5 If the restoration process fails or is interrupted in any manner, fix the problem that
caused the failure and execute these steps again.
6 If you want the Teradata Notification Service to run on a Windows server, start this
service.
69
Migrating Teradata Viewpoint to a New Server
Migrating Teradata Viewpoint to a New Server
Prerequisite:
The Teradata software version on the new server must be equal to or greater than the version
on the current Viewpoint server. A local backup must be available on the current server.
1 On the new server, run the /opt/teradata/viewpoint/bin/restore.sh script
and select the Migrate from another server option.
2 Validate that the script completed successfully by looking for the message: Restore or
migration performed successfully. If historical data is also
being restored or migrated, progress of this operation can be
viewed in the portal's notification bar.
If the restoration process failed, an error message is displayed instead of the success
message.
3 If the migration process fails or is interrupted in any manner, fix the problem that caused
the failure and execute these steps again.
Backing Down to a Previous Teradata Viewpoint
Version
If an upgrade of Teradata Viewpoint does not completely successfully, the following steps
allow you to back down to the previously installed version of Teradata Viewpoint.
The only supported mechanism to backdown Teradata Viewpoint is to use VM&F during the
upgrade.
1 Reboot back into the alternate boot environment that contains the copy of the root
partition prior to the upgrade.
2 Stop all of the Teradata Viewpoint services on all Teradata Viewpoint servers by typing:
3 If the Teradata Notification Service is running on a Windows server, stop this service.
4 Restore the last successful backup of the Teradata Viewpoint databases.
The duration of this process varies depending on the size of the databases. If the Teradata
Viewpoint databases are in a clustered environment, perform the restore against the
primary database server.
5 Restore the Viewpoint portal.
a Uninstall the Viewpoint package:
rpm -e --nodeps viewpoint
b Reinstall the version of the Viewpoint package that was uninstalled:
rpm -ivh viewpoint*.rpm
c Run the post-upgrade setup script:
/opt/teradata/viewpoint/portal/bin/setup.sh
70
Backing Down to a Previous Teradata Viewpoint Version
d Start the Teradata Viewpoint service:
/etc/init.d/viewpoint start
71
Backing Down to a Previous Teradata Viewpoint Version
72

Teradata Viewpoint Installation, Configuration, and Upgrade Guide

Transcription

Similar documents

Map 8b Area Visible from the Viewpoint at Beckford`s Tower

Freedom to Explore - Teradata Magazine Online

ViewPoint™

Introduction to Teradata RDBMS

The view point Datasheet

MAXxess eAXxess Data Sheet

Efficiently Maximizing Retail Value Across Distributed Data

MYG-ES-Fig8.11bi - Plynlimon Range Glaslyn Foel Fadian

Presto