Introduction


Skedler Reports is available as a ready-to-use Amazon Machine Image(AMI) in AWS that can be used to schedule, generate, and distribute PDF, XLS, CSV reports from Elasticsearch Kibana (ELK) applications or Grafana applications with Elasticsearch.   In addition to providing an easy-to-use, affordable ELK, Grafana Reporting Solution, The Skedler Reports AMI solution offers the following advantages to your business:

  • Flexibility: An elastic cloud based infrastructure for running Skedler.
  • Faster Time to Market: Easy to launch and configure the reporting solution since the Skedler AMI is pre-packaged with all the required components such as Ubuntu 16, OpenJDK, and Skedler.    
  • Powerful Custom Reporting for Your Business: An ideal business user ready reporting solution for AWS Elasticsearch Service application, Other Cloud based ELK applications, and On-premise ELK applications.   


Skedler AWS AMI  can connect to the following:

1. ELK or Grafana applications running in your AWS instance

2. Amazon Elasticsearch Service

3. ELK or Grafana applications running on-premise in your own servers.  This requires configuration of a VPC so that Skedler in AWS can connect to your on-premise ELK application.   


Skedler AMI is a Bring Your Own License (BYOL) AMI.  At this time, you cannot purchase/bill Skedler License through Amazon.  Please contact sales@skedler.com to learn more about Skedler Reports pricing and how to purchase license.    

Please review the information below to learn more about this solution and also how to use it to meet your Elasticsearch Kibana Grafana Reporting needs in an efficient manner.  


21-Days Skedler AMI Free Trial


Skedler Reports AMI is available for a 21 day free trial.  During this period, you can evaluate Skedler and explore if it meets your ELK reporting requirements.  During this 21 day free trial period, you are responsible for the AWS infrastructure cost for evaluating Skedler.  


During the free trial period, you can evaluate the key features of Skedler and experiences its value.  The 21 day free trial version has the following restrictions:

1.  Report Templates: Only 1 report template can be created

2.  Number of Reports: Only 2 reports can be scheduled

3.  Report Scheduling:  Only hourly reports can be scheduled.

4.  Number of Filters: Only 2 filter queries can be applied to reports.


After the 21 free trial period, the report scheduler will no longer work.  To remove the restrictions, consider purchasing one of the the licensed editions of Skedler.   Please review the below table for a comparison of Free Trial version vs.  Licensed Editions of Skedler.  


 Features    
Free Trial
Premier License
Designer License
    Validity    
21 Days
Annual Subscription License
Annual Subscription License
Basic customization - Adding header Logo,applying fonts and select PDF page sizes
Available
Available
Available
Advanced report customization - create templates    
Can create 1 Template

Not Available

Available

Report Designer - Drag-n-drop designer for creating custom reports    
Available

Not Available

Available

Report Layout - Printer Optimized Smart Layout
Available

Available

Available

No of reports allowed
2
No Limit
No Limit
Filters: Dynamic Query Filters for Reports
1 Filter and 2 Filter queries per Filter is allowed
No Limit
No Limit
Filters: Advanced Time Window Filters
Available
Available
Available
Report Scheduling
Only Hourly Schedule is available
Hourly/Daily/Weekly/Monthly/Yearly schedule available
Hourly/Daily/Weekly/Monthly/Yearly schedule available
Report Scheduling
Available
Available
Available
Channels: Send reports via Email    
Available
Available
Available
Channels: Publish Reports to Slack    
Available
Available
Available
Security: Kibana Shield Plugin, Search Guard Plugin, and Nginx support
Available
Available
Available
Integration: Rest API to integrate with any app
Available
Not Available*
Available
Reports History - Can view history of generated reports and download    
Available
Not Available*
Available

* These features are available as a Beta feature in Premier Edition in v3.3.  They will be removed in Skedler Reports v3.4


Pricing and Licensing Skedler Reports


Skedler Reports AMI is a BYOL AMI.  At this time you need to purchase the license directly from Skedler and use it in your AWS cloud instance. To learn more about Skedler Reports pricing and purchase a license for your AWS instance, please contact the sales team from Skedler Software Editions Page.  Fill in the contact form in the page and a sales representative will reach out to you within 24 hours regarding the purchase of license.


Launching AWS instance from skedler AMI


1. Login to your AWS account and click "Launch Instance" in the EC2 Dashboard.

2. Search for Skedler Reports AMI in the AWS Market Place.

3. Select Skedler Reports AMI.

4. Select the instance type. Please check the minimum requirements mentioned below:

  • Minimum of 2 CPU cores and 8 GB of RAM is recommended for deploying Skedler Reports.
  • In AWS minimum instance type should be t2.large which will meet the above minimum requirements. 



5. Configure the instance details and network configuration as follows.

  • Configure the number of instance for scaling as 1.
  • In network select the VPC you created. Make sure you select the same VPC nework you have selected for the ES service (if ES service is public access service then select any VPC) 
  • Select public subnet (which will be created for the VPC when you create the VPC). Read more about VPC
  • Auto-assign public IP :
    • If  option "Enabled" is selected, AWS will create a public IP for the instance. Note this IP will be terminated once you shutdown the system and another IP will assigned on restart. 
    • If you need a permanent IP,  Select the option "Use subnet setting (Disable)", you can associate an Public Elastic IP once the instance is Launched
  • Select the IAM Role to access the instance  - to secure the instance. Read More about EC2 Iam Roles
  • Configure the shutdown behavior and termination protection. And click Next.



6. Add necessary storage to the instance


7. Configure the Security Groups as follows

  • Before configuring the instance create a security group from the dashboard as given below
    • Port 22 - To connect to skedler reports instance through SSH and configure skedler reports
    • Port 3000 - (port on which skedler will run by default. Can change the port in reporting.yml later. In that case, add permission to the new port later to the security group
  • In the Instance creation wizard, Select "Select an existing security group" option - Select the security group created as  shown above or create a new security group with permissions for the following ports
  • Make sure that the assigned security group is added to the AWS Elasicsearch service. (Once created you cannot modify the VPC settings in the AWS ES service)
  • On selecting, it will show the inbound rules as in the image above


8. Add a key pair or use an already exisiting key pair to login into the system. Follow the instruction in the wizard

  • Download the pem file and store it securely (you cannot download it later)


9. After configuring the instance,launch the instance. Once the instance is launched, select the instance and copy the IP address or the public DNS


10. SSH into the instance using putty:

To connect to the system with the putty follow the steps:

  • install putty tools using the following command:
    1. sudo apt-get update && sudo apt-get install putty-tools
  • Generate ppk file using the following command
    1. puttygen  /path/key.pem  -o  <keyname>.ppk
  • Copy the public DNS or the IP for the instance as mentioned above and configure putty as follows

                  a.  Configure the putty session - paste the IP in the "Host Name" box

   b.  Configure the authentication by selecting SSH→Auth, Browse and select the ppk file generated and click open

    

      c.  If everything is configured correct you will see a screen like below asking for confirmation, Click "Accept" and proceed

           

 d. Once you "Accept" and proceed you will get the login screen. Login username will be by default "ubuntu". Enter the username and press enter you will be logged into the instance.

      


11. Once logged into the system, Follow the steps to configure skedler. (Skedler is installed in the home folder of the instance)

  • cd skedler/config
  • sudo vi reporting.yml
  • Configure elasticsearch and kibana URL and other configurations as mentioned below:

           ElasticSearch and Kibana  URL configuration


  • Add Elasticsearch URL with the port (even if the port is 80) and the Kibana URL/Grafana URL with the port in the reporting.yml file in the following format <protocol>://<server>:<port>

    UjokHQ7W7-G0MffXOAYKpKUOyf7J5fSTEA.png


        Grafana URL configuration


  • For Skedler to discover Grafana dashboards and generate the report for Grafana you would need to configure Grafana details in reporting.yml. By default, the Grafana configuration variables are commented in the reporting.yml. Uncomment the variables and assign the Grafana URL with the port and the Grafana authentication credentials or the Grafana authentication token key to access the dashboard
  • .

        

        Proxy server basic authentication configuration

  • If you are using Nginx, follow the steps below. 
    • If Kibana is configured behind Nginx, configure the Nginx username and password for Kibana in reporting.yml as shown. k7eu_10yeN7Wn4RU23RYbFjNR61iPIdKqw.png
    • If Nginx is configured as a reverse proxy for elasticsearch, configure Nginx username and password for Elasticsearch as shown:
    • 7QMiT4FB5D_sdXOGs0AKPbrhVSWWv50tOQ.png
  • Note: If you are using Shield then refer to Step-by-Step Configuration Guide for Shield.
  • Save changes to reporting.yml

For more configuration options please refer Reporting.yml and ReportEngineOptions Configuration.


12. Open a browser and type in the instance URL as:

<aws-publicDNS>:<port>

eg:  ec2.xxx-xxx-xxx-xx.compute-1.amazonaws.com:3000

If everything is successfully configured as mentioned, you will see a screen like this:



13. Activate License


To activate Skedler (in Free Trial or Licensed) you must activate a valid license key.  A trial license key is automatically populated in the license activation form.  If you purchase Skedler license, you will receive a license key by email.  

License keys can be activated using Online Activation or Offline Activation.  However, Free Trial license key requires Online Activation.  If your server doesn’t have an internet connection, please refer to Step-by-Step Guide for Offline License Activation of Skedler.



1. Click Activate License.



2.  The License Activation page is displayed.

A_QLox9NP4eaaFYlnQFJXsO2mFPAw8ee2Q.png



3. Enter the required values in the Name, Email, and Company field.

ykKQcDxVKA4RHwT1GFGw4RNO0XR_tl1m3Q.png




By default, a trial license key is auto-populated in the “License Key” field. If you received a Product license key, update the License key field. 


4. If the Internet connection requires a proxy server, click Proxy Setting in the License Activation page to enter the details. Specify the protocol, server name or proxy IP, and port. If the proxy setting requires user authentication, enter the username and password in the Username and Password fields. Click Save button. The License Activation page is displayed.


B4jkZPERM1BhOcjsrJ3tm56j4GobuO1zKg.png



5. Read and select I agree to the Terms and Conditions checkbox.

6. Click Online Activation to activate the Skedler Trial License.


E4reSxfu9FwLjoR5s9TAZHxnvimu9O4SnQ.png



Configuring and Using Skedler to Generate Reports



References