Difference between revisions of "Getting started with KHIKA"

From khika
Jump to navigation Jump to search
 
(22 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
== Introduction ==
 
== Introduction ==
  
When setting up and configuring KHIKA in your organisation network, you need to perform few steps and shall find this page helpful for the same.  
+
When setting up and configuring KHIKA in your own network, you need to perform few steps and shall find this page helpful for the same.  
For more information on KHIKA components you can click [[KHIKA Components|here]].
+
For more information on KHIKA components you can click [[KHIKA Components|here]]. When you install KHIKA on-premise, you are responsible for administration and managing entire life cycle of the data. You must have a valid support account and a sales contact from KHIKA for hosting KHIKA on-premise.
  
 
== KHIKA Virtual Appliance ==
 
== KHIKA Virtual Appliance ==
  
KHIKA is available as a Virtual Appliance which can be provisioned on your organisation’s VMware platform. There is at least one KHIKA core app server VM. In addition, there can be optional collector nodes or KHIKA aggregator VMs, one at each location where the data sources are present.
+
KHIKA is shipped as a Virtual Appliance (popularly called as KHIKA VA) in the form of an OVA file which can be provisioned on your VMware platform. KHIKA virtual appliance bundles everything you need to run KHIKA on-premise, including the OS. Please note that KHIKA Virtual Appliance  (aka KHIKA VA) is '''NOT available''' for download on demand. You must contact our sales for evaluating KHIKA on-premise. When you decide to install KHIKA on-premise, you must install at least one KHIKA core app server VM. In addition, there can be optional collector nodes or KHIKA aggregator VMs, one at each location where the data sources are present.
For more information refer to [[KHIKA Data Aggregator]].
+
For more information refer to [[KHIKA Data Aggregator]]. Note that when you use KHIKA SaaS, you just have to install KHIKA Data Aggregator node as KHIKA core is managed by us in cloud.
  
Download the [https://goo.gl/74kRRi KHIKA Virtual Appliance] in the form of a .ova file on your VMware platform.  
+
Contact info@khika.com for availing evaluation version of KHIKA Virtual Appliance (aka KHIKA VA).
  
===== Pre requisites for KHIKA VA =====
+
=== Pre requisites for KHIKA VA ===
  
We recommend following hardware resources to be allocated to the KHIKA VMs for optimum performance.
+
'''Hardware sizing for PoC and testing : - All KHIKA components on one single server'''
 +
 
 +
CPU= 8 vCPU <br/>
 +
Memory = 16GB <br/>
 +
Disk1=500GB (for KHIKA Application, OS etc) <br/>
 +
Network= Fast ethernet with static IP <br/>
 +
OS: Bundled with KHIKA Virtual Appliance <br/>
 +
Note that we do not recommend this configuration in production. '''This is just for testing'''. Please check section below for hardware sizing suggested for your production environment.
 +
 
 +
 
 +
In production we recommend installing KHIKA on '''at least two separate servers''', one for KHIKA Central and one for KHIKA Data Aggregator
  
 
'''KHIKA Central Server'''
 
'''KHIKA Central Server'''
Line 20: Line 30:
 
Memory = 64GB <br/>
 
Memory = 64GB <br/>
 
Disk1=500GB (for KHIKA Application, OS etc) <br/>
 
Disk1=500GB (for KHIKA Application, OS etc) <br/>
Disk1 = 2 TB (to begin with for storing KHIKA data.) <br/>
+
Disk1 = 2 TB (To begin with for storing KHIKA data. This '''must be''' an SSD or 15000RPM disk) <br/>
 
Network= Fast ethernet with static IP <br/>
 
Network= Fast ethernet with static IP <br/>
 
OS: Bundled with KHIKA Virtual Appliance <br/>
 
OS: Bundled with KHIKA Virtual Appliance <br/>
Line 26: Line 36:
 
'''KHIKA Aggregator'''
 
'''KHIKA Aggregator'''
  
CPU= 16 vCPU <br/>
+
CPU= 6 vCPU <br/>
Memory = 16 GB (to process incoming volume of data with high speed) <br/>  
+
Memory = 8 GB (to process incoming volume of data with high speed) <br/>  
 
Disk1= 500GB (for KHIKA Application, OS etc) <br/>
 
Disk1= 500GB (for KHIKA Application, OS etc) <br/>
Disk1 = 500GB (to store immediate data and some buffer in case of connection loss) <br/>
 
 
Network= Fast ethernet with static IP <br/>
 
Network= Fast ethernet with static IP <br/>
 
OS: Bundled with KHIKA Virtual Appliance <br/>
 
OS: Bundled with KHIKA Virtual Appliance <br/>
 +
These two servers should be able to handle data up to 100GB per day.
  
Minimum Hardware sizing you require depends on the volume of your data. You can refer the table below :
+
Minimum Hardware sizing required for running KHIKA depends on the volume of your data (Events Per Second or GB per day). You can refer the table below for rough idea :
  
 
{| class="wikitable"
 
{| class="wikitable"
|+ style="caption-side:bottom; color:#e76700;"|''Hardware calculation Table''
+
|+ style="caption-side:bottom; color:#e76700;"|''Server sizing calculation Table''
 
|-
 
|-
 
|'''Data expected in GBs per day'''
 
|'''Data expected in GBs per day'''
Line 48: Line 58:
 
|500G <br/> SSD or 15K RPM
 
|500G <br/> SSD or 15K RPM
 
|-
 
|-
|24 to 48
+
|24 to 100
 
|12
 
|12
 
|64
 
|64
 
|500G <br/> SSD or 15K RPM
 
|500G <br/> SSD or 15K RPM
 
|-
 
|-
|48GB and more
+
|100GB and more
 
|colspan="3"| Needs customized distributed architecture (contact sales for Professional Services)  
 
|colspan="3"| Needs customized distributed architecture (contact sales for Professional Services)  
  
Line 59: Line 69:
 
|}
 
|}
  
 
+
=== Import the KHIKA Virtual Appliance ===
 
 
== Import the KHIKA Virtual Appliance ==
 
  
 
Download or transfer the KHIKA VA .ova file on the required server. This section considers a VMware Workstation environment in which we shall setup the KHIKA VA.  
 
Download or transfer the KHIKA VA .ova file on the required server. This section considers a VMware Workstation environment in which we shall setup the KHIKA VA.  
Line 84: Line 92:
  
  
== Allocate Resources ==
+
=== Allocate Resources ===
  
 
In the left panel, we can see the name of our virtual image. Right click on it go to Settings.  
 
In the left panel, we can see the name of our virtual image. Right click on it go to Settings.  
Line 106: Line 114:
  
 
Please ensure the hardware pre requisites discussed in the section above, are present on your server, so that it can be allocated to the VM.
 
Please ensure the hardware pre requisites discussed in the section above, are present on your server, so that it can be allocated to the VM.
 +
 +
 +
=== Boot the Appliance ===
 +
 +
Now click on the option “Play virtual machine”
 +
 +
 +
[[File:Boot1.jpg|600px]]
 +
 +
 +
The VM shall boot after this step.
 +
 +
 +
[[File:Boot2.jpg|600px]]
 +
 +
 +
After booting successfully, you shall be prompted to login into KHIKA.
 +
 +
 +
=== Allocate static IP Address ===
 +
 +
KHIKA is shipped as a Virtual Appliance with only one network interface by default, which is the 'loopback' interface with IP address of 127.0.0.1. This means, you cannot connect externally to this VM unless you provide an IPv4 IP Address to this VM.
 +
Assign a static IP address to each VM. All the data sources and configurations done further will refer to the VMs using their IP address only. Any change in this, shall make all configurations ineffective and incoming data may stop due to the same.
 +
Login using user name = khika and password = khika123 (default values) on the console terminal.
 +
At the prompt, enter command “sudo nmtui”. A “Network Manager TUI” pop up appears.
 +
 +
 +
[[File:Nmtui1.jpg|600px]]
 +
 +
 +
Select "Edit a Connection" and a pop up shall appear. Select the device (i.e. newly added network interface) that you have already added before booting the VM. Scroll to “Edit”
 +
 +
 +
[[File:Nmtui2.jpg|600px]]
 +
 +
 +
Following screen appears
 +
 +
 +
[[File:Nmtui3.jpg|600px]]
 +
 +
 +
Here instead of Automatic, select “Manual” - since you have to provide a static address to this VM. We highly recommend you provide static IP to the ‘MARS’ Virtual Appliance. (You may select to provide an automatic IP address to your VM using the DHCP which is not recommended as this IP may change after a reboot. Using a DHCP assigned IP is not recommended as it may cause various connectivity issues in the future.)
 +
 +
 +
[[File:Nmtui4.jpg|600px]]
 +
 +
 +
Provide IPv4 Address, Gateway, DNS Server and all other required details on this screen.
 +
(Use TAB and Arrow keys to navigate)
 +
You may need to consult your network administrator at this stage to get the correct IP Address to allocate to this VM, Gateway, DNS Servers etc
 +
 +
 +
[[File:Nmtui5.jpg|600px]]
 +
 +
 +
Select "OK" And "Quit”
 +
It will display a message “Khika will be configured to use IP address: 192.168.1.45. Do you want to continue(Y/N)?” (You will see the IP address allocated in previous step here)
 +
 +
 +
[[File:Nmtui6.jpg|600px]]
 +
 +
 +
Enter Y for Yes and KHIKA Application Server will be configured to use this particular IP. It will ask you to set time zone. Please enter appropriate value according to your time zone.
 +
 +
 +
[[File:Nmtui7.jpg|600px]]
 +
 +
 +
It will ask for time zone confirmation.
 +
 +
 +
[[File:Nmtui8.jpg|600px]]
 +
 +
 +
Enter 1 for Yes if time is shown correctly. After confirming the information, KHIKA will start automatically.
 +
 +
 +
=== Firewall Settings ===
 +
 +
Following ports will have to be opened on your firewall for communicating with KHIKA and the VM.
 +
 +
{| class="wikitable"
 +
|-
 +
! Purpose !! Port !! Protocol !! Description
 +
|-
 +
| SSH|| 22 || TCP|| SSH is required for maintenance and administration activities such as applying patches, restart and routine maintenance
 +
|-
 +
| Web GUI for KHIKA || 80, 443|| TCP || KHIKA Web Server listens on port 80 and 443. The ‘http’ requests to port 80 will be automatically redirected to ‘https’ port 443
 +
KHIKA supports Google Chrome browser only
 +
|-
 +
| Syslog (Required for syslog based data collection)|| 514 || TCP and UDP || ‘KHIKA’ Server listens on port 514 for syslog messages. The Network Devices typically send their messages to KHIKA using syslog protocol.
 +
 +
|}

Latest revision as of 01:15, 27 March 2020

Introduction

When setting up and configuring KHIKA in your own network, you need to perform few steps and shall find this page helpful for the same. For more information on KHIKA components you can click here. When you install KHIKA on-premise, you are responsible for administration and managing entire life cycle of the data. You must have a valid support account and a sales contact from KHIKA for hosting KHIKA on-premise.

KHIKA Virtual Appliance

KHIKA is shipped as a Virtual Appliance (popularly called as KHIKA VA) in the form of an OVA file which can be provisioned on your VMware platform. KHIKA virtual appliance bundles everything you need to run KHIKA on-premise, including the OS. Please note that KHIKA Virtual Appliance (aka KHIKA VA) is NOT available for download on demand. You must contact our sales for evaluating KHIKA on-premise. When you decide to install KHIKA on-premise, you must install at least one KHIKA core app server VM. In addition, there can be optional collector nodes or KHIKA aggregator VMs, one at each location where the data sources are present. For more information refer to KHIKA Data Aggregator. Note that when you use KHIKA SaaS, you just have to install KHIKA Data Aggregator node as KHIKA core is managed by us in cloud.

Contact info@khika.com for availing evaluation version of KHIKA Virtual Appliance (aka KHIKA VA).

Pre requisites for KHIKA VA

Hardware sizing for PoC and testing : - All KHIKA components on one single server

CPU= 8 vCPU
Memory = 16GB
Disk1=500GB (for KHIKA Application, OS etc)
Network= Fast ethernet with static IP
OS: Bundled with KHIKA Virtual Appliance
Note that we do not recommend this configuration in production. This is just for testing. Please check section below for hardware sizing suggested for your production environment.


In production we recommend installing KHIKA on at least two separate servers, one for KHIKA Central and one for KHIKA Data Aggregator

KHIKA Central Server

CPU= 16 vCPU
Memory = 64GB
Disk1=500GB (for KHIKA Application, OS etc)
Disk1 = 2 TB (To begin with for storing KHIKA data. This must be an SSD or 15000RPM disk)
Network= Fast ethernet with static IP
OS: Bundled with KHIKA Virtual Appliance

KHIKA Aggregator

CPU= 6 vCPU
Memory = 8 GB (to process incoming volume of data with high speed)
Disk1= 500GB (for KHIKA Application, OS etc)
Network= Fast ethernet with static IP
OS: Bundled with KHIKA Virtual Appliance
These two servers should be able to handle data up to 100GB per day.

Minimum Hardware sizing required for running KHIKA depends on the volume of your data (Events Per Second or GB per day). You can refer the table below for rough idea :

Server sizing calculation Table
Data expected in GBs per day CPU Cores Memory in GB Disk
10 to 24 8 16 500G
SSD or 15K RPM
24 to 100 12 64 500G
SSD or 15K RPM
100GB and more Needs customized distributed architecture (contact sales for Professional Services)


Import the KHIKA Virtual Appliance

Download or transfer the KHIKA VA .ova file on the required server. This section considers a VMware Workstation environment in which we shall setup the KHIKA VA.

In the VMware workstation, start by clicking on “Open a Virtual Machine”


Va1.jpg


A browser window opens which prompts you to select the .ova file, the KHIKA virtual appliance which is present on your local machine. Select the file and click Open. Another pop up window appears where you can rename it if required, or select another file by clicking on “browse” again. Verify the details and click on Import.


Va2.jpg


After the .ova file is successfully imported, it is seen as follows in the VMware workstation


Va3.jpg


Allocate Resources

In the left panel, we can see the name of our virtual image. Right click on it go to Settings.


Ar1.jpg


Following window opens with options to allocate compute resources to this newly created virtual appliance.


Ar2.jpg


Click on the options Memory, Processors, Hard Disk one by one and on the right side of the window, allocate enough resources for the selected component. Click on Add button in the bottom, for additional resources. In the new pop up, select Network Adapter and click on Finish. Network Adapter is required for the VM, so that we can connect using an IP address to this VM.


Ar3.jpg


Please ensure the hardware pre requisites discussed in the section above, are present on your server, so that it can be allocated to the VM.


Boot the Appliance

Now click on the option “Play virtual machine”


Boot1.jpg


The VM shall boot after this step.


Boot2.jpg


After booting successfully, you shall be prompted to login into KHIKA.


Allocate static IP Address

KHIKA is shipped as a Virtual Appliance with only one network interface by default, which is the 'loopback' interface with IP address of 127.0.0.1. This means, you cannot connect externally to this VM unless you provide an IPv4 IP Address to this VM. Assign a static IP address to each VM. All the data sources and configurations done further will refer to the VMs using their IP address only. Any change in this, shall make all configurations ineffective and incoming data may stop due to the same. Login using user name = khika and password = khika123 (default values) on the console terminal. At the prompt, enter command “sudo nmtui”. A “Network Manager TUI” pop up appears.


Nmtui1.jpg


Select "Edit a Connection" and a pop up shall appear. Select the device (i.e. newly added network interface) that you have already added before booting the VM. Scroll to “Edit”


Nmtui2.jpg


Following screen appears


Nmtui3.jpg


Here instead of Automatic, select “Manual” - since you have to provide a static address to this VM. We highly recommend you provide static IP to the ‘MARS’ Virtual Appliance. (You may select to provide an automatic IP address to your VM using the DHCP which is not recommended as this IP may change after a reboot. Using a DHCP assigned IP is not recommended as it may cause various connectivity issues in the future.)


Nmtui4.jpg


Provide IPv4 Address, Gateway, DNS Server and all other required details on this screen. (Use TAB and Arrow keys to navigate) You may need to consult your network administrator at this stage to get the correct IP Address to allocate to this VM, Gateway, DNS Servers etc


Nmtui5.jpg


Select "OK" And "Quit” It will display a message “Khika will be configured to use IP address: 192.168.1.45. Do you want to continue(Y/N)?” (You will see the IP address allocated in previous step here)


Nmtui6.jpg


Enter Y for Yes and KHIKA Application Server will be configured to use this particular IP. It will ask you to set time zone. Please enter appropriate value according to your time zone.


Nmtui7.jpg


It will ask for time zone confirmation.


Nmtui8.jpg


Enter 1 for Yes if time is shown correctly. After confirming the information, KHIKA will start automatically.


Firewall Settings

Following ports will have to be opened on your firewall for communicating with KHIKA and the VM.

Purpose Port Protocol Description
SSH 22 TCP SSH is required for maintenance and administration activities such as applying patches, restart and routine maintenance
Web GUI for KHIKA 80, 443 TCP KHIKA Web Server listens on port 80 and 443. The ‘http’ requests to port 80 will be automatically redirected to ‘https’ port 443

KHIKA supports Google Chrome browser only

Syslog (Required for syslog based data collection) 514 TCP and UDP ‘KHIKA’ Server listens on port 514 for syslog messages. The Network Devices typically send their messages to KHIKA using syslog protocol.