Installation – QuickStart

PuzzleLogic Service Advisor QuickStart Installation

Welcome to the PuzzleLogic Service Advisor QuickStart Installation. This overview provides information for installing and deploying the main PuzzleLogic Service Advisor components on a single machine. For larger production systems, we recommend that you follow the installation and deployment process in the PuzzleLogic Service Advisor Installation and Deployment Guide. You can find the PuzzleLogic Service Advisor Installation and Deployment Guide in the documentation section on our Support website.

The following diagram depicts the installation locations for the Service Advisor components in a typical environment.

QuickStart Installation Steps

The QuickStart Installation walks you through the process of setting up the NGINX web server, PuzzleLogic Application Server, and PuzzleLogic MongoDB Data Repository on a single host. To install and configure the Command Line Interface and Agent, please visit the Integration section on our Support website.

IMPORTANT: Administrator (sudo) privileges are required for the installation of external software packages and updates to Unix service-related files.

Before you begin the installation process, make sure you have the username, password, download URL, and license required to download and install PuzzleLogic Service Advisor. Click here if you are missing any of these requirements.

For PuzzleLogic filenames and directories containing XXXXXX, replace the XXXXXX with the version number of the PuzzleLogic software (for example, the version1.7 of the file plviewer-install-XXXXXX-setup.tar.gz would be plviewer-install-1.7.0-setup.tar.gz).

Jan-2017
For the latest release, the PuzzleLogic file name is plviewer-install-1.7.1.setup.tar.gz

Step Action
1 Set the system clock to generate correct timestamps during run-time.

Red Hat
% service ntpd start
Ubuntu
% sudo apt-get install ntp 
% service ntp start
2 Download the PuzzleLogic setup file to the /tmp directory. Use the username, password, and download URL provided by PuzzleLogic to download the file.

If you do not have the required information to download the PuzzleLogic setup file, please click here.

% cd /tmp

% wget --user <username> --password '<password>' <plviewer-download-URL>/plviewer-install-XXXXXX-setup.tar.gz

Alternatively, you can download the PuzzleLogic setup file from our download site through your browser by clicking here.

3 Extract the contents of the setup file.

% tar -xvzf plviewer-install-XXXXXX-setup.tar.gz
4 Run the prerequisites shell script install-prereqs.sh. Follow the instructions and select java-1.8.0-openjdk when prompted.

% sudo /tmp/plviewer-install-XXXXXX/setup/install-prereqs.sh
5 Run the installation credentials shell script install-creds-setup.sh to create the PuzzleLogic user 'pluser' with the sudo privileges required for installation. Verify the 'pluser' account was created.

% sudo /tmp/plviewer-install-XXXXXX/setup/install-creds-setup.sh -p <password>

% ls -l /home
6 As the 'pluser' user, download the PuzzleLogic distribution file plviewer-install-XXXXXX-all.tar.gz.

% su - pluser

% cd $HOME

% wget --user <pluser_user> --password '<pluser_password>' <plviewer-download-URL>/plviewer-install-XXXXXX-all.tar.gz
7 Extract the contents of the distribution file in /home/pluser.

% tar -xvzf plviewer-install-XXXXXX-all.tar.gz
8 Create the deployment configuration file. Follow the instructions and provide the system information when prompted.

% cd ~/plviewer-install-XXXXXX/installer/

% ./deploy.sh configure -f ~/<deployment-config-file>

The default value for each configuration variable is shown in square brackets [ ].

  • Deployer user ID [pluser]: The 'pluser' user created through the install-creds-setup.sh script.
  • Deployer sudo password: Password provided to create to create the 'pluser' user account through the install-creds-setup.sh script.
  • Host name or IP address of the app server for PuzzleLogic: Target machine where PuzzleLogic will be installed.
  • Download URL for the PuzzleLogic Viewer distribution. For QuickStart, the URL is https://resource.puzzlelogic.com/download/eval/
  • User name for the download URL. This is the username provided in your Trial email
  • Password for the download URL. This is the password provided in your Trial email.
  • MongoDB Data Repository IP address. Enter the single IP address of the Target machine where PuzzleLogic will be installed.
  • MongoDB Data Repository server port number [27017]:
  • Open firewall to allow all client connection from any host to MongoDB [false]: Take default "false" for standalone.
  • MongoDB administrator user name [admin]:
  • MongoDB administrator user password []: <Enter a secure password>
  • MongoDB database name for PuzzleLogic Viewer [plasm]:
  • MongoDB database user name for the PuzzleLogic Viewer [plasmuser]:
  • MongoDB database user password []: <Enter a secure password>
9 Deploy the installation using the -l option (deploys installation without authentication).

% ./deploy.sh all -l -f ~/<deployment-config-file>
10 Verify the installation. Open a browser and enter the URL https://<hostname-or-IP>, where <hostname-or-IP> is the hostname or IP address of the PuzzleLogic machine. Log in using the username and password of root.

PuzzleLogic Service Advisor appears in the browser. Click the Account Settings icon on the left navigation bar and click Users on the top menu. You should see the System Root user.

11 Set the run-time system settings for your environment in the system.properties file. You can find a sample system.properties file in the plviewer-install-XXXXXX/samples/ directory.

NOTE: Be sure the following variables are set correctly:
server.url=https://<server_hostname>, where <server_hostname> is the hostname of the PuzzleLogic machine
ssl.accept_all_certs= set to true if you wish to use the self-signed certificate provided by PuzzleLogic.

 

% vi <directory-of-system.properties file>/system.properties

% ./deploy.sh settings –f <deployment-config-file> -c <path to system.properties file>
12 Create the sample company PuzzleLogic, Inc. which you can use to load your sample data. Note that you need a valid evaluation license to complete this step. Click here to request an evaluation license if you do not have one.

% ./deploy.sh data -f ~/<deployment-config-file>

% ./deploy.sh license –f ~/<deployment-config-file> -n "PuzzleLogic Inc." –i <complete_path_to_license_file>
Verify the installation. Open a browser and enter the URL https://<hostname-or-IP>, where <hostname-or-IP> is the hostname or IP address of the PuzzleLogic machine. Log in using the username and password of pladmin.

PuzzleLogic Service Advisor appears in the browser. Click the Account Settings icon on the left navigation bar. You should see the following information on the Account Settings pages:

  • Users: PuzzleLogic Administrator and PuzzleLogic Support users
  • Licenses: 30-day license issued to PuzzleLogic Inc.
  • Organizations: PuzzleLogic Inc.

Optional: Loading sample application data into PuzzleLogic Service Advisor

Service Advisor ships with sample application data. Complete the steps in the following section to load and view the sample data in Service Advisor.

1 Install the PuzzleLogic Agent.

Create a new directory (e.g. plviewer-agent) where you will run the PuzzleLogic Agent.

% mkdir –p $HOME/plviewer-agent

 

Extract the Agent archive file to the new directory.

% cd $HOME/plviewer-agent

% cp ~/plviewer-install-XXXXXX/assets/agent-XXXXXX.tar.gz .

% tar xvf agent-XXXXXX.tar.gz
2 Configure the PuzzleLogic Agent. Copy the application.properties file from the /samples to the /bin directory of the Agent directory.

% cd plviewer-agent-XXXXXX/bin

% cp ../samples/application.properties .

NOTE: In the application.properties file, make sure ssl.accept_all_certs= is set to the same value as in the system.properties file.

3 Run the PuzzleLogic Agent.

% ./agent.sh start
4 Create the PuzzleLogic Agent input directory and load sample application data into the directory.

% cd ~/plviewer-agent/plviewer-agent-XXXXXX/samples

% ./copy_sample_json.sh ../bin/target/data/input ./<dataset_to_import>

NOTE: Replace <dataset_to_import> with Demo_Remedy_V1_7 to load Remedy sample data or Demo_SNO_V1_7 to load ServiceNow sample data.

5 Set the Application Types in the Service Advisor application. You need to set the application types in order to view the sample data on the Service Advisor Home page. Service Advisor displays only data for application types that have been defined by a PuzzleLogic administrator.

See the PuzzleLogic Service Advisor Getting Started Guide for information on setting the application types.

Please let us know how Service Advisor has made it easier for you to support your enterprise applications.

If you have any questions or ideas on how to make Service Advisor even easier to setup, use, or have ideas for additional features that you would like to see, please let us know by sending us an email at support@puzzlelogic.com.