pulsenet enterprise installation guide · entranet (3.07), inet-900 (6.9.1), inet-ii (2.9.1),...

14
MDS 05-6567A01 Version 4.0.0 Installation Guide PulseNET Enterprise

Upload: others

Post on 27-Jul-2020

26 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: PulseNET Enterprise Installation Guide · EntraNET (3.07), iNET-900 (6.9.1), iNET-II (2.9.1), Intrepid (1.9.00 b1730), Mercury 1800 ... (SSL) mode only. If you uncheck this checkbox

MDS 05-6567A01

Version 4.0.0

Installation GuidePulseNET Enterprise

Page 2: PulseNET Enterprise Installation Guide · EntraNET (3.07), iNET-900 (6.9.1), iNET-II (2.9.1), Intrepid (1.9.00 b1730), Mercury 1800 ... (SSL) mode only. If you uncheck this checkbox

Table of Contents

Planning Your Installation 3System Requirements 364-bit Operating System Support 3Web Browser and Web Client Support 3Device Support 3TCP/UDP Ports Required 4Network Requirements 4

Installing PulseNET 5Initial Considerations 5Installing PulseNET on your Server 5

Step 1: Running the Installer 5Step 2: Introduction 6Step 3: License Agreement 6Step 4: Installation Directory 7Step 5: Select Services to Install 7Step 6: Configure PulseNET Services 7Step 7: PulseNET Configuration Summary 8Step 8: PulseNET Installation 9Step 9: PulseNET Server Startup 9Step 10: Startup Verification 9

Starting PulseNET Manually 10Stopping PulseNET Manually 10Importing a Network Security Certificate 10Uninstalling PulseNET 11

Upgrading PulseNET 12Preparing to Upgrade 12Upgrading from PulseNET 3.x to 4.x 12

Page 3: PulseNET Enterprise Installation Guide · EntraNET (3.07), iNET-900 (6.9.1), iNET-II (2.9.1), Intrepid (1.9.00 b1730), Mercury 1800 ... (SSL) mode only. If you uncheck this checkbox

Planning Your Installation 1

System Requirements

Before installing PulseNET, ensure that your system meets the following minimum hardware and software requirements.

• CPU = Quad Core at 2 GHz or greater

• Memory = 8 GB or greater of available memory

• Disk = 60 GB or greater of available storage

• Java = Ensure that a version of Java (8.x or newer) is present in order to run the PulseNET installer. You will be prompted to install Java if the PulseNET installer detects that it is not present on your server.

64-bit Operating System Support• Microsoft Windows = Server 2008/R2, 2012/R2

• RedHat Enterprise Linux or Centos = version 7.x or greater

• SuSe Linux Enterprise Server = version 11 or greater

• Ubuntu Server = version 16.04 LTS

Web Browser and Web Client Support • Chrome (version 52 or newer)

• Firefox (version 42 or newer)

• Internet Explorer or Edge (version 10 or newer)

Device Support

The following GE MDS devices can be monitored by PulseNET. (Minimum firmware ver-sion in parentheses)

Page 4: PulseNET Enterprise Installation Guide · EntraNET (3.07), iNET-900 (6.9.1), iNET-II (2.9.1), Intrepid (1.9.00 b1730), Mercury 1800 ... (SSL) mode only. If you uncheck this checkbox

4

EntraNET (3.07), iNET-900 (6.9.1), iNET-II (2.9.1), Intrepid (1.9.00 b1730), Mercury 1800 (3.0.6), Mercury 3650 D (3.7.3), Mercury 3650 E (3.2.6), Mercury 5800 (3.0.6), Orbit (6.1.2), SD Master Station (3.2.5), TransNET 900 (3.2.3), WiYZ (1.5.5), x790 (2.2.1), x710 (3.7.1).

TCP/UDP Ports Required

Network Requirements

In order for PulseNET to operate correctly on your server, ensure that you have a static host name and that the server’s IP address can be resolved consistently using that host name.

Function Access Port NumberHTTP External 8080HTTPS External 8443

AJP Internal 8009Shutdown Internal 8005Database Internal 27017

SNMP External 161ICMP External —

SSH/SFTP External 22FTP External 21

Telnet External 23

Internal: This port is only used internally on the PulseNET server.

External: This port provides communication with other systems. If a firewall is implemented, this port must be allowed for proper communication.

PulseNET Installation GuidePlanning Your Installation

Page 5: PulseNET Enterprise Installation Guide · EntraNET (3.07), iNET-900 (6.9.1), iNET-II (2.9.1), Intrepid (1.9.00 b1730), Mercury 1800 ... (SSL) mode only. If you uncheck this checkbox

Initial Considerations

PulseNET should run on a dedicated machine because it will process and store large volumes of data. Before beginning your installation, verify that you have full adminis-trator access to your server’s operating system.

After the installation completes, you will probably want to change the default PulseNET administrator account password. The default user name and password (admin/admin) will initially be used to log in to the browser interface and use PulseNET command-line tools with administrator privileges. It is strongly recommended that you change the default password for this account after installation.

Installing PulseNET on your Server

When all system requirements are in place, you are ready to install. Verify that your machine(s) meet the minimum system requirements for the devices PulseNET will be monitoring.

Step 1: Running the Installer

1 Locate and run the PulseNET install file on your computer. If the installer does not find an available version of Java on your computer, it will prompt you to install Java.

• If installing on a Windows server, right-click the executable and select Run as administrator. This is vital to ensure proper installation and to avoid permission issues later.

• If installing on Linux, you may install either as a root or non-root user. Linux services will be installed automatically when running as root, but services will not be installed when running as a non-root user. Have your Linux system administrator create services for PulseNET after the instal-lation is completed.

Installing PulseNET 2

Page 6: PulseNET Enterprise Installation Guide · EntraNET (3.07), iNET-900 (6.9.1), iNET-II (2.9.1), Intrepid (1.9.00 b1730), Mercury 1800 ... (SSL) mode only. If you uncheck this checkbox

6

Installer command line flags

Without any command line options the PulseNET installer will open the installation wiz-ard as described beginning with Step 2 in the following sections.

PulseNET also supports a “silent” install option which will install PulseNET without prompts using all default values. Use the following syntax for a silent mode install.

• Windows: pulsenet-install-4.0.0-SNAPSHOT-xxxx.exe -s

• Linux: java -jar pulsenet-install-4.0.0-SNAPSHOT-xxxx.jar -s

The silent mode install also supports an option that allows you to set the directory loca-tion for the installation. -t D:\full\path\to\install\location

To reinstall the PulseNET services without installing any other components, use the -a flag. You may also include the -t flag to specify the path to the parent of the existing GE_MDS folder if it is different than the default. On Linux you also have the option to do an Interactive Command Line Install using the -i flag.

Step 2: Introduction

The Introduction screen shows whether the installation requirements have been met. Each installation screen includes a Previous button so you can go back to adjust the specified information as needed. Click Next after reading the contents of the Introduc-tion screen.

Step 3: License Agreement

Read the PulseNET License Agreement and select I Agree. You may print the entire li-cense agreement here if you desire. Click Next.

PulseNET Installation GuideInstalling PulseNET

Page 7: PulseNET Enterprise Installation Guide · EntraNET (3.07), iNET-900 (6.9.1), iNET-II (2.9.1), Intrepid (1.9.00 b1730), Mercury 1800 ... (SSL) mode only. If you uncheck this checkbox

7

Step 4: Installation Directory

Select an existing directory for the installation of PulseNET. Click Next.

Step 5: Select Services to Install

This screen shows the PulseNET services that will be installed. Required services are pre-selected and shown in gray. In most cases, choose a Standard install. The Custom install option displays additional fields which can be customized for more complex server configurations. Click Next.

Step 6: Configure PulseNET Services

Here you may change any of the default PulseNET ports as required. You may also select whether you want PulseNET’s web interface to run in secure (SSL) mode only. If you uncheck this checkbox then PulseNET will provide both HTTP and HTTPS connections.

PulseNET Installation GuideInstalling PulseNET

Page 8: PulseNET Enterprise Installation Guide · EntraNET (3.07), iNET-900 (6.9.1), iNET-II (2.9.1), Intrepid (1.9.00 b1730), Mercury 1800 ... (SSL) mode only. If you uncheck this checkbox

8

The Custom install option also allows you to change the default settings for PulseNET’s data service since it may be hosted on a separate network node. Click Next.

Step 7: PulseNET Configuration Summary

Review the installation configuration and use the Previous button to change any set-tings that are not correct. When you are satisfied that the settings are accurate, click Next.

PulseNET Installation GuideInstalling PulseNET

Page 9: PulseNET Enterprise Installation Guide · EntraNET (3.07), iNET-900 (6.9.1), iNET-II (2.9.1), Intrepid (1.9.00 b1730), Mercury 1800 ... (SSL) mode only. If you uncheck this checkbox

9

Step 8: PulseNET Installation

PulseNET installs the files into the selected directory. The default installation path is <directory_you_selected>\GE_MDS\PulseNET. Once the progress bar reaches 100%, click Next.

Step 9: PulseNET Server Startup

If you installed PulseNET using server Administrator or root credentials, you will have the choice to start the PulseNET ser-vices now by checking the Start Server checkbox and clicking Finish. If you installed on Linux using a non-root account, the Start Server checkbox will not be available and you must start PulseNET manually.

Additional steps for non-root user install on Linux

If PulseNET was installed as a non-root user on Linux, then the ping service must be given escalated privileges in order to run correctly. The Installation Complete screen provides detailed instructions for changing the file attributes of the ping service and adding the non-root user to the sudoers file.

Step 10: Startup Verification

You can verify that PulseNET is running by checking the processes started on your server. Six services will be running as shown below from the Windows Services console. A similar services application is available on Linux servers with graphical displays.

PulseNET Installation GuideInstalling PulseNET

Page 10: PulseNET Enterprise Installation Guide · EntraNET (3.07), iNET-900 (6.9.1), iNET-II (2.9.1), Intrepid (1.9.00 b1730), Mercury 1800 ... (SSL) mode only. If you uncheck this checkbox

10

Starting PulseNET Manually

Windows

Open a command window and navigate to the directory <pulsenet_home> and ex-ecute the following command: start.bat

When PulseNET starts successfully, the following message appears in the command window: PulseNET startup completed.

Linux

Open a terminal window and navigate to <pulsenet_home> and execute the follow-ing command: start.sh

Stopping PulseNET Manually

Windows—Choose one of the methods listed below.• Is PulseNET is running in a command window, type Ctrl-C to stop PulseNET.

• Navigate to the directory <pulsenet_home> and execute the following command: stop.bat

Linux—Choose one of the methods listed below.• If PulseNET is running in a terminal window, type Ctrl-C to stop PulseNET.

• Open a terminal window and navigate to <pulsenet_home> and execute the follow-ing command: stop.sh

Importing a Network Security Certificate

PulseNET relies on the underlying Apache Tomcat web service to provide secure access. To install network security certificates, refer to the steps for configuring security on the

PulseNET Installation GuideInstalling PulseNET

Page 11: PulseNET Enterprise Installation Guide · EntraNET (3.07), iNET-900 (6.9.1), iNET-II (2.9.1), Intrepid (1.9.00 b1730), Mercury 1800 ... (SSL) mode only. If you uncheck this checkbox

11

Apache Tomcat website (https://tomcat.apache.org/tomcat-8.0-doc/ssl-howto.html). Once the Apache Tomcat security certificates have been imported, PulseNET will need to know how to use them.

1 Locate the full path to your certificate file (PKCS12 format).

2 Edit the PulseNET server.xml file in

<pulsenet-home>\apache-tomcat-8.x.x\conf

3 Find the keystoreFile variable and set it to the full path of your certificate

4 Set the keyAlias to “tomcat”

5 Set the keystoreType to “PKCS12”

6 Set the keyStorePass to the password for your keystore file

7 Save the server.xml file and restart the stingapache service.

Uninstalling PulseNET

There are still a few steps that must be accomplished outside of this uninstall program in order to completely remove PulseNET from the machine. The simple process listed below can be used to uninstall PulseNET manually.

1 Open a command window and navigate to the <pulsenet-home> directory to run the uninstall.bat or uninstall.sh program that is appropriate for your operating system

2 To delete any remaining program files, navigate to the GE_MDS install location and re-cursively remove all of the remaining files and folders

PulseNET Installation GuideInstalling PulseNET

Page 12: PulseNET Enterprise Installation Guide · EntraNET (3.07), iNET-900 (6.9.1), iNET-II (2.9.1), Intrepid (1.9.00 b1730), Mercury 1800 ... (SSL) mode only. If you uncheck this checkbox

Preparing to Upgrade

Before upgrading PulseNET, complete the following steps:1 Review the list of installation considerations given in Planning Your Installation.

2 Ensure that your PulseNET machine has enough disc space to store both the old and new versions of PulseNET, as well as any backup files you will create.

3 Generate a backup of the previous version by copying the GE_MDS directory to some-thing like GE_MDS-<timestamp>, or use an archiving tool to package your previous directory tree into a compressed archive file (zip or 7z).

Upgrading from PulseNET 3.x to 4.x

If you will be upgrading from PulseNET version 3.x to the new 4.x release, please contact the GE MDS Support Center for assistance with the upgrade. Be aware that the licensing feature in PulseNET requires that you obtain a new license key from GE MDS Support after the 4.x installation has completed.

The upgrade process requires that the previous and new versions of PulseNET be run-ning simultaneously so that existing information can be extracted from the previous version and entered into the new version. This means that PulseNET directory and port settings may need to be configured to allow both versions to run (especially on the same machine), and after the upgrade these directory and port settings can be reset.

The data transfer is accomplished by the PulseNET 4.x Upgrade Service, which must be executed from an Administrator command prompt as shown below.

Upgrading PulseNET 3

Page 13: PulseNET Enterprise Installation Guide · EntraNET (3.07), iNET-900 (6.9.1), iNET-II (2.9.1), Intrepid (1.9.00 b1730), Mercury 1800 ... (SSL) mode only. If you uncheck this checkbox

13

The upgrade service requires the following command line parameters:The hostname or IP address of the existing PulseNET 3.x server, the PulseNET 3.x web server port number (8080 or 8443), whether the PulseNET 3.x web server is using HTTPS/SSL encryption (true or false), and the username/password for the administrative user.

If the upgrade service reports any error messages, the GE MDS Support team can trou-bleshoot them using the PulseNET 4.x log files.

PulseNET Installation GuideUpgrading PulseNET

Page 14: PulseNET Enterprise Installation Guide · EntraNET (3.07), iNET-900 (6.9.1), iNET-II (2.9.1), Intrepid (1.9.00 b1730), Mercury 1800 ... (SSL) mode only. If you uncheck this checkbox

About GE MDSOver two decades ago GE MDS began building radios for business-critical applications. Since then we have installed millions of radios in countries across the globe. We over-came impassable terrain, brutal operating conditions, and complex network configurations to succeed. We also be-came experts in wireless communication standards and applications worldwide. The result of our efforts is that to-day thousands of organizations around the world rely on GE MDS wireless networks to manage their critical assets.

The majority of GE MDS radios deployed since 1985 are still installed and performing within our customers’ wireless networks. That’s because we design and manufacture our products in-house, according to ISO 9001, which allows us to meet stringent global quality standards.

Thanks to our durable products and comprehensive solu-tions, GE MDS is the wireless leader in industrial automa-tion—including oil and gas production and transportation, water/wastewater treatment, supply, and transportation, electric transmission and distribution, and many other ap-plications. GE MDS is also at the forefront of wireless com-munications for private and public infrastructure and on-line transaction processing. As your wireless needs change, you can continue to expect more from GE MDS. We’ll al-ways put the performance of your network above all.

GE MDS ISO 9001 RegistrationGE MDS adheres to the internationally-accepted ISO 9001 quality system standard.

To GE CustomersWe appreciate your patronage. You are our business. We promise to serve and anticipate your needs. We will strive to give you solutions that are cost effective, innovative, reli-able and of the highest quality possible. We promise to en-gage in a relationship that is forthright and ethical, one that builds confidence and trust. Data sheets, frequently asked questions, application notes, firmware upgrades and other updated information is available on the GE MDS Web site.

Manual Revision and AccuracyThis manual was prepared to cover a specific version of our product. Accordingly, some screens and features may differ from the actual version you are using. While every reasonable effort has been made to ensure the accuracy of this guide, product improvements may also result in minor differences between the manual and the product shipped to you. If you have additional questions or need an exact specification for a product, please contact our Customer Service Team using the information below. In addition, manual updates can often be found on the GE MDS Web site.

About End 2 End TechnologiesEnd 2 End (E2E) Technologies offers a unique combination of wireless communications and information technology expertise. We improve efficiency, reduce risk and lower the cost of industrial field operations via modernization and management of our customer’s wireless communications networks. From initial planning through lifecycle support we assist your team in adopting a wireless solution that keeps communication costs low while maximizing network reliability and performance. For more information visit us at www.e2etechinc.com.

In case of difficulty...

If you have problems, comments, or questions pertaining to the MDS PulseNET application, please contact GE MDS via one of the methods below:

Phone: 585-241-5510Email: [email protected]: 585-242-8369

License CreditsMDS PulseNET contains several third party components. Please refer to the complete list of these components at www.e2etechinc.com/index.php/about/legal.