KonyOne Server Installation Guide - Linux KonyOne Platform Release 5.0
Copyright 2013 by Kony, Inc. All rights reserved. August, 2013 This document contains information proprietary to Kony, Inc., is bound by the Kony license agreements and may not be used except in the context of understanding the use and methods of Kony software without prior, express, written permission. Kony, KonyOne and Empowering Everywhere are trademarks of Kony, Inc. Microsoft, the Microsoft logo, Internet Explorer, Windows and Windows Vista are registered trademarks of Microsoft Corporation. Apple, the Apple logo, itunes, iphone, ipad, OS X, Objective-C, Safari and Xcode are registered trademarks of Apple, Inc.. Google, the Google logo, Android and the Android logo are registered trademarks of Google, Inc. Chrome is a trademark of Google, Inc. BlackBerry, PlayBook, Research in Motion, and RIM are registered trademarks of BlackBerry. All other terms, trademarks or service marks mentioned in this document have been capitalized and are to be considered the property of their respective owners. Copyright 2013 Kony, Inc. All Rights Reserved. Page 2 of 39
Revision History Date Document Version 1/21/2013 1.0 Initial Release Description of Modifications/Release 7/31/2013 2.0 Updated Troubleshooting section 8/26/2013 3.0 Updated APR related Post Installation steps Copyright 2013 Kony, Inc. All Rights Reserved. Page 3 of 39
Table of Contents 1. Overview 6 1.1 Intended Audience 7 1.2 Typographical Conventions 7 1.3 Reference Documents 7 1.4 Contact Us 8 2. Prerequisites 9 2.1 Hardware Requirements (per physical instance) 9 2.2 Software System Requirements (per physical instance) 9 3. Pre-installation Tasks 10 3.0.1 Install JDK 1.6 10 3.0.2 Configure Database 10 4. Install KonyOne Server 11 5. Silent Installation 25 6. Post Installation Tasks 26 6.1 Install Apache Portable Runtime 26 6.2 Compile APR for Tomcat Instance 26 6.3 Verification 27 6.4 Tomcat Configurations Changes for APR 27 6.5 Start KonyOne Server - Tomcat 28 6.6 Start KonyOne Server - JBoss 29 6.7 Verify Installation and Connectivity 30 7. Publish and Download Verification 34 8. Upgrade KonyOne Server 37 8.1 Application Upgrade 37 9. License Activation and Deactivation 38 Copyright 2013 Kony, Inc. All Rights Reserved. Page 4 of 39
10. Troubleshooting 39 Copyright 2013 Kony, Inc. All Rights Reserved. Page 5 of 39
1. Overview KonyOne Platform provides an integrated approach in the mobile application design, development, and management in a device independent manner and delivers the applications in different formats that run on all the major device platforms. KonyOne Platform consists of three main components: KonyOne Studio: Used to design and develop the mobile applications. KonyOne Server: Provides server side functionality for the applications, common data integration, and device support services Client Runtime: A component for each major device platform that enables the same mobile application to execute directly on the device. KonyOne Server KonyOne Server is an important component of KonyOne Platform installation. KonyOne Server acts as a gateway for KonyOne applications to access the existing services and web sites in your organization. The application functionality developed and generated by KonyOne Studio is enabled and delivered using the Application Server. The SMS and Mobile Web channels are hosted on the Application Server and the Native App binaries are deployed to the server, which can be downloaded to the device. The Application Server has the following features: A sophisticated device database which enables it to detect and deliver the appropriate binary to a requesting device. Inbuilt backend data services integration capability, with out-of-the-box support for Web Services, XML feeds and HTML extraction. Integration with optional third party connector libraries that offer access to a large number of ERP, database and legacy systems. Built in usage tracking and analysis capability that provides a wide range of reports on system and application usage. Server Installation Guide This document describes the installation and configuration of KonyOne Server on a Linux host operating system, using an installer. Copyright 2013 Kony, Inc. All Rights Reserved. Page 6 of 39
1.1 Intended Audience This document is intended for engineers or system administrators who are responsible for installing and deploying KonyOne Server. We assume that the reader of this document is familiar with deploying software on a Red Hat Linux server. The reader of this document must understand how to install the database software. 1.2 Typographical Conventions Following are the typographical conventions used throughout the document: Convention Explanation User input text, system prompts and responses File Path Monospace Commands Program Code File Names Emphasis Italic Names of Books and Documents New Terminology Windows Menus Bold Buttons Icons Fields Tabs URL Note: Important! Active link to a URL Provides helpful hints or additional information Highlights actions or information that might cause problems to systems or data 1.3 Reference Documents 1. Kony Database Setup Guide (Oracle/MySQL/MSSQL) 2. KonyOne Studio Installation Guide 3. KonyOne Studio User Guide 4. KonyOne Widget User Guide 5. KonyOne API Reference Guide Copyright 2013 Kony, Inc. All Rights Reserved. Page 7 of 39
1.4 Contact Us We welcome your feedback on our documentation. Write to us at techpubs@kony.com. For technical questions, suggestions, comments or to report problems on Kony's product line, contact productsupport@kony.com. Copyright 2013 Kony, Inc. All Rights Reserved. Page 8 of 39
2. Prerequisites The following sections provide you the information to understand the hardware and software required to install KonyOne Server. 2.1 Hardware Requirements (per physical instance) The following table displays the hardware requirements for both Production and Development and Testing environments for installation on an Application server, and the supported DBMS versions that can be installed on an apppropriate Database server. Component Processor Production Environment Quad-Core 2.2 GHz 64 bit Memory 16 GB 4 GB Internal Storage Network 146 GB (15K RPM ) with 2 Drives (Raid 1) Gigabit Ethernet Network Adapter Card with 2 Ports Development and Testing Environment One or more Intel Core or Intel Xeon Processor 20 GB HDD space One wired 10/100 Ethernet port; an external HTTP/HTTPS load balancer may be required depending on the server configuration you choose. Red Hat Enterprise Linux 5.8 Operating System Linux CentOS 5.4 2.2 Software System Requirements (per physical instance) The following table displays the software requirements for both Production and Development and Testing environments for installation on an Application server, and the supported DBMS versions that can be installed on an apppropriate Database server. Purpose Java Runtime Environment Database (Metrics / Device Database) *Database is shared across instances. Production Environment jdk1.6.0_35 (64 bit) MySQL 5.1, 5.5 Oracle 10g, 11g Std Edition MS SQL 2008, 2012 Development and Testing Environment Oracle/Sun JDK1.6.0_35 for Linux (Install the 32-bit JDK on 32-bit host systems and the 64-bit JDK on 64-bit hosts). MySQL 5.1, 5,5 Oracle 10g, 11g Std Edition MS SQL 2008, 2012 Copyright 2013 Kony, Inc. All Rights Reserved. Page 9 of 39
3. Pre-installation Tasks Before you begin the installation of KonyOne Server, you need to perform the following pre-installation tasks to successfully run the installer: 1. Install JDK 1.6 2. Configure Database 3.0.1 Install JDK 1.6 Before starting KonyOne Server installation, download and install Oracle/Sun JDK1.6.0_35 for Linux. The Oracle/Sun JDK for Linux can be downloaded from JDK web page after accepting the Oracle Binary Code License Agreement for Java SE. 3.0.2 Configure Database Depending on the runtime configuration that is chosen, you need to create one or more database instances to support the server operations. To configure a database for KonyOne Server, refer to the appropriate links: http://developer.kony.com/pre/mysql http://developer.kony.com/pre/mssql http://developer.kony.com/pre/oracle Copyright 2013 Kony, Inc. All Rights Reserved. Page 10 of 39
4. Install KonyOne Server This section of the document provides you with the instructions for installing and configuring KonyOne Server using KonyOne Server Installer. Ensure that you have the required hardware and access to the supporting software as mentioned in the Prerequisites section and performed the steps as mentioned in the Pre-installation Tasks section. When a database transaction logging is enabled, the messaging server provides Java Messaging Services at each host. The transaction logging is only available if logdaemon feature is selected in custom installation. The LITE installation is enabled with file logging. JBoss JMS Server comes with a built-in jmx-console through which we can check the status of the configured LogTopic, message count in the queue, and may be used for certain JMS administration. JBoss default HTTP port can be used to connect to the console. Default JBoss authentication needs to be enabled to access the jmx-console, and to be protected through a firewall to limit the access to the enterprise network. The Kony licensing is based on time based licensing phenomenon, session based licensing is not supported. To install KonyOne Server through a terminal, follow these steps: Note: It is recommended to run this installer as a superuser (root) to prevent any access issues during installation. At any point during the installation, if you wish to go back to the previous step, you can type BACK and press <Enter>. A sample console interaction steps are mentioned below; user input is highlighted: 1. Run # sh <location of the file/konyoneserver-linux-<version>.bin> console on a terminal. Launching installer... [root@localhost Desktop]# sh./konyoneserver-linux- <version>.bin Preparing to install... Extracting the installation resources from the installer archive... Configuring the installer for this system's environment... Launching installer... ============================================================== KonyOne Server for Tomcat (created with InstallAnywhere) -------------------------------------------------------------- Preparing CONSOLE Mode Installation... ============================================================== Introduction ------------ Copyright 2013 Kony, Inc. All Rights Reserved. Page 11 of 39
This wizard will guide you through the installation of KonyOne Server for Tomcat. It is strongly recommended that you quit all programs before continuing with this installation. Respond to each prompt to proceed to the next step in the installation. If you want to change something on a previous step, type 'back'. You may cancel this installation at any time by typing 'quit'. PRESS <ENTER> TO CONTINUE: ============================================================== 2. Press Enter. The License Agreement view appears. License Agreement ----------------- Installation and use of KonyOne Server for Tomcat requires acceptance of the following License Agreement: KONY SOLUTIONS, INC. SOFTWARE LICENSE AGREEMENT THE TERMS AND CONDITIONS CONTAINED HEREIN CONSTITUTE A LEGAL AGREEMENT. THIS AGREEMENT ("AGREEMENT") CONTAINS THE ENTIRE AGREEMENT BETWEEN YOU ("LICENSEE") AND KONY SOLUTIONS, INC. ("KONY") WITH RESPECT TO THE TERMS AND CONDITIONS DESCRIBED HEREIN. READ THIS AGREEMENT CAREFULLY BEFORE YOU CLICK THE "I ACCEPT" BUTTON BELOW. BY CLICKING ON THE "I ACCEPT" BUTTON, YOU ACKNOWLEDGE THAT (1) YOU ARE AUTHORIZED TO ENTER THIS AGREEMENT FOR AND ON BEHALF OF YOUR COMPANY, AND ARE DOING SO, AND (2) YOU HAVE READ, UNDERSTOOD, AND AGREE THAT YOU AND THE COMPANY SHALL BE BOUND BY THESE TERMS AND CONDITIONS AND ALL MODIFICATIONS AND ADDITIONS PROVIDED FOR. IF YOU DO NOT AGREE WITH THESE TERMS AND CONDITIONS, CLICK ON THE "I DO NOT ACCEPT" BUTTON BELOW AND INSTALLATION WILL TERMINATE. Software products included with this product that are not Kony products are licensed to you by the software provider. Please refer to the license contained in the provider's product for the terms of use before using such products. 1. License Grant. Kony grants you a limited, non-exclusive, non-transferable license to use, for developmental purposes only, the Kony software program(s), known as the KonyOne TM Platform (the "Software") and related product PRESS <ENTER> TO CONTINUE: documentation at no charge subject to the terms and restrictions set forth in this License Agreement. You are not permitted to use the Software in any manner not expressly authorized by this License. You acknowledge and agree that ownership of the Software and all subsequent copies thereof regardless of the form or media are held by Kony. The terms of this License will govern any Software upgrades provided by Kony that replace and/or supplement the original Software, unless such upgrade is accompanied by a separate license in which case Copyright 2013 Kony, Inc. All Rights Reserved. Page 12 of 39
the terms of that license will govern. 2. Term of Agreement. Your license is effective until terminated by Kony. The License will terminate automatically if you fail to comply with any of the limitations or other requirements described herein. At termination you shall cease all use of the Software and destroy all copies, full or partial of the Software. 3. Ownership Rights. The Software and related documentation are protected by United States copyright laws and international treaties. Kony, third party component providers and open source component providers own and retain all right, title and interest in and to the Software and related documentation, including all copyrights, patents, trade secret rights, trademarks and other intellectual property rights therein. Your possession, installation, or use of the Software and related documentation does not transfer to you any title to PRESS <ENTER> TO CONTINUE: the intellectual property in the Software and the related documentation, and you will not acquire any rights to the Software and product documentation, except the limited right to use it as expressly set forth in this Agreement. 4. Use of Name and Trademarks. You shall not use the name, trade names or trademarks of Kony or any of its affiliates in any advertising, promotional literature or any other material, whether in written, electronic or other form, distributed to any third party, except in the form provided by Kony, and then solely for purposes of identifying Kony software. 5. Restrictions. (A) Except as provided in this Agreement, you may not rent, lease, lend, redistribute or sublicense the Software. You may not copy the Software except to make archival or backup copies, provided that the backup copy must include all copyright or other proprietary notices contained on the original. You may not copy the related product documentation. You may not modify, reverse engineer, decompile, or disassemble the Software, except to the extent the foregoing restriction is expressly prohibited by applicable law. The Software is not intended for use in the operation of nuclear facilities, aircraft navigation or communication systems, air traffic control systems, life support machines or other equipment in which the failure of the Software could lead to PRESS <ENTER> TO CONTINUE: death, personal injury or severe physical or environmental damage. (B) Certain components of the Software are provided under various Open Source licenses that have been made available to Kony. You may modify or replace only these Open-Sourced Components; provided that (i) the resultant Software is used in place of the unmodified Software, on a single computer; and Copyright 2013 Kony, Inc. All Rights Reserved. Page 13 of 39
(ii) you otherwise comply with the terms of this License and any applicable licensing terms governing use of the Open- Sourced Components. Kony is not obligated to provide any maintenance, technical or other support for the resultant Software. 6. Exclusion of Warranties. THE SOFTWARE IS PROVIDED TO LICENSEE "AS IS", AND ANY USE BY LICENSEE OF THE SOFTWARE WILL BE AT LICENSEE'S SOLE RISK. KONY MAKES NO WARRANTIES RELATING TO THE SOFTWARE AND EXPRESSLY DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. SOME STATES AND JURISDICTIONS DO NOT ALLOW LIMITATIONS ON IMPLIED WARRANTIES, SO THE ABOVE JURISDICTION MAY NOT APPLY TO YOU. The foregoing provisions shall be enforceable to the maximum extent permitted by applicable law. 7. Limitation of Liability. TO THE EXTENT NOT PROHIBITED BY LAW, IN NO EVENT SHALL KONY BE LIABLE FOR PERSONAL INJURY, OR ANY INCIDENTAL, SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES WHATSOEVER, INCLUDING, WITHOUT LIMITATION, DAMAGES FOR PRESS <ENTER> TO CONTINUE: LOSS OF PROFITS, LOSS OF DATA, BUSINESS INTERRUPTON OR ANY OTHER COMMERCIAL DAMAGES OR LOSSES, ARISING OUT OF OR RELATED TO YOUR USE OR INABILITY TO USE THE KONY SOFTWARE, HOWEVER CAUSED, REGARDLESS OF THE THEORY OF LIABILTY (CONTRACT, TORT OR OTHERWISE) AND EVEN IF KONY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. SOME JUSISDICTIONS DO NOT ALLOW THE LIMITATION OF LIABILITY FOR PERSONAL INJURY, OR FOR INCIDENTIAL OR CONSEQUENTIAL DAMAGES, SO THIS LIMITATION MAY NOT APPLY TO YOU. In no event shall Kony's total liability to you for all damages (other than as may be required by applicable law in cases involving personal injury) exceed the amount of fifty dollars ($50.00). The foregoing limitations will apply even if the above stated remedy fails of its essential purpose. 8. Export Law Assurances. You may not use or otherwise export or re-export the Software except as authorized by United States law and the laws of the jurisdiction in which the Software was obtained. In particular, but without limitation, the Software may not be exported or re-exported (a) into (or to a national or resident of) any U.S. embargoed countries (currently Cuba, Iran, Iraq, Libya, North Korea, Sudan, and Syria) or (b) to anyone on the U.S. Treasury Department's list of Specially Designated Nationals or the U.S. Department of Commerce Denied Person's List or Entity List. By using the Software, you represent and warrant that you are not located in, under control of, or a national or resident of any such country or on any such list. PRESS <ENTER> TO CONTINUE: 9. United States Government. The Software and related Copyright 2013 Kony, Inc. All Rights Reserved. Page 14 of 39
explanatory written materials are "Commercial Items" as that term is defined at 48 C.F.R. 2.101, consisting of "Commercial Computer Software" and "Commercial Computer Software Documentation", as such terms are used in 48 C.F.R. 12.212 or 48 C.F.R. 227.7202, as applicable. Consistent with 48 C.F.R. 12.212 or 48 C.F.R. 227.7202-1 through 227.7202-4, as applicable, the Commercial Computer Software and Commercial Computer Software Documentation are being licensed to U.S. Government end users (a) only as Commercial Items and (b) with only those rights as are granted to all other end users pursuant to the terms and conditions herein. 10. Governing Law. This Agreement is governed by the law of the State of Florida, U.S.A., without reference to conflict of laws principles. The application of the United Nations Convention of Contracts for the International Sale of Goods is expressly excluded. 11. Assignment/Transfers. The parties may not assign or transfer this Agreement, in whole or in part, without the other Party's prior written consent. Any attempted assignment or transfer in violation of this Section will be null and void. PRESS <ENTER> TO CONTINUE: 12. Third Party Acknowledgements. (A) Aspects of the Software utilize or include third party software and other copyrighted material. Acknowledgements, licensing terms and disclaimers for such material are available when accessing the Software on the Kony website, and your use of such material is governed by their respective terms. (B) The Software includes certain software provided under various Open Source licenses. You may obtain complete machinereadable copies of the source code and licenses for the Open Source software at the Kony Open Source website (http://kony.com/oslicenses). Open Source Software is distributed WITHOUT ANY WARRANTY, without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 13. Severability. If any provision of this Agreement is held invalid, illegal or unenforceable, the validity, legality and enforceability of any of the remaining provisions of this Agreement shall not in any way be affected or impaired. 14. Entire Agreement. This Agreement is the entire agreement between you and Kony concerning the Software and all related documentation and supersedes any other prior or contemporaneous agreements or communications with respect to the PRESS <ENTER> TO CONTINUE: Software and related documentation, whether written or oral. This Agreement may not be modified except by a written addendum issued by a duly authorized representative of Kony. No provision hereof shall be deemed waived unless such waiver Copyright 2013 Kony, Inc. All Rights Reserved. Page 15 of 39
shall be in writing and signed by Kony or a duly authorized representative of Kony. Should you have any questions concerning this Agreement, or if you desire to contact Kony for any reason, please write to Kony Solutions, Inc., 7380 West Sand Lake Road, Suite 390, Orlando FL 32819, Attention: Legal Services. DO YOU ACCEPT THE TERMS OF THIS LICENSE AGREEMENT? (Y/N): Y 3. After reading and to accept the License Agreement, type "Y" and press Enter. 4. The Select Installer Set option appears. Select the configuration according to your requirements. The configurations are as follows: LITE (This helps to setup a development instance with minimal inputs) - This is a basic and default configuration. It is suitable for most of the development and test environments. Database Scripts Only - This configuration is suitable when you want to configure database schema and scripts. Customize - This configuration allows the user to selectively deploy and install KonyOne Server components. ============================================================== Select Installer Set -------------------- Please choose the Install Set to be installed by this installer. ->1- LITE (This helps to setup a development instance with minimal inputs) 2- Database Scripts Only 3- Customize... ENTER THE NUMBER FOR THE INSTALL SET, OR PRESS <ENTER> TO ACCEPT THE DEFAULT :3 Note: The default option is indicated as ->. When ever you press <Enter> without any input, it indicates that you have selected the default option. Let us install the server using the option "3" (Customize). It is a combination of LITE and Database Scripts that will run through all the options available. 5. Press Enter. The Choose Product Features option appears. The options 2, 3, and 4 are part of Middleware feature. Type the numbers separated by a comma and the corresponding feature gets installed. The option Middleware gets installed when you select any of the middleware features. Note: [-] indicates that the feature is selected however not all of its subfeatures are selected. [ ] indicates that the feature is not selected. [X] indicates that the feature is selected. Copyright 2013 Kony, Inc. All Rights Reserved. Page 16 of 39
The "x" indicates that it is selected. When you type "2" again it gets unselected. Note that mentioning the number of a feature toggles the selection. So, if you enter 2 below, Admin is un-selected. Choose Product Features ----------------------- ENTER A COMMA_SEPARATED LIST OF NUMBERS REPRESENTING THE FEATURES YOU WOULD LIKE TO SELECT, OR DESELECT. TO VIEW A FEATURE'S DESCRIPTION, ENTER '?<NUMBER>'. PRESS <RETURN> WHEN YOU ARE DONE: 1- [-] Middleware 2- -[X] Admin 3- -[ ] Logdaemon 4- -[ ] Create Database Schema Please choose the Features to be installed by this installer.: 3,4 6. Press Enter. The Selected Features option appears showing you the features you have selected. Type "2" to Confirm or "1" to Cancel and select the features again. Selected Features ----------------- You have selected the following features. Middleware, Admin, Logdaemon, Create Database Schema Confirm to continue. Cancel to re-select the features. ->1- Cancel 2- Confirm ENTER THE NUMBER OF THE DESIRED CHOICE, OR PRESS <ENTER> TO ACCEPT THE DEFAULT: 2 7. Press Enter. The Choose Install Folder option appears. Type the location of the install folder or press Enter to accept the default location. Choose Install Folder --------------------- Where would you like to install? Default Install Folder: /root/konyoneserver ENTER AN ABSOLUTE PATH, OR PRESS <ENTER> TO ACCEPT THE DEFAULT: 8. The Log Directory option appears. Type the location of the log file or press Enter to accept the default location. Copyright 2013 Kony, Inc. All Rights Reserved. Page 17 of 39
Log Directory ------------- Where do you want to store log files? (DEFAULT: /root/konyoneserver/logs): ENTER AN ABSOLUTE PATH, OR PRESS <ENTER> TO ACCEPT THE DEFAULT: 9. The License File option appears. Press Enter to provide the license file or type "2" to continue with the installation. If you have a valid middleware license file, you can mention the file location here. Alternatively, you could skip this step to continue with the installation and configure the license location later in middleware.properties file. License File ------------ Do you have license file for this installer? ->1- Yes 2- Skip ENTER THE NUMBER FOR YOUR CHOICE, OR PRESS <ENTER> TO ACCEPT THE DEFAULT:2 10. Press Enter. The Server Configuration option appears. Press Enter to accept the default values or change the server host IP address, HTTP Connector, and Shutdown ports. Note: Enter the IP address separated by a space. Press Enter to accept the default ports or change according to your needs. Server Configuration -------------------- A KonyOne Server may be composed of one or more server host machines. List the IP addresses of each host machine that will make up this server cluster. These advanced system configuration settings can be turned if required, but the current values should be correct for most system configurations. Enter the server host IP address, separated by a space (DEFAULT: <local system IP address>):10.10.2.5 Server HTTP Connector Base Port (DEFAULT: 9090): Server Shutdown Base Port (DEFAULT: 9105): 11. The Select server option appears. Type "2" for JBoss or press Enter to continue with the default option. Copyright 2013 Kony, Inc. All Rights Reserved. Page 18 of 39
Select server ------------- Which Application server you want? ->1- Tomcat 2- JBoss ENTER THE NUMBER FOR YOUR CHOICE, OR PRESS <ENTER> TO ACCEPT THE DEFAULT: 12. The Add Topology option appears. Type "2" for Advance options or press Enter to continue with the default option. In Basic installation only one middleware instance is installed and configured. However in Advanced installation, you will be able to install multiple instances of middleware on the same host. Copyright 2013 Kony, Inc. All Rights Reserved. Page 19 of 39
Add Topology ------------ About Topology: https://developer.kony.com/topology What is your topology? ->1- Basic (Single Instance per Physical Server) 2- Advanced (Multiple Instances per Physical Server) ENTER THE NUMBER FOR YOUR CHOICE, OR PRESS <ENTER> TO ACCEPT THE DEFAULT:2 13. The Add Database option appears. Type "2" for SQL Server or "3" for Oracle or press Enter to continue with the default option. Add Database ------------ What is your database? ->1- MySql 2- SQLServer 3- Oracle ENTER THE NUMBER FOR YOUR CHOICE, OR PRESS <ENTER> TO ACCEPT THE DEFAULT: 14. The Server Configuration option appears. Type "2" for HTTP or press Enter to continue with the default option. Server Configuration -------------------- What do you want to use? ->1- HTTPS 2- HTTP ENTER THE NUMBER FOR YOUR CHOICE, OR PRESS <ENTER> TO ACCEPT THE DEFAULT: 15. The Server HTTPS Configuration option appears. Type HTTPS port and Java Key Store path or press Enter to continue with the default options. Server HTTPS Configuration -------------------------- HTTPS_PORT (DEFAULT: 8443): Server Certificate java Key Store (jks) path (DEFAULT:/usr/java/jdk1.6.0_30/jre/lib/security/cacerts): Copyright 2013 Kony, Inc. All Rights Reserved. Page 20 of 39
16. The Enter Password option appears. Type your password or press Enter to continue with the default option (without password). Enter Password -------------- If there is no password, just press enter Java Key Store Password (optional): 17. The Database Prerequisites option appears. Refer to the links provided to execute certain steps in the respective database instance. Press Enter to continue with the next option. Database Prerequisites ---------------------- The installer requires running SQL scripts and fundamental knowledge of the database instance. You may also have to execute certain setup actions within the database instance. For MySQL 5 or later : https://developer.kony.com/pre/mysql For MS SQL Server : https://developer.kony.com/pre/mssql For Oracle Server : https://developer.kony.com/pre/oracle PRESS <ENTER> TO CONTINUE: 18. The Database Connection Parameters option appears. Press Enter to continue with the default options or change according to your requirements. Database Connection Parameters ------------------------------ The KonyOne Database is needed to store transcation activity for the transcation log database. Enter the JDBC connection parameters for this database. After entering all parameters, the DB connection will be tested at the backend. Hostname or IP Address (DEFAULT: localhost): Port (DEFAULT: 3306): Copyright 2013 Kony, Inc. All Rights Reserved. Page 21 of 39
Database Name (DEFAULT: test): Database Username (DEFAULT: root): 19. The Enter password for Database user root option appears. Type password and press Enter to continue with the next option. Enter password for Database user root ------------------------------------- Enter Password: 20. The DB Connection Status status message appears. Press Enter to continue with the next option. If the connection is unsuccessful enter <BACK> to go back to the previous steps and verify the database details. DB Connection Status -------------------- Database Connection Successful!!!! PRESS <ENTER> TO CONTINUE: 21. The JNP Port option appears. Press Enter to continue with the default option or change according to your requirements. JNP Port -------- JNP Port (for LOGDB) (DEFAULT: 1099): PRESS <ENTER> TO CONTINUE: 22. The Advanced Server Configurations option appears. Press Enter to continue with the default options or change according to your requirements. Server Instances per Host - The number of server instances to be installed on this machine. Instances begin count - You might want to change the instance begin count, if you are installing this on multiple servers and you wish to have unique instance ids. Advanced Server Configurations ------------------------------ Server Instances per Host (DEFAULT: 3): Instances begin count (DEFAULT: 1): Session servers (memcached) per host (DEFAULT: 3): Session Servers (memcached) base port (DEFAULT: 21201): Copyright 2013 Kony, Inc. All Rights Reserved. Page 22 of 39
23. The Tomcat Virtual Hostname option appears. Press Enter to continue with the default options or change according to your requirements. Tomcat Virtual Hostname ----------------------- Virtual hostname (Tomcat setting) (DEFAULT: localhost): PRESS <ENTER> TO CONTINUE: 24. The Admin User Creation option appears. Press Enter to continue to create an administrative user or type "2" to create later. Admin User Creation ------------------- The KonyOne admin console runs as a web application with its own unique set of user credentials. In order to access the console,you will need to create a user account. Do you want to create user for admin console now? ->1- Yes, I want to create an administrative user now 2- No, I will create an administrative user later ENTER THE NUMBER FOR YOUR CHOICE, OR PRESS <ENTER> TO ACCEPT THE DEFAULT: Note: Admin module of KonyOne Server is to be used only in development or testing environment and not in production. We use the Admin module to publish applications or services to the KonyOne server from KonyOne Studio. 25. The Create Admin Console User option appears. Press Enter to continue with the default option or change according to your requirements. Create Admin Console User ------------------------- Username (DEFAULT: admin): ENTER THE USERNAME FOR YOUR ADMIN, OR PRESS <ENTER> TO ACCEPT THE DEFAULT: 26. The Enter password for admin option appears. Type a password for admin and press Enter. Enter password for admin ------------------------ Enter Password: Copyright 2013 Kony, Inc. All Rights Reserved. Page 23 of 39
27. The Pre-Installation Summary appears on the console. Review the features being installed and press Enter. Pre-Installation Summary ------------------------ Please Review the Following Before Continuing: Product Name: KonyOne Server for Tomcat Install Folder: /home/core/konyserver Install Set: Custom Product Features: Middleware, Admin, Logdaemon, Create Database Schema, Disk Space Information (for Installation Target): Required: 457.45 MegaBytes Available: 4,148.02 MegaBytes PRESS <ENTER> TO CONTINUE: 28. The Installation progress appears on the console. Installing... ------------- [============== ============== ============== =============] [-------------- -------------- -------------- -------------] ============================================================ 29. The installation is complete. Press Enter to exit the installer. Install Complete --------------------- Congratulations. KonyOneServer has been successfully installed to: /root/konyoneserver PRESS <ENTER> TO EXIT THE INSTALLER: Copyright 2013 Kony, Inc. All Rights Reserved. Page 24 of 39
5. Silent Installation KonyOne Server can also be installed through Unattended/Silent Installation process. Along with the KonyOne Server Installer, a sample file installer.properties is provided. Update the variables based on your requirement. To install KonyOne Server through Unattended/Silent Installation, follow these steps: 1. Open Linux console and go to the location where the installer is located. Type <KonyOneServer-linux-<version>.bin> -i silent -f <complete path of installer.properties file> and press Enter. 2. A message appears after the installation is completed. Note: If the file name is installer.properties and is in the same location as KonyOneServer-linux-<version>.bin file, then the option -f is not required in the silent installation. But if the file name is changed to other than installer.properties, then you must use -f option irrespective of file location. Copyright 2013 Kony, Inc. All Rights Reserved. Page 25 of 39
6. Post Installation Tasks After you have installed the server, complete the post-installation tasks to configure your server as required. Few steps have to be performed to verify the database successful installation and provide access permissions on some tables. 6.1 Install Apache Portable Runtime Note: This procedure is applicable for Tomcat and is required for production environments only. Apache Portable Runtime (APR) improves the response time for serving static resources like image files, Cascading Style Sheets and Java script. 1. Create a folder with the name apr under /home/core/. $ mkdir -p /home/core/apr 2. Download APR 1.4.5 and copy it into /home/core/apr/. Download it from http://archive.apache.org/dist/apr. 3. Extract apr-1.4.5.tar.gz and navigate to /home/core/apr/apr-1.4.5/. $ tar -xvf apr-1.4.5.tar.gz $ cd /home/core/apr/apr-1.4.5/ 4. Extract apr-1.4.5.tar.gz and navigate to /home/core/apr/apr-1.4.5/.$ tar -xvf apr-1.4.5.tar.gz $./configure enable-threads $ make Login with root to execute the following command: $ cd /home/core/apr/apr-1.4.5/ $ make install Relogin with the user account i.e core. 6.2 Compile APR for Tomcat Instance Note: Compilation and verification of APR is required for production environments only. Note: Before proceeding further, check if the autoconf is installed on the machine. If it is not available, install it with yum - yum install autoconf. 1. Export the Java Path in core user. export JAVA_HOME=/usr/java/jdk1.6.0_35/ export PATH=$JAVA_HOME/bin:$PATH Copyright 2013 Kony, Inc. All Rights Reserved. Page 26 of 39
Note: For core user, exporting Java Path to jdk1.6.0_35 is a temporary change till the APR installation is complete. 2. Navigate to $TOMCAT_HOME/instance1/bin/tomcat-native-1.1.20- src/jni/native location of the Tomcat instance. $ cd $TOMCAT_HOME/instance1/bin $ tar -xvf tomcat-native.tar $ cd tomcat-native-1.1.20-src/jni/native 3. Execute the following command to prepare the build system for compilation: $ sh buildconf --with-apr=/home/core/apr/apr-1.4.5/ 4. Execute the following commands to build: $./configure --with-apr=/home/core/apr/apr-1.4.5/ --with-javahome=/usr/java/jdk1.6.0_35 $ make # make install Note: If you have multiple instances of Tomcat, perform the steps 2-4 for each instance. 6.3 Verification To check if APR is properly configured to Tomcat: 1. Check config.log under $TOMCAT_HOME/instance1/ bin/tomcat-native-1.1.20- src/jni/native/ folder. Make sure the following line uses JDK 1.6: /usr/java/jdk1.6.0_35/ 2. Navigate to the hidden folder $TOMCAT_HOME/instance1/bin/tomcat-native- 1.1.20-src/jni/native/.libs and check if libtcnative-1.so is created. Check the time stamp for the latest file. 6.4 Tomcat Configurations Changes for APR Follow the below steps to add Tomcat configurations for APR: 1. Navigate to the Kony server installation location tomcat/instance*/conf/server.xml enable the commented line below. <Listener classname="org.apache.catalina.core.aprlifecyclelistener" SSLEngine="off" /> Note: SSLEngine should be turned off if you are terminating SSL on the loadbalancer. Note: SSLEngine should be turned on if you are terminating SSL on the Tomcat. Copyright 2013 Kony, Inc. All Rights Reserved. Page 27 of 39
2. In the same file, update APR protocol attribute in HTTP and HTTPS connector sections as highlighted below. Add the below attribute for HTTP <Connector address="${tomcat_bind_ip}" port="${tomcat_http_ PORT}" maxhttpheadersize="8192" maxthreads="150" enablelookups="false" redirectport="8443" acceptcount="5" connectiontimeout="20000" secure="true" disableuploadtimeout="true" server="kony" tcpnodelay="true" protocol="org.apache.coyote.http11.http11aprprotocol" proxyname="${dns_name}" proxyport="80" compression="on" compressablemimetype="text/css,text/javascript,text/html"/> Add the below attribute for HTTPS <Connector address="${tomcat_bind_ip}" port="${tomcat_https_ PORT}" maxhttpheadersize="8192" maxthreads="150" enablelookups="false" redirectport="8443" acceptcount="5" connectiontimeout="20000" disableuploadtimeout="true" server="kony" tcpnodelay="true" protocol="org.apache.coyote.http11.http11aprprotocol" proxyname="${dns_name}" proxyport="443" scheme="https" secure="true" compression="on" compressablemimetype="text/css, text/javascript,text/html"/> 3. Navigate to the Kony server installation location tomcat/instance*/bin/catalina.sh and add the system property as shown below. CATALINA_OPTS="-Djava.library.path=$TOMCAT_ HOME/instance1/bin/tomcat-native-1.1.20-src/jni/native/.libs" Note: If you have multiple instances of Tomcat, perform the steps 1-3 for each instance. 6.5 Start KonyOne Server - Tomcat To start KonyOne Server for Tomcat, follow these steps: Note: Tomcat logs are stored in <drive>:/konyoneserver/tomcat/instance*/logs folder. 1. Start the memcached server - Navigate to../memcache directory and run startmemcached1.sh file in the console. Check for the server startup message on the console that appears. Copyright 2013 Kony, Inc. All Rights Reserved. Page 28 of 39
Note: You can have more than one instance of memcached, in such cases the subsequent instances will be startmemcached2.sh, startmemcached3 etc. 2. Start the JBoss-JMS - Navigate to../jboss_jms/bin directory and run startjboss.sh. As the JBoss-JMS runs in the background, close the console that appears after the service starts. 3. Start the logdaemon - Navigate to../konylogdaemon/bin directory and run rundaemon.sh. As the logdaemon runs in the background, close the console that appears after the service starts. 4. Start the Tomcat server - Navigate to tomcat/instance*/bin directory and run startup.sh file. Check for the server startup message on the console that appears. Note: If you have chosen multiple tomcat instances to install, repeat the step 4 for other tomcat instances. 6.6 Start KonyOne Server - JBoss To start KonyOne Server for JBoss, follow these steps: 1. Start the memcached server - Navigate to../memcache directory and run startmemcached1.sh file in the console. Check for the server startup message on the console that appears. 2. Start the JBoss-JMS - Navigate to../jboss_jms/bin directory and run startjboss.sh. As the JBoss-JMS runs in the background, close the console that appears after the service starts. Copyright 2013 Kony, Inc. All Rights Reserved. Page 29 of 39
3. Start the logdaemon - Navigate to../konylogdaemon/bin directory and run rundaemon.sh. As the logdaemon runs in the background, close the console that appears after the service starts. 4. Start the jboss service - Navigate to../jboss/instance*/bin directory and run startjboss.sh file in the console. Check for the successful jboss startup message on the console that appears. Note: If you have chosen multiple JBoss instances to install, repeat the step 4 for other JBoss instances. 6.7 Verify Installation and Connectivity To verify the database successful installation, follow these steps: 1. Check the middleware.log file. It should display a successful license validation message. 2. Check the catalina.out file for the successful middleware validation message. If the log displays FATAL ERRORS, verify the setup. Copyright 2013 Kony, Inc. All Rights Reserved. Page 30 of 39
3. Check for the successful validation messages in the catalina.out file for the sslkeystore and ssltruststore paths. It should display the path as JAVA_HOME/jre/lib/security/cacerts, as configured in the middleware.properties file. 4. Check for the successful validation messages in catalina.out file for admin module validation and context root. Copyright 2013 Kony, Inc. All Rights Reserved. Page 31 of 39
5. Open the browser and enter http://<ipaddress> or <hostname>:<port>/middleware/version.html. It should display Build Date, Build Time, and Build Number. 6. Open the browser and enter http://<ipaddress> or <hostname>:<port>/middleware/mwservlet. It should display the message as HTTP GET is not supported. Copyright 2013 Kony, Inc. All Rights Reserved. Page 32 of 39
To verify successful configuration, follow these steps for respective database: To verify the database for KonyOne Server, refer to the appropriate links: http://developer.kony.com/pre/mysql http://developer.kony.com/pre/mssql http://developer.kony.com/pre/oracle Copyright 2013 Kony, Inc. All Rights Reserved. Page 33 of 39
7. Publish and Download Verification After installing KonyOne Server, you can publish the application and download it on to a device. The applications can be published only if it is built in release mode and the session manager option is selected as Kony Session Manager. To go the below screen in KonyOne Studio, right-click Application > Properties > and select Mobile Web tab. Note: For Tomcat server, you can publish both Applications and Services using KonyOne Studio. For JBoss server, you can only publish Services and manually copy the war file in the web apps folder. To publish an application, follow these steps: 1. In KonyOne Studio, right-click the application, point to Build on the menu, and then click Clean build. The Build screen appears. Copyright 2013 Kony, Inc. All Rights Reserved. Page 34 of 39
2. Select the required platforms. 3. Click Finish. The application builds for the selected platforms. 4. Right-click the application, point to Publish on the menu, and then click Application. A warning message appears. If the application meets the requirements, click Proceed. The Publish application screen appears with selected platforms. Copyright 2013 Kony, Inc. All Rights Reserved. Page 35 of 39
5. Click Finish. The Publish is successful message is displayed on the console. To verify the deployment of the application, follow these steps: 1. Open a browser. 2. In the address bar, Type the text http://<host>:<port>/appdownload/status.jsp and press Enter. To download the binary of the application, follow these steps: The device needs to hit the URL to download the application binary: http://<host>:<port>/appdownload/download?appid=<appid> Note: In the above URL: Host: Domain Name/IP Address of the server on which the AppDownloader is deployed. Port: Listening Port of the server on which the AppDownloader is deployed. appid: appid of the application for which the binary is requested. The AppDownloader will try to find a matching app element for this appid in the registry and use the information available in the app element to form the final downloadable URL. Copyright 2013 Kony, Inc. All Rights Reserved. Page 36 of 39
8. Upgrade KonyOne Server To upgrade KonyOne Server, follow the steps as mentioned in the table: Upgrade File devicestore-<build.version>.tar libraries-<build.version>.tar Upgrade KonyOne Server konylogdaemon.tar middleware.war Procedure Replace this database with the new database. Copy the file to <drive>:/konyoneserver/install/derby/1 folder, and extract it in the same folder. For additional information see the steps mentioned in Configure DeviceDB to Derby DB. Copy the file to $TOMCAT_HOME/instance1/lib folder. Extract the file to the same location to overwrite the existing files. For additional information see Deploy KonyOne Server Files section. Copy the file to <drive>:/konyoneserver/konylogdaemon folder and extract. For additional information see Install Reporting Agent section. Used for Native Apps applications only. Copy the latest middleware.war to $TOMCAT_HOME/instance1/webapps folder. For additional information, see Deploy KonyOne Server Files section. 8.1 Application Upgrade To upgrade application, follow the steps as mentioned in the table: Upgrade File <ServiceDefinition>.xml Custom java libraries (Optional) <application>.war Procedure Place <ServiceDefinition>.xml file in <drive>:- /KonyOneServer/install/middleware/middlewarebootconfig/appregistry folder. Copy Pre-Processor, Post-Processor, and required files to $TOMCAT_HOME/instance1/lib folder. Mobile Web Application. It is advisable to create the file in tar file format and deploy as root, so that it can be deployed as a main application. The.war file format ensures that the time stamps of the files are maintained across all tomcat instances. It should be copied to $TOMCAT_ HOME/instance1/webapps folder. Copyright 2013 Kony, Inc. All Rights Reserved. Page 37 of 39
9. License Activation and Deactivation KonyOne server requires a valid license for activation. To activate the license, execute the steps as mentioned in the document: Activate the License To deactivate the license, execute the steps as mentioned in the document: Deactivate the License Copyright 2013 Kony, Inc. All Rights Reserved. Page 38 of 39
10. Troubleshooting This section lists the troubleshooting tips to resolve problems that you may encounter during installation. The error messages are stored in log files. Error Message Command.run(): Cannot run program "/tmp/640545.tmp/executescripttmp0": java.io.ioexception: error=13, Permission denied XMLScriptWriter: No Installation Objects were skipped Command.run(): Cannot run program "/tmp/640545.tmp/executescripttmp0": java.io.ioexception: error=13, Permission denied Retrying Installables deferred in pass 0 Cause In operating system "/tmp" directory is secured and mounted with "nodev", "nosuid", and "noexec" permissions installer fails to execute the scripts from this location. In enterprise environment this could be a known issue. Solution You can configure the extracts of the installer to a directory where you have read, write and execute permissions. Run the below command before installation. export IATEMPDIR=<absolute path of a temporary directory> Copyright 2013 Kony, Inc. All Rights Reserved. Page 39 of 39