Difference between revisions of "Getting Started with KHIKA SaaS"

From khika
Jump to navigation Jump to search
Line 2: Line 2:
  
 
[[File:Sign_up_1.jpg|user registration form|400px]]
 
[[File:Sign_up_1.jpg|user registration form|400px]]
 +
 +
This will open the User Registration form.
  
 
[[File:Onboarding 2.jpg|user registration form|400px]]
 
[[File:Onboarding 2.jpg|user registration form|400px]]
 +
 +
Fill in all the required details.
 +
 Note that the Customer Name is the brief name of your company and will be used when you login.
 +
 Please make sure to give your official email address as a verification email will be sent on this email ID
 +
 Also, mention a valid phone number as it will be used for recovering your account in future.
 +
 Submit the form by clicking on the Register button.
 +
  
 
[[File:Onboarding 3.jpg|user registration form|400px]]
 
[[File:Onboarding 3.jpg|user registration form|400px]]
 +
 +
On successful User Registration, a pop appears with success message:
  
 
[[File:Onboarding 4.jpg|user registration form|400px]]
 
[[File:Onboarding 4.jpg|user registration form|400px]]
 +
 +
Check your inbox for an email from khika.com.
 +
 Note : If you do not see the email in your inbox, please check your junk folder.
 +
 On opening the email, click on the “Verify Email” button to activate your account.
 +
  
 
[[File:Onboarding 5.jpg|user registration form|400px]]
 
[[File:Onboarding 5.jpg|user registration form|400px]]
 +
 +
You should see a pop-up in your browser mentioning that your email has been verified and you can use your account.
  
 
[[File:Onboarding 6.jpg|user registration form|400px]]
 
[[File:Onboarding 6.jpg|user registration form|400px]]
 +
 +
You will receive confirmation email on your email ID. You can now login into KHIKA SaaS using the customer name, username and password, you had selected at the time of registration.
  
 
[[File:Onboarding 7.jpg|user registration form|400px]]
 
[[File:Onboarding 7.jpg|user registration form|400px]]
 +
 +
When you login for the first time, you do not see any data in Kibana dashboards which is expected. This is simply because we have not added any data yet.
  
 
[[File:Onboarding 8.jpg|user registration form|400px]]
 
[[File:Onboarding 8.jpg|user registration form|400px]]
 +
 +
Before adding any data to KHIKA SaaS, you must configure the KHIKA Data Aggregator.
 +
Click “Configure” from the side menu and go to “Node” tab
 +
KHIKA SaaS has created an Aggregator Node for you and assigned a unique identity to this node.
  
 
[[File:Onboarding 9.jpg|user registration form|400px]]
 
[[File:Onboarding 9.jpg|user registration form|400px]]
 +
 +
Note: DO NOT share this identity with anyone as this is the secret identity you use to communicate with KHIKA. Copy-Paste this identity string into your favourite editor as we will need this when we configure our Data Aggregator VM.
 +
 +
Installing and configuring KHIKA Data Aggregator VM
 +
1. If you are on AWS, you can directly use the ami-81171 for installing KHIKA Data Aggregator in your VPC.
 +
2. If you are not on AWS, you can download the OVA image of KHIKA Data Aggregator from our Google Drive. You will have to add a network interface to KHIKA Data Aggregator while provisioning your VM. Please refer to documentation of VMWare technology you are using.
 +
 Boot the VM and login as user=khika and password=khika123
 +
  
 
[[File:Onboarding 10.jpg|user registration form|400px]]
 
[[File:Onboarding 10.jpg|user registration form|400px]]
 +
 +
 We highly recommend to change the password of user ‘khika’ using ‘sudo passwd’ command. (explain steps or link to steps ? Changing password can be done after configuration as configuration msg comes directly on logging in)
 +
 When you login for the first time KHIKA Data Aggregator takes you through various steps to configure it. Section below explains each step on-by-one
 +
 +
As you login for the first time, KHIKA Aggregator will identify that it is not configured and ask you to configure
 +
  
 
[[File:Onboarding 11.jpg|user registration form|400px]]
 
[[File:Onboarding 11.jpg|user registration form|400px]]
 +
 +
Press “Y” and proceed. This will start CentOS “nmtui” interface to configure the IP address for your KHIKA Aggregator. Select appropriate interface and provide an IP address.
 +
We highly recommend you to consult you network administrator for providing IP address and an internet gateway to your Data Aggregator. Here, we are sharing screenshots for your reference.
 +
 +
Your Data Aggregator must be able to communicate with KHIKA SaaS on internet to following host and TCP port
 +
Host = KHIKA-DATA-GATEWAY-219b38e8fbe34670.elb.ap-south-1.amazonaws.com
 +
Port = 9095
 +
Please ensure your firewall allows this connection
 +
 +
After configuring the network parameters for you Aggregator, KHIKA will prompt you to provide details for your location
 +
  
 
[[File:Onboarding 12.jpg|user registration form|400px]]
 
[[File:Onboarding 12.jpg|user registration form|400px]]
 +
 +
For example, if you are in India, enter number 5 after the hash sign prompted. This input is for Asia.
 +
This will prompt you for your country
 +
  
 
[[File:Onboarding 13.jpg|user registration form|400px]]
 
[[File:Onboarding 13.jpg|user registration form|400px]]
 +
 +
Select your country (enter the appropriate number after the hash sign) and proceed
 +
This will prompt you for time. Verify the time and type 1 for Yes, if appropriate.
 +
  
 
[[File:Onboarding 14.jpg|user registration form|400px]]
 
[[File:Onboarding 14.jpg|user registration form|400px]]
 +
 +
Further, it will prompt you to set the NTP server. We highly recommend to set a proper NTP server here. You can also enter an NTP server on internet
  
 
[[File:Onboarding 15.jpg|user registration form|400px]]
 
[[File:Onboarding 15.jpg|user registration form|400px]]
 +
 +
Type Y at this prompt.
  
 
[[File:Onboarding 16.jpg|user registration form|400px]]
 
[[File:Onboarding 16.jpg|user registration form|400px]]
 +
 +
System then asks you to enter the Server details. Enter the IP address of your NTP server.
  
 
[[File:Onboarding 17.jpg|user registration form|400px]]
 
[[File:Onboarding 17.jpg|user registration form|400px]]
 +
 +
It takes a few moments to connect to the mentioned NTP server and shows details including the synchronisation status. It further asks you to select the nearest KHIKA Data Gateway.
  
 
[[File:Onboarding 18.jpg|user registration form|400px]]
 
[[File:Onboarding 18.jpg|user registration form|400px]]
 +
 +
The nearest data gateway is pre-populated and you can just press “N” to select the default one.
  
 
[[File:Onboarding 19.jpg|user registration form|400px]]
 
[[File:Onboarding 19.jpg|user registration form|400px]]
 +
 +
In the above example, it is seen that the KHIKA Data Gateway is set in “ap-south-1” region.
 +
 +
The next step is crucial one where you set the identity of your KHIKA Data Aggregator.
  
 
[[File:Onboarding 20.jpg|user registration form|400px]]
 
[[File:Onboarding 20.jpg|user registration form|400px]]
 +
 +
This identity is visible in your “Node” tab on KHIKA We GUI. It was seen in this step.  Copy paste this identity below
  
 
[[File:Onboarding 21.jpg|user registration form|400px]]
 
[[File:Onboarding 21.jpg|user registration form|400px]]
  
 
[[File:Onboarding 22.jpg|user registration form|400px]]
 
[[File:Onboarding 22.jpg|user registration form|400px]]
 +
 +
And finally,
  
 
[[File:Onboarding 23.jpg|user registration form|400px]]
 
[[File:Onboarding 23.jpg|user registration form|400px]]
 +
 +
This will configure all the required inputs for KHIKA Data Aggregator and start the services.
 +
Now go to KHIKA Web GUI and check aggregator status
  
 
[[File:Onboarding 24.jpg|user registration form|400px]]
 
[[File:Onboarding 24.jpg|user registration form|400px]]
  
−
[[File:Onboarding 26.jpg|user registration form|400px]]
+
You should see a message indicating your aggregator is successfully connected with KHIKA SaaS
 +
 
 +
[[File:Onboarding 25.jpg|user registration form|400px]]
 +
 
 +
If you do not see this message, click here to go to “trouble shooting connectivity of KHIKA Data Aggregator section”
 +
 
 +
If everything has worked so far, now you can :
 +
[[load a KHIKA App|Load KHIKA App]]
 +
[[configure Data using agent/syslog or appropriate method|Add Ossec device]]
 +
[[start exploring your data in KHIKA|Discover screen check data]]

Revision as of 10:58, 28 May 2019

Go to KHIKA SaaS from Google Chrome browser and click on “Sign Up”.

user registration form

This will open the User Registration form.

user registration form

Fill in all the required details.  Note that the Customer Name is the brief name of your company and will be used when you login.  Please make sure to give your official email address as a verification email will be sent on this email ID  Also, mention a valid phone number as it will be used for recovering your account in future.  Submit the form by clicking on the Register button.


user registration form

On successful User Registration, a pop appears with success message:

user registration form

Check your inbox for an email from khika.com.  Note : If you do not see the email in your inbox, please check your junk folder.  On opening the email, click on the “Verify Email” button to activate your account.


user registration form

You should see a pop-up in your browser mentioning that your email has been verified and you can use your account.

user registration form

You will receive confirmation email on your email ID. You can now login into KHIKA SaaS using the customer name, username and password, you had selected at the time of registration.

user registration form

When you login for the first time, you do not see any data in Kibana dashboards which is expected. This is simply because we have not added any data yet.

user registration form

Before adding any data to KHIKA SaaS, you must configure the KHIKA Data Aggregator. Click “Configure” from the side menu and go to “Node” tab KHIKA SaaS has created an Aggregator Node for you and assigned a unique identity to this node.

user registration form

Note: DO NOT share this identity with anyone as this is the secret identity you use to communicate with KHIKA. Copy-Paste this identity string into your favourite editor as we will need this when we configure our Data Aggregator VM.

Installing and configuring KHIKA Data Aggregator VM 1. If you are on AWS, you can directly use the ami-81171 for installing KHIKA Data Aggregator in your VPC. 2. If you are not on AWS, you can download the OVA image of KHIKA Data Aggregator from our Google Drive. You will have to add a network interface to KHIKA Data Aggregator while provisioning your VM. Please refer to documentation of VMWare technology you are using.  Boot the VM and login as user=khika and password=khika123


user registration form

 We highly recommend to change the password of user ‘khika’ using ‘sudo passwd’ command. (explain steps or link to steps ? Changing password can be done after configuration as configuration msg comes directly on logging in)  When you login for the first time KHIKA Data Aggregator takes you through various steps to configure it. Section below explains each step on-by-one

As you login for the first time, KHIKA Aggregator will identify that it is not configured and ask you to configure


user registration form

Press “Y” and proceed. This will start CentOS “nmtui” interface to configure the IP address for your KHIKA Aggregator. Select appropriate interface and provide an IP address. We highly recommend you to consult you network administrator for providing IP address and an internet gateway to your Data Aggregator. Here, we are sharing screenshots for your reference.

Your Data Aggregator must be able to communicate with KHIKA SaaS on internet to following host and TCP port Host = KHIKA-DATA-GATEWAY-219b38e8fbe34670.elb.ap-south-1.amazonaws.com Port = 9095 Please ensure your firewall allows this connection

After configuring the network parameters for you Aggregator, KHIKA will prompt you to provide details for your location


user registration form

For example, if you are in India, enter number 5 after the hash sign prompted. This input is for Asia. This will prompt you for your country


user registration form

Select your country (enter the appropriate number after the hash sign) and proceed This will prompt you for time. Verify the time and type 1 for Yes, if appropriate.


user registration form

Further, it will prompt you to set the NTP server. We highly recommend to set a proper NTP server here. You can also enter an NTP server on internet

user registration form

Type Y at this prompt.

user registration form

System then asks you to enter the Server details. Enter the IP address of your NTP server.

user registration form

It takes a few moments to connect to the mentioned NTP server and shows details including the synchronisation status. It further asks you to select the nearest KHIKA Data Gateway.

user registration form

The nearest data gateway is pre-populated and you can just press “N” to select the default one.

user registration form

In the above example, it is seen that the KHIKA Data Gateway is set in “ap-south-1” region.

The next step is crucial one where you set the identity of your KHIKA Data Aggregator.

user registration form

This identity is visible in your “Node” tab on KHIKA We GUI. It was seen in this step. Copy paste this identity below

user registration form

user registration form

And finally,

user registration form

This will configure all the required inputs for KHIKA Data Aggregator and start the services. Now go to KHIKA Web GUI and check aggregator status

user registration form

You should see a message indicating your aggregator is successfully connected with KHIKA SaaS

user registration form

If you do not see this message, click here to go to “trouble shooting connectivity of KHIKA Data Aggregator section”

If everything has worked so far, now you can : Load KHIKA App Add Ossec device Discover screen check data

Retrieved from "http://khika.com/wiki/index.php?title=Getting_Started_with_KHIKA_SaaS&oldid=96"