Installation Guide for Kony Fabric on Microsoft Azure Cloud

Transcription

1 Kony Fabric Installation Guide for Kony Fabric on Microsoft Azure Cloud Release V8 SP3 GA Document Relevance and Accuracy This document is considered relevant to the Release stated on this title page and the document version stated on the Revision History page. Remember to always view and download the latest document version relevant to the software release you are using by Kony, Inc. All rights reserved 1 of 80

2 Installation Guide Copyright 2017 Kony, Inc. All rights reserved. October, 2018 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, Inc., software without prior, express, written permission. Kony, Empowering Everywhere, Kony Fabric, Kony Nitro, and Kony Visualizer are trademarks of Kony, Inc. MobileFabric is a registered trademark 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, Apple Pay, Apple Watch, and Xcode are trademarks or 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. SAP and SAP Business Suite are registered trademarks of SAP SE in Germany and in several other countries. 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 by Kony, Inc. All rights reserved 2 of 80

3 Installation Guide Revision History Date Document Version Description of Modifications/Release 10/16/ Document Released for V 8.3 GA 07/25/ Document Released for V GA 05/07/ Document Released for V GA Getting Started Options Release Notes Kony Downloads Video Tutorials QuickStart Guides Kony Fabric User Guide Visualizer User Guide Sample Apps 2018 by Kony, Inc. All rights reserved 3 of 80

4 Installation Guide Table of Contents 1. Overview 6 2. Kony Fabric on Azure Prerequisites VM Setup Source code setup Configuration Script Execution Configuring Visualizer to connect to Kony Fabric on Azure Updating the Azure Kubernetes Service Cluster configuration Appendices Prerequisite Packages Hosting your domain with Azure DNS Generating a PFX file from PEM Extracting Logs from your Application Connecting to AKS nodes through Jumpbox Log Analytics New Relic Monitoring Rolling Updates Kubernetes Dashboard VPN Reference Implementation by Kony, Inc. All rights reserved 4 of 80

5 Installation Guide 4. Frequently Asked Questions (FAQs) by Kony, Inc. All rights reserved 5 of 80

6 1. Overview Installation Guide 1. Overview Kony Fabric Containers on Azure Solution is designed to facilitate Kony Fabric on Azure for Trial and Enterprise needs. This setup occurs with minimal manual intervention and leverages the following technologies: Docker - To package different components as portable container images (with all the required binaries and libs) Kubernetes - To orchestrate and maintain all these running containers. It will also have features like auto-scaling, secrets, deployment upgrades and rollbacks. Azure - For provisioning of the underlying infrastructure. Salient Features The Kony Fabric Containers on Azure Solution Trial Version provides developers with tools to build applications and the Enterprise Version provides IT with multi-architecture operations at scale. The Kony Fabric Containers on Azure Solution has the following features: Creates a multi-layer architecture along with the Application Gateway in a Virtual Network making it secure. Supports options to configure a custom DNS name, SSL cert support for secure communication, and includes Jumpbox for DevOps activities by Kony, Inc. All rights reserved 6 of 80

7 2. Kony Fabric on Azure Installation Guide 2. Kony Fabric on Azure 2.1 Prerequisites 1. Azure Account - The setup script creates all the resources in this account. In your Azure subscription, your account should have the following permissions: i. Azure Subscription Permissions: Your account must have the role of an Owner. If your account has the role of a Contributor, you do not have adequate permissions. Contact your Azure Account Administrator for getting the required permissions by Kony, Inc. All rights reserved 7 of 80

8 2. Kony Fabric on Azure Installation Guide Steps to check the permissions of your Azure subscription: a. In the Azure Portal, select your account from the upper right corner, and select My permissions. b. From the drop-down list, select Subscription. Select Click here to view complete access details for this subscription by Kony, Inc. All rights reserved 8 of 80

9 2. Kony Fabric on Azure Installation Guide c. View the roles assigned to you. In the following image, the user has the role of the Owner, which means that the user has adequate permissions. ii. Azure Active Directory Permissions: To check your Azure AD permissions: 2018 by Kony, Inc. All rights reserved 9 of 80

10 2. Kony Fabric on Azure Installation Guide a. Select Azure Active Directory. b. In Azure Active Directory, select Overview and look at your user information. You should have the role of a Global Administrator to proceed further. If you do not 2018 by Kony, Inc. All rights reserved 10 of 80

11 2. Kony Fabric on Azure Installation Guide have this role, contact your administrator to assign this role to you. 2. Prerequisite packages - The Kony Fabric Containers on Azure Solution does not need any additional software to be pre-installed, as the prerequisite packages are downloaded as a part of the setup scripts. The packages that are installed as part of the install scripts are: azure-cli, kubectl, jq, and sponge. Note: To make sure that the script is able to download all the necessary software, you might need to open outbound connections to the respective sites. For more information, refer to the Appendices section of this document. 3. SSH Public Key Using the SSH protocol, you can connect and authenticate to remote servers and services. Kony Fabric setup expects an SSH key pair for authentication. The SSH public key is used for creating the Azure Virtual Machine, and for installing the Kony Fabric Setup. You need to specify the SSH Public Key in the.properties file. On Ubuntu terminal, use the ssh-keygen command to generate SSH public and private key files that are created by default in the ~/.ssh directory. This command can be executed from your local (Ubuntu) machine: ssh-keygen -t rsa -b by Kony, Inc. All rights reserved 11 of 80

12 2. Kony Fabric on Azure Installation Guide You must create and configure a key pair as you need to provide them in the Configuration settings. 4. Domain Name(Optional) - You can have a Domain Name for the solution, which you can purchase from any third-party organizations, such as GoDaddy, and a proper DNS which you need to map to the public DNS of the Application Gateway. Refer to the Appendices section, for more details. 5. SSL certs(optional)- To secure the communication, acquire the SSL certs (Azure Application Gateway requires certificates in.pfx format) and provide them during the Installation process. These SSL certs must be associated with the Domain Name that the user has procured. Refer to the Appendices section on SSL cert pfx format conversion. 2.2 VM Setup You need an Azure Virtual Machine to download the artefacts, and execute the setup scripts from the VM to install Kony Fabric on Azure. Follow these steps to create a VM through Azure Portal: 1. Login to the Azure Portal with the same account you configured for the role of the Global Administrator. Navigate to the Virtual Machines Tab. Click on +Add button and select the Ubuntu Server image by Kony, Inc. All rights reserved 12 of 80

13 2. Kony Fabric on Azure Installation Guide 2. Select Ubuntu Server LTS image and click on Create by Kony, Inc. All rights reserved 13 of 80

14 2. Kony Fabric on Azure Installation Guide 3. Proceed with the remaining steps in the wizard and provide the SSH Public Key where needed. 2.3 Source code setup Steps to Install Kony Fabric on MS Azure: 1. Fetch the Public IP of the Virtual Machine from Azure Portal. Login to the VM by executing the following command in the Terminal: $ ssh azureuser@<public-ip> -i ~/.ssh/id_rsa 2018 by Kony, Inc. All rights reserved 14 of 80

15 2. Kony Fabric on Azure Installation Guide 2. Switch to the root user, install the unzip package for extracting contents, and download the kony-fabric-containers-azure.zip file: $ sudo -s $ apt-get install unzip $ curl -o kony-fabric-containers-azure.zip -Lhttp://download.kony.com/onpremise/mobilefabric/ /konyfabric-containers-azure_ _GA.zip 3. Unzip the downloaded artefacts: $ unzip kony-fabric-containers-azure.zip -d <directory-name> The structure of the document will be as shown below: 2.4 Configuration Edit the input parameters in the following files based on the type of solution you want to create. <Installation Directory>/conf/trial.properties for Trial solution. <Installation Directory>/conf/enterprise.properties for Enterprise solution. For more information, refer to the sample.properties file. You need to provide the following parameters during Installation: Note: None of the values for parameters in trial or enterprise properties file should contain quotes. 1. Azure Subscription ID, Azure Service Principal ID Name and Azure Service Principal ID Secret - Azure Subscription ID is a GUID that uniquely identifies your subscription to use Azure 2018 by Kony, Inc. All rights reserved 15 of 80

16 2. Kony Fabric on Azure Installation Guide services. The Application needs the Service Principal to access or configure resources through the Azure Resource Manager (ARM) in the Azure Stack. You must have an Azure account with the permissions of a Global Administrator and the role of a User. Without these privileges, it is not possible to create the AKS clusters (or other resources). The following section describes fetching Azure Subscription ID, generating Azure Service Principal ID Name, and Azure Service Principal ID Secret. i. Steps to get the subscription id: Navigate to Navigate to Browse. In the search box, begin to type subscription by Kony, Inc. All rights reserved 16 of 80

17 2. Kony Fabric on Azure Installation Guide Select Subscriptions from the search results by Kony, Inc. All rights reserved 17 of 80

18 2. Kony Fabric on Azure Installation Guide Find the appropriate subscription to check your Azure subscription GUID. ii. Generating Azure Service Principal ID Name and Azure Service Principal ID Secret: Login to Azure Portal and click on Cloud Shell as shown: a. Execute: $ az group create --name "resource_group_name" --location "eastus". b. Execute: $ az ad sp create-for-rbac --role="contributor" -- scopes="/subscriptions/<subscription_id>/resourcegroups/<resource_group_ 2018 by Kony, Inc. All rights reserved 18 of 80

19 2. Kony Fabric on Azure Installation Guide name>" After executing the above command, a json response will be displayed on the command prompt. { "appid": "APP_ID", "displayname": "ServicePrincipalName", "name": " "password":..., "tenant": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" } In the properties file of the conf directory: SERVICE_PRINCIPAL_CLIENT_ID is the value of the appid. SERVICE_PRINCIPAL_CLIENT_SECRET is the value of the password. Note: The values of the SERVICE_PRINCIPAL_CLIENT_ID and SERVICE_ PRINCIPAL_CLIENT_SECRET should not contain any quotation marks. For example: SERVICE_PRINCIPAL_CLIENT_ID = a5afa c-436c-ca4f-f442027cfd2e SERVICE_PRINCIPAL_CLIENT_SECRET = cx4q44eq-fq7a-450v-zf d1eb by Kony, Inc. All rights reserved 19 of 80

20 2. Kony Fabric on Azure Installation Guide 2. Azure Location - This is the location of the Azure Resource group. Note: Azure AKS is supported only in eastus, westeurope, centralus, canadacentral, canadaeast. 3. SSH Public Key - You need this to configure all the Linux machines with the SSH RSA public key string. 4. IS_SSL_ENABLED Flag to enable/ disable SSL on Kony Fabric setup. This flag is set to false by default. If you require SSL, set this parameter to true, place the SSL cert (in a.pfx file format) in the ssl-cert folder, and then provide the Server Domain Name and AppGateway SSL Cert Password. 5. Server Domain Name - This is the external server domain that you need to map with the Azure Application Gateway DNS name. 6. AppGateway SSL Cert Password This is the Password used for getting the pfx key for the SSL offloading. 7. AZURE_LOG_ANALYTICS_ENABLED Flag to enable Azure Operations Management Suite (OMS) Log analytics solution. 8. AZURE_LOG_ANALYTICS_SERVICE_TIER - Service tier for Azure log analytics. The allowed values are Free, Standalone, and PerNode.The Free Tier is applicable only if you created your Azure account before 02-April This tier has a 500MB limit on the amount of data collected daily and also has a 7-day limit on data retention. If you created your Azure Account after 02-April-2018, you only have the Standalone or PerNode options. If you use the Free tier, the installation throws an error. For information about the pricing of the Standalone and PerNode options, refer to the Azure pricing for Log Analytics. 9. AZURE_LOG_ANALYTICS_DATA_RETENTION_PERIOD This is the data retention period for the logs in log analytics solution (minimum data retention period: 7, maximum data retention period : 738). This value is required if log analytics is enabled. For Free tier, data retention period is not allowed for more than 7 days. For Standalone and PerNode tiers, data is 2018 by Kony, Inc. All rights reserved 20 of 80

21 2. Kony Fabric on Azure Installation Guide retained at no charge for the first 31 days. There is no daily limit for data upload for Standalone or PerNode tiers. 10. Database Type - This is the database type you want to use for hosting Kony Fabric on Azure. The Kony Fabric Containers on Azure Solution supports only the MS SQL Server Database. 11. Database Username - Database Username preferred (other than Admin). Note: Ensure that the value of the DB_NAME parameter in the properties file is unique. An installation error is thrown when a DB service with the same name already exists. 12. Database Password - String containing a minimum of 8 characters and combination of alphanumeric and non-alpha-numeric characters. Important: The Database Username and Database Password provided here must also be used to login to the Database using the Azure Portal. 13. JUMPBOX_ENABLED - Flag to create Jumpbox as a part of the Kony Fabric setup. Set this to false if you do not require Jumpbox. Refer to Appendices for more details on how to connect to the Azure Kubernetes through Jumpbox. Important: After completion of installation, the user must whitelist the URLs that the DevOps would use to Log-in. 14. Automatic Registration Details: PARAMETER DESCRIPTION AUTO_REGISTRATION_USER_ID The id used for Kony Fabric Registration. AUTO_REGISTRATION_PASSWORD The Password used for Kony Fabric Registration by Kony, Inc. All rights reserved 21 of 80

22 2. Kony Fabric on Azure Installation Guide PARAMETER DESCRIPTION AUTO_REGISTRATION_FIRST_NAME The First Name used for Kony Fabric Registration. AUTO_REGISTRATION_LAST_NAME The Last Name used for Kony Fabric Registration. AUTO_REGISTRATION_ENV_NAME - Name of the environment. You can set this in the.properties file Important: The AUTO_REGISTRATION_USER_ID and AUTO_REGISTRATION_ PASSWORD provided here will also be used to login to the Kony Fabric Console. You must provide the following parameters additionally for an Enterprise solution. AKS Node Count - This is the number of worker nodes in the cluster. AKS Node Size - Type of the worker nodes in the cluster. AKS Master Node Count - This is the AKS Master Node Count. 2.5 Script Execution 1. Switch to the directory that contains the kf_setup.sh file and execute the setup script using: $ bash kf_setup.sh 2. Select the Installation mode Trial or Enterprise by Kony, Inc. All rights reserved 22 of 80

23 2. Kony Fabric on Azure Installation Guide 3. Login to your Azure account using the link printed on the screen, and enter the given code for the script to continue the setup process. 4. The Bash prompt prints the Public DNS of the Application Gateway while executing the script. You must map this DNS to your custom Domain Name, if SSL is to be configured. Once the user confirms the mapping on the command line, the script resumes execution and completes the setup. Upon successful completion of the setup, all the Application URLs will be printed on the screen as shown in the image. You can start using Kony Fabric using the Kony Fabric Console URL. The credentials to login to the Console are the same as that of the Auto-registration details provided in the properties file. Once the installation is complete, and you take a backup, you can delete the Virtual Machine created for executing the setup script. To do so, go to the Azure Portal and navigate to the Virtual Machines Tab. Select the VM and confirm its deletion. 2.6 Configuring Visualizer to connect to Kony Fabric on Azure For details about connecting to Kony Fabric Console through Visualizer, refer to Connecting to Kony Fabric by Kony, Inc. All rights reserved 23 of 80

24 2. Kony Fabric on Azure Installation Guide 2.7 Updating the Azure Kubernetes Service Cluster configuration You need to have the current config files if you want to update the AKS cluster configuration. Once the installation is complete, take a backup of the unzipped directory where you installed the konyfabric-containers-azure.zip to perform further updates to the AKS clusters. Important: If you do not have a backup of the unzipped directory, updating the AKS cluster is difficult by Kony, Inc. All rights reserved 24 of 80

25 3. Appendices 3.1 Prerequisite Packages White-list the URL to allow the Kony Fabric Containers on Azure Solution to download Azure CLI. 3.2 Hosting your domain with Azure DNS The Domain Name System, or DNS, is responsible for translating (or resolving) a website or service name to its IP address. Azure DNS is a hosting service for DNS domains, providing name resolution using Microsoft Azure infrastructure. By hosting your domains in Azure, you can manage your DNS records using the same credentials, APIs, tools, and billing as your other Azure services. Follow these steps to create your first DNS zone and record using the Azure Portal: 1. Create a DNS Zone i. Sign in to the Azure portal by Kony, Inc. All rights reserved 25 of 80

26 ii. On the Hub menu, click Create a resource > Networking > and then click DNS zone to open the Create DNS zone page. iii. On the Create DNS zone page enter the following values, then click Create: Setting Value Details Name customdomainname.com The name of the DNS zone 2018 by Kony, Inc. All rights reserved 26 of 80

27 Setting Value Details Subscription [Your subscription] Select a subscription to create the DNS zone in. Resource group Create new: testresourcegroup Create a resource group. The resource group name must be unique within the subscription you selected. Location West US Note: The resource group refers to the location of the resource group, and has no impact on the DNS zone. The DNS zone location is always global, and is not shown. 2. Create a DNS Record i. Go to DNS Zones in the Azure portal and select customdomainname.com DNS zone in the list. ii. At the top of the DNS zone page, select + Record set to open the Add record set page. iii. On the Add record set page, enter the following values, and click OK. In this example, you are creating a CNAME record. Setting Value Details Name www Name of the record by Kony, Inc. All rights reserved 27 of 80

28 Setting Value Details Type CNAME Type of DNS record you want to create. Acceptable values are A, AAAA, CNAME, MX, NS, SRV, TXT, and PTR. For more information about record types, visit Overview of DNS zones and records. TTL 1 Time-to-live of the DNS request. TTL unit Hours Measurement of time for TTL value. IP Address Alias value This value is the Alias that the DNS record resolves. 3. Update Name Servers Once you are satisfied that your DNS zone and records have been set up correctly, you need to configure your domain name to use the Azure DNS name servers. This enables other users on the Internet to find your DNS records. The name servers for your zone are given in the Azure portal: 2018 by Kony, Inc. All rights reserved 28 of 80

29 These name servers should be configured with the domain name registrar (where you purchased the domain name). Your registrar offers the option to set up the name servers for the domain. For more information, refer Delegate your domain to Azure DNS. Note: Currently, Azure DNS does not support purchasing of domain names. If you want to purchase domains, you need to use a third-party domain name registrar. The domains can then be hosted in Azure DNS for management of DNS records. 3.3 Generating a PFX file from PEM Different platforms and devices require SSL certificates to be converted to different formats. Use the following command to generate the.pfx file from a.pem file: $ openssl pkcs12 -inkey private.pem -in public.pem -export -out certificate.pfx -passout pass:xxxxxxxx -certfile more.crt Breaking down the command: 2018 by Kony, Inc. All rights reserved 29 of 80

30 openssl the command for executing OpenSSL pkcs12 the file utility for PKCS#12 files in OpenSSL -export -out certificate.pfx export and save the PFX file as certificate.pfx -inkey privatekey.key use the private key file privatekey.pem as the private key to combine with the certificate. -in infile - input filename -passout p - output file to pass phrase source. Should be passed as pass:<password> -certfile more.crt This is optional, this is if you have any additional certificates you would like to include in the PFX file. 3.4 Extracting Logs from your Application If you want to extract logs from a container, execute the following commands from your terminal: COMMAND LOG $ kubectl config current-context Display the current-context $ kubectl config use-context <cluster-name> Set the default context to the cluster-name if the current context does not point to the Kony Fabric cluster. $ kubectl get pods Lists all the pods $ kubectl logs -f <pod-name> To tail logs from a specific pod $ kubectl logs podname > logs.txt To extract the logs of a specific pod to local file 2018 by Kony, Inc. All rights reserved 30 of 80

31 3.5 Connecting to AKS nodes through Jumpbox 1. Get the Public IP of the Jumpbox from the Azure Portal. 2. Use the following SSH command to connect to the Jumpbox: $ ssh username@publicip The default username is devops and password is Devops@ To log in to Azure Kubernetes node from Jumpbox, you need to get the Private IP of the node from the Azure Portal. 4. Use the private key of the public key you have provided during Kony Fabric installation. Copy the private key to Jumpbox. Make sure you delete the key during logout. 5. Execute the following command to login to AKS node: $ ssh -i key.pem username@privateipofnode The default username is azureuser. 3.6 Log Analytics Microsoft Azure provides OMS (Operation Management Suite) Log Analytics solution to view the application logs. If you enable the flag for installation of log analytics solution (AZURE_LOG_ ANALYTICS_ENABLED) in the properties file, then the Operations Management Workspace is created in the Azure Resource Group. Follow these steps to view the application specific logs: 2018 by Kony, Inc. All rights reserved 31 of 80

32 1. Navigate to 2. On the home page, select the resource group in which the AKS cluster is created. You can find the resource group (AZURE_RESOURCE_GROUP) in the properties file which was used in the Kony Fabric installation. 3. Select Containers solution by Kony, Inc. All rights reserved 32 of 80

33 4. Select Container Monitoring Solution. 5. Select CONTAINER LOGS. 6. In the Log Search page, you need to execute the following queries to fetch the logs by Kony, Inc. All rights reserved 33 of 80

34 ContainerLog where LogEntrySource == "stdout" sort by TimeGenerated desc - To fetch all the logs. ContainerLog where LogEntrySource == "stderr" sort by TimeGenerated desc - To fetch all the error logs Search Logs Using Docker Image Name: If you want to view feature specific (console, identity, integration, engagement, API Portal) logs, select the respective image. Feature Docker image Console Kony-fabric-console Identity Kony-fabric-identity Integration Kony-fabric-integration Engagement Kony-fabric-engagement 2018 by Kony, Inc. All rights reserved 34 of 80

35 Feature Docker image API Portal Kony-fabric-apiportal The image name gets appended to the query when you select the image. Execute the new query to get logs specific to the image by Kony, Inc. All rights reserved 35 of 80

36 Using content When you want to search specific key word in the logs execute the following query: ContainerLog where LogEntrySource == "stdout" where Image == "<image-name>" sort by TimeGenerated desc search "<keyword>" 2018 by Kony, Inc. All rights reserved 36 of 80

37 You can also apply filters to the logs. Filters can be applied to any column. Using request ID 2018 by Kony, Inc. All rights reserved 37 of 80

38 To view the logs based on request id, you need to apply a filter on the Log Entry column. Using date range You can select custom date range to access the logs. By pod name You can fetch the logs specific to a pod in the kubernetes cluster by Kony, Inc. All rights reserved 38 of 80

39 Feature Pod name prefix Console K8s_Kony-fabric-console Identity K8s_Kony-fabric-identity Integration K8s_Kony-fabric-integration Engagement K8s_Kony-fabric-engagement Api Portal K8s_Kony-fabric-apiportal 3.7 New Relic Monitoring New Relic is a monitoring system that enables you to understand the performance of the application, dependencies, bottlenecks, and also increases the efficiency and accuracy. New Relic enables you to: Get a complete overview of the application and the operating environment. Manage your application's performance by Kony, Inc. All rights reserved 39 of 80

40 Identify and troubleshoot bottlenecks. Analyze data about customers' usage and experience. Monitor your technical resources and ecosystem. Monitoring of Kony Fabric on Azure using New Relic is performed at two levels: Infrastructure Monitoring Application Performance Monitoring Infrastructure Monitoring enables you to monitor node-level metrics like CPU, Memory, Disk Usage, Average load, and I/O metrics. Application Performance Monitoring enables you to view application performance trends like page load times, error rates, slow transactions, and a list of servers running the application in the real-time. It helps in identifying and troubleshooting the issues and metrics of Transactions, Databases, JVM's, Error analytics of each pod individually Enabling New Relic Monitoring in Microsoft Azure Cloud You must have a New Relic license key to enable New Relic Monitoring in Microsoft Azure cloud. For more information, refer license key. Follow these steps to enable New Relic Monitoring in Microsoft Azure cloud: To enable New Relic Infrastructure Monitoring, change the value of NEW_RELIC_INFRA_ MONITORING_ENABLED to true in the trial.properties or enterprise.properties file. To enable New Relic Application Performance Monitoring, change the value of NEW_ RELIC_APP_PERF_MONITORING_ENABLED to true in the trial.properties or enterprise.properties file. Provide the New Relic Authorized license key for the NEW_RELIC_LICENSE_KEY parameter in the trial.properties or enterprise.properties file by Kony, Inc. All rights reserved 40 of 80

41 3.7.2 Accessing New Relic Monitoring Data Follow these steps to view the business insights or application performance results: 1. Create a New Relic account to get the required NEW_RELIC_LICENSE_KEY to enable the New Relic Monitoring feature. 2. Sign in to the New Relic portal by providing your credentials at 3. Choose the required monitoring option in the upper left corner of the New Relic portal. Select APM for Application Performance Monitoring and INFRASTRUCTURE for Infrastructure 2018 by Kony, Inc. All rights reserved 41 of 80

42 Monitoring by Kony, Inc. All rights reserved 42 of 80

43 Application Performance Monitoring In APM, you can view the metrics of Kony Fabric Kubernetes pods deployed on Microsoft Azure Kubernetes cluster. Select a specific pod to view the performance metrics of that pod by Kony, Inc. All rights reserved 43 of 80

44 You can view various application performance metrics by selecting the options from the left navigation pane by Kony, Inc. All rights reserved 44 of 80

45 Distributed tracing lets you trace the path of a single request in a complex system. You can understand the entire chain of events, discover the latency of that complete request, and know which step in the path is creating a bottleneck. Service maps show the connections and dependencies of your app, including databases and external services. Health indicators and performance metrics show you the current operational status for every part of your architecture. The Transactions screen provides an overview of the throughput metrics and the top five timeconsuming transactions. A transaction trace gives a detailed snapshot of a single transaction in your application. It records the available function calls, database calls, and external calls. You can use transaction traces to troubleshoot performance issues and get detailed low-level insight into how your app is working. The Databases screen provides a detailed overview of the performance of your database - pointing out critical errors that are slowing down your application. The database overview 2018 by Kony, Inc. All rights reserved 45 of 80

46 provides a stack ranking of the most time-consuming database calls along with aggregated metrics around response times, throughput, and slow SQL traces. The External services screen captures calls to out-of-process services such as web services, resources in the cloud, and any other network calls. The external services dashboard provides charts with your top five external services by response time and external calls per minute by Kony, Inc. All rights reserved 46 of 80

47 The JVMs screen captures metrics that include thread activity, HTTP session data, connection pool metrics, class load (or) unload counts, and so on by Kony, Inc. All rights reserved 47 of 80

48 Infrastructure Monitoring In the Infrastructure portal of New Relic Monitoring, you can view the Infrastructure metrics of Kony Fabric. You can view various infrastructure level metrics by selecting different options from the top navigation pane by Kony, Inc. All rights reserved 48 of 80

49 The Hosts screen helps you understand the performance metrics such as CPU usage, load average, and memory used. The Network screen provides real-time visibility into the health and performance of individual hosts, web servers, or other groups of resources across your network. Charts include bandwidth metrics by packet, bandwidth by bytes, and errors per second by Kony, Inc. All rights reserved 49 of 80

50 The Storage screen allows you to monitor the capacity and efficiency of your resources, overall utilization, disk usage, or I/O operations by Kony, Inc. All rights reserved 50 of 80

51 The Processes screen lets you view information about the processes running on your infrastructure and set alerts on process metrics. The Inventory screen provides a real-time view to filter and search the inventories in each host's configuration The Events screen is a live feed of important system and host activity; including inventory change events, configuration changes, and log analytics events. The event feed helps you understand the correlations between the events and the performance of your system. You can search and filter your events to decrease the mean time to detect and repair the infrastructure issues. The INSIGHTS tab leverages the data from New Relic's other products to allow you to analyze user behavior, business transactions, customer insights, and more. Using the Insights interface, you can quickly and easily build dashboards to identify problems with your apps and hosts in real-time or to track ongoing data trends by Kony, Inc. All rights reserved 51 of 80

52 Select a Dashboard from Kubernetes insights window to view the data about container CPU usage, container memory usage, container restarts, resources used etc. 3.8 Rolling Updates Microsoft Azure provides rolling updates feature to update the deployment with zero downtime by incrementally updating the pod instances with new pods by Kony, Inc. All rights reserved 52 of 80

53 Using the rolling updates feature, you can perform the following actions: Update kubernetes pod configuration. o Update the properties in the deployment section. o Update the -d parameters. Increase or decrease the pod count. Update the docker image of the container present in the pod Prerequisites Following are the prerequisites to perform rolling updates: Linux machine with Ubuntu installed. Unzipped directory of the Kony Fabric installation zip (Use the same unzipped directory of the Kony Fabric installation which was used for the initial Kony Fabric setup). Note: You can update the following Kony Fabric pods using the rolling update feature: kony-fabric-apiportal kony-fabric-console kony-fabric-engagement kony-fabric-identity kony-fabric-integration Execute Rolling Updates in Azure kubernetes Cluster To execute the rolling updates in Azure kuberenetes cluster, perform the following steps by Kony, Inc. All rights reserved 53 of 80

54 1. Log on to the Linux machine. 2. Perform the following actions in the unzipped directory of the Kony Fabric on Azure setup. a. Provide the inputs in the properties file. b. Execute the kf_setup.sh script. c. Execute kubectl commands to check the latest status of pods. Note: Upgrade one pod at a time for smooth roll out of upgrade process. Modify the properties file for the specific pod you want to upgrade, and execute the script. Once the new pod is created, repeat the process for other pods Provide Inputs in Properties File Note: Use the same properties file that was used to create the cluster. Make sure that all the values (AZURE_RESOURCE_GROUP, AZURE_SUBSCRIPTION_ID, SERVICE_PRINCIPAL_CLIENT_ID, SERVICE_PRINCIPAL_CLIENT_SECRET, AZURE_ LOCATION, SSH_PUBLIC_KEY, SERVER_DOMAIN_NAME, NEW_RELIC_LICENSE_KEY, Azure DB service parameters, Azure Redis cache details) match with the existing cluster. For Non-SSL cloud, SERVER_DOMAIN_NAME must be the Domain Name of the Azure Application Gateway. For example, <random_value>.cloudapp.net. You can find the Domain Name in Azure console using the following path: Home > resource group > application gateway > Frontend public IP address For SSL Cloud, SERVER_DOMAIN_NAME must be the External Domain Name. To execute the rolling update for a pod, set the values of the following parameters in the properties file: 2018 by Kony, Inc. All rights reserved 54 of 80

55 MAX_SURGE - The number of pods that are created in addition to the desired number of pods during rolling update. Once the roll out is complete, the number of pods are reduced to the desired number of pods. MAX_SURGE is set to one in the properties file, by default. For example, if the number of pods is three, and maxsurge= 1, then there are at most four pods during the update process. Once the roll out is complete, the number of pods will be three. MAX_UNAVAILABLE - The maximum number of pods that can be unavailable during the update process. MAX_UNAVAILABLE is set to one in the properties file, by default. For example, If the number of pods is three, and maxunavailable=1, then there will be at least two pods in service during the update process. Once the roll out is complete, the number of pods will be three. Note: The values of MAX_SURGE and MAX_UNAVAILABLE must not be zero simultaneously Execute the kf_setup.sh Script 1. Make sure the current directory is /azure. 2. Execute the kf_setup.sh script using the $bash kf_setup.sh command. 3. Select the installation mode of the cloud that you want to upgrade (If the setup was done in enterprise mode, then select enterprise; otherwise, select trial mode) by Kony, Inc. All rights reserved 55 of 80

56 4. Select the execution mode. For rolling updates, select Update. 5. If a database upgrade is required, choose to execute flyway migration. Otherwise, skip the flyway migration Execute kubectl Commands to Check Latest Status of Pods Execute the following actions to check the latest status of the pods Open a new terminal instance on the Linux machine. While the rolling update is in progress, execute the following command in the terminal to view the current state of the pod: $kubectl get pods $kubectl get deployments Wait till the desired and available counts for the specific pod are equal by Kony, Inc. All rights reserved 56 of 80

57 If you want to upgrade other pods, repeat the process Update kubernetes Pod Configuration Modify the Properties in Deployment Section The kubernetes rolling update allows you to update the values in the deployment object for every deployment of the Kony Fabric pod. You can update the following values in the kubernetes cluster: Number of Pods Docker image Readiness init delay Liveness probe init delay Update the values in the properties file based on your requirement. The image displays the options available to upgrade the Integration pod: 2018 by Kony, Inc. All rights reserved 57 of 80

58 Modify -d parameters for the Pod Perform the following actions to modify other parameter values for the pod: Edit the required values in the properties file. Increase the value of readiness_init_delay (or) liveness_init_delay of the pod by one second so that the kubernetes rolling update for the pod will get triggered. Note: The kubernetes rolling update starts only when the parameter values in the deployment object are modified. To modify the -d parameters in the configmap section, edit the liveness (or) readiness probe delay to perform the rolling update. Note: Consider a scenario where your Kony Fabric setup does not contain New Relic Monitoring enabled, and you obtain the license key later. You can enable new relic on your Kony Fabric setup by setting the following values to true. NEW_RELIC_INFRA_MONITORING_ENABLED = true NEW_RELIC_APP_PERF_MONITORING_ENABLED = true 2018 by Kony, Inc. All rights reserved 58 of 80

59 Provide the license key value in the properties file NEW_RELIC_LICENSE_KEY = <value> You must increase the value of readiness (or) liveness probe by one second for a pod to trigger the rolling update and enable the new relic agent in the pod. Perform the rolling update Increase (or) Decrease Pod Count To increase the pod count, make sure that the kubernetes worker nodes (Azure VM s) are scaled properly, and the number of pods is equal to the number of worker nodes. For example, if you want to increase the integration pod count to three, then the number of worker nodes must be three Increasing kubernetes Worker Nodes in Azure 1. Sign In to Microsoft Azure Console. 2. Select the resource group in which the AKS Cluster is created. 3. Select the Scale option on the cluster home page, increase (or) decrease the count of worker nodes based on your requirement. Save the configuration by Kony, Inc. All rights reserved 59 of 80

60 Increase (or) Decrease the Number of Pods After increasing (or) decreasing the number of worker nodes (Azure VM s), you can modify the pod count by following the given steps: 1. Modify the node count of the pod in the properties file. 2. Execute the kf_setup.sh file as described in the earlier section by Kony, Inc. All rights reserved 60 of 80

61 3.8.5 Update the Docker Image of the Container inside the Pod Modify the docker image in the properties file. Execute the kf_setup.sh file as described in the earlier section. 3.9 Kubernetes Dashboard Azure Kubernetes Service (AKS) includes a web dashboard which can be used to view kubernetes objects such as deployments, pods, configmaps, and so on. Using the kubernetes dashboard, you can also view pod metrics such as CPU Usage, Memory Consumption, and so on Prerequisites Following are the prerequisites to use the Kubernetes dashboard: Linux machine with Ubuntu installed A valid Azure account AKS Cluster deployed in Azure 2018 by Kony, Inc. All rights reserved 61 of 80

62 3.9.2 Steps to Initialize Kubernetes Dashboard in Browser Following are the steps to initialize kubernetes dashboard in browser: 1. Sign in to the Azure portal. 2. Select the Resource Group in which the kubernetes cluster is created. 3. In the list of resources, select the created kubernetes cluster. 4. Select the View Kubernetes dashboard tab in the lower-right corner of the screen. The configuration screen appears: 2018 by Kony, Inc. All rights reserved 62 of 80

63 5. Follow these steps to initialize the kubernetes dashboard i. You must have Azure CLI of version or above installed. If it is not installed, run the following command to install it: $az aks install-cli ii. Change the current context of the deployed cluster by running the following command: $az aks get-credentials --resource-group <resource group name> --name <aks cluster name> iii. Run the following command to connect the cloud to the web UI: $az aks browse --resource-group <resource group name> --name <aks cluster name> The kubernetes dashboard is rendered on the browser. You can view the summary of all the aspects of the cloud like daemon sets, jobs, pods, CPU usage, memory usage, and so on by Kony, Inc. All rights reserved 63 of 80

64 Select options from the left navigation pane to view the detailed information of various analytics. For example, select Daemon Sets to view the analytics specific to daemon sets by Kony, Inc. All rights reserved 64 of 80

65 3.9.3 Viewing an Application Select Pods from the left pane to view the information about each pod by Kony, Inc. All rights reserved 65 of 80

66 Click Services from the left pane to get the IP address of the application. You can also view more information about daemon sets, replica sets, replication controllers, jobs, deployments, pods, and stateful sets VPN Reference Implementation Note: VPN Reference Implementation is documented assuming that the FortiGate Firewall is used on the On-Premise setup. If you are using any other firewall, contact your system administrator for setting up the incoming policies from Kony Fabric set up on Microsoft Azure Cloud. A Site-to-Site VPN gateway connection is used to connect your on-premises network to an Azure virtual network over an IPsec or IKE (IKEv1 or IKEv2) VPN tunnel. This type of connection requires an on-premises VPN device that has an externally facing public IP address assigned to it. Follow the steps described here to setup a site-to-site VPN by Kony, Inc. All rights reserved 66 of 80

67 Virtual Private Network (VPN) Reference Implementation: Site-to-Site tunnel between Microsoft Azure and On-Premise Network with FortiGate Firewall This document outlines the process required to set up a site-to-site tunnel between an Azure network and an on-premise network with FortiGate Firewall. Note: VPN Reference Implementation is documented assuming that the FortiGate Firewall is used on the On-Premise setup. If you are using any other firewall, contact your system administrator for setting up the incoming policies from Kony Fabric set up on Microsoft Azure Cloud. The following steps help you to implement a VPN connection between Microsoft Azure and an On- Premise Network: 1. Create the Azure Virtual Network 2. Create the Gateway Subnet 3. Create the Virtual Network Gateway Object 4. Create the Local Network Gateway Object 5. Create Site-to-Site VPN Step 1. Create the Azure Virtual Network From the Azure portal, click New and start typing Virtual network into the search field, then click on Virtual network by Kony, Inc. All rights reserved 67 of 80

68 Name: Provide the name for the Virtual Network object in Azure. Address space: Provide a subnet IP Address and ensure that it does not overlap with your onpremises IP address space. Pick an address that is outside the range of your local subnets.for example, /16. Resource group: Creates an object in Azure called a Resource group (a container with items related to one another). Location: Places your network into a specific Microsoft datacenter. You cannot connect a virtual machine from a different datacenter to this virtual network. Subnet: Provide a Name and an Address range. You can provide the same details, or a sub-set of the details (saving additional space for later use), that you provided in the Address space. For example, /24. Once you configure all the fields, click Create to complete the setup by Kony, Inc. All rights reserved 68 of 80

69 Step 2. Create the Gateway Subnet You need an internal gateway in your network that Azure can use to route traffic back to your onpremises environment. 1. After your virtual network is built, select it from All resources. 2. On the left menu, select Subnets. 3. Click the option to add a Gateway subnet. Note: Azure picks an address range within the space you previously defined. In the given example, it uses /24 as the GatewaySubnet. You cannot pick any other name as this is how Azure knows what the subnet is for by Kony, Inc. All rights reserved 69 of 80

70 4. Click OK Step 3. Create the Virtual Network Gateway object You need a software VPN service which is the endpoint for your firewall. The VPN is called a Virtual network gateway in Azure. Follow these steps to create a new Virtual network gateway: 1. Go to New. 2. Search for Virtual network gateway, and select it from the search results. 3. On the next screen, Click Create by Kony, Inc. All rights reserved 70 of 80

71 Enter the following details: Name: Provide a name that matches with the name of your virtual network. Gateway type: Select VPN. VPN type: Select Route-based VPN. SKU: Select Basic, as it fits the requirements of most SMBs (Server Message Blocks). Virtual network: Choose the Virtual Network that you created. Public IP address: To create a new Public IP Address: Click on Create new, give it a name, and click OK. It is recommended to append IP to the name that matches the gateway object you create by Kony, Inc. All rights reserved 71 of 80

72 Choose your Subscription and your Location (make sure that you match it with your other resources), and click Create. The creation of the virtual network gateway may take some time to complete Step 4. Create the Local Network Gateway object You must create another object to represent your local on-premises network, so that Azure knows your location, and what is behind your firewall. Basically, this defines your on-premises IP address space, as well as an endpoint or gateway (the public IP assigned to your firewall). Search for Local network gateway and click Add by Kony, Inc. All rights reserved 72 of 80

73 Enter the following details: Name: Provide a name that is distinct from the Azure Gateway. IP address: This is your firewall s primary public IP address. Address space: Add all the internal subnets that exist behind your firewall. The Azure virtual network requires routes to these subnets by Kony, Inc. All rights reserved 73 of 80

74 Note: Include only those subnets that require communication with the Azure virtual network. Subscription: Select your subscription type. Resource group: Choose your resource group. Location: Select the same location as you did during the creation of the Azure Virtual Network. After entering all these details, click Create Step 5. Create Site-to-Site VPN Go to More Services > Virtual network gateways > Connections > Add 2018 by Kony, Inc. All rights reserved 74 of 80

75 Name: Provide a name related to the Azure Virtual network that you are creating. Connection type: From the drop-down, select Site-to-Site (IPSec). Local network gateway: Select the Local network gateway that you created. Shared key (PSK): Provide a complex string and save it securely. You must provide this key on your on-premises firewall. After entering these details, click OK by Kony, Inc. All rights reserved 75 of 80

76 On-Prem FortiGate Firewall configuration Log in to Fortinet and go to the VPN tab. Configure both the phases based on the following sections: Phase 1 Configuration Click the Auto Key (IKE) Tab and create Phase 1. Fill out the IP address with the Azure Virtual GW IP. Under P1 Proposal, ensure the following: Encryption must be AES256. This is mandatory for the FortiGate Vendor. Authentication must be SHA1. Key life must be Enable NAT translation by Kony, Inc. All rights reserved 76 of 80

77 Phase 2 Configuration Click Auto Key (IKE) Tab and create Phase 2. Under Phase 2, set Local Address to the local subnet and Remote Address to the VPN tunnel endpoint subnet (present at the Virtual Network Address Spaces in Microsoft Azure) Policies Follow these steps to create the FortiGate firewall policies: Go to Policy & Objects > Policy Create a new policy for the site-to-site connection that allows outgoing traffic. Set the Source Address and Destination Address using the Firewall objects you just created. Create another policy for the same connection to allow incoming traffic and swap the Source Address and Destination Address by Kony, Inc. All rights reserved 77 of 80