40
Copyright © 2016 Guidanz Inc. 1 Skedler – A Report Scheduler for Kibana Installation Guide
Copyright copy 2016 Guidanz Inc 1
Skedler ndash A Report Scheduler forKibana
Installation Guide
Copyright copy 2016 Guidanz Inc 2
Table of Contents
1 Introduction3
2 Prerequisites3
3 Skedler Configuration6
4 Skedler Quick Installation 9
5 Skedler Detailed Installation11
6 Access Skedler13
7 How to embed Skedler in your application 16
7 Activate License 17
8 Move Skedler from one machine to another27
9 Deactivate Skedler with License 28
10 Shield Configuration29
11 Kibana Shield Configuration 37
12 Nginx Configuration39
13 Feedback40
Copyright copy 2016 Guidanz Inc 3
1 IntroductionKibana is an excellent dashboard for building Elasticsearch applications such as LogMonitoring and Security applications but it is not a substitute for email delivered reportsthat are expected by stakeholders Skedler - Report Scheduler for Kibana is easy to usereport scheduling and distribution application for Kibana that will allow you to centrallyschedule and distribute Kibana Dashboards as hourly daily weekly and monthly PDFreports to customers managers and other stakeholders
Skedler allows you to send the right information to recipients at the right time Customersmanagers and stakeholders appreciate the convenience of Kibana reports deliveredautomatically to their email inbox which they can open and read at their convenienceeither from mobile or desktop email clients Skedler saves money for IT departmentsboth capital and operational expenses by eliminating redundant reporting systems forElasticsearch since you can now drive both analysis and reporting from the KibanaPlatform
This document provides step-by-step instructions for installing the Skedler for Kibana 4releases For information regarding using the Skedler -Report Scheduler for Kibanaplease refer to the User Guide
2 Prerequisites21 System Pre-requisites
The following are the system pre-requisites for Skedler
We recommend installing Skedler in a separate VM or server
Linux Operating System with x86_64 bit architecture
o Ubuntu from 1204 onward
o Debian from version 7 onward
Copyright copy 2016 Guidanz Inc 4
o Centos from version 7 onward
o Red Hat Enterprise Linux 7 onward
A server with a minimum of 2 CPU cores and 16 GB of RAM isrecommended for deploying Skedler
Skedler have dependencies on libstdc++ library Following are theGLIBCXX versions the code depend on
libstdc++so6 (GLIBCXX_349) =gt usrlibx86_64-linux-gnulibstdc++so6libstdc++so6 (GLIBCXX_3415) =gt usrlibx86_64-linux-gnulibstdc++so6libstdc++so6 (GLIBCXX_34) =gt usrlibx86_64-linux-gnulibstdc++so6
To check the versions on your server Please run the command
o For CentOS
strings usrlib64libstdc++so6 | grep GLIBCXX
o For DebianUbuntu
strings usrlibx86_64-linux-gnulibstdc++so6 | grep GLIBCXX
If the version is not available you need to update your GCC compiler
22 Hostname should be configured in etchosts
Skedler requires hostname of the server in which Skedler is installed to be configured inetchosts
1 Check hostname by giving this command
$gthostname
In reportingyml the host parameter is the host in which skedler binds
2 It can be 127001 in that case make sure you have an entry in etchosts as givenbelow
127001 lthostnamegt
3 However If the bind address is 0000 that means skedler binds to any IP(configured for you system) In this case your entry in hosts file(etchosts) should be
ltipaddressgt lthostnamegt
Copyright copy 2016 Guidanz Inc 5
4 If the host(IP address of server) in reportingyml is changed other than the defaultvalue 0000 then there should be an entry for the host in etchosts like
lthostgt lthostnamegt
And reboot the system
NOTE If you are using any proxy server add your hostname to a no_proxy list in thefile etcenvironment add the following line
no_proxy=ltipaddressgtlthostnamegt
23 ElasticSearch and Kibana Version
Skedler supports Elasticsearch version from 17x to 24X and Kibana version from 41to 46
24 Install libraries for Skedler
Skedler report engine requires font config library to generate report To install the libraryrefer the following steps
For Ubuntu
sudo apt-get install libfontconfig
For Debian
sudo apt-get install libfontconfig
For CentosRedhat
sudo yum install fontconfig
25 Requires JAVA_HOME
Skedler requires Java 7 or 8 and JAVA_HOME should be configured Check ifJAVA_HOME is configured using the following command
gt $echo JAVA_HOME
Copyright copy 2016 Guidanz Inc 6
if the result is empty follow the below steps to configure JAVA_HOME
For ubuntuDebian in etcbashbashrc and for CentosRedhat in etcbashrc
Add the JAVA_HOME variable as follows
export JAVA_HOME = ltyour_java_pathgt
In etcenvironment file as follows
JAVA_HOME = ltyour_java_pathgt
3 Skedler Configuration
1 Unzip the Skedlerzip file in the server to be installed
2 ReadWrite Permissions are required for generating reports1 skedler_homelog2 skedler_homereports3 skedler_homesrcpreview4 And the custom folder given in reportingyml or the folder specified while
creating reports or folder specified while creating filters3 For new installation go to config folder
cd skedlerconfig
4 Add elasticsearch URL with the port (even if the port is 80) and your kibana URLwith the port to the reportingyml file as shown in the following formatltprotocolgtltservergtltportgt
Copyright copy 2016 Guidanz Inc 7
5 Skedler is bound to host 0000 (any host) by default This parameter can bechanged to bind skedler to any IP address eg 127001 means skedler will bebound to 127001 If the host is changed in reportingyml make sure it has anentry in etchosts file against its hostname For the above-given example youneed to have an entry as this in etchosts 127001 lthostnamegt
6 If you are using Elastic Shield to authenticate Elasticsearch users please followthe steps given in Shield configuration section later in this document
7 If Nginx is used for reverse proxy settings please follow the steps given in Nginxconfiguration section later in this document
8 You can configure the location for storing your scheduled reports using Reportshome directory as shown below Make sure the folder has readwrite permissionsThe default location is skedlerreports in the application directory
Copyright copy 2016 Guidanz Inc 8
9 Save the changes to reportingyml file10ReportingEngine is scaled as per the CPU cores in the system and is configurable
The parameter workerCount in the file configreportingEngineOptions specifieshow many worker threads are created to scale Ideally it can be set as n2 where nis the no of CPU cores as shown The default value is 2 assuming a 4 CPU coresystem If the system hangs try reducing the workerCount Minimum value is 1
11Other setting in reportingEngineOptions
S No Name MandatoryOptional Description1 quality Optional You can set the quality of the image
between a range of 0 to 100 Defaultquality 0NOTE As the quality increases thegenerated PNG size also increases
12Other setting in reportingyml
S No Name MandatoryOptional Description1 port Mandatory The port in which skedler runs
Default port is 3000
Copyright copy 2016 Guidanz Inc 9
2 host Optional The host to bind the skedler serverThis bind address should beconfigured in etchosts with hostname eg if bind address is127001 then in etchosts127001 lthostnamegt should beadded
3 kibana_index Mandatory Kibana uses an index inElasticsearch to all data Configurekibana index here skedler will usethis index to auto discoverdashboardsSkedler will not create this indexDefault kibana_index is kibana
4 skedler_index Mandatory Skedler index which will be createdin elasticsearch It will create a newindex if it doesnt already existDefault skedler_index is skedler
5 Kibana_version Mandatory Skedler to identify Kibanaconfigurations
6 load_time Optional Kibana dashboard load time is theapproximate load time provided bySkelder for Kibana to generate thedashboardsIf reports are not fully loadedconfigure(increase) the load time (inmilliseconds) here so that Skedlerprovides adequate time for Kibana toload the dashboardDefault load_time value is 10seconds (10000 milliseconds)
7 kibana_shield_plugin
Optional Kibana shield plugin is installed inkibana to connect to elasticsearchshieldIf kibana shield plugin is installed inKibana please set this variable asyes By detfault the variable is setto ldquonordquoIf kibana doesnt have shield pluginand elasticsearch is configured withshield set this variable to ldquonordquo
Copyright copy 2016 Guidanz Inc 10
4 Skedler Quick Installation1 Download the latest skedler zip (or targz) file
2 Unpack the skedler zip file that you downloaded
3 cd to the unpacked folder
4 Give necessary permission to the script file installsh Use the following command togive permission
sudo chmod u+x installsh
5 Set the value for variable JAVA_HOME in the script file installsh as follows
a) To check JAVA_HOME given the following command
echo $JAVA_HOME
b) Copy and paste the output to installsh script as shown in screenshot
6 Run installsh script as follows
7 Add elasticsearch URL with the port (even if the port is 80) and your kibana URLwith the port to the skedler_homeconfigreportingyml file as shown in the followingformat ltprotocolgtltservergtltportgt
8 Skedler can be deployed in the following ways
a) Start Skedler as service
sudo service skedler start
Copyright copy 2016 Guidanz Inc 11
b) Start Skedler manually from skedler_home directory
binskedler
9 Skedler License activation Trial key is packed with Skedler by default
a) Click ldquoAboutrdquo icon on Skedler home page and click ldquoActivate Licenserdquo button
b) Fill the fields NameEmail and Company name with required values
You will find the License Key filled with a Trial Key Read and click the Termsand Conditions and Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
If there is any issues with the Quick Installation process follow the section DetailedInstallation
5 Skedler Detailed Installation
Requires LD_LIBRARY_PATH
For ubuntuDebian in etcbashbashrc and for CentosRedhat in etcbashrc
Add the LD_LIBRARY_PATH variable as follows
Copyright copy 2016 Guidanz Inc 12
export LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
In etcenvironment file as follows
LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
Starting SkedlerStart the application from skedler home folder by typing
binskedler
a) Starting Skedler in debug modei When you start the application as a root user check whether
LD_LIBRARY_PATH is present in your environment variable To check use thefollowing commandsudo envIf LD_LIBRARY_PATH is present to start the application in debug mode fromskedler home type
binskedler debugElse specify LD_LIBRARY_PATH to start the application in debug mode from
skedler home as followssudo LD_LIBRARY_PATH=ltpathgt binskedler debug
ii When you start the application as a normal user type binskedler debug fromskedler home
b) Starting Skedler as Service
For UbuntuDebian servers (less than 1601 versions)To start skedler as a service
1 Copy skedler_homebinservicescriptsskedler_debian file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_debianchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$update-rcd skedler_debian defaults 97 8
Copyright copy 2016 Guidanz Inc 13
6 To start the skedler as service in normal mode execute this command$sudo service skedler_debian start
7 To start skedler as service in debug mode$sudo service skedler_debian start debug
For Ubuntu 1601To start skedler as a service
1 Copy skedler_homebinservicescriptsskedler_debian file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_debianchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$update-rcd skedler_debian defaults 97 8$ systemctl daemon-reload
6 To start the skedler as service in normal mode execute this command$sudo service skedler_debian start
7 To start skedler as service in debug mode$sudo service skedler_debian start debug
For CentosRedhat1 Copy skedler_homebinservicescriptsskedler_redhat file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_redhatchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$ chkconfig --add skedler_rehat$ chkconfig --level 2345 skedler_redhat on
6 To start the skedler as service in normal mode execute this command$sudo service skedler_redhat start
7 To start skedler as service in debug mode
Copyright copy 2016 Guidanz Inc 14
$sudo service skedler_redhat start debug
6 Access Skedler
1 Skedler can be accessed from the following URL httpltyourServergt3000 Ifeverything is installed fine you will see the Email configuration pagea) If you do not require your reports to be mailed you can disable your mail
settings using switch ldquooffrdquob) If you require reports to be mailed configure the outgoing mail settings and
email id (from which all the reports will be sent) If the SMTP server hasany authentication then check ldquoEnable Passwordrdquo and fill the passwordfield After setting the configuration click ldquoSaverdquo button
c) Update time zone for scheduling your report using ldquoTimeZone Settingrdquo andclick ldquoUpdaterdquo
Copyright copy 2016 Guidanz Inc 15
2 Optionally you can upload default logo for your generated PDF report byuploading image using ldquoSelect imagerdquo and click ldquoSaverdquo To reset image clickldquoResetrdquo
3 Click ldquoHomerdquo icon and you will be taken to the home page of Skedler Toschedule a report follow the User Guide
Copyright copy 2016 Guidanz Inc 16
7 How to embed Skedler in your applicationTo embed Skedler UI in your application without the Skedler header and footer followthe steps given below
1 If your application does not require Authentication
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreports
ii Filters - httpltyourServergtfilters
iii Eamil - httpltyourServergtemail
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltyourServergtreportsquery=rdquocitycastrordquo
2 If you application requires Authentication - Admin user can set the emailconfiguration details
Copyright copy 2016 Guidanz Inc 17
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreportsid=ltauthenticationIDgt
ii Filters - httpltyourServergtfiltersid=ltauthenticationIDgt
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltgtreportsid=ltauthenticationIDgtampquery=rdquocitycastrordquo
NOTE authenticationID can be username or ID wich is used to login your application
authenticationID for admin user is ldquoadminrdquo
8 Activate LicenseWhen Skedler is installed it operates in Free Edition with limited functionality Pleasenote the following features that are available when running Skedler in Free Edition
radic You can create and delete a report
radic Preview the report with different Time Window
radic Mail the report
Skedler license can be activated in two ways Online Activation and Offline ActivationFollow the steps given in each section for successful activation If you have not yetinstalled Skedler please refer to the Skedler Installation Guide
You can activate license by clicking ldquoAboutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 18
To activate license key click ldquoActivate Licenserdquo button
The following screenshot displays the License Activation Page
Copyright copy 2016 Guidanz Inc 19
License KeyOnline and Offline activation both require a 25 character alphanumeric license key oractivation code
Typically you would receive the license key along with the product downloadinformation If you have any questions or need help with the license key please contactus at supportskedlercom
Skedler provides different Editions
Trial Edition ndash Typically valid for 21days When the trial period expires Skedlerswitches to Free Edition
NOTE Trial Edition is not available for Offline Activation
Standard Edition
Advanced Edition
Premium Edition
a) Online Trial License Activation
Trial key is packed with Skedler by default
To activate your trial license key online you will need an Internet connection
1 Fill the fields NameEmail and Company name with required values
Copyright copy 2016 Guidanz Inc 20
2 You will find the License Key filled with a Skedler Trial Key
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 21
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
Copyright copy 2016 Guidanz Inc 22
b) Online Product License ActivationTo activate your license online you will need an Internet connection
Fill the required details in License Activation Page
You must have a license key for the edition you requested
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 23
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo to activate the license
c) Offline Product License ActivationFill the required details in License Activation Page
You must have a license key for the edition you requested
Copyright copy 2016 Guidanz Inc 24
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 Offline Activation does not require proxy setting
4 Read and click the Terms and Conditions
5 Click ldquoOffline Activationrdquo link
6 On clicking it will generate a producttxt file Use the steps given below to generatethe licensing file(actOffdat)
Copyright copy 2016 Guidanz Inc 25
a) Open the generated producttxt file
b) Copy the contenttext inside the producttxt file
c) Use the following curl command to generate the licensing file(actOffdat) replace theSTRING_FROM_THE_FILE with the copied content from producttxt file
curl -XPOST httpsskedlercomOfflineActivationphp -drequestData=STRING_FROM_THE_FILE gt actOffdat
Note Make sure the contenttext which you copy paste to the curl command inrequestData is same as in the generated producttxt file
d) Open the terminal that has an Internet connection and run the curl command Aresponse license file (actOffdat) is generated Copy the response license file(actOffdat) to a server location where Skedler runs
7 After generating the license file (actOffdat) using the curl command Click ldquoAboutrdquoicon in Skedler home page
8 Click ldquoLicense informationrdquo button Edition type and the license key is automaticallyfilled Click ldquoSelect Filerdquo find the license file ldquoactOffdatrdquo on your computer andupload it
Note Retain the same file name ldquoactOffdatrdquo during file upload
Copyright copy 2016 Guidanz Inc 26
9 Click ldquoActivaterdquo button to activate license
10 Click ldquoAbortrdquo button to abort your offline activation
Copyright copy 2016 Guidanz Inc 27
9 Move skedler with license from one server toanotherTo move skedler with license from one server to another follow the steps mention inDeactivate skedler with License section and continue with the steps given below
1 Stop skedler in old server
2 Copy skedler to new server
3 Give necessary permissions to skedler_home directory as follows
sudo chmod -R 765 skedler_home
4 Verify the necessary pre-requisites in the new server as given in Prerequisites section
5 Start skedler in new server using the following command
cd skedler_home
binskedler
Copyright copy 2016 Guidanz Inc 28
6 Activate license with the same key which was used to activate skedler on the oldserver and use the same details to fill the form
If you find any issues during the process contact skelder supportskedlercom
10 Deactivate Skedler with LicenseSkedler license is bound to the computer where you activated it Until you deactivate theskedler license key you cannot use it on another machine Deactivation remove licensedata from the current machine so that you can activate the skedler license key on anothermachine
You can deactivate skedler license key either Online or Offline
NOTE Trial edition cannot be deactivated
Deactivate skedler license key Online
Online deactivation requires an Internet connection To deactivate skedler license keynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate online
Deactivate skedler license key Offline
Offline deactivation does not require an Internet connection To deactivate skedler licensekeynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate offline
It will generate a text file in skedler_homeskedler_offline_deactivation_requesttxt pathwhich you must send to supportskedlercom
Copyright copy 2016 Guidanz Inc 29
11 Shield ConfigurationScenario 1
Kibana managers need access to dataindex 1 and 2
Kibana Users should have access only to dataindex 1
Skedler generates reports based on user permission for dataindex and Skedler needspermission to lsquokibanarsquo index for discovery
Assuming shield is configured for kibana as follows
1 For example if you have kibana_manager and kibana_user roles and skedlerindex configured for both the roles
2 Once the roles have full permission to access the dataindex configured for the roleSkedler can discover all the dashboards and searches from kibana And you canpreview or a generate report for dashboards and search for the configureddataindex
3 In case(a) kibana_manager role has full permission to access lsquokibanarsquodataindex1 dataindex2 and lsquoskedlerrsquo index Skedler can discover all thedashboards and searches from kibana And you can preview or generate report forall dashboards and search from dataindex1 and dataindex2
a) The required permissions for kibana_manager
kibana_manager
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
Copyright copy 2016 Guidanz Inc 30
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
dataindex2
- indicesadminexists
- indicesadminmappingsfieldsget
Copyright copy 2016 Guidanz Inc 31
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
4 In case(b) kibana_user role have full permission to access lsquokibanarsquodataindex1and lsquoskedlerrsquo index Skedler can discover all the dashboards and
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 2
Table of Contents
1 Introduction3
2 Prerequisites3
3 Skedler Configuration6
4 Skedler Quick Installation 9
5 Skedler Detailed Installation11
6 Access Skedler13
7 How to embed Skedler in your application 16
7 Activate License 17
8 Move Skedler from one machine to another27
9 Deactivate Skedler with License 28
10 Shield Configuration29
11 Kibana Shield Configuration 37
12 Nginx Configuration39
13 Feedback40
Copyright copy 2016 Guidanz Inc 3
1 IntroductionKibana is an excellent dashboard for building Elasticsearch applications such as LogMonitoring and Security applications but it is not a substitute for email delivered reportsthat are expected by stakeholders Skedler - Report Scheduler for Kibana is easy to usereport scheduling and distribution application for Kibana that will allow you to centrallyschedule and distribute Kibana Dashboards as hourly daily weekly and monthly PDFreports to customers managers and other stakeholders
Skedler allows you to send the right information to recipients at the right time Customersmanagers and stakeholders appreciate the convenience of Kibana reports deliveredautomatically to their email inbox which they can open and read at their convenienceeither from mobile or desktop email clients Skedler saves money for IT departmentsboth capital and operational expenses by eliminating redundant reporting systems forElasticsearch since you can now drive both analysis and reporting from the KibanaPlatform
This document provides step-by-step instructions for installing the Skedler for Kibana 4releases For information regarding using the Skedler -Report Scheduler for Kibanaplease refer to the User Guide
2 Prerequisites21 System Pre-requisites
The following are the system pre-requisites for Skedler
We recommend installing Skedler in a separate VM or server
Linux Operating System with x86_64 bit architecture
o Ubuntu from 1204 onward
o Debian from version 7 onward
Copyright copy 2016 Guidanz Inc 4
o Centos from version 7 onward
o Red Hat Enterprise Linux 7 onward
A server with a minimum of 2 CPU cores and 16 GB of RAM isrecommended for deploying Skedler
Skedler have dependencies on libstdc++ library Following are theGLIBCXX versions the code depend on
libstdc++so6 (GLIBCXX_349) =gt usrlibx86_64-linux-gnulibstdc++so6libstdc++so6 (GLIBCXX_3415) =gt usrlibx86_64-linux-gnulibstdc++so6libstdc++so6 (GLIBCXX_34) =gt usrlibx86_64-linux-gnulibstdc++so6
To check the versions on your server Please run the command
o For CentOS
strings usrlib64libstdc++so6 | grep GLIBCXX
o For DebianUbuntu
strings usrlibx86_64-linux-gnulibstdc++so6 | grep GLIBCXX
If the version is not available you need to update your GCC compiler
22 Hostname should be configured in etchosts
Skedler requires hostname of the server in which Skedler is installed to be configured inetchosts
1 Check hostname by giving this command
$gthostname
In reportingyml the host parameter is the host in which skedler binds
2 It can be 127001 in that case make sure you have an entry in etchosts as givenbelow
127001 lthostnamegt
3 However If the bind address is 0000 that means skedler binds to any IP(configured for you system) In this case your entry in hosts file(etchosts) should be
ltipaddressgt lthostnamegt
Copyright copy 2016 Guidanz Inc 5
4 If the host(IP address of server) in reportingyml is changed other than the defaultvalue 0000 then there should be an entry for the host in etchosts like
lthostgt lthostnamegt
And reboot the system
NOTE If you are using any proxy server add your hostname to a no_proxy list in thefile etcenvironment add the following line
no_proxy=ltipaddressgtlthostnamegt
23 ElasticSearch and Kibana Version
Skedler supports Elasticsearch version from 17x to 24X and Kibana version from 41to 46
24 Install libraries for Skedler
Skedler report engine requires font config library to generate report To install the libraryrefer the following steps
For Ubuntu
sudo apt-get install libfontconfig
For Debian
sudo apt-get install libfontconfig
For CentosRedhat
sudo yum install fontconfig
25 Requires JAVA_HOME
Skedler requires Java 7 or 8 and JAVA_HOME should be configured Check ifJAVA_HOME is configured using the following command
gt $echo JAVA_HOME
Copyright copy 2016 Guidanz Inc 6
if the result is empty follow the below steps to configure JAVA_HOME
For ubuntuDebian in etcbashbashrc and for CentosRedhat in etcbashrc
Add the JAVA_HOME variable as follows
export JAVA_HOME = ltyour_java_pathgt
In etcenvironment file as follows
JAVA_HOME = ltyour_java_pathgt
3 Skedler Configuration
1 Unzip the Skedlerzip file in the server to be installed
2 ReadWrite Permissions are required for generating reports1 skedler_homelog2 skedler_homereports3 skedler_homesrcpreview4 And the custom folder given in reportingyml or the folder specified while
creating reports or folder specified while creating filters3 For new installation go to config folder
cd skedlerconfig
4 Add elasticsearch URL with the port (even if the port is 80) and your kibana URLwith the port to the reportingyml file as shown in the following formatltprotocolgtltservergtltportgt
Copyright copy 2016 Guidanz Inc 7
5 Skedler is bound to host 0000 (any host) by default This parameter can bechanged to bind skedler to any IP address eg 127001 means skedler will bebound to 127001 If the host is changed in reportingyml make sure it has anentry in etchosts file against its hostname For the above-given example youneed to have an entry as this in etchosts 127001 lthostnamegt
6 If you are using Elastic Shield to authenticate Elasticsearch users please followthe steps given in Shield configuration section later in this document
7 If Nginx is used for reverse proxy settings please follow the steps given in Nginxconfiguration section later in this document
8 You can configure the location for storing your scheduled reports using Reportshome directory as shown below Make sure the folder has readwrite permissionsThe default location is skedlerreports in the application directory
Copyright copy 2016 Guidanz Inc 8
9 Save the changes to reportingyml file10ReportingEngine is scaled as per the CPU cores in the system and is configurable
The parameter workerCount in the file configreportingEngineOptions specifieshow many worker threads are created to scale Ideally it can be set as n2 where nis the no of CPU cores as shown The default value is 2 assuming a 4 CPU coresystem If the system hangs try reducing the workerCount Minimum value is 1
11Other setting in reportingEngineOptions
S No Name MandatoryOptional Description1 quality Optional You can set the quality of the image
between a range of 0 to 100 Defaultquality 0NOTE As the quality increases thegenerated PNG size also increases
12Other setting in reportingyml
S No Name MandatoryOptional Description1 port Mandatory The port in which skedler runs
Default port is 3000
Copyright copy 2016 Guidanz Inc 9
2 host Optional The host to bind the skedler serverThis bind address should beconfigured in etchosts with hostname eg if bind address is127001 then in etchosts127001 lthostnamegt should beadded
3 kibana_index Mandatory Kibana uses an index inElasticsearch to all data Configurekibana index here skedler will usethis index to auto discoverdashboardsSkedler will not create this indexDefault kibana_index is kibana
4 skedler_index Mandatory Skedler index which will be createdin elasticsearch It will create a newindex if it doesnt already existDefault skedler_index is skedler
5 Kibana_version Mandatory Skedler to identify Kibanaconfigurations
6 load_time Optional Kibana dashboard load time is theapproximate load time provided bySkelder for Kibana to generate thedashboardsIf reports are not fully loadedconfigure(increase) the load time (inmilliseconds) here so that Skedlerprovides adequate time for Kibana toload the dashboardDefault load_time value is 10seconds (10000 milliseconds)
7 kibana_shield_plugin
Optional Kibana shield plugin is installed inkibana to connect to elasticsearchshieldIf kibana shield plugin is installed inKibana please set this variable asyes By detfault the variable is setto ldquonordquoIf kibana doesnt have shield pluginand elasticsearch is configured withshield set this variable to ldquonordquo
Copyright copy 2016 Guidanz Inc 10
4 Skedler Quick Installation1 Download the latest skedler zip (or targz) file
2 Unpack the skedler zip file that you downloaded
3 cd to the unpacked folder
4 Give necessary permission to the script file installsh Use the following command togive permission
sudo chmod u+x installsh
5 Set the value for variable JAVA_HOME in the script file installsh as follows
a) To check JAVA_HOME given the following command
echo $JAVA_HOME
b) Copy and paste the output to installsh script as shown in screenshot
6 Run installsh script as follows
7 Add elasticsearch URL with the port (even if the port is 80) and your kibana URLwith the port to the skedler_homeconfigreportingyml file as shown in the followingformat ltprotocolgtltservergtltportgt
8 Skedler can be deployed in the following ways
a) Start Skedler as service
sudo service skedler start
Copyright copy 2016 Guidanz Inc 11
b) Start Skedler manually from skedler_home directory
binskedler
9 Skedler License activation Trial key is packed with Skedler by default
a) Click ldquoAboutrdquo icon on Skedler home page and click ldquoActivate Licenserdquo button
b) Fill the fields NameEmail and Company name with required values
You will find the License Key filled with a Trial Key Read and click the Termsand Conditions and Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
If there is any issues with the Quick Installation process follow the section DetailedInstallation
5 Skedler Detailed Installation
Requires LD_LIBRARY_PATH
For ubuntuDebian in etcbashbashrc and for CentosRedhat in etcbashrc
Add the LD_LIBRARY_PATH variable as follows
Copyright copy 2016 Guidanz Inc 12
export LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
In etcenvironment file as follows
LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
Starting SkedlerStart the application from skedler home folder by typing
binskedler
a) Starting Skedler in debug modei When you start the application as a root user check whether
LD_LIBRARY_PATH is present in your environment variable To check use thefollowing commandsudo envIf LD_LIBRARY_PATH is present to start the application in debug mode fromskedler home type
binskedler debugElse specify LD_LIBRARY_PATH to start the application in debug mode from
skedler home as followssudo LD_LIBRARY_PATH=ltpathgt binskedler debug
ii When you start the application as a normal user type binskedler debug fromskedler home
b) Starting Skedler as Service
For UbuntuDebian servers (less than 1601 versions)To start skedler as a service
1 Copy skedler_homebinservicescriptsskedler_debian file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_debianchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$update-rcd skedler_debian defaults 97 8
Copyright copy 2016 Guidanz Inc 13
6 To start the skedler as service in normal mode execute this command$sudo service skedler_debian start
7 To start skedler as service in debug mode$sudo service skedler_debian start debug
For Ubuntu 1601To start skedler as a service
1 Copy skedler_homebinservicescriptsskedler_debian file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_debianchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$update-rcd skedler_debian defaults 97 8$ systemctl daemon-reload
6 To start the skedler as service in normal mode execute this command$sudo service skedler_debian start
7 To start skedler as service in debug mode$sudo service skedler_debian start debug
For CentosRedhat1 Copy skedler_homebinservicescriptsskedler_redhat file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_redhatchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$ chkconfig --add skedler_rehat$ chkconfig --level 2345 skedler_redhat on
6 To start the skedler as service in normal mode execute this command$sudo service skedler_redhat start
7 To start skedler as service in debug mode
Copyright copy 2016 Guidanz Inc 14
$sudo service skedler_redhat start debug
6 Access Skedler
1 Skedler can be accessed from the following URL httpltyourServergt3000 Ifeverything is installed fine you will see the Email configuration pagea) If you do not require your reports to be mailed you can disable your mail
settings using switch ldquooffrdquob) If you require reports to be mailed configure the outgoing mail settings and
email id (from which all the reports will be sent) If the SMTP server hasany authentication then check ldquoEnable Passwordrdquo and fill the passwordfield After setting the configuration click ldquoSaverdquo button
c) Update time zone for scheduling your report using ldquoTimeZone Settingrdquo andclick ldquoUpdaterdquo
Copyright copy 2016 Guidanz Inc 15
2 Optionally you can upload default logo for your generated PDF report byuploading image using ldquoSelect imagerdquo and click ldquoSaverdquo To reset image clickldquoResetrdquo
3 Click ldquoHomerdquo icon and you will be taken to the home page of Skedler Toschedule a report follow the User Guide
Copyright copy 2016 Guidanz Inc 16
7 How to embed Skedler in your applicationTo embed Skedler UI in your application without the Skedler header and footer followthe steps given below
1 If your application does not require Authentication
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreports
ii Filters - httpltyourServergtfilters
iii Eamil - httpltyourServergtemail
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltyourServergtreportsquery=rdquocitycastrordquo
2 If you application requires Authentication - Admin user can set the emailconfiguration details
Copyright copy 2016 Guidanz Inc 17
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreportsid=ltauthenticationIDgt
ii Filters - httpltyourServergtfiltersid=ltauthenticationIDgt
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltgtreportsid=ltauthenticationIDgtampquery=rdquocitycastrordquo
NOTE authenticationID can be username or ID wich is used to login your application
authenticationID for admin user is ldquoadminrdquo
8 Activate LicenseWhen Skedler is installed it operates in Free Edition with limited functionality Pleasenote the following features that are available when running Skedler in Free Edition
radic You can create and delete a report
radic Preview the report with different Time Window
radic Mail the report
Skedler license can be activated in two ways Online Activation and Offline ActivationFollow the steps given in each section for successful activation If you have not yetinstalled Skedler please refer to the Skedler Installation Guide
You can activate license by clicking ldquoAboutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 18
To activate license key click ldquoActivate Licenserdquo button
The following screenshot displays the License Activation Page
Copyright copy 2016 Guidanz Inc 19
License KeyOnline and Offline activation both require a 25 character alphanumeric license key oractivation code
Typically you would receive the license key along with the product downloadinformation If you have any questions or need help with the license key please contactus at supportskedlercom
Skedler provides different Editions
Trial Edition ndash Typically valid for 21days When the trial period expires Skedlerswitches to Free Edition
NOTE Trial Edition is not available for Offline Activation
Standard Edition
Advanced Edition
Premium Edition
a) Online Trial License Activation
Trial key is packed with Skedler by default
To activate your trial license key online you will need an Internet connection
1 Fill the fields NameEmail and Company name with required values
Copyright copy 2016 Guidanz Inc 20
2 You will find the License Key filled with a Skedler Trial Key
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 21
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
Copyright copy 2016 Guidanz Inc 22
b) Online Product License ActivationTo activate your license online you will need an Internet connection
Fill the required details in License Activation Page
You must have a license key for the edition you requested
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 23
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo to activate the license
c) Offline Product License ActivationFill the required details in License Activation Page
You must have a license key for the edition you requested
Copyright copy 2016 Guidanz Inc 24
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 Offline Activation does not require proxy setting
4 Read and click the Terms and Conditions
5 Click ldquoOffline Activationrdquo link
6 On clicking it will generate a producttxt file Use the steps given below to generatethe licensing file(actOffdat)
Copyright copy 2016 Guidanz Inc 25
a) Open the generated producttxt file
b) Copy the contenttext inside the producttxt file
c) Use the following curl command to generate the licensing file(actOffdat) replace theSTRING_FROM_THE_FILE with the copied content from producttxt file
curl -XPOST httpsskedlercomOfflineActivationphp -drequestData=STRING_FROM_THE_FILE gt actOffdat
Note Make sure the contenttext which you copy paste to the curl command inrequestData is same as in the generated producttxt file
d) Open the terminal that has an Internet connection and run the curl command Aresponse license file (actOffdat) is generated Copy the response license file(actOffdat) to a server location where Skedler runs
7 After generating the license file (actOffdat) using the curl command Click ldquoAboutrdquoicon in Skedler home page
8 Click ldquoLicense informationrdquo button Edition type and the license key is automaticallyfilled Click ldquoSelect Filerdquo find the license file ldquoactOffdatrdquo on your computer andupload it
Note Retain the same file name ldquoactOffdatrdquo during file upload
Copyright copy 2016 Guidanz Inc 26
9 Click ldquoActivaterdquo button to activate license
10 Click ldquoAbortrdquo button to abort your offline activation
Copyright copy 2016 Guidanz Inc 27
9 Move skedler with license from one server toanotherTo move skedler with license from one server to another follow the steps mention inDeactivate skedler with License section and continue with the steps given below
1 Stop skedler in old server
2 Copy skedler to new server
3 Give necessary permissions to skedler_home directory as follows
sudo chmod -R 765 skedler_home
4 Verify the necessary pre-requisites in the new server as given in Prerequisites section
5 Start skedler in new server using the following command
cd skedler_home
binskedler
Copyright copy 2016 Guidanz Inc 28
6 Activate license with the same key which was used to activate skedler on the oldserver and use the same details to fill the form
If you find any issues during the process contact skelder supportskedlercom
10 Deactivate Skedler with LicenseSkedler license is bound to the computer where you activated it Until you deactivate theskedler license key you cannot use it on another machine Deactivation remove licensedata from the current machine so that you can activate the skedler license key on anothermachine
You can deactivate skedler license key either Online or Offline
NOTE Trial edition cannot be deactivated
Deactivate skedler license key Online
Online deactivation requires an Internet connection To deactivate skedler license keynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate online
Deactivate skedler license key Offline
Offline deactivation does not require an Internet connection To deactivate skedler licensekeynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate offline
It will generate a text file in skedler_homeskedler_offline_deactivation_requesttxt pathwhich you must send to supportskedlercom
Copyright copy 2016 Guidanz Inc 29
11 Shield ConfigurationScenario 1
Kibana managers need access to dataindex 1 and 2
Kibana Users should have access only to dataindex 1
Skedler generates reports based on user permission for dataindex and Skedler needspermission to lsquokibanarsquo index for discovery
Assuming shield is configured for kibana as follows
1 For example if you have kibana_manager and kibana_user roles and skedlerindex configured for both the roles
2 Once the roles have full permission to access the dataindex configured for the roleSkedler can discover all the dashboards and searches from kibana And you canpreview or a generate report for dashboards and search for the configureddataindex
3 In case(a) kibana_manager role has full permission to access lsquokibanarsquodataindex1 dataindex2 and lsquoskedlerrsquo index Skedler can discover all thedashboards and searches from kibana And you can preview or generate report forall dashboards and search from dataindex1 and dataindex2
a) The required permissions for kibana_manager
kibana_manager
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
Copyright copy 2016 Guidanz Inc 30
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
dataindex2
- indicesadminexists
- indicesadminmappingsfieldsget
Copyright copy 2016 Guidanz Inc 31
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
4 In case(b) kibana_user role have full permission to access lsquokibanarsquodataindex1and lsquoskedlerrsquo index Skedler can discover all the dashboards and
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 3
1 IntroductionKibana is an excellent dashboard for building Elasticsearch applications such as LogMonitoring and Security applications but it is not a substitute for email delivered reportsthat are expected by stakeholders Skedler - Report Scheduler for Kibana is easy to usereport scheduling and distribution application for Kibana that will allow you to centrallyschedule and distribute Kibana Dashboards as hourly daily weekly and monthly PDFreports to customers managers and other stakeholders
Skedler allows you to send the right information to recipients at the right time Customersmanagers and stakeholders appreciate the convenience of Kibana reports deliveredautomatically to their email inbox which they can open and read at their convenienceeither from mobile or desktop email clients Skedler saves money for IT departmentsboth capital and operational expenses by eliminating redundant reporting systems forElasticsearch since you can now drive both analysis and reporting from the KibanaPlatform
This document provides step-by-step instructions for installing the Skedler for Kibana 4releases For information regarding using the Skedler -Report Scheduler for Kibanaplease refer to the User Guide
2 Prerequisites21 System Pre-requisites
The following are the system pre-requisites for Skedler
We recommend installing Skedler in a separate VM or server
Linux Operating System with x86_64 bit architecture
o Ubuntu from 1204 onward
o Debian from version 7 onward
Copyright copy 2016 Guidanz Inc 4
o Centos from version 7 onward
o Red Hat Enterprise Linux 7 onward
A server with a minimum of 2 CPU cores and 16 GB of RAM isrecommended for deploying Skedler
Skedler have dependencies on libstdc++ library Following are theGLIBCXX versions the code depend on
libstdc++so6 (GLIBCXX_349) =gt usrlibx86_64-linux-gnulibstdc++so6libstdc++so6 (GLIBCXX_3415) =gt usrlibx86_64-linux-gnulibstdc++so6libstdc++so6 (GLIBCXX_34) =gt usrlibx86_64-linux-gnulibstdc++so6
To check the versions on your server Please run the command
o For CentOS
strings usrlib64libstdc++so6 | grep GLIBCXX
o For DebianUbuntu
strings usrlibx86_64-linux-gnulibstdc++so6 | grep GLIBCXX
If the version is not available you need to update your GCC compiler
22 Hostname should be configured in etchosts
Skedler requires hostname of the server in which Skedler is installed to be configured inetchosts
1 Check hostname by giving this command
$gthostname
In reportingyml the host parameter is the host in which skedler binds
2 It can be 127001 in that case make sure you have an entry in etchosts as givenbelow
127001 lthostnamegt
3 However If the bind address is 0000 that means skedler binds to any IP(configured for you system) In this case your entry in hosts file(etchosts) should be
ltipaddressgt lthostnamegt
Copyright copy 2016 Guidanz Inc 5
4 If the host(IP address of server) in reportingyml is changed other than the defaultvalue 0000 then there should be an entry for the host in etchosts like
lthostgt lthostnamegt
And reboot the system
NOTE If you are using any proxy server add your hostname to a no_proxy list in thefile etcenvironment add the following line
no_proxy=ltipaddressgtlthostnamegt
23 ElasticSearch and Kibana Version
Skedler supports Elasticsearch version from 17x to 24X and Kibana version from 41to 46
24 Install libraries for Skedler
Skedler report engine requires font config library to generate report To install the libraryrefer the following steps
For Ubuntu
sudo apt-get install libfontconfig
For Debian
sudo apt-get install libfontconfig
For CentosRedhat
sudo yum install fontconfig
25 Requires JAVA_HOME
Skedler requires Java 7 or 8 and JAVA_HOME should be configured Check ifJAVA_HOME is configured using the following command
gt $echo JAVA_HOME
Copyright copy 2016 Guidanz Inc 6
if the result is empty follow the below steps to configure JAVA_HOME
For ubuntuDebian in etcbashbashrc and for CentosRedhat in etcbashrc
Add the JAVA_HOME variable as follows
export JAVA_HOME = ltyour_java_pathgt
In etcenvironment file as follows
JAVA_HOME = ltyour_java_pathgt
3 Skedler Configuration
1 Unzip the Skedlerzip file in the server to be installed
2 ReadWrite Permissions are required for generating reports1 skedler_homelog2 skedler_homereports3 skedler_homesrcpreview4 And the custom folder given in reportingyml or the folder specified while
creating reports or folder specified while creating filters3 For new installation go to config folder
cd skedlerconfig
4 Add elasticsearch URL with the port (even if the port is 80) and your kibana URLwith the port to the reportingyml file as shown in the following formatltprotocolgtltservergtltportgt
Copyright copy 2016 Guidanz Inc 7
5 Skedler is bound to host 0000 (any host) by default This parameter can bechanged to bind skedler to any IP address eg 127001 means skedler will bebound to 127001 If the host is changed in reportingyml make sure it has anentry in etchosts file against its hostname For the above-given example youneed to have an entry as this in etchosts 127001 lthostnamegt
6 If you are using Elastic Shield to authenticate Elasticsearch users please followthe steps given in Shield configuration section later in this document
7 If Nginx is used for reverse proxy settings please follow the steps given in Nginxconfiguration section later in this document
8 You can configure the location for storing your scheduled reports using Reportshome directory as shown below Make sure the folder has readwrite permissionsThe default location is skedlerreports in the application directory
Copyright copy 2016 Guidanz Inc 8
9 Save the changes to reportingyml file10ReportingEngine is scaled as per the CPU cores in the system and is configurable
The parameter workerCount in the file configreportingEngineOptions specifieshow many worker threads are created to scale Ideally it can be set as n2 where nis the no of CPU cores as shown The default value is 2 assuming a 4 CPU coresystem If the system hangs try reducing the workerCount Minimum value is 1
11Other setting in reportingEngineOptions
S No Name MandatoryOptional Description1 quality Optional You can set the quality of the image
between a range of 0 to 100 Defaultquality 0NOTE As the quality increases thegenerated PNG size also increases
12Other setting in reportingyml
S No Name MandatoryOptional Description1 port Mandatory The port in which skedler runs
Default port is 3000
Copyright copy 2016 Guidanz Inc 9
2 host Optional The host to bind the skedler serverThis bind address should beconfigured in etchosts with hostname eg if bind address is127001 then in etchosts127001 lthostnamegt should beadded
3 kibana_index Mandatory Kibana uses an index inElasticsearch to all data Configurekibana index here skedler will usethis index to auto discoverdashboardsSkedler will not create this indexDefault kibana_index is kibana
4 skedler_index Mandatory Skedler index which will be createdin elasticsearch It will create a newindex if it doesnt already existDefault skedler_index is skedler
5 Kibana_version Mandatory Skedler to identify Kibanaconfigurations
6 load_time Optional Kibana dashboard load time is theapproximate load time provided bySkelder for Kibana to generate thedashboardsIf reports are not fully loadedconfigure(increase) the load time (inmilliseconds) here so that Skedlerprovides adequate time for Kibana toload the dashboardDefault load_time value is 10seconds (10000 milliseconds)
7 kibana_shield_plugin
Optional Kibana shield plugin is installed inkibana to connect to elasticsearchshieldIf kibana shield plugin is installed inKibana please set this variable asyes By detfault the variable is setto ldquonordquoIf kibana doesnt have shield pluginand elasticsearch is configured withshield set this variable to ldquonordquo
Copyright copy 2016 Guidanz Inc 10
4 Skedler Quick Installation1 Download the latest skedler zip (or targz) file
2 Unpack the skedler zip file that you downloaded
3 cd to the unpacked folder
4 Give necessary permission to the script file installsh Use the following command togive permission
sudo chmod u+x installsh
5 Set the value for variable JAVA_HOME in the script file installsh as follows
a) To check JAVA_HOME given the following command
echo $JAVA_HOME
b) Copy and paste the output to installsh script as shown in screenshot
6 Run installsh script as follows
7 Add elasticsearch URL with the port (even if the port is 80) and your kibana URLwith the port to the skedler_homeconfigreportingyml file as shown in the followingformat ltprotocolgtltservergtltportgt
8 Skedler can be deployed in the following ways
a) Start Skedler as service
sudo service skedler start
Copyright copy 2016 Guidanz Inc 11
b) Start Skedler manually from skedler_home directory
binskedler
9 Skedler License activation Trial key is packed with Skedler by default
a) Click ldquoAboutrdquo icon on Skedler home page and click ldquoActivate Licenserdquo button
b) Fill the fields NameEmail and Company name with required values
You will find the License Key filled with a Trial Key Read and click the Termsand Conditions and Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
If there is any issues with the Quick Installation process follow the section DetailedInstallation
5 Skedler Detailed Installation
Requires LD_LIBRARY_PATH
For ubuntuDebian in etcbashbashrc and for CentosRedhat in etcbashrc
Add the LD_LIBRARY_PATH variable as follows
Copyright copy 2016 Guidanz Inc 12
export LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
In etcenvironment file as follows
LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
Starting SkedlerStart the application from skedler home folder by typing
binskedler
a) Starting Skedler in debug modei When you start the application as a root user check whether
LD_LIBRARY_PATH is present in your environment variable To check use thefollowing commandsudo envIf LD_LIBRARY_PATH is present to start the application in debug mode fromskedler home type
binskedler debugElse specify LD_LIBRARY_PATH to start the application in debug mode from
skedler home as followssudo LD_LIBRARY_PATH=ltpathgt binskedler debug
ii When you start the application as a normal user type binskedler debug fromskedler home
b) Starting Skedler as Service
For UbuntuDebian servers (less than 1601 versions)To start skedler as a service
1 Copy skedler_homebinservicescriptsskedler_debian file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_debianchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$update-rcd skedler_debian defaults 97 8
Copyright copy 2016 Guidanz Inc 13
6 To start the skedler as service in normal mode execute this command$sudo service skedler_debian start
7 To start skedler as service in debug mode$sudo service skedler_debian start debug
For Ubuntu 1601To start skedler as a service
1 Copy skedler_homebinservicescriptsskedler_debian file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_debianchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$update-rcd skedler_debian defaults 97 8$ systemctl daemon-reload
6 To start the skedler as service in normal mode execute this command$sudo service skedler_debian start
7 To start skedler as service in debug mode$sudo service skedler_debian start debug
For CentosRedhat1 Copy skedler_homebinservicescriptsskedler_redhat file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_redhatchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$ chkconfig --add skedler_rehat$ chkconfig --level 2345 skedler_redhat on
6 To start the skedler as service in normal mode execute this command$sudo service skedler_redhat start
7 To start skedler as service in debug mode
Copyright copy 2016 Guidanz Inc 14
$sudo service skedler_redhat start debug
6 Access Skedler
1 Skedler can be accessed from the following URL httpltyourServergt3000 Ifeverything is installed fine you will see the Email configuration pagea) If you do not require your reports to be mailed you can disable your mail
settings using switch ldquooffrdquob) If you require reports to be mailed configure the outgoing mail settings and
email id (from which all the reports will be sent) If the SMTP server hasany authentication then check ldquoEnable Passwordrdquo and fill the passwordfield After setting the configuration click ldquoSaverdquo button
c) Update time zone for scheduling your report using ldquoTimeZone Settingrdquo andclick ldquoUpdaterdquo
Copyright copy 2016 Guidanz Inc 15
2 Optionally you can upload default logo for your generated PDF report byuploading image using ldquoSelect imagerdquo and click ldquoSaverdquo To reset image clickldquoResetrdquo
3 Click ldquoHomerdquo icon and you will be taken to the home page of Skedler Toschedule a report follow the User Guide
Copyright copy 2016 Guidanz Inc 16
7 How to embed Skedler in your applicationTo embed Skedler UI in your application without the Skedler header and footer followthe steps given below
1 If your application does not require Authentication
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreports
ii Filters - httpltyourServergtfilters
iii Eamil - httpltyourServergtemail
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltyourServergtreportsquery=rdquocitycastrordquo
2 If you application requires Authentication - Admin user can set the emailconfiguration details
Copyright copy 2016 Guidanz Inc 17
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreportsid=ltauthenticationIDgt
ii Filters - httpltyourServergtfiltersid=ltauthenticationIDgt
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltgtreportsid=ltauthenticationIDgtampquery=rdquocitycastrordquo
NOTE authenticationID can be username or ID wich is used to login your application
authenticationID for admin user is ldquoadminrdquo
8 Activate LicenseWhen Skedler is installed it operates in Free Edition with limited functionality Pleasenote the following features that are available when running Skedler in Free Edition
radic You can create and delete a report
radic Preview the report with different Time Window
radic Mail the report
Skedler license can be activated in two ways Online Activation and Offline ActivationFollow the steps given in each section for successful activation If you have not yetinstalled Skedler please refer to the Skedler Installation Guide
You can activate license by clicking ldquoAboutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 18
To activate license key click ldquoActivate Licenserdquo button
The following screenshot displays the License Activation Page
Copyright copy 2016 Guidanz Inc 19
License KeyOnline and Offline activation both require a 25 character alphanumeric license key oractivation code
Typically you would receive the license key along with the product downloadinformation If you have any questions or need help with the license key please contactus at supportskedlercom
Skedler provides different Editions
Trial Edition ndash Typically valid for 21days When the trial period expires Skedlerswitches to Free Edition
NOTE Trial Edition is not available for Offline Activation
Standard Edition
Advanced Edition
Premium Edition
a) Online Trial License Activation
Trial key is packed with Skedler by default
To activate your trial license key online you will need an Internet connection
1 Fill the fields NameEmail and Company name with required values
Copyright copy 2016 Guidanz Inc 20
2 You will find the License Key filled with a Skedler Trial Key
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 21
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
Copyright copy 2016 Guidanz Inc 22
b) Online Product License ActivationTo activate your license online you will need an Internet connection
Fill the required details in License Activation Page
You must have a license key for the edition you requested
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 23
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo to activate the license
c) Offline Product License ActivationFill the required details in License Activation Page
You must have a license key for the edition you requested
Copyright copy 2016 Guidanz Inc 24
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 Offline Activation does not require proxy setting
4 Read and click the Terms and Conditions
5 Click ldquoOffline Activationrdquo link
6 On clicking it will generate a producttxt file Use the steps given below to generatethe licensing file(actOffdat)
Copyright copy 2016 Guidanz Inc 25
a) Open the generated producttxt file
b) Copy the contenttext inside the producttxt file
c) Use the following curl command to generate the licensing file(actOffdat) replace theSTRING_FROM_THE_FILE with the copied content from producttxt file
curl -XPOST httpsskedlercomOfflineActivationphp -drequestData=STRING_FROM_THE_FILE gt actOffdat
Note Make sure the contenttext which you copy paste to the curl command inrequestData is same as in the generated producttxt file
d) Open the terminal that has an Internet connection and run the curl command Aresponse license file (actOffdat) is generated Copy the response license file(actOffdat) to a server location where Skedler runs
7 After generating the license file (actOffdat) using the curl command Click ldquoAboutrdquoicon in Skedler home page
8 Click ldquoLicense informationrdquo button Edition type and the license key is automaticallyfilled Click ldquoSelect Filerdquo find the license file ldquoactOffdatrdquo on your computer andupload it
Note Retain the same file name ldquoactOffdatrdquo during file upload
Copyright copy 2016 Guidanz Inc 26
9 Click ldquoActivaterdquo button to activate license
10 Click ldquoAbortrdquo button to abort your offline activation
Copyright copy 2016 Guidanz Inc 27
9 Move skedler with license from one server toanotherTo move skedler with license from one server to another follow the steps mention inDeactivate skedler with License section and continue with the steps given below
1 Stop skedler in old server
2 Copy skedler to new server
3 Give necessary permissions to skedler_home directory as follows
sudo chmod -R 765 skedler_home
4 Verify the necessary pre-requisites in the new server as given in Prerequisites section
5 Start skedler in new server using the following command
cd skedler_home
binskedler
Copyright copy 2016 Guidanz Inc 28
6 Activate license with the same key which was used to activate skedler on the oldserver and use the same details to fill the form
If you find any issues during the process contact skelder supportskedlercom
10 Deactivate Skedler with LicenseSkedler license is bound to the computer where you activated it Until you deactivate theskedler license key you cannot use it on another machine Deactivation remove licensedata from the current machine so that you can activate the skedler license key on anothermachine
You can deactivate skedler license key either Online or Offline
NOTE Trial edition cannot be deactivated
Deactivate skedler license key Online
Online deactivation requires an Internet connection To deactivate skedler license keynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate online
Deactivate skedler license key Offline
Offline deactivation does not require an Internet connection To deactivate skedler licensekeynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate offline
It will generate a text file in skedler_homeskedler_offline_deactivation_requesttxt pathwhich you must send to supportskedlercom
Copyright copy 2016 Guidanz Inc 29
11 Shield ConfigurationScenario 1
Kibana managers need access to dataindex 1 and 2
Kibana Users should have access only to dataindex 1
Skedler generates reports based on user permission for dataindex and Skedler needspermission to lsquokibanarsquo index for discovery
Assuming shield is configured for kibana as follows
1 For example if you have kibana_manager and kibana_user roles and skedlerindex configured for both the roles
2 Once the roles have full permission to access the dataindex configured for the roleSkedler can discover all the dashboards and searches from kibana And you canpreview or a generate report for dashboards and search for the configureddataindex
3 In case(a) kibana_manager role has full permission to access lsquokibanarsquodataindex1 dataindex2 and lsquoskedlerrsquo index Skedler can discover all thedashboards and searches from kibana And you can preview or generate report forall dashboards and search from dataindex1 and dataindex2
a) The required permissions for kibana_manager
kibana_manager
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
Copyright copy 2016 Guidanz Inc 30
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
dataindex2
- indicesadminexists
- indicesadminmappingsfieldsget
Copyright copy 2016 Guidanz Inc 31
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
4 In case(b) kibana_user role have full permission to access lsquokibanarsquodataindex1and lsquoskedlerrsquo index Skedler can discover all the dashboards and
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 4
o Centos from version 7 onward
o Red Hat Enterprise Linux 7 onward
A server with a minimum of 2 CPU cores and 16 GB of RAM isrecommended for deploying Skedler
Skedler have dependencies on libstdc++ library Following are theGLIBCXX versions the code depend on
libstdc++so6 (GLIBCXX_349) =gt usrlibx86_64-linux-gnulibstdc++so6libstdc++so6 (GLIBCXX_3415) =gt usrlibx86_64-linux-gnulibstdc++so6libstdc++so6 (GLIBCXX_34) =gt usrlibx86_64-linux-gnulibstdc++so6
To check the versions on your server Please run the command
o For CentOS
strings usrlib64libstdc++so6 | grep GLIBCXX
o For DebianUbuntu
strings usrlibx86_64-linux-gnulibstdc++so6 | grep GLIBCXX
If the version is not available you need to update your GCC compiler
22 Hostname should be configured in etchosts
Skedler requires hostname of the server in which Skedler is installed to be configured inetchosts
1 Check hostname by giving this command
$gthostname
In reportingyml the host parameter is the host in which skedler binds
2 It can be 127001 in that case make sure you have an entry in etchosts as givenbelow
127001 lthostnamegt
3 However If the bind address is 0000 that means skedler binds to any IP(configured for you system) In this case your entry in hosts file(etchosts) should be
ltipaddressgt lthostnamegt
Copyright copy 2016 Guidanz Inc 5
4 If the host(IP address of server) in reportingyml is changed other than the defaultvalue 0000 then there should be an entry for the host in etchosts like
lthostgt lthostnamegt
And reboot the system
NOTE If you are using any proxy server add your hostname to a no_proxy list in thefile etcenvironment add the following line
no_proxy=ltipaddressgtlthostnamegt
23 ElasticSearch and Kibana Version
Skedler supports Elasticsearch version from 17x to 24X and Kibana version from 41to 46
24 Install libraries for Skedler
Skedler report engine requires font config library to generate report To install the libraryrefer the following steps
For Ubuntu
sudo apt-get install libfontconfig
For Debian
sudo apt-get install libfontconfig
For CentosRedhat
sudo yum install fontconfig
25 Requires JAVA_HOME
Skedler requires Java 7 or 8 and JAVA_HOME should be configured Check ifJAVA_HOME is configured using the following command
gt $echo JAVA_HOME
Copyright copy 2016 Guidanz Inc 6
if the result is empty follow the below steps to configure JAVA_HOME
For ubuntuDebian in etcbashbashrc and for CentosRedhat in etcbashrc
Add the JAVA_HOME variable as follows
export JAVA_HOME = ltyour_java_pathgt
In etcenvironment file as follows
JAVA_HOME = ltyour_java_pathgt
3 Skedler Configuration
1 Unzip the Skedlerzip file in the server to be installed
2 ReadWrite Permissions are required for generating reports1 skedler_homelog2 skedler_homereports3 skedler_homesrcpreview4 And the custom folder given in reportingyml or the folder specified while
creating reports or folder specified while creating filters3 For new installation go to config folder
cd skedlerconfig
4 Add elasticsearch URL with the port (even if the port is 80) and your kibana URLwith the port to the reportingyml file as shown in the following formatltprotocolgtltservergtltportgt
Copyright copy 2016 Guidanz Inc 7
5 Skedler is bound to host 0000 (any host) by default This parameter can bechanged to bind skedler to any IP address eg 127001 means skedler will bebound to 127001 If the host is changed in reportingyml make sure it has anentry in etchosts file against its hostname For the above-given example youneed to have an entry as this in etchosts 127001 lthostnamegt
6 If you are using Elastic Shield to authenticate Elasticsearch users please followthe steps given in Shield configuration section later in this document
7 If Nginx is used for reverse proxy settings please follow the steps given in Nginxconfiguration section later in this document
8 You can configure the location for storing your scheduled reports using Reportshome directory as shown below Make sure the folder has readwrite permissionsThe default location is skedlerreports in the application directory
Copyright copy 2016 Guidanz Inc 8
9 Save the changes to reportingyml file10ReportingEngine is scaled as per the CPU cores in the system and is configurable
The parameter workerCount in the file configreportingEngineOptions specifieshow many worker threads are created to scale Ideally it can be set as n2 where nis the no of CPU cores as shown The default value is 2 assuming a 4 CPU coresystem If the system hangs try reducing the workerCount Minimum value is 1
11Other setting in reportingEngineOptions
S No Name MandatoryOptional Description1 quality Optional You can set the quality of the image
between a range of 0 to 100 Defaultquality 0NOTE As the quality increases thegenerated PNG size also increases
12Other setting in reportingyml
S No Name MandatoryOptional Description1 port Mandatory The port in which skedler runs
Default port is 3000
Copyright copy 2016 Guidanz Inc 9
2 host Optional The host to bind the skedler serverThis bind address should beconfigured in etchosts with hostname eg if bind address is127001 then in etchosts127001 lthostnamegt should beadded
3 kibana_index Mandatory Kibana uses an index inElasticsearch to all data Configurekibana index here skedler will usethis index to auto discoverdashboardsSkedler will not create this indexDefault kibana_index is kibana
4 skedler_index Mandatory Skedler index which will be createdin elasticsearch It will create a newindex if it doesnt already existDefault skedler_index is skedler
5 Kibana_version Mandatory Skedler to identify Kibanaconfigurations
6 load_time Optional Kibana dashboard load time is theapproximate load time provided bySkelder for Kibana to generate thedashboardsIf reports are not fully loadedconfigure(increase) the load time (inmilliseconds) here so that Skedlerprovides adequate time for Kibana toload the dashboardDefault load_time value is 10seconds (10000 milliseconds)
7 kibana_shield_plugin
Optional Kibana shield plugin is installed inkibana to connect to elasticsearchshieldIf kibana shield plugin is installed inKibana please set this variable asyes By detfault the variable is setto ldquonordquoIf kibana doesnt have shield pluginand elasticsearch is configured withshield set this variable to ldquonordquo
Copyright copy 2016 Guidanz Inc 10
4 Skedler Quick Installation1 Download the latest skedler zip (or targz) file
2 Unpack the skedler zip file that you downloaded
3 cd to the unpacked folder
4 Give necessary permission to the script file installsh Use the following command togive permission
sudo chmod u+x installsh
5 Set the value for variable JAVA_HOME in the script file installsh as follows
a) To check JAVA_HOME given the following command
echo $JAVA_HOME
b) Copy and paste the output to installsh script as shown in screenshot
6 Run installsh script as follows
7 Add elasticsearch URL with the port (even if the port is 80) and your kibana URLwith the port to the skedler_homeconfigreportingyml file as shown in the followingformat ltprotocolgtltservergtltportgt
8 Skedler can be deployed in the following ways
a) Start Skedler as service
sudo service skedler start
Copyright copy 2016 Guidanz Inc 11
b) Start Skedler manually from skedler_home directory
binskedler
9 Skedler License activation Trial key is packed with Skedler by default
a) Click ldquoAboutrdquo icon on Skedler home page and click ldquoActivate Licenserdquo button
b) Fill the fields NameEmail and Company name with required values
You will find the License Key filled with a Trial Key Read and click the Termsand Conditions and Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
If there is any issues with the Quick Installation process follow the section DetailedInstallation
5 Skedler Detailed Installation
Requires LD_LIBRARY_PATH
For ubuntuDebian in etcbashbashrc and for CentosRedhat in etcbashrc
Add the LD_LIBRARY_PATH variable as follows
Copyright copy 2016 Guidanz Inc 12
export LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
In etcenvironment file as follows
LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
Starting SkedlerStart the application from skedler home folder by typing
binskedler
a) Starting Skedler in debug modei When you start the application as a root user check whether
LD_LIBRARY_PATH is present in your environment variable To check use thefollowing commandsudo envIf LD_LIBRARY_PATH is present to start the application in debug mode fromskedler home type
binskedler debugElse specify LD_LIBRARY_PATH to start the application in debug mode from
skedler home as followssudo LD_LIBRARY_PATH=ltpathgt binskedler debug
ii When you start the application as a normal user type binskedler debug fromskedler home
b) Starting Skedler as Service
For UbuntuDebian servers (less than 1601 versions)To start skedler as a service
1 Copy skedler_homebinservicescriptsskedler_debian file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_debianchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$update-rcd skedler_debian defaults 97 8
Copyright copy 2016 Guidanz Inc 13
6 To start the skedler as service in normal mode execute this command$sudo service skedler_debian start
7 To start skedler as service in debug mode$sudo service skedler_debian start debug
For Ubuntu 1601To start skedler as a service
1 Copy skedler_homebinservicescriptsskedler_debian file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_debianchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$update-rcd skedler_debian defaults 97 8$ systemctl daemon-reload
6 To start the skedler as service in normal mode execute this command$sudo service skedler_debian start
7 To start skedler as service in debug mode$sudo service skedler_debian start debug
For CentosRedhat1 Copy skedler_homebinservicescriptsskedler_redhat file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_redhatchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$ chkconfig --add skedler_rehat$ chkconfig --level 2345 skedler_redhat on
6 To start the skedler as service in normal mode execute this command$sudo service skedler_redhat start
7 To start skedler as service in debug mode
Copyright copy 2016 Guidanz Inc 14
$sudo service skedler_redhat start debug
6 Access Skedler
1 Skedler can be accessed from the following URL httpltyourServergt3000 Ifeverything is installed fine you will see the Email configuration pagea) If you do not require your reports to be mailed you can disable your mail
settings using switch ldquooffrdquob) If you require reports to be mailed configure the outgoing mail settings and
email id (from which all the reports will be sent) If the SMTP server hasany authentication then check ldquoEnable Passwordrdquo and fill the passwordfield After setting the configuration click ldquoSaverdquo button
c) Update time zone for scheduling your report using ldquoTimeZone Settingrdquo andclick ldquoUpdaterdquo
Copyright copy 2016 Guidanz Inc 15
2 Optionally you can upload default logo for your generated PDF report byuploading image using ldquoSelect imagerdquo and click ldquoSaverdquo To reset image clickldquoResetrdquo
3 Click ldquoHomerdquo icon and you will be taken to the home page of Skedler Toschedule a report follow the User Guide
Copyright copy 2016 Guidanz Inc 16
7 How to embed Skedler in your applicationTo embed Skedler UI in your application without the Skedler header and footer followthe steps given below
1 If your application does not require Authentication
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreports
ii Filters - httpltyourServergtfilters
iii Eamil - httpltyourServergtemail
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltyourServergtreportsquery=rdquocitycastrordquo
2 If you application requires Authentication - Admin user can set the emailconfiguration details
Copyright copy 2016 Guidanz Inc 17
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreportsid=ltauthenticationIDgt
ii Filters - httpltyourServergtfiltersid=ltauthenticationIDgt
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltgtreportsid=ltauthenticationIDgtampquery=rdquocitycastrordquo
NOTE authenticationID can be username or ID wich is used to login your application
authenticationID for admin user is ldquoadminrdquo
8 Activate LicenseWhen Skedler is installed it operates in Free Edition with limited functionality Pleasenote the following features that are available when running Skedler in Free Edition
radic You can create and delete a report
radic Preview the report with different Time Window
radic Mail the report
Skedler license can be activated in two ways Online Activation and Offline ActivationFollow the steps given in each section for successful activation If you have not yetinstalled Skedler please refer to the Skedler Installation Guide
You can activate license by clicking ldquoAboutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 18
To activate license key click ldquoActivate Licenserdquo button
The following screenshot displays the License Activation Page
Copyright copy 2016 Guidanz Inc 19
License KeyOnline and Offline activation both require a 25 character alphanumeric license key oractivation code
Typically you would receive the license key along with the product downloadinformation If you have any questions or need help with the license key please contactus at supportskedlercom
Skedler provides different Editions
Trial Edition ndash Typically valid for 21days When the trial period expires Skedlerswitches to Free Edition
NOTE Trial Edition is not available for Offline Activation
Standard Edition
Advanced Edition
Premium Edition
a) Online Trial License Activation
Trial key is packed with Skedler by default
To activate your trial license key online you will need an Internet connection
1 Fill the fields NameEmail and Company name with required values
Copyright copy 2016 Guidanz Inc 20
2 You will find the License Key filled with a Skedler Trial Key
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 21
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
Copyright copy 2016 Guidanz Inc 22
b) Online Product License ActivationTo activate your license online you will need an Internet connection
Fill the required details in License Activation Page
You must have a license key for the edition you requested
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 23
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo to activate the license
c) Offline Product License ActivationFill the required details in License Activation Page
You must have a license key for the edition you requested
Copyright copy 2016 Guidanz Inc 24
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 Offline Activation does not require proxy setting
4 Read and click the Terms and Conditions
5 Click ldquoOffline Activationrdquo link
6 On clicking it will generate a producttxt file Use the steps given below to generatethe licensing file(actOffdat)
Copyright copy 2016 Guidanz Inc 25
a) Open the generated producttxt file
b) Copy the contenttext inside the producttxt file
c) Use the following curl command to generate the licensing file(actOffdat) replace theSTRING_FROM_THE_FILE with the copied content from producttxt file
curl -XPOST httpsskedlercomOfflineActivationphp -drequestData=STRING_FROM_THE_FILE gt actOffdat
Note Make sure the contenttext which you copy paste to the curl command inrequestData is same as in the generated producttxt file
d) Open the terminal that has an Internet connection and run the curl command Aresponse license file (actOffdat) is generated Copy the response license file(actOffdat) to a server location where Skedler runs
7 After generating the license file (actOffdat) using the curl command Click ldquoAboutrdquoicon in Skedler home page
8 Click ldquoLicense informationrdquo button Edition type and the license key is automaticallyfilled Click ldquoSelect Filerdquo find the license file ldquoactOffdatrdquo on your computer andupload it
Note Retain the same file name ldquoactOffdatrdquo during file upload
Copyright copy 2016 Guidanz Inc 26
9 Click ldquoActivaterdquo button to activate license
10 Click ldquoAbortrdquo button to abort your offline activation
Copyright copy 2016 Guidanz Inc 27
9 Move skedler with license from one server toanotherTo move skedler with license from one server to another follow the steps mention inDeactivate skedler with License section and continue with the steps given below
1 Stop skedler in old server
2 Copy skedler to new server
3 Give necessary permissions to skedler_home directory as follows
sudo chmod -R 765 skedler_home
4 Verify the necessary pre-requisites in the new server as given in Prerequisites section
5 Start skedler in new server using the following command
cd skedler_home
binskedler
Copyright copy 2016 Guidanz Inc 28
6 Activate license with the same key which was used to activate skedler on the oldserver and use the same details to fill the form
If you find any issues during the process contact skelder supportskedlercom
10 Deactivate Skedler with LicenseSkedler license is bound to the computer where you activated it Until you deactivate theskedler license key you cannot use it on another machine Deactivation remove licensedata from the current machine so that you can activate the skedler license key on anothermachine
You can deactivate skedler license key either Online or Offline
NOTE Trial edition cannot be deactivated
Deactivate skedler license key Online
Online deactivation requires an Internet connection To deactivate skedler license keynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate online
Deactivate skedler license key Offline
Offline deactivation does not require an Internet connection To deactivate skedler licensekeynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate offline
It will generate a text file in skedler_homeskedler_offline_deactivation_requesttxt pathwhich you must send to supportskedlercom
Copyright copy 2016 Guidanz Inc 29
11 Shield ConfigurationScenario 1
Kibana managers need access to dataindex 1 and 2
Kibana Users should have access only to dataindex 1
Skedler generates reports based on user permission for dataindex and Skedler needspermission to lsquokibanarsquo index for discovery
Assuming shield is configured for kibana as follows
1 For example if you have kibana_manager and kibana_user roles and skedlerindex configured for both the roles
2 Once the roles have full permission to access the dataindex configured for the roleSkedler can discover all the dashboards and searches from kibana And you canpreview or a generate report for dashboards and search for the configureddataindex
3 In case(a) kibana_manager role has full permission to access lsquokibanarsquodataindex1 dataindex2 and lsquoskedlerrsquo index Skedler can discover all thedashboards and searches from kibana And you can preview or generate report forall dashboards and search from dataindex1 and dataindex2
a) The required permissions for kibana_manager
kibana_manager
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
Copyright copy 2016 Guidanz Inc 30
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
dataindex2
- indicesadminexists
- indicesadminmappingsfieldsget
Copyright copy 2016 Guidanz Inc 31
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
4 In case(b) kibana_user role have full permission to access lsquokibanarsquodataindex1and lsquoskedlerrsquo index Skedler can discover all the dashboards and
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 5
4 If the host(IP address of server) in reportingyml is changed other than the defaultvalue 0000 then there should be an entry for the host in etchosts like
lthostgt lthostnamegt
And reboot the system
NOTE If you are using any proxy server add your hostname to a no_proxy list in thefile etcenvironment add the following line
no_proxy=ltipaddressgtlthostnamegt
23 ElasticSearch and Kibana Version
Skedler supports Elasticsearch version from 17x to 24X and Kibana version from 41to 46
24 Install libraries for Skedler
Skedler report engine requires font config library to generate report To install the libraryrefer the following steps
For Ubuntu
sudo apt-get install libfontconfig
For Debian
sudo apt-get install libfontconfig
For CentosRedhat
sudo yum install fontconfig
25 Requires JAVA_HOME
Skedler requires Java 7 or 8 and JAVA_HOME should be configured Check ifJAVA_HOME is configured using the following command
gt $echo JAVA_HOME
Copyright copy 2016 Guidanz Inc 6
if the result is empty follow the below steps to configure JAVA_HOME
For ubuntuDebian in etcbashbashrc and for CentosRedhat in etcbashrc
Add the JAVA_HOME variable as follows
export JAVA_HOME = ltyour_java_pathgt
In etcenvironment file as follows
JAVA_HOME = ltyour_java_pathgt
3 Skedler Configuration
1 Unzip the Skedlerzip file in the server to be installed
2 ReadWrite Permissions are required for generating reports1 skedler_homelog2 skedler_homereports3 skedler_homesrcpreview4 And the custom folder given in reportingyml or the folder specified while
creating reports or folder specified while creating filters3 For new installation go to config folder
cd skedlerconfig
4 Add elasticsearch URL with the port (even if the port is 80) and your kibana URLwith the port to the reportingyml file as shown in the following formatltprotocolgtltservergtltportgt
Copyright copy 2016 Guidanz Inc 7
5 Skedler is bound to host 0000 (any host) by default This parameter can bechanged to bind skedler to any IP address eg 127001 means skedler will bebound to 127001 If the host is changed in reportingyml make sure it has anentry in etchosts file against its hostname For the above-given example youneed to have an entry as this in etchosts 127001 lthostnamegt
6 If you are using Elastic Shield to authenticate Elasticsearch users please followthe steps given in Shield configuration section later in this document
7 If Nginx is used for reverse proxy settings please follow the steps given in Nginxconfiguration section later in this document
8 You can configure the location for storing your scheduled reports using Reportshome directory as shown below Make sure the folder has readwrite permissionsThe default location is skedlerreports in the application directory
Copyright copy 2016 Guidanz Inc 8
9 Save the changes to reportingyml file10ReportingEngine is scaled as per the CPU cores in the system and is configurable
The parameter workerCount in the file configreportingEngineOptions specifieshow many worker threads are created to scale Ideally it can be set as n2 where nis the no of CPU cores as shown The default value is 2 assuming a 4 CPU coresystem If the system hangs try reducing the workerCount Minimum value is 1
11Other setting in reportingEngineOptions
S No Name MandatoryOptional Description1 quality Optional You can set the quality of the image
between a range of 0 to 100 Defaultquality 0NOTE As the quality increases thegenerated PNG size also increases
12Other setting in reportingyml
S No Name MandatoryOptional Description1 port Mandatory The port in which skedler runs
Default port is 3000
Copyright copy 2016 Guidanz Inc 9
2 host Optional The host to bind the skedler serverThis bind address should beconfigured in etchosts with hostname eg if bind address is127001 then in etchosts127001 lthostnamegt should beadded
3 kibana_index Mandatory Kibana uses an index inElasticsearch to all data Configurekibana index here skedler will usethis index to auto discoverdashboardsSkedler will not create this indexDefault kibana_index is kibana
4 skedler_index Mandatory Skedler index which will be createdin elasticsearch It will create a newindex if it doesnt already existDefault skedler_index is skedler
5 Kibana_version Mandatory Skedler to identify Kibanaconfigurations
6 load_time Optional Kibana dashboard load time is theapproximate load time provided bySkelder for Kibana to generate thedashboardsIf reports are not fully loadedconfigure(increase) the load time (inmilliseconds) here so that Skedlerprovides adequate time for Kibana toload the dashboardDefault load_time value is 10seconds (10000 milliseconds)
7 kibana_shield_plugin
Optional Kibana shield plugin is installed inkibana to connect to elasticsearchshieldIf kibana shield plugin is installed inKibana please set this variable asyes By detfault the variable is setto ldquonordquoIf kibana doesnt have shield pluginand elasticsearch is configured withshield set this variable to ldquonordquo
Copyright copy 2016 Guidanz Inc 10
4 Skedler Quick Installation1 Download the latest skedler zip (or targz) file
2 Unpack the skedler zip file that you downloaded
3 cd to the unpacked folder
4 Give necessary permission to the script file installsh Use the following command togive permission
sudo chmod u+x installsh
5 Set the value for variable JAVA_HOME in the script file installsh as follows
a) To check JAVA_HOME given the following command
echo $JAVA_HOME
b) Copy and paste the output to installsh script as shown in screenshot
6 Run installsh script as follows
7 Add elasticsearch URL with the port (even if the port is 80) and your kibana URLwith the port to the skedler_homeconfigreportingyml file as shown in the followingformat ltprotocolgtltservergtltportgt
8 Skedler can be deployed in the following ways
a) Start Skedler as service
sudo service skedler start
Copyright copy 2016 Guidanz Inc 11
b) Start Skedler manually from skedler_home directory
binskedler
9 Skedler License activation Trial key is packed with Skedler by default
a) Click ldquoAboutrdquo icon on Skedler home page and click ldquoActivate Licenserdquo button
b) Fill the fields NameEmail and Company name with required values
You will find the License Key filled with a Trial Key Read and click the Termsand Conditions and Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
If there is any issues with the Quick Installation process follow the section DetailedInstallation
5 Skedler Detailed Installation
Requires LD_LIBRARY_PATH
For ubuntuDebian in etcbashbashrc and for CentosRedhat in etcbashrc
Add the LD_LIBRARY_PATH variable as follows
Copyright copy 2016 Guidanz Inc 12
export LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
In etcenvironment file as follows
LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
Starting SkedlerStart the application from skedler home folder by typing
binskedler
a) Starting Skedler in debug modei When you start the application as a root user check whether
LD_LIBRARY_PATH is present in your environment variable To check use thefollowing commandsudo envIf LD_LIBRARY_PATH is present to start the application in debug mode fromskedler home type
binskedler debugElse specify LD_LIBRARY_PATH to start the application in debug mode from
skedler home as followssudo LD_LIBRARY_PATH=ltpathgt binskedler debug
ii When you start the application as a normal user type binskedler debug fromskedler home
b) Starting Skedler as Service
For UbuntuDebian servers (less than 1601 versions)To start skedler as a service
1 Copy skedler_homebinservicescriptsskedler_debian file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_debianchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$update-rcd skedler_debian defaults 97 8
Copyright copy 2016 Guidanz Inc 13
6 To start the skedler as service in normal mode execute this command$sudo service skedler_debian start
7 To start skedler as service in debug mode$sudo service skedler_debian start debug
For Ubuntu 1601To start skedler as a service
1 Copy skedler_homebinservicescriptsskedler_debian file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_debianchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$update-rcd skedler_debian defaults 97 8$ systemctl daemon-reload
6 To start the skedler as service in normal mode execute this command$sudo service skedler_debian start
7 To start skedler as service in debug mode$sudo service skedler_debian start debug
For CentosRedhat1 Copy skedler_homebinservicescriptsskedler_redhat file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_redhatchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$ chkconfig --add skedler_rehat$ chkconfig --level 2345 skedler_redhat on
6 To start the skedler as service in normal mode execute this command$sudo service skedler_redhat start
7 To start skedler as service in debug mode
Copyright copy 2016 Guidanz Inc 14
$sudo service skedler_redhat start debug
6 Access Skedler
1 Skedler can be accessed from the following URL httpltyourServergt3000 Ifeverything is installed fine you will see the Email configuration pagea) If you do not require your reports to be mailed you can disable your mail
settings using switch ldquooffrdquob) If you require reports to be mailed configure the outgoing mail settings and
email id (from which all the reports will be sent) If the SMTP server hasany authentication then check ldquoEnable Passwordrdquo and fill the passwordfield After setting the configuration click ldquoSaverdquo button
c) Update time zone for scheduling your report using ldquoTimeZone Settingrdquo andclick ldquoUpdaterdquo
Copyright copy 2016 Guidanz Inc 15
2 Optionally you can upload default logo for your generated PDF report byuploading image using ldquoSelect imagerdquo and click ldquoSaverdquo To reset image clickldquoResetrdquo
3 Click ldquoHomerdquo icon and you will be taken to the home page of Skedler Toschedule a report follow the User Guide
Copyright copy 2016 Guidanz Inc 16
7 How to embed Skedler in your applicationTo embed Skedler UI in your application without the Skedler header and footer followthe steps given below
1 If your application does not require Authentication
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreports
ii Filters - httpltyourServergtfilters
iii Eamil - httpltyourServergtemail
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltyourServergtreportsquery=rdquocitycastrordquo
2 If you application requires Authentication - Admin user can set the emailconfiguration details
Copyright copy 2016 Guidanz Inc 17
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreportsid=ltauthenticationIDgt
ii Filters - httpltyourServergtfiltersid=ltauthenticationIDgt
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltgtreportsid=ltauthenticationIDgtampquery=rdquocitycastrordquo
NOTE authenticationID can be username or ID wich is used to login your application
authenticationID for admin user is ldquoadminrdquo
8 Activate LicenseWhen Skedler is installed it operates in Free Edition with limited functionality Pleasenote the following features that are available when running Skedler in Free Edition
radic You can create and delete a report
radic Preview the report with different Time Window
radic Mail the report
Skedler license can be activated in two ways Online Activation and Offline ActivationFollow the steps given in each section for successful activation If you have not yetinstalled Skedler please refer to the Skedler Installation Guide
You can activate license by clicking ldquoAboutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 18
To activate license key click ldquoActivate Licenserdquo button
The following screenshot displays the License Activation Page
Copyright copy 2016 Guidanz Inc 19
License KeyOnline and Offline activation both require a 25 character alphanumeric license key oractivation code
Typically you would receive the license key along with the product downloadinformation If you have any questions or need help with the license key please contactus at supportskedlercom
Skedler provides different Editions
Trial Edition ndash Typically valid for 21days When the trial period expires Skedlerswitches to Free Edition
NOTE Trial Edition is not available for Offline Activation
Standard Edition
Advanced Edition
Premium Edition
a) Online Trial License Activation
Trial key is packed with Skedler by default
To activate your trial license key online you will need an Internet connection
1 Fill the fields NameEmail and Company name with required values
Copyright copy 2016 Guidanz Inc 20
2 You will find the License Key filled with a Skedler Trial Key
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 21
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
Copyright copy 2016 Guidanz Inc 22
b) Online Product License ActivationTo activate your license online you will need an Internet connection
Fill the required details in License Activation Page
You must have a license key for the edition you requested
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 23
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo to activate the license
c) Offline Product License ActivationFill the required details in License Activation Page
You must have a license key for the edition you requested
Copyright copy 2016 Guidanz Inc 24
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 Offline Activation does not require proxy setting
4 Read and click the Terms and Conditions
5 Click ldquoOffline Activationrdquo link
6 On clicking it will generate a producttxt file Use the steps given below to generatethe licensing file(actOffdat)
Copyright copy 2016 Guidanz Inc 25
a) Open the generated producttxt file
b) Copy the contenttext inside the producttxt file
c) Use the following curl command to generate the licensing file(actOffdat) replace theSTRING_FROM_THE_FILE with the copied content from producttxt file
curl -XPOST httpsskedlercomOfflineActivationphp -drequestData=STRING_FROM_THE_FILE gt actOffdat
Note Make sure the contenttext which you copy paste to the curl command inrequestData is same as in the generated producttxt file
d) Open the terminal that has an Internet connection and run the curl command Aresponse license file (actOffdat) is generated Copy the response license file(actOffdat) to a server location where Skedler runs
7 After generating the license file (actOffdat) using the curl command Click ldquoAboutrdquoicon in Skedler home page
8 Click ldquoLicense informationrdquo button Edition type and the license key is automaticallyfilled Click ldquoSelect Filerdquo find the license file ldquoactOffdatrdquo on your computer andupload it
Note Retain the same file name ldquoactOffdatrdquo during file upload
Copyright copy 2016 Guidanz Inc 26
9 Click ldquoActivaterdquo button to activate license
10 Click ldquoAbortrdquo button to abort your offline activation
Copyright copy 2016 Guidanz Inc 27
9 Move skedler with license from one server toanotherTo move skedler with license from one server to another follow the steps mention inDeactivate skedler with License section and continue with the steps given below
1 Stop skedler in old server
2 Copy skedler to new server
3 Give necessary permissions to skedler_home directory as follows
sudo chmod -R 765 skedler_home
4 Verify the necessary pre-requisites in the new server as given in Prerequisites section
5 Start skedler in new server using the following command
cd skedler_home
binskedler
Copyright copy 2016 Guidanz Inc 28
6 Activate license with the same key which was used to activate skedler on the oldserver and use the same details to fill the form
If you find any issues during the process contact skelder supportskedlercom
10 Deactivate Skedler with LicenseSkedler license is bound to the computer where you activated it Until you deactivate theskedler license key you cannot use it on another machine Deactivation remove licensedata from the current machine so that you can activate the skedler license key on anothermachine
You can deactivate skedler license key either Online or Offline
NOTE Trial edition cannot be deactivated
Deactivate skedler license key Online
Online deactivation requires an Internet connection To deactivate skedler license keynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate online
Deactivate skedler license key Offline
Offline deactivation does not require an Internet connection To deactivate skedler licensekeynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate offline
It will generate a text file in skedler_homeskedler_offline_deactivation_requesttxt pathwhich you must send to supportskedlercom
Copyright copy 2016 Guidanz Inc 29
11 Shield ConfigurationScenario 1
Kibana managers need access to dataindex 1 and 2
Kibana Users should have access only to dataindex 1
Skedler generates reports based on user permission for dataindex and Skedler needspermission to lsquokibanarsquo index for discovery
Assuming shield is configured for kibana as follows
1 For example if you have kibana_manager and kibana_user roles and skedlerindex configured for both the roles
2 Once the roles have full permission to access the dataindex configured for the roleSkedler can discover all the dashboards and searches from kibana And you canpreview or a generate report for dashboards and search for the configureddataindex
3 In case(a) kibana_manager role has full permission to access lsquokibanarsquodataindex1 dataindex2 and lsquoskedlerrsquo index Skedler can discover all thedashboards and searches from kibana And you can preview or generate report forall dashboards and search from dataindex1 and dataindex2
a) The required permissions for kibana_manager
kibana_manager
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
Copyright copy 2016 Guidanz Inc 30
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
dataindex2
- indicesadminexists
- indicesadminmappingsfieldsget
Copyright copy 2016 Guidanz Inc 31
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
4 In case(b) kibana_user role have full permission to access lsquokibanarsquodataindex1and lsquoskedlerrsquo index Skedler can discover all the dashboards and
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 6
if the result is empty follow the below steps to configure JAVA_HOME
For ubuntuDebian in etcbashbashrc and for CentosRedhat in etcbashrc
Add the JAVA_HOME variable as follows
export JAVA_HOME = ltyour_java_pathgt
In etcenvironment file as follows
JAVA_HOME = ltyour_java_pathgt
3 Skedler Configuration
1 Unzip the Skedlerzip file in the server to be installed
2 ReadWrite Permissions are required for generating reports1 skedler_homelog2 skedler_homereports3 skedler_homesrcpreview4 And the custom folder given in reportingyml or the folder specified while
creating reports or folder specified while creating filters3 For new installation go to config folder
cd skedlerconfig
4 Add elasticsearch URL with the port (even if the port is 80) and your kibana URLwith the port to the reportingyml file as shown in the following formatltprotocolgtltservergtltportgt
Copyright copy 2016 Guidanz Inc 7
5 Skedler is bound to host 0000 (any host) by default This parameter can bechanged to bind skedler to any IP address eg 127001 means skedler will bebound to 127001 If the host is changed in reportingyml make sure it has anentry in etchosts file against its hostname For the above-given example youneed to have an entry as this in etchosts 127001 lthostnamegt
6 If you are using Elastic Shield to authenticate Elasticsearch users please followthe steps given in Shield configuration section later in this document
7 If Nginx is used for reverse proxy settings please follow the steps given in Nginxconfiguration section later in this document
8 You can configure the location for storing your scheduled reports using Reportshome directory as shown below Make sure the folder has readwrite permissionsThe default location is skedlerreports in the application directory
Copyright copy 2016 Guidanz Inc 8
9 Save the changes to reportingyml file10ReportingEngine is scaled as per the CPU cores in the system and is configurable
The parameter workerCount in the file configreportingEngineOptions specifieshow many worker threads are created to scale Ideally it can be set as n2 where nis the no of CPU cores as shown The default value is 2 assuming a 4 CPU coresystem If the system hangs try reducing the workerCount Minimum value is 1
11Other setting in reportingEngineOptions
S No Name MandatoryOptional Description1 quality Optional You can set the quality of the image
between a range of 0 to 100 Defaultquality 0NOTE As the quality increases thegenerated PNG size also increases
12Other setting in reportingyml
S No Name MandatoryOptional Description1 port Mandatory The port in which skedler runs
Default port is 3000
Copyright copy 2016 Guidanz Inc 9
2 host Optional The host to bind the skedler serverThis bind address should beconfigured in etchosts with hostname eg if bind address is127001 then in etchosts127001 lthostnamegt should beadded
3 kibana_index Mandatory Kibana uses an index inElasticsearch to all data Configurekibana index here skedler will usethis index to auto discoverdashboardsSkedler will not create this indexDefault kibana_index is kibana
4 skedler_index Mandatory Skedler index which will be createdin elasticsearch It will create a newindex if it doesnt already existDefault skedler_index is skedler
5 Kibana_version Mandatory Skedler to identify Kibanaconfigurations
6 load_time Optional Kibana dashboard load time is theapproximate load time provided bySkelder for Kibana to generate thedashboardsIf reports are not fully loadedconfigure(increase) the load time (inmilliseconds) here so that Skedlerprovides adequate time for Kibana toload the dashboardDefault load_time value is 10seconds (10000 milliseconds)
7 kibana_shield_plugin
Optional Kibana shield plugin is installed inkibana to connect to elasticsearchshieldIf kibana shield plugin is installed inKibana please set this variable asyes By detfault the variable is setto ldquonordquoIf kibana doesnt have shield pluginand elasticsearch is configured withshield set this variable to ldquonordquo
Copyright copy 2016 Guidanz Inc 10
4 Skedler Quick Installation1 Download the latest skedler zip (or targz) file
2 Unpack the skedler zip file that you downloaded
3 cd to the unpacked folder
4 Give necessary permission to the script file installsh Use the following command togive permission
sudo chmod u+x installsh
5 Set the value for variable JAVA_HOME in the script file installsh as follows
a) To check JAVA_HOME given the following command
echo $JAVA_HOME
b) Copy and paste the output to installsh script as shown in screenshot
6 Run installsh script as follows
7 Add elasticsearch URL with the port (even if the port is 80) and your kibana URLwith the port to the skedler_homeconfigreportingyml file as shown in the followingformat ltprotocolgtltservergtltportgt
8 Skedler can be deployed in the following ways
a) Start Skedler as service
sudo service skedler start
Copyright copy 2016 Guidanz Inc 11
b) Start Skedler manually from skedler_home directory
binskedler
9 Skedler License activation Trial key is packed with Skedler by default
a) Click ldquoAboutrdquo icon on Skedler home page and click ldquoActivate Licenserdquo button
b) Fill the fields NameEmail and Company name with required values
You will find the License Key filled with a Trial Key Read and click the Termsand Conditions and Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
If there is any issues with the Quick Installation process follow the section DetailedInstallation
5 Skedler Detailed Installation
Requires LD_LIBRARY_PATH
For ubuntuDebian in etcbashbashrc and for CentosRedhat in etcbashrc
Add the LD_LIBRARY_PATH variable as follows
Copyright copy 2016 Guidanz Inc 12
export LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
In etcenvironment file as follows
LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
Starting SkedlerStart the application from skedler home folder by typing
binskedler
a) Starting Skedler in debug modei When you start the application as a root user check whether
LD_LIBRARY_PATH is present in your environment variable To check use thefollowing commandsudo envIf LD_LIBRARY_PATH is present to start the application in debug mode fromskedler home type
binskedler debugElse specify LD_LIBRARY_PATH to start the application in debug mode from
skedler home as followssudo LD_LIBRARY_PATH=ltpathgt binskedler debug
ii When you start the application as a normal user type binskedler debug fromskedler home
b) Starting Skedler as Service
For UbuntuDebian servers (less than 1601 versions)To start skedler as a service
1 Copy skedler_homebinservicescriptsskedler_debian file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_debianchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$update-rcd skedler_debian defaults 97 8
Copyright copy 2016 Guidanz Inc 13
6 To start the skedler as service in normal mode execute this command$sudo service skedler_debian start
7 To start skedler as service in debug mode$sudo service skedler_debian start debug
For Ubuntu 1601To start skedler as a service
1 Copy skedler_homebinservicescriptsskedler_debian file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_debianchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$update-rcd skedler_debian defaults 97 8$ systemctl daemon-reload
6 To start the skedler as service in normal mode execute this command$sudo service skedler_debian start
7 To start skedler as service in debug mode$sudo service skedler_debian start debug
For CentosRedhat1 Copy skedler_homebinservicescriptsskedler_redhat file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_redhatchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$ chkconfig --add skedler_rehat$ chkconfig --level 2345 skedler_redhat on
6 To start the skedler as service in normal mode execute this command$sudo service skedler_redhat start
7 To start skedler as service in debug mode
Copyright copy 2016 Guidanz Inc 14
$sudo service skedler_redhat start debug
6 Access Skedler
1 Skedler can be accessed from the following URL httpltyourServergt3000 Ifeverything is installed fine you will see the Email configuration pagea) If you do not require your reports to be mailed you can disable your mail
settings using switch ldquooffrdquob) If you require reports to be mailed configure the outgoing mail settings and
email id (from which all the reports will be sent) If the SMTP server hasany authentication then check ldquoEnable Passwordrdquo and fill the passwordfield After setting the configuration click ldquoSaverdquo button
c) Update time zone for scheduling your report using ldquoTimeZone Settingrdquo andclick ldquoUpdaterdquo
Copyright copy 2016 Guidanz Inc 15
2 Optionally you can upload default logo for your generated PDF report byuploading image using ldquoSelect imagerdquo and click ldquoSaverdquo To reset image clickldquoResetrdquo
3 Click ldquoHomerdquo icon and you will be taken to the home page of Skedler Toschedule a report follow the User Guide
Copyright copy 2016 Guidanz Inc 16
7 How to embed Skedler in your applicationTo embed Skedler UI in your application without the Skedler header and footer followthe steps given below
1 If your application does not require Authentication
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreports
ii Filters - httpltyourServergtfilters
iii Eamil - httpltyourServergtemail
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltyourServergtreportsquery=rdquocitycastrordquo
2 If you application requires Authentication - Admin user can set the emailconfiguration details
Copyright copy 2016 Guidanz Inc 17
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreportsid=ltauthenticationIDgt
ii Filters - httpltyourServergtfiltersid=ltauthenticationIDgt
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltgtreportsid=ltauthenticationIDgtampquery=rdquocitycastrordquo
NOTE authenticationID can be username or ID wich is used to login your application
authenticationID for admin user is ldquoadminrdquo
8 Activate LicenseWhen Skedler is installed it operates in Free Edition with limited functionality Pleasenote the following features that are available when running Skedler in Free Edition
radic You can create and delete a report
radic Preview the report with different Time Window
radic Mail the report
Skedler license can be activated in two ways Online Activation and Offline ActivationFollow the steps given in each section for successful activation If you have not yetinstalled Skedler please refer to the Skedler Installation Guide
You can activate license by clicking ldquoAboutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 18
To activate license key click ldquoActivate Licenserdquo button
The following screenshot displays the License Activation Page
Copyright copy 2016 Guidanz Inc 19
License KeyOnline and Offline activation both require a 25 character alphanumeric license key oractivation code
Typically you would receive the license key along with the product downloadinformation If you have any questions or need help with the license key please contactus at supportskedlercom
Skedler provides different Editions
Trial Edition ndash Typically valid for 21days When the trial period expires Skedlerswitches to Free Edition
NOTE Trial Edition is not available for Offline Activation
Standard Edition
Advanced Edition
Premium Edition
a) Online Trial License Activation
Trial key is packed with Skedler by default
To activate your trial license key online you will need an Internet connection
1 Fill the fields NameEmail and Company name with required values
Copyright copy 2016 Guidanz Inc 20
2 You will find the License Key filled with a Skedler Trial Key
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 21
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
Copyright copy 2016 Guidanz Inc 22
b) Online Product License ActivationTo activate your license online you will need an Internet connection
Fill the required details in License Activation Page
You must have a license key for the edition you requested
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 23
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo to activate the license
c) Offline Product License ActivationFill the required details in License Activation Page
You must have a license key for the edition you requested
Copyright copy 2016 Guidanz Inc 24
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 Offline Activation does not require proxy setting
4 Read and click the Terms and Conditions
5 Click ldquoOffline Activationrdquo link
6 On clicking it will generate a producttxt file Use the steps given below to generatethe licensing file(actOffdat)
Copyright copy 2016 Guidanz Inc 25
a) Open the generated producttxt file
b) Copy the contenttext inside the producttxt file
c) Use the following curl command to generate the licensing file(actOffdat) replace theSTRING_FROM_THE_FILE with the copied content from producttxt file
curl -XPOST httpsskedlercomOfflineActivationphp -drequestData=STRING_FROM_THE_FILE gt actOffdat
Note Make sure the contenttext which you copy paste to the curl command inrequestData is same as in the generated producttxt file
d) Open the terminal that has an Internet connection and run the curl command Aresponse license file (actOffdat) is generated Copy the response license file(actOffdat) to a server location where Skedler runs
7 After generating the license file (actOffdat) using the curl command Click ldquoAboutrdquoicon in Skedler home page
8 Click ldquoLicense informationrdquo button Edition type and the license key is automaticallyfilled Click ldquoSelect Filerdquo find the license file ldquoactOffdatrdquo on your computer andupload it
Note Retain the same file name ldquoactOffdatrdquo during file upload
Copyright copy 2016 Guidanz Inc 26
9 Click ldquoActivaterdquo button to activate license
10 Click ldquoAbortrdquo button to abort your offline activation
Copyright copy 2016 Guidanz Inc 27
9 Move skedler with license from one server toanotherTo move skedler with license from one server to another follow the steps mention inDeactivate skedler with License section and continue with the steps given below
1 Stop skedler in old server
2 Copy skedler to new server
3 Give necessary permissions to skedler_home directory as follows
sudo chmod -R 765 skedler_home
4 Verify the necessary pre-requisites in the new server as given in Prerequisites section
5 Start skedler in new server using the following command
cd skedler_home
binskedler
Copyright copy 2016 Guidanz Inc 28
6 Activate license with the same key which was used to activate skedler on the oldserver and use the same details to fill the form
If you find any issues during the process contact skelder supportskedlercom
10 Deactivate Skedler with LicenseSkedler license is bound to the computer where you activated it Until you deactivate theskedler license key you cannot use it on another machine Deactivation remove licensedata from the current machine so that you can activate the skedler license key on anothermachine
You can deactivate skedler license key either Online or Offline
NOTE Trial edition cannot be deactivated
Deactivate skedler license key Online
Online deactivation requires an Internet connection To deactivate skedler license keynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate online
Deactivate skedler license key Offline
Offline deactivation does not require an Internet connection To deactivate skedler licensekeynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate offline
It will generate a text file in skedler_homeskedler_offline_deactivation_requesttxt pathwhich you must send to supportskedlercom
Copyright copy 2016 Guidanz Inc 29
11 Shield ConfigurationScenario 1
Kibana managers need access to dataindex 1 and 2
Kibana Users should have access only to dataindex 1
Skedler generates reports based on user permission for dataindex and Skedler needspermission to lsquokibanarsquo index for discovery
Assuming shield is configured for kibana as follows
1 For example if you have kibana_manager and kibana_user roles and skedlerindex configured for both the roles
2 Once the roles have full permission to access the dataindex configured for the roleSkedler can discover all the dashboards and searches from kibana And you canpreview or a generate report for dashboards and search for the configureddataindex
3 In case(a) kibana_manager role has full permission to access lsquokibanarsquodataindex1 dataindex2 and lsquoskedlerrsquo index Skedler can discover all thedashboards and searches from kibana And you can preview or generate report forall dashboards and search from dataindex1 and dataindex2
a) The required permissions for kibana_manager
kibana_manager
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
Copyright copy 2016 Guidanz Inc 30
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
dataindex2
- indicesadminexists
- indicesadminmappingsfieldsget
Copyright copy 2016 Guidanz Inc 31
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
4 In case(b) kibana_user role have full permission to access lsquokibanarsquodataindex1and lsquoskedlerrsquo index Skedler can discover all the dashboards and
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 7
5 Skedler is bound to host 0000 (any host) by default This parameter can bechanged to bind skedler to any IP address eg 127001 means skedler will bebound to 127001 If the host is changed in reportingyml make sure it has anentry in etchosts file against its hostname For the above-given example youneed to have an entry as this in etchosts 127001 lthostnamegt
6 If you are using Elastic Shield to authenticate Elasticsearch users please followthe steps given in Shield configuration section later in this document
7 If Nginx is used for reverse proxy settings please follow the steps given in Nginxconfiguration section later in this document
8 You can configure the location for storing your scheduled reports using Reportshome directory as shown below Make sure the folder has readwrite permissionsThe default location is skedlerreports in the application directory
Copyright copy 2016 Guidanz Inc 8
9 Save the changes to reportingyml file10ReportingEngine is scaled as per the CPU cores in the system and is configurable
The parameter workerCount in the file configreportingEngineOptions specifieshow many worker threads are created to scale Ideally it can be set as n2 where nis the no of CPU cores as shown The default value is 2 assuming a 4 CPU coresystem If the system hangs try reducing the workerCount Minimum value is 1
11Other setting in reportingEngineOptions
S No Name MandatoryOptional Description1 quality Optional You can set the quality of the image
between a range of 0 to 100 Defaultquality 0NOTE As the quality increases thegenerated PNG size also increases
12Other setting in reportingyml
S No Name MandatoryOptional Description1 port Mandatory The port in which skedler runs
Default port is 3000
Copyright copy 2016 Guidanz Inc 9
2 host Optional The host to bind the skedler serverThis bind address should beconfigured in etchosts with hostname eg if bind address is127001 then in etchosts127001 lthostnamegt should beadded
3 kibana_index Mandatory Kibana uses an index inElasticsearch to all data Configurekibana index here skedler will usethis index to auto discoverdashboardsSkedler will not create this indexDefault kibana_index is kibana
4 skedler_index Mandatory Skedler index which will be createdin elasticsearch It will create a newindex if it doesnt already existDefault skedler_index is skedler
5 Kibana_version Mandatory Skedler to identify Kibanaconfigurations
6 load_time Optional Kibana dashboard load time is theapproximate load time provided bySkelder for Kibana to generate thedashboardsIf reports are not fully loadedconfigure(increase) the load time (inmilliseconds) here so that Skedlerprovides adequate time for Kibana toload the dashboardDefault load_time value is 10seconds (10000 milliseconds)
7 kibana_shield_plugin
Optional Kibana shield plugin is installed inkibana to connect to elasticsearchshieldIf kibana shield plugin is installed inKibana please set this variable asyes By detfault the variable is setto ldquonordquoIf kibana doesnt have shield pluginand elasticsearch is configured withshield set this variable to ldquonordquo
Copyright copy 2016 Guidanz Inc 10
4 Skedler Quick Installation1 Download the latest skedler zip (or targz) file
2 Unpack the skedler zip file that you downloaded
3 cd to the unpacked folder
4 Give necessary permission to the script file installsh Use the following command togive permission
sudo chmod u+x installsh
5 Set the value for variable JAVA_HOME in the script file installsh as follows
a) To check JAVA_HOME given the following command
echo $JAVA_HOME
b) Copy and paste the output to installsh script as shown in screenshot
6 Run installsh script as follows
7 Add elasticsearch URL with the port (even if the port is 80) and your kibana URLwith the port to the skedler_homeconfigreportingyml file as shown in the followingformat ltprotocolgtltservergtltportgt
8 Skedler can be deployed in the following ways
a) Start Skedler as service
sudo service skedler start
Copyright copy 2016 Guidanz Inc 11
b) Start Skedler manually from skedler_home directory
binskedler
9 Skedler License activation Trial key is packed with Skedler by default
a) Click ldquoAboutrdquo icon on Skedler home page and click ldquoActivate Licenserdquo button
b) Fill the fields NameEmail and Company name with required values
You will find the License Key filled with a Trial Key Read and click the Termsand Conditions and Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
If there is any issues with the Quick Installation process follow the section DetailedInstallation
5 Skedler Detailed Installation
Requires LD_LIBRARY_PATH
For ubuntuDebian in etcbashbashrc and for CentosRedhat in etcbashrc
Add the LD_LIBRARY_PATH variable as follows
Copyright copy 2016 Guidanz Inc 12
export LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
In etcenvironment file as follows
LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
Starting SkedlerStart the application from skedler home folder by typing
binskedler
a) Starting Skedler in debug modei When you start the application as a root user check whether
LD_LIBRARY_PATH is present in your environment variable To check use thefollowing commandsudo envIf LD_LIBRARY_PATH is present to start the application in debug mode fromskedler home type
binskedler debugElse specify LD_LIBRARY_PATH to start the application in debug mode from
skedler home as followssudo LD_LIBRARY_PATH=ltpathgt binskedler debug
ii When you start the application as a normal user type binskedler debug fromskedler home
b) Starting Skedler as Service
For UbuntuDebian servers (less than 1601 versions)To start skedler as a service
1 Copy skedler_homebinservicescriptsskedler_debian file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_debianchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$update-rcd skedler_debian defaults 97 8
Copyright copy 2016 Guidanz Inc 13
6 To start the skedler as service in normal mode execute this command$sudo service skedler_debian start
7 To start skedler as service in debug mode$sudo service skedler_debian start debug
For Ubuntu 1601To start skedler as a service
1 Copy skedler_homebinservicescriptsskedler_debian file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_debianchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$update-rcd skedler_debian defaults 97 8$ systemctl daemon-reload
6 To start the skedler as service in normal mode execute this command$sudo service skedler_debian start
7 To start skedler as service in debug mode$sudo service skedler_debian start debug
For CentosRedhat1 Copy skedler_homebinservicescriptsskedler_redhat file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_redhatchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$ chkconfig --add skedler_rehat$ chkconfig --level 2345 skedler_redhat on
6 To start the skedler as service in normal mode execute this command$sudo service skedler_redhat start
7 To start skedler as service in debug mode
Copyright copy 2016 Guidanz Inc 14
$sudo service skedler_redhat start debug
6 Access Skedler
1 Skedler can be accessed from the following URL httpltyourServergt3000 Ifeverything is installed fine you will see the Email configuration pagea) If you do not require your reports to be mailed you can disable your mail
settings using switch ldquooffrdquob) If you require reports to be mailed configure the outgoing mail settings and
email id (from which all the reports will be sent) If the SMTP server hasany authentication then check ldquoEnable Passwordrdquo and fill the passwordfield After setting the configuration click ldquoSaverdquo button
c) Update time zone for scheduling your report using ldquoTimeZone Settingrdquo andclick ldquoUpdaterdquo
Copyright copy 2016 Guidanz Inc 15
2 Optionally you can upload default logo for your generated PDF report byuploading image using ldquoSelect imagerdquo and click ldquoSaverdquo To reset image clickldquoResetrdquo
3 Click ldquoHomerdquo icon and you will be taken to the home page of Skedler Toschedule a report follow the User Guide
Copyright copy 2016 Guidanz Inc 16
7 How to embed Skedler in your applicationTo embed Skedler UI in your application without the Skedler header and footer followthe steps given below
1 If your application does not require Authentication
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreports
ii Filters - httpltyourServergtfilters
iii Eamil - httpltyourServergtemail
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltyourServergtreportsquery=rdquocitycastrordquo
2 If you application requires Authentication - Admin user can set the emailconfiguration details
Copyright copy 2016 Guidanz Inc 17
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreportsid=ltauthenticationIDgt
ii Filters - httpltyourServergtfiltersid=ltauthenticationIDgt
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltgtreportsid=ltauthenticationIDgtampquery=rdquocitycastrordquo
NOTE authenticationID can be username or ID wich is used to login your application
authenticationID for admin user is ldquoadminrdquo
8 Activate LicenseWhen Skedler is installed it operates in Free Edition with limited functionality Pleasenote the following features that are available when running Skedler in Free Edition
radic You can create and delete a report
radic Preview the report with different Time Window
radic Mail the report
Skedler license can be activated in two ways Online Activation and Offline ActivationFollow the steps given in each section for successful activation If you have not yetinstalled Skedler please refer to the Skedler Installation Guide
You can activate license by clicking ldquoAboutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 18
To activate license key click ldquoActivate Licenserdquo button
The following screenshot displays the License Activation Page
Copyright copy 2016 Guidanz Inc 19
License KeyOnline and Offline activation both require a 25 character alphanumeric license key oractivation code
Typically you would receive the license key along with the product downloadinformation If you have any questions or need help with the license key please contactus at supportskedlercom
Skedler provides different Editions
Trial Edition ndash Typically valid for 21days When the trial period expires Skedlerswitches to Free Edition
NOTE Trial Edition is not available for Offline Activation
Standard Edition
Advanced Edition
Premium Edition
a) Online Trial License Activation
Trial key is packed with Skedler by default
To activate your trial license key online you will need an Internet connection
1 Fill the fields NameEmail and Company name with required values
Copyright copy 2016 Guidanz Inc 20
2 You will find the License Key filled with a Skedler Trial Key
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 21
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
Copyright copy 2016 Guidanz Inc 22
b) Online Product License ActivationTo activate your license online you will need an Internet connection
Fill the required details in License Activation Page
You must have a license key for the edition you requested
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 23
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo to activate the license
c) Offline Product License ActivationFill the required details in License Activation Page
You must have a license key for the edition you requested
Copyright copy 2016 Guidanz Inc 24
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 Offline Activation does not require proxy setting
4 Read and click the Terms and Conditions
5 Click ldquoOffline Activationrdquo link
6 On clicking it will generate a producttxt file Use the steps given below to generatethe licensing file(actOffdat)
Copyright copy 2016 Guidanz Inc 25
a) Open the generated producttxt file
b) Copy the contenttext inside the producttxt file
c) Use the following curl command to generate the licensing file(actOffdat) replace theSTRING_FROM_THE_FILE with the copied content from producttxt file
curl -XPOST httpsskedlercomOfflineActivationphp -drequestData=STRING_FROM_THE_FILE gt actOffdat
Note Make sure the contenttext which you copy paste to the curl command inrequestData is same as in the generated producttxt file
d) Open the terminal that has an Internet connection and run the curl command Aresponse license file (actOffdat) is generated Copy the response license file(actOffdat) to a server location where Skedler runs
7 After generating the license file (actOffdat) using the curl command Click ldquoAboutrdquoicon in Skedler home page
8 Click ldquoLicense informationrdquo button Edition type and the license key is automaticallyfilled Click ldquoSelect Filerdquo find the license file ldquoactOffdatrdquo on your computer andupload it
Note Retain the same file name ldquoactOffdatrdquo during file upload
Copyright copy 2016 Guidanz Inc 26
9 Click ldquoActivaterdquo button to activate license
10 Click ldquoAbortrdquo button to abort your offline activation
Copyright copy 2016 Guidanz Inc 27
9 Move skedler with license from one server toanotherTo move skedler with license from one server to another follow the steps mention inDeactivate skedler with License section and continue with the steps given below
1 Stop skedler in old server
2 Copy skedler to new server
3 Give necessary permissions to skedler_home directory as follows
sudo chmod -R 765 skedler_home
4 Verify the necessary pre-requisites in the new server as given in Prerequisites section
5 Start skedler in new server using the following command
cd skedler_home
binskedler
Copyright copy 2016 Guidanz Inc 28
6 Activate license with the same key which was used to activate skedler on the oldserver and use the same details to fill the form
If you find any issues during the process contact skelder supportskedlercom
10 Deactivate Skedler with LicenseSkedler license is bound to the computer where you activated it Until you deactivate theskedler license key you cannot use it on another machine Deactivation remove licensedata from the current machine so that you can activate the skedler license key on anothermachine
You can deactivate skedler license key either Online or Offline
NOTE Trial edition cannot be deactivated
Deactivate skedler license key Online
Online deactivation requires an Internet connection To deactivate skedler license keynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate online
Deactivate skedler license key Offline
Offline deactivation does not require an Internet connection To deactivate skedler licensekeynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate offline
It will generate a text file in skedler_homeskedler_offline_deactivation_requesttxt pathwhich you must send to supportskedlercom
Copyright copy 2016 Guidanz Inc 29
11 Shield ConfigurationScenario 1
Kibana managers need access to dataindex 1 and 2
Kibana Users should have access only to dataindex 1
Skedler generates reports based on user permission for dataindex and Skedler needspermission to lsquokibanarsquo index for discovery
Assuming shield is configured for kibana as follows
1 For example if you have kibana_manager and kibana_user roles and skedlerindex configured for both the roles
2 Once the roles have full permission to access the dataindex configured for the roleSkedler can discover all the dashboards and searches from kibana And you canpreview or a generate report for dashboards and search for the configureddataindex
3 In case(a) kibana_manager role has full permission to access lsquokibanarsquodataindex1 dataindex2 and lsquoskedlerrsquo index Skedler can discover all thedashboards and searches from kibana And you can preview or generate report forall dashboards and search from dataindex1 and dataindex2
a) The required permissions for kibana_manager
kibana_manager
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
Copyright copy 2016 Guidanz Inc 30
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
dataindex2
- indicesadminexists
- indicesadminmappingsfieldsget
Copyright copy 2016 Guidanz Inc 31
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
4 In case(b) kibana_user role have full permission to access lsquokibanarsquodataindex1and lsquoskedlerrsquo index Skedler can discover all the dashboards and
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 8
9 Save the changes to reportingyml file10ReportingEngine is scaled as per the CPU cores in the system and is configurable
The parameter workerCount in the file configreportingEngineOptions specifieshow many worker threads are created to scale Ideally it can be set as n2 where nis the no of CPU cores as shown The default value is 2 assuming a 4 CPU coresystem If the system hangs try reducing the workerCount Minimum value is 1
11Other setting in reportingEngineOptions
S No Name MandatoryOptional Description1 quality Optional You can set the quality of the image
between a range of 0 to 100 Defaultquality 0NOTE As the quality increases thegenerated PNG size also increases
12Other setting in reportingyml
S No Name MandatoryOptional Description1 port Mandatory The port in which skedler runs
Default port is 3000
Copyright copy 2016 Guidanz Inc 9
2 host Optional The host to bind the skedler serverThis bind address should beconfigured in etchosts with hostname eg if bind address is127001 then in etchosts127001 lthostnamegt should beadded
3 kibana_index Mandatory Kibana uses an index inElasticsearch to all data Configurekibana index here skedler will usethis index to auto discoverdashboardsSkedler will not create this indexDefault kibana_index is kibana
4 skedler_index Mandatory Skedler index which will be createdin elasticsearch It will create a newindex if it doesnt already existDefault skedler_index is skedler
5 Kibana_version Mandatory Skedler to identify Kibanaconfigurations
6 load_time Optional Kibana dashboard load time is theapproximate load time provided bySkelder for Kibana to generate thedashboardsIf reports are not fully loadedconfigure(increase) the load time (inmilliseconds) here so that Skedlerprovides adequate time for Kibana toload the dashboardDefault load_time value is 10seconds (10000 milliseconds)
7 kibana_shield_plugin
Optional Kibana shield plugin is installed inkibana to connect to elasticsearchshieldIf kibana shield plugin is installed inKibana please set this variable asyes By detfault the variable is setto ldquonordquoIf kibana doesnt have shield pluginand elasticsearch is configured withshield set this variable to ldquonordquo
Copyright copy 2016 Guidanz Inc 10
4 Skedler Quick Installation1 Download the latest skedler zip (or targz) file
2 Unpack the skedler zip file that you downloaded
3 cd to the unpacked folder
4 Give necessary permission to the script file installsh Use the following command togive permission
sudo chmod u+x installsh
5 Set the value for variable JAVA_HOME in the script file installsh as follows
a) To check JAVA_HOME given the following command
echo $JAVA_HOME
b) Copy and paste the output to installsh script as shown in screenshot
6 Run installsh script as follows
7 Add elasticsearch URL with the port (even if the port is 80) and your kibana URLwith the port to the skedler_homeconfigreportingyml file as shown in the followingformat ltprotocolgtltservergtltportgt
8 Skedler can be deployed in the following ways
a) Start Skedler as service
sudo service skedler start
Copyright copy 2016 Guidanz Inc 11
b) Start Skedler manually from skedler_home directory
binskedler
9 Skedler License activation Trial key is packed with Skedler by default
a) Click ldquoAboutrdquo icon on Skedler home page and click ldquoActivate Licenserdquo button
b) Fill the fields NameEmail and Company name with required values
You will find the License Key filled with a Trial Key Read and click the Termsand Conditions and Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
If there is any issues with the Quick Installation process follow the section DetailedInstallation
5 Skedler Detailed Installation
Requires LD_LIBRARY_PATH
For ubuntuDebian in etcbashbashrc and for CentosRedhat in etcbashrc
Add the LD_LIBRARY_PATH variable as follows
Copyright copy 2016 Guidanz Inc 12
export LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
In etcenvironment file as follows
LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
Starting SkedlerStart the application from skedler home folder by typing
binskedler
a) Starting Skedler in debug modei When you start the application as a root user check whether
LD_LIBRARY_PATH is present in your environment variable To check use thefollowing commandsudo envIf LD_LIBRARY_PATH is present to start the application in debug mode fromskedler home type
binskedler debugElse specify LD_LIBRARY_PATH to start the application in debug mode from
skedler home as followssudo LD_LIBRARY_PATH=ltpathgt binskedler debug
ii When you start the application as a normal user type binskedler debug fromskedler home
b) Starting Skedler as Service
For UbuntuDebian servers (less than 1601 versions)To start skedler as a service
1 Copy skedler_homebinservicescriptsskedler_debian file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_debianchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$update-rcd skedler_debian defaults 97 8
Copyright copy 2016 Guidanz Inc 13
6 To start the skedler as service in normal mode execute this command$sudo service skedler_debian start
7 To start skedler as service in debug mode$sudo service skedler_debian start debug
For Ubuntu 1601To start skedler as a service
1 Copy skedler_homebinservicescriptsskedler_debian file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_debianchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$update-rcd skedler_debian defaults 97 8$ systemctl daemon-reload
6 To start the skedler as service in normal mode execute this command$sudo service skedler_debian start
7 To start skedler as service in debug mode$sudo service skedler_debian start debug
For CentosRedhat1 Copy skedler_homebinservicescriptsskedler_redhat file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_redhatchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$ chkconfig --add skedler_rehat$ chkconfig --level 2345 skedler_redhat on
6 To start the skedler as service in normal mode execute this command$sudo service skedler_redhat start
7 To start skedler as service in debug mode
Copyright copy 2016 Guidanz Inc 14
$sudo service skedler_redhat start debug
6 Access Skedler
1 Skedler can be accessed from the following URL httpltyourServergt3000 Ifeverything is installed fine you will see the Email configuration pagea) If you do not require your reports to be mailed you can disable your mail
settings using switch ldquooffrdquob) If you require reports to be mailed configure the outgoing mail settings and
email id (from which all the reports will be sent) If the SMTP server hasany authentication then check ldquoEnable Passwordrdquo and fill the passwordfield After setting the configuration click ldquoSaverdquo button
c) Update time zone for scheduling your report using ldquoTimeZone Settingrdquo andclick ldquoUpdaterdquo
Copyright copy 2016 Guidanz Inc 15
2 Optionally you can upload default logo for your generated PDF report byuploading image using ldquoSelect imagerdquo and click ldquoSaverdquo To reset image clickldquoResetrdquo
3 Click ldquoHomerdquo icon and you will be taken to the home page of Skedler Toschedule a report follow the User Guide
Copyright copy 2016 Guidanz Inc 16
7 How to embed Skedler in your applicationTo embed Skedler UI in your application without the Skedler header and footer followthe steps given below
1 If your application does not require Authentication
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreports
ii Filters - httpltyourServergtfilters
iii Eamil - httpltyourServergtemail
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltyourServergtreportsquery=rdquocitycastrordquo
2 If you application requires Authentication - Admin user can set the emailconfiguration details
Copyright copy 2016 Guidanz Inc 17
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreportsid=ltauthenticationIDgt
ii Filters - httpltyourServergtfiltersid=ltauthenticationIDgt
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltgtreportsid=ltauthenticationIDgtampquery=rdquocitycastrordquo
NOTE authenticationID can be username or ID wich is used to login your application
authenticationID for admin user is ldquoadminrdquo
8 Activate LicenseWhen Skedler is installed it operates in Free Edition with limited functionality Pleasenote the following features that are available when running Skedler in Free Edition
radic You can create and delete a report
radic Preview the report with different Time Window
radic Mail the report
Skedler license can be activated in two ways Online Activation and Offline ActivationFollow the steps given in each section for successful activation If you have not yetinstalled Skedler please refer to the Skedler Installation Guide
You can activate license by clicking ldquoAboutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 18
To activate license key click ldquoActivate Licenserdquo button
The following screenshot displays the License Activation Page
Copyright copy 2016 Guidanz Inc 19
License KeyOnline and Offline activation both require a 25 character alphanumeric license key oractivation code
Typically you would receive the license key along with the product downloadinformation If you have any questions or need help with the license key please contactus at supportskedlercom
Skedler provides different Editions
Trial Edition ndash Typically valid for 21days When the trial period expires Skedlerswitches to Free Edition
NOTE Trial Edition is not available for Offline Activation
Standard Edition
Advanced Edition
Premium Edition
a) Online Trial License Activation
Trial key is packed with Skedler by default
To activate your trial license key online you will need an Internet connection
1 Fill the fields NameEmail and Company name with required values
Copyright copy 2016 Guidanz Inc 20
2 You will find the License Key filled with a Skedler Trial Key
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 21
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
Copyright copy 2016 Guidanz Inc 22
b) Online Product License ActivationTo activate your license online you will need an Internet connection
Fill the required details in License Activation Page
You must have a license key for the edition you requested
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 23
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo to activate the license
c) Offline Product License ActivationFill the required details in License Activation Page
You must have a license key for the edition you requested
Copyright copy 2016 Guidanz Inc 24
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 Offline Activation does not require proxy setting
4 Read and click the Terms and Conditions
5 Click ldquoOffline Activationrdquo link
6 On clicking it will generate a producttxt file Use the steps given below to generatethe licensing file(actOffdat)
Copyright copy 2016 Guidanz Inc 25
a) Open the generated producttxt file
b) Copy the contenttext inside the producttxt file
c) Use the following curl command to generate the licensing file(actOffdat) replace theSTRING_FROM_THE_FILE with the copied content from producttxt file
curl -XPOST httpsskedlercomOfflineActivationphp -drequestData=STRING_FROM_THE_FILE gt actOffdat
Note Make sure the contenttext which you copy paste to the curl command inrequestData is same as in the generated producttxt file
d) Open the terminal that has an Internet connection and run the curl command Aresponse license file (actOffdat) is generated Copy the response license file(actOffdat) to a server location where Skedler runs
7 After generating the license file (actOffdat) using the curl command Click ldquoAboutrdquoicon in Skedler home page
8 Click ldquoLicense informationrdquo button Edition type and the license key is automaticallyfilled Click ldquoSelect Filerdquo find the license file ldquoactOffdatrdquo on your computer andupload it
Note Retain the same file name ldquoactOffdatrdquo during file upload
Copyright copy 2016 Guidanz Inc 26
9 Click ldquoActivaterdquo button to activate license
10 Click ldquoAbortrdquo button to abort your offline activation
Copyright copy 2016 Guidanz Inc 27
9 Move skedler with license from one server toanotherTo move skedler with license from one server to another follow the steps mention inDeactivate skedler with License section and continue with the steps given below
1 Stop skedler in old server
2 Copy skedler to new server
3 Give necessary permissions to skedler_home directory as follows
sudo chmod -R 765 skedler_home
4 Verify the necessary pre-requisites in the new server as given in Prerequisites section
5 Start skedler in new server using the following command
cd skedler_home
binskedler
Copyright copy 2016 Guidanz Inc 28
6 Activate license with the same key which was used to activate skedler on the oldserver and use the same details to fill the form
If you find any issues during the process contact skelder supportskedlercom
10 Deactivate Skedler with LicenseSkedler license is bound to the computer where you activated it Until you deactivate theskedler license key you cannot use it on another machine Deactivation remove licensedata from the current machine so that you can activate the skedler license key on anothermachine
You can deactivate skedler license key either Online or Offline
NOTE Trial edition cannot be deactivated
Deactivate skedler license key Online
Online deactivation requires an Internet connection To deactivate skedler license keynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate online
Deactivate skedler license key Offline
Offline deactivation does not require an Internet connection To deactivate skedler licensekeynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate offline
It will generate a text file in skedler_homeskedler_offline_deactivation_requesttxt pathwhich you must send to supportskedlercom
Copyright copy 2016 Guidanz Inc 29
11 Shield ConfigurationScenario 1
Kibana managers need access to dataindex 1 and 2
Kibana Users should have access only to dataindex 1
Skedler generates reports based on user permission for dataindex and Skedler needspermission to lsquokibanarsquo index for discovery
Assuming shield is configured for kibana as follows
1 For example if you have kibana_manager and kibana_user roles and skedlerindex configured for both the roles
2 Once the roles have full permission to access the dataindex configured for the roleSkedler can discover all the dashboards and searches from kibana And you canpreview or a generate report for dashboards and search for the configureddataindex
3 In case(a) kibana_manager role has full permission to access lsquokibanarsquodataindex1 dataindex2 and lsquoskedlerrsquo index Skedler can discover all thedashboards and searches from kibana And you can preview or generate report forall dashboards and search from dataindex1 and dataindex2
a) The required permissions for kibana_manager
kibana_manager
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
Copyright copy 2016 Guidanz Inc 30
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
dataindex2
- indicesadminexists
- indicesadminmappingsfieldsget
Copyright copy 2016 Guidanz Inc 31
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
4 In case(b) kibana_user role have full permission to access lsquokibanarsquodataindex1and lsquoskedlerrsquo index Skedler can discover all the dashboards and
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 9
2 host Optional The host to bind the skedler serverThis bind address should beconfigured in etchosts with hostname eg if bind address is127001 then in etchosts127001 lthostnamegt should beadded
3 kibana_index Mandatory Kibana uses an index inElasticsearch to all data Configurekibana index here skedler will usethis index to auto discoverdashboardsSkedler will not create this indexDefault kibana_index is kibana
4 skedler_index Mandatory Skedler index which will be createdin elasticsearch It will create a newindex if it doesnt already existDefault skedler_index is skedler
5 Kibana_version Mandatory Skedler to identify Kibanaconfigurations
6 load_time Optional Kibana dashboard load time is theapproximate load time provided bySkelder for Kibana to generate thedashboardsIf reports are not fully loadedconfigure(increase) the load time (inmilliseconds) here so that Skedlerprovides adequate time for Kibana toload the dashboardDefault load_time value is 10seconds (10000 milliseconds)
7 kibana_shield_plugin
Optional Kibana shield plugin is installed inkibana to connect to elasticsearchshieldIf kibana shield plugin is installed inKibana please set this variable asyes By detfault the variable is setto ldquonordquoIf kibana doesnt have shield pluginand elasticsearch is configured withshield set this variable to ldquonordquo
Copyright copy 2016 Guidanz Inc 10
4 Skedler Quick Installation1 Download the latest skedler zip (or targz) file
2 Unpack the skedler zip file that you downloaded
3 cd to the unpacked folder
4 Give necessary permission to the script file installsh Use the following command togive permission
sudo chmod u+x installsh
5 Set the value for variable JAVA_HOME in the script file installsh as follows
a) To check JAVA_HOME given the following command
echo $JAVA_HOME
b) Copy and paste the output to installsh script as shown in screenshot
6 Run installsh script as follows
7 Add elasticsearch URL with the port (even if the port is 80) and your kibana URLwith the port to the skedler_homeconfigreportingyml file as shown in the followingformat ltprotocolgtltservergtltportgt
8 Skedler can be deployed in the following ways
a) Start Skedler as service
sudo service skedler start
Copyright copy 2016 Guidanz Inc 11
b) Start Skedler manually from skedler_home directory
binskedler
9 Skedler License activation Trial key is packed with Skedler by default
a) Click ldquoAboutrdquo icon on Skedler home page and click ldquoActivate Licenserdquo button
b) Fill the fields NameEmail and Company name with required values
You will find the License Key filled with a Trial Key Read and click the Termsand Conditions and Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
If there is any issues with the Quick Installation process follow the section DetailedInstallation
5 Skedler Detailed Installation
Requires LD_LIBRARY_PATH
For ubuntuDebian in etcbashbashrc and for CentosRedhat in etcbashrc
Add the LD_LIBRARY_PATH variable as follows
Copyright copy 2016 Guidanz Inc 12
export LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
In etcenvironment file as follows
LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
Starting SkedlerStart the application from skedler home folder by typing
binskedler
a) Starting Skedler in debug modei When you start the application as a root user check whether
LD_LIBRARY_PATH is present in your environment variable To check use thefollowing commandsudo envIf LD_LIBRARY_PATH is present to start the application in debug mode fromskedler home type
binskedler debugElse specify LD_LIBRARY_PATH to start the application in debug mode from
skedler home as followssudo LD_LIBRARY_PATH=ltpathgt binskedler debug
ii When you start the application as a normal user type binskedler debug fromskedler home
b) Starting Skedler as Service
For UbuntuDebian servers (less than 1601 versions)To start skedler as a service
1 Copy skedler_homebinservicescriptsskedler_debian file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_debianchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$update-rcd skedler_debian defaults 97 8
Copyright copy 2016 Guidanz Inc 13
6 To start the skedler as service in normal mode execute this command$sudo service skedler_debian start
7 To start skedler as service in debug mode$sudo service skedler_debian start debug
For Ubuntu 1601To start skedler as a service
1 Copy skedler_homebinservicescriptsskedler_debian file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_debianchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$update-rcd skedler_debian defaults 97 8$ systemctl daemon-reload
6 To start the skedler as service in normal mode execute this command$sudo service skedler_debian start
7 To start skedler as service in debug mode$sudo service skedler_debian start debug
For CentosRedhat1 Copy skedler_homebinservicescriptsskedler_redhat file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_redhatchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$ chkconfig --add skedler_rehat$ chkconfig --level 2345 skedler_redhat on
6 To start the skedler as service in normal mode execute this command$sudo service skedler_redhat start
7 To start skedler as service in debug mode
Copyright copy 2016 Guidanz Inc 14
$sudo service skedler_redhat start debug
6 Access Skedler
1 Skedler can be accessed from the following URL httpltyourServergt3000 Ifeverything is installed fine you will see the Email configuration pagea) If you do not require your reports to be mailed you can disable your mail
settings using switch ldquooffrdquob) If you require reports to be mailed configure the outgoing mail settings and
email id (from which all the reports will be sent) If the SMTP server hasany authentication then check ldquoEnable Passwordrdquo and fill the passwordfield After setting the configuration click ldquoSaverdquo button
c) Update time zone for scheduling your report using ldquoTimeZone Settingrdquo andclick ldquoUpdaterdquo
Copyright copy 2016 Guidanz Inc 15
2 Optionally you can upload default logo for your generated PDF report byuploading image using ldquoSelect imagerdquo and click ldquoSaverdquo To reset image clickldquoResetrdquo
3 Click ldquoHomerdquo icon and you will be taken to the home page of Skedler Toschedule a report follow the User Guide
Copyright copy 2016 Guidanz Inc 16
7 How to embed Skedler in your applicationTo embed Skedler UI in your application without the Skedler header and footer followthe steps given below
1 If your application does not require Authentication
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreports
ii Filters - httpltyourServergtfilters
iii Eamil - httpltyourServergtemail
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltyourServergtreportsquery=rdquocitycastrordquo
2 If you application requires Authentication - Admin user can set the emailconfiguration details
Copyright copy 2016 Guidanz Inc 17
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreportsid=ltauthenticationIDgt
ii Filters - httpltyourServergtfiltersid=ltauthenticationIDgt
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltgtreportsid=ltauthenticationIDgtampquery=rdquocitycastrordquo
NOTE authenticationID can be username or ID wich is used to login your application
authenticationID for admin user is ldquoadminrdquo
8 Activate LicenseWhen Skedler is installed it operates in Free Edition with limited functionality Pleasenote the following features that are available when running Skedler in Free Edition
radic You can create and delete a report
radic Preview the report with different Time Window
radic Mail the report
Skedler license can be activated in two ways Online Activation and Offline ActivationFollow the steps given in each section for successful activation If you have not yetinstalled Skedler please refer to the Skedler Installation Guide
You can activate license by clicking ldquoAboutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 18
To activate license key click ldquoActivate Licenserdquo button
The following screenshot displays the License Activation Page
Copyright copy 2016 Guidanz Inc 19
License KeyOnline and Offline activation both require a 25 character alphanumeric license key oractivation code
Typically you would receive the license key along with the product downloadinformation If you have any questions or need help with the license key please contactus at supportskedlercom
Skedler provides different Editions
Trial Edition ndash Typically valid for 21days When the trial period expires Skedlerswitches to Free Edition
NOTE Trial Edition is not available for Offline Activation
Standard Edition
Advanced Edition
Premium Edition
a) Online Trial License Activation
Trial key is packed with Skedler by default
To activate your trial license key online you will need an Internet connection
1 Fill the fields NameEmail and Company name with required values
Copyright copy 2016 Guidanz Inc 20
2 You will find the License Key filled with a Skedler Trial Key
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 21
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
Copyright copy 2016 Guidanz Inc 22
b) Online Product License ActivationTo activate your license online you will need an Internet connection
Fill the required details in License Activation Page
You must have a license key for the edition you requested
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 23
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo to activate the license
c) Offline Product License ActivationFill the required details in License Activation Page
You must have a license key for the edition you requested
Copyright copy 2016 Guidanz Inc 24
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 Offline Activation does not require proxy setting
4 Read and click the Terms and Conditions
5 Click ldquoOffline Activationrdquo link
6 On clicking it will generate a producttxt file Use the steps given below to generatethe licensing file(actOffdat)
Copyright copy 2016 Guidanz Inc 25
a) Open the generated producttxt file
b) Copy the contenttext inside the producttxt file
c) Use the following curl command to generate the licensing file(actOffdat) replace theSTRING_FROM_THE_FILE with the copied content from producttxt file
curl -XPOST httpsskedlercomOfflineActivationphp -drequestData=STRING_FROM_THE_FILE gt actOffdat
Note Make sure the contenttext which you copy paste to the curl command inrequestData is same as in the generated producttxt file
d) Open the terminal that has an Internet connection and run the curl command Aresponse license file (actOffdat) is generated Copy the response license file(actOffdat) to a server location where Skedler runs
7 After generating the license file (actOffdat) using the curl command Click ldquoAboutrdquoicon in Skedler home page
8 Click ldquoLicense informationrdquo button Edition type and the license key is automaticallyfilled Click ldquoSelect Filerdquo find the license file ldquoactOffdatrdquo on your computer andupload it
Note Retain the same file name ldquoactOffdatrdquo during file upload
Copyright copy 2016 Guidanz Inc 26
9 Click ldquoActivaterdquo button to activate license
10 Click ldquoAbortrdquo button to abort your offline activation
Copyright copy 2016 Guidanz Inc 27
9 Move skedler with license from one server toanotherTo move skedler with license from one server to another follow the steps mention inDeactivate skedler with License section and continue with the steps given below
1 Stop skedler in old server
2 Copy skedler to new server
3 Give necessary permissions to skedler_home directory as follows
sudo chmod -R 765 skedler_home
4 Verify the necessary pre-requisites in the new server as given in Prerequisites section
5 Start skedler in new server using the following command
cd skedler_home
binskedler
Copyright copy 2016 Guidanz Inc 28
6 Activate license with the same key which was used to activate skedler on the oldserver and use the same details to fill the form
If you find any issues during the process contact skelder supportskedlercom
10 Deactivate Skedler with LicenseSkedler license is bound to the computer where you activated it Until you deactivate theskedler license key you cannot use it on another machine Deactivation remove licensedata from the current machine so that you can activate the skedler license key on anothermachine
You can deactivate skedler license key either Online or Offline
NOTE Trial edition cannot be deactivated
Deactivate skedler license key Online
Online deactivation requires an Internet connection To deactivate skedler license keynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate online
Deactivate skedler license key Offline
Offline deactivation does not require an Internet connection To deactivate skedler licensekeynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate offline
It will generate a text file in skedler_homeskedler_offline_deactivation_requesttxt pathwhich you must send to supportskedlercom
Copyright copy 2016 Guidanz Inc 29
11 Shield ConfigurationScenario 1
Kibana managers need access to dataindex 1 and 2
Kibana Users should have access only to dataindex 1
Skedler generates reports based on user permission for dataindex and Skedler needspermission to lsquokibanarsquo index for discovery
Assuming shield is configured for kibana as follows
1 For example if you have kibana_manager and kibana_user roles and skedlerindex configured for both the roles
2 Once the roles have full permission to access the dataindex configured for the roleSkedler can discover all the dashboards and searches from kibana And you canpreview or a generate report for dashboards and search for the configureddataindex
3 In case(a) kibana_manager role has full permission to access lsquokibanarsquodataindex1 dataindex2 and lsquoskedlerrsquo index Skedler can discover all thedashboards and searches from kibana And you can preview or generate report forall dashboards and search from dataindex1 and dataindex2
a) The required permissions for kibana_manager
kibana_manager
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
Copyright copy 2016 Guidanz Inc 30
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
dataindex2
- indicesadminexists
- indicesadminmappingsfieldsget
Copyright copy 2016 Guidanz Inc 31
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
4 In case(b) kibana_user role have full permission to access lsquokibanarsquodataindex1and lsquoskedlerrsquo index Skedler can discover all the dashboards and
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 10
4 Skedler Quick Installation1 Download the latest skedler zip (or targz) file
2 Unpack the skedler zip file that you downloaded
3 cd to the unpacked folder
4 Give necessary permission to the script file installsh Use the following command togive permission
sudo chmod u+x installsh
5 Set the value for variable JAVA_HOME in the script file installsh as follows
a) To check JAVA_HOME given the following command
echo $JAVA_HOME
b) Copy and paste the output to installsh script as shown in screenshot
6 Run installsh script as follows
7 Add elasticsearch URL with the port (even if the port is 80) and your kibana URLwith the port to the skedler_homeconfigreportingyml file as shown in the followingformat ltprotocolgtltservergtltportgt
8 Skedler can be deployed in the following ways
a) Start Skedler as service
sudo service skedler start
Copyright copy 2016 Guidanz Inc 11
b) Start Skedler manually from skedler_home directory
binskedler
9 Skedler License activation Trial key is packed with Skedler by default
a) Click ldquoAboutrdquo icon on Skedler home page and click ldquoActivate Licenserdquo button
b) Fill the fields NameEmail and Company name with required values
You will find the License Key filled with a Trial Key Read and click the Termsand Conditions and Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
If there is any issues with the Quick Installation process follow the section DetailedInstallation
5 Skedler Detailed Installation
Requires LD_LIBRARY_PATH
For ubuntuDebian in etcbashbashrc and for CentosRedhat in etcbashrc
Add the LD_LIBRARY_PATH variable as follows
Copyright copy 2016 Guidanz Inc 12
export LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
In etcenvironment file as follows
LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
Starting SkedlerStart the application from skedler home folder by typing
binskedler
a) Starting Skedler in debug modei When you start the application as a root user check whether
LD_LIBRARY_PATH is present in your environment variable To check use thefollowing commandsudo envIf LD_LIBRARY_PATH is present to start the application in debug mode fromskedler home type
binskedler debugElse specify LD_LIBRARY_PATH to start the application in debug mode from
skedler home as followssudo LD_LIBRARY_PATH=ltpathgt binskedler debug
ii When you start the application as a normal user type binskedler debug fromskedler home
b) Starting Skedler as Service
For UbuntuDebian servers (less than 1601 versions)To start skedler as a service
1 Copy skedler_homebinservicescriptsskedler_debian file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_debianchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$update-rcd skedler_debian defaults 97 8
Copyright copy 2016 Guidanz Inc 13
6 To start the skedler as service in normal mode execute this command$sudo service skedler_debian start
7 To start skedler as service in debug mode$sudo service skedler_debian start debug
For Ubuntu 1601To start skedler as a service
1 Copy skedler_homebinservicescriptsskedler_debian file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_debianchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$update-rcd skedler_debian defaults 97 8$ systemctl daemon-reload
6 To start the skedler as service in normal mode execute this command$sudo service skedler_debian start
7 To start skedler as service in debug mode$sudo service skedler_debian start debug
For CentosRedhat1 Copy skedler_homebinservicescriptsskedler_redhat file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_redhatchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$ chkconfig --add skedler_rehat$ chkconfig --level 2345 skedler_redhat on
6 To start the skedler as service in normal mode execute this command$sudo service skedler_redhat start
7 To start skedler as service in debug mode
Copyright copy 2016 Guidanz Inc 14
$sudo service skedler_redhat start debug
6 Access Skedler
1 Skedler can be accessed from the following URL httpltyourServergt3000 Ifeverything is installed fine you will see the Email configuration pagea) If you do not require your reports to be mailed you can disable your mail
settings using switch ldquooffrdquob) If you require reports to be mailed configure the outgoing mail settings and
email id (from which all the reports will be sent) If the SMTP server hasany authentication then check ldquoEnable Passwordrdquo and fill the passwordfield After setting the configuration click ldquoSaverdquo button
c) Update time zone for scheduling your report using ldquoTimeZone Settingrdquo andclick ldquoUpdaterdquo
Copyright copy 2016 Guidanz Inc 15
2 Optionally you can upload default logo for your generated PDF report byuploading image using ldquoSelect imagerdquo and click ldquoSaverdquo To reset image clickldquoResetrdquo
3 Click ldquoHomerdquo icon and you will be taken to the home page of Skedler Toschedule a report follow the User Guide
Copyright copy 2016 Guidanz Inc 16
7 How to embed Skedler in your applicationTo embed Skedler UI in your application without the Skedler header and footer followthe steps given below
1 If your application does not require Authentication
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreports
ii Filters - httpltyourServergtfilters
iii Eamil - httpltyourServergtemail
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltyourServergtreportsquery=rdquocitycastrordquo
2 If you application requires Authentication - Admin user can set the emailconfiguration details
Copyright copy 2016 Guidanz Inc 17
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreportsid=ltauthenticationIDgt
ii Filters - httpltyourServergtfiltersid=ltauthenticationIDgt
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltgtreportsid=ltauthenticationIDgtampquery=rdquocitycastrordquo
NOTE authenticationID can be username or ID wich is used to login your application
authenticationID for admin user is ldquoadminrdquo
8 Activate LicenseWhen Skedler is installed it operates in Free Edition with limited functionality Pleasenote the following features that are available when running Skedler in Free Edition
radic You can create and delete a report
radic Preview the report with different Time Window
radic Mail the report
Skedler license can be activated in two ways Online Activation and Offline ActivationFollow the steps given in each section for successful activation If you have not yetinstalled Skedler please refer to the Skedler Installation Guide
You can activate license by clicking ldquoAboutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 18
To activate license key click ldquoActivate Licenserdquo button
The following screenshot displays the License Activation Page
Copyright copy 2016 Guidanz Inc 19
License KeyOnline and Offline activation both require a 25 character alphanumeric license key oractivation code
Typically you would receive the license key along with the product downloadinformation If you have any questions or need help with the license key please contactus at supportskedlercom
Skedler provides different Editions
Trial Edition ndash Typically valid for 21days When the trial period expires Skedlerswitches to Free Edition
NOTE Trial Edition is not available for Offline Activation
Standard Edition
Advanced Edition
Premium Edition
a) Online Trial License Activation
Trial key is packed with Skedler by default
To activate your trial license key online you will need an Internet connection
1 Fill the fields NameEmail and Company name with required values
Copyright copy 2016 Guidanz Inc 20
2 You will find the License Key filled with a Skedler Trial Key
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 21
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
Copyright copy 2016 Guidanz Inc 22
b) Online Product License ActivationTo activate your license online you will need an Internet connection
Fill the required details in License Activation Page
You must have a license key for the edition you requested
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 23
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo to activate the license
c) Offline Product License ActivationFill the required details in License Activation Page
You must have a license key for the edition you requested
Copyright copy 2016 Guidanz Inc 24
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 Offline Activation does not require proxy setting
4 Read and click the Terms and Conditions
5 Click ldquoOffline Activationrdquo link
6 On clicking it will generate a producttxt file Use the steps given below to generatethe licensing file(actOffdat)
Copyright copy 2016 Guidanz Inc 25
a) Open the generated producttxt file
b) Copy the contenttext inside the producttxt file
c) Use the following curl command to generate the licensing file(actOffdat) replace theSTRING_FROM_THE_FILE with the copied content from producttxt file
curl -XPOST httpsskedlercomOfflineActivationphp -drequestData=STRING_FROM_THE_FILE gt actOffdat
Note Make sure the contenttext which you copy paste to the curl command inrequestData is same as in the generated producttxt file
d) Open the terminal that has an Internet connection and run the curl command Aresponse license file (actOffdat) is generated Copy the response license file(actOffdat) to a server location where Skedler runs
7 After generating the license file (actOffdat) using the curl command Click ldquoAboutrdquoicon in Skedler home page
8 Click ldquoLicense informationrdquo button Edition type and the license key is automaticallyfilled Click ldquoSelect Filerdquo find the license file ldquoactOffdatrdquo on your computer andupload it
Note Retain the same file name ldquoactOffdatrdquo during file upload
Copyright copy 2016 Guidanz Inc 26
9 Click ldquoActivaterdquo button to activate license
10 Click ldquoAbortrdquo button to abort your offline activation
Copyright copy 2016 Guidanz Inc 27
9 Move skedler with license from one server toanotherTo move skedler with license from one server to another follow the steps mention inDeactivate skedler with License section and continue with the steps given below
1 Stop skedler in old server
2 Copy skedler to new server
3 Give necessary permissions to skedler_home directory as follows
sudo chmod -R 765 skedler_home
4 Verify the necessary pre-requisites in the new server as given in Prerequisites section
5 Start skedler in new server using the following command
cd skedler_home
binskedler
Copyright copy 2016 Guidanz Inc 28
6 Activate license with the same key which was used to activate skedler on the oldserver and use the same details to fill the form
If you find any issues during the process contact skelder supportskedlercom
10 Deactivate Skedler with LicenseSkedler license is bound to the computer where you activated it Until you deactivate theskedler license key you cannot use it on another machine Deactivation remove licensedata from the current machine so that you can activate the skedler license key on anothermachine
You can deactivate skedler license key either Online or Offline
NOTE Trial edition cannot be deactivated
Deactivate skedler license key Online
Online deactivation requires an Internet connection To deactivate skedler license keynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate online
Deactivate skedler license key Offline
Offline deactivation does not require an Internet connection To deactivate skedler licensekeynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate offline
It will generate a text file in skedler_homeskedler_offline_deactivation_requesttxt pathwhich you must send to supportskedlercom
Copyright copy 2016 Guidanz Inc 29
11 Shield ConfigurationScenario 1
Kibana managers need access to dataindex 1 and 2
Kibana Users should have access only to dataindex 1
Skedler generates reports based on user permission for dataindex and Skedler needspermission to lsquokibanarsquo index for discovery
Assuming shield is configured for kibana as follows
1 For example if you have kibana_manager and kibana_user roles and skedlerindex configured for both the roles
2 Once the roles have full permission to access the dataindex configured for the roleSkedler can discover all the dashboards and searches from kibana And you canpreview or a generate report for dashboards and search for the configureddataindex
3 In case(a) kibana_manager role has full permission to access lsquokibanarsquodataindex1 dataindex2 and lsquoskedlerrsquo index Skedler can discover all thedashboards and searches from kibana And you can preview or generate report forall dashboards and search from dataindex1 and dataindex2
a) The required permissions for kibana_manager
kibana_manager
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
Copyright copy 2016 Guidanz Inc 30
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
dataindex2
- indicesadminexists
- indicesadminmappingsfieldsget
Copyright copy 2016 Guidanz Inc 31
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
4 In case(b) kibana_user role have full permission to access lsquokibanarsquodataindex1and lsquoskedlerrsquo index Skedler can discover all the dashboards and
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 11
b) Start Skedler manually from skedler_home directory
binskedler
9 Skedler License activation Trial key is packed with Skedler by default
a) Click ldquoAboutrdquo icon on Skedler home page and click ldquoActivate Licenserdquo button
b) Fill the fields NameEmail and Company name with required values
You will find the License Key filled with a Trial Key Read and click the Termsand Conditions and Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
If there is any issues with the Quick Installation process follow the section DetailedInstallation
5 Skedler Detailed Installation
Requires LD_LIBRARY_PATH
For ubuntuDebian in etcbashbashrc and for CentosRedhat in etcbashrc
Add the LD_LIBRARY_PATH variable as follows
Copyright copy 2016 Guidanz Inc 12
export LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
In etcenvironment file as follows
LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
Starting SkedlerStart the application from skedler home folder by typing
binskedler
a) Starting Skedler in debug modei When you start the application as a root user check whether
LD_LIBRARY_PATH is present in your environment variable To check use thefollowing commandsudo envIf LD_LIBRARY_PATH is present to start the application in debug mode fromskedler home type
binskedler debugElse specify LD_LIBRARY_PATH to start the application in debug mode from
skedler home as followssudo LD_LIBRARY_PATH=ltpathgt binskedler debug
ii When you start the application as a normal user type binskedler debug fromskedler home
b) Starting Skedler as Service
For UbuntuDebian servers (less than 1601 versions)To start skedler as a service
1 Copy skedler_homebinservicescriptsskedler_debian file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_debianchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$update-rcd skedler_debian defaults 97 8
Copyright copy 2016 Guidanz Inc 13
6 To start the skedler as service in normal mode execute this command$sudo service skedler_debian start
7 To start skedler as service in debug mode$sudo service skedler_debian start debug
For Ubuntu 1601To start skedler as a service
1 Copy skedler_homebinservicescriptsskedler_debian file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_debianchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$update-rcd skedler_debian defaults 97 8$ systemctl daemon-reload
6 To start the skedler as service in normal mode execute this command$sudo service skedler_debian start
7 To start skedler as service in debug mode$sudo service skedler_debian start debug
For CentosRedhat1 Copy skedler_homebinservicescriptsskedler_redhat file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_redhatchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$ chkconfig --add skedler_rehat$ chkconfig --level 2345 skedler_redhat on
6 To start the skedler as service in normal mode execute this command$sudo service skedler_redhat start
7 To start skedler as service in debug mode
Copyright copy 2016 Guidanz Inc 14
$sudo service skedler_redhat start debug
6 Access Skedler
1 Skedler can be accessed from the following URL httpltyourServergt3000 Ifeverything is installed fine you will see the Email configuration pagea) If you do not require your reports to be mailed you can disable your mail
settings using switch ldquooffrdquob) If you require reports to be mailed configure the outgoing mail settings and
email id (from which all the reports will be sent) If the SMTP server hasany authentication then check ldquoEnable Passwordrdquo and fill the passwordfield After setting the configuration click ldquoSaverdquo button
c) Update time zone for scheduling your report using ldquoTimeZone Settingrdquo andclick ldquoUpdaterdquo
Copyright copy 2016 Guidanz Inc 15
2 Optionally you can upload default logo for your generated PDF report byuploading image using ldquoSelect imagerdquo and click ldquoSaverdquo To reset image clickldquoResetrdquo
3 Click ldquoHomerdquo icon and you will be taken to the home page of Skedler Toschedule a report follow the User Guide
Copyright copy 2016 Guidanz Inc 16
7 How to embed Skedler in your applicationTo embed Skedler UI in your application without the Skedler header and footer followthe steps given below
1 If your application does not require Authentication
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreports
ii Filters - httpltyourServergtfilters
iii Eamil - httpltyourServergtemail
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltyourServergtreportsquery=rdquocitycastrordquo
2 If you application requires Authentication - Admin user can set the emailconfiguration details
Copyright copy 2016 Guidanz Inc 17
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreportsid=ltauthenticationIDgt
ii Filters - httpltyourServergtfiltersid=ltauthenticationIDgt
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltgtreportsid=ltauthenticationIDgtampquery=rdquocitycastrordquo
NOTE authenticationID can be username or ID wich is used to login your application
authenticationID for admin user is ldquoadminrdquo
8 Activate LicenseWhen Skedler is installed it operates in Free Edition with limited functionality Pleasenote the following features that are available when running Skedler in Free Edition
radic You can create and delete a report
radic Preview the report with different Time Window
radic Mail the report
Skedler license can be activated in two ways Online Activation and Offline ActivationFollow the steps given in each section for successful activation If you have not yetinstalled Skedler please refer to the Skedler Installation Guide
You can activate license by clicking ldquoAboutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 18
To activate license key click ldquoActivate Licenserdquo button
The following screenshot displays the License Activation Page
Copyright copy 2016 Guidanz Inc 19
License KeyOnline and Offline activation both require a 25 character alphanumeric license key oractivation code
Typically you would receive the license key along with the product downloadinformation If you have any questions or need help with the license key please contactus at supportskedlercom
Skedler provides different Editions
Trial Edition ndash Typically valid for 21days When the trial period expires Skedlerswitches to Free Edition
NOTE Trial Edition is not available for Offline Activation
Standard Edition
Advanced Edition
Premium Edition
a) Online Trial License Activation
Trial key is packed with Skedler by default
To activate your trial license key online you will need an Internet connection
1 Fill the fields NameEmail and Company name with required values
Copyright copy 2016 Guidanz Inc 20
2 You will find the License Key filled with a Skedler Trial Key
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 21
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
Copyright copy 2016 Guidanz Inc 22
b) Online Product License ActivationTo activate your license online you will need an Internet connection
Fill the required details in License Activation Page
You must have a license key for the edition you requested
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 23
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo to activate the license
c) Offline Product License ActivationFill the required details in License Activation Page
You must have a license key for the edition you requested
Copyright copy 2016 Guidanz Inc 24
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 Offline Activation does not require proxy setting
4 Read and click the Terms and Conditions
5 Click ldquoOffline Activationrdquo link
6 On clicking it will generate a producttxt file Use the steps given below to generatethe licensing file(actOffdat)
Copyright copy 2016 Guidanz Inc 25
a) Open the generated producttxt file
b) Copy the contenttext inside the producttxt file
c) Use the following curl command to generate the licensing file(actOffdat) replace theSTRING_FROM_THE_FILE with the copied content from producttxt file
curl -XPOST httpsskedlercomOfflineActivationphp -drequestData=STRING_FROM_THE_FILE gt actOffdat
Note Make sure the contenttext which you copy paste to the curl command inrequestData is same as in the generated producttxt file
d) Open the terminal that has an Internet connection and run the curl command Aresponse license file (actOffdat) is generated Copy the response license file(actOffdat) to a server location where Skedler runs
7 After generating the license file (actOffdat) using the curl command Click ldquoAboutrdquoicon in Skedler home page
8 Click ldquoLicense informationrdquo button Edition type and the license key is automaticallyfilled Click ldquoSelect Filerdquo find the license file ldquoactOffdatrdquo on your computer andupload it
Note Retain the same file name ldquoactOffdatrdquo during file upload
Copyright copy 2016 Guidanz Inc 26
9 Click ldquoActivaterdquo button to activate license
10 Click ldquoAbortrdquo button to abort your offline activation
Copyright copy 2016 Guidanz Inc 27
9 Move skedler with license from one server toanotherTo move skedler with license from one server to another follow the steps mention inDeactivate skedler with License section and continue with the steps given below
1 Stop skedler in old server
2 Copy skedler to new server
3 Give necessary permissions to skedler_home directory as follows
sudo chmod -R 765 skedler_home
4 Verify the necessary pre-requisites in the new server as given in Prerequisites section
5 Start skedler in new server using the following command
cd skedler_home
binskedler
Copyright copy 2016 Guidanz Inc 28
6 Activate license with the same key which was used to activate skedler on the oldserver and use the same details to fill the form
If you find any issues during the process contact skelder supportskedlercom
10 Deactivate Skedler with LicenseSkedler license is bound to the computer where you activated it Until you deactivate theskedler license key you cannot use it on another machine Deactivation remove licensedata from the current machine so that you can activate the skedler license key on anothermachine
You can deactivate skedler license key either Online or Offline
NOTE Trial edition cannot be deactivated
Deactivate skedler license key Online
Online deactivation requires an Internet connection To deactivate skedler license keynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate online
Deactivate skedler license key Offline
Offline deactivation does not require an Internet connection To deactivate skedler licensekeynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate offline
It will generate a text file in skedler_homeskedler_offline_deactivation_requesttxt pathwhich you must send to supportskedlercom
Copyright copy 2016 Guidanz Inc 29
11 Shield ConfigurationScenario 1
Kibana managers need access to dataindex 1 and 2
Kibana Users should have access only to dataindex 1
Skedler generates reports based on user permission for dataindex and Skedler needspermission to lsquokibanarsquo index for discovery
Assuming shield is configured for kibana as follows
1 For example if you have kibana_manager and kibana_user roles and skedlerindex configured for both the roles
2 Once the roles have full permission to access the dataindex configured for the roleSkedler can discover all the dashboards and searches from kibana And you canpreview or a generate report for dashboards and search for the configureddataindex
3 In case(a) kibana_manager role has full permission to access lsquokibanarsquodataindex1 dataindex2 and lsquoskedlerrsquo index Skedler can discover all thedashboards and searches from kibana And you can preview or generate report forall dashboards and search from dataindex1 and dataindex2
a) The required permissions for kibana_manager
kibana_manager
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
Copyright copy 2016 Guidanz Inc 30
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
dataindex2
- indicesadminexists
- indicesadminmappingsfieldsget
Copyright copy 2016 Guidanz Inc 31
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
4 In case(b) kibana_user role have full permission to access lsquokibanarsquodataindex1and lsquoskedlerrsquo index Skedler can discover all the dashboards and
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 12
export LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
In etcenvironment file as follows
LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
Starting SkedlerStart the application from skedler home folder by typing
binskedler
a) Starting Skedler in debug modei When you start the application as a root user check whether
LD_LIBRARY_PATH is present in your environment variable To check use thefollowing commandsudo envIf LD_LIBRARY_PATH is present to start the application in debug mode fromskedler home type
binskedler debugElse specify LD_LIBRARY_PATH to start the application in debug mode from
skedler home as followssudo LD_LIBRARY_PATH=ltpathgt binskedler debug
ii When you start the application as a normal user type binskedler debug fromskedler home
b) Starting Skedler as Service
For UbuntuDebian servers (less than 1601 versions)To start skedler as a service
1 Copy skedler_homebinservicescriptsskedler_debian file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_debianchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$update-rcd skedler_debian defaults 97 8
Copyright copy 2016 Guidanz Inc 13
6 To start the skedler as service in normal mode execute this command$sudo service skedler_debian start
7 To start skedler as service in debug mode$sudo service skedler_debian start debug
For Ubuntu 1601To start skedler as a service
1 Copy skedler_homebinservicescriptsskedler_debian file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_debianchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$update-rcd skedler_debian defaults 97 8$ systemctl daemon-reload
6 To start the skedler as service in normal mode execute this command$sudo service skedler_debian start
7 To start skedler as service in debug mode$sudo service skedler_debian start debug
For CentosRedhat1 Copy skedler_homebinservicescriptsskedler_redhat file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_redhatchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$ chkconfig --add skedler_rehat$ chkconfig --level 2345 skedler_redhat on
6 To start the skedler as service in normal mode execute this command$sudo service skedler_redhat start
7 To start skedler as service in debug mode
Copyright copy 2016 Guidanz Inc 14
$sudo service skedler_redhat start debug
6 Access Skedler
1 Skedler can be accessed from the following URL httpltyourServergt3000 Ifeverything is installed fine you will see the Email configuration pagea) If you do not require your reports to be mailed you can disable your mail
settings using switch ldquooffrdquob) If you require reports to be mailed configure the outgoing mail settings and
email id (from which all the reports will be sent) If the SMTP server hasany authentication then check ldquoEnable Passwordrdquo and fill the passwordfield After setting the configuration click ldquoSaverdquo button
c) Update time zone for scheduling your report using ldquoTimeZone Settingrdquo andclick ldquoUpdaterdquo
Copyright copy 2016 Guidanz Inc 15
2 Optionally you can upload default logo for your generated PDF report byuploading image using ldquoSelect imagerdquo and click ldquoSaverdquo To reset image clickldquoResetrdquo
3 Click ldquoHomerdquo icon and you will be taken to the home page of Skedler Toschedule a report follow the User Guide
Copyright copy 2016 Guidanz Inc 16
7 How to embed Skedler in your applicationTo embed Skedler UI in your application without the Skedler header and footer followthe steps given below
1 If your application does not require Authentication
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreports
ii Filters - httpltyourServergtfilters
iii Eamil - httpltyourServergtemail
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltyourServergtreportsquery=rdquocitycastrordquo
2 If you application requires Authentication - Admin user can set the emailconfiguration details
Copyright copy 2016 Guidanz Inc 17
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreportsid=ltauthenticationIDgt
ii Filters - httpltyourServergtfiltersid=ltauthenticationIDgt
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltgtreportsid=ltauthenticationIDgtampquery=rdquocitycastrordquo
NOTE authenticationID can be username or ID wich is used to login your application
authenticationID for admin user is ldquoadminrdquo
8 Activate LicenseWhen Skedler is installed it operates in Free Edition with limited functionality Pleasenote the following features that are available when running Skedler in Free Edition
radic You can create and delete a report
radic Preview the report with different Time Window
radic Mail the report
Skedler license can be activated in two ways Online Activation and Offline ActivationFollow the steps given in each section for successful activation If you have not yetinstalled Skedler please refer to the Skedler Installation Guide
You can activate license by clicking ldquoAboutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 18
To activate license key click ldquoActivate Licenserdquo button
The following screenshot displays the License Activation Page
Copyright copy 2016 Guidanz Inc 19
License KeyOnline and Offline activation both require a 25 character alphanumeric license key oractivation code
Typically you would receive the license key along with the product downloadinformation If you have any questions or need help with the license key please contactus at supportskedlercom
Skedler provides different Editions
Trial Edition ndash Typically valid for 21days When the trial period expires Skedlerswitches to Free Edition
NOTE Trial Edition is not available for Offline Activation
Standard Edition
Advanced Edition
Premium Edition
a) Online Trial License Activation
Trial key is packed with Skedler by default
To activate your trial license key online you will need an Internet connection
1 Fill the fields NameEmail and Company name with required values
Copyright copy 2016 Guidanz Inc 20
2 You will find the License Key filled with a Skedler Trial Key
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 21
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
Copyright copy 2016 Guidanz Inc 22
b) Online Product License ActivationTo activate your license online you will need an Internet connection
Fill the required details in License Activation Page
You must have a license key for the edition you requested
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 23
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo to activate the license
c) Offline Product License ActivationFill the required details in License Activation Page
You must have a license key for the edition you requested
Copyright copy 2016 Guidanz Inc 24
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 Offline Activation does not require proxy setting
4 Read and click the Terms and Conditions
5 Click ldquoOffline Activationrdquo link
6 On clicking it will generate a producttxt file Use the steps given below to generatethe licensing file(actOffdat)
Copyright copy 2016 Guidanz Inc 25
a) Open the generated producttxt file
b) Copy the contenttext inside the producttxt file
c) Use the following curl command to generate the licensing file(actOffdat) replace theSTRING_FROM_THE_FILE with the copied content from producttxt file
curl -XPOST httpsskedlercomOfflineActivationphp -drequestData=STRING_FROM_THE_FILE gt actOffdat
Note Make sure the contenttext which you copy paste to the curl command inrequestData is same as in the generated producttxt file
d) Open the terminal that has an Internet connection and run the curl command Aresponse license file (actOffdat) is generated Copy the response license file(actOffdat) to a server location where Skedler runs
7 After generating the license file (actOffdat) using the curl command Click ldquoAboutrdquoicon in Skedler home page
8 Click ldquoLicense informationrdquo button Edition type and the license key is automaticallyfilled Click ldquoSelect Filerdquo find the license file ldquoactOffdatrdquo on your computer andupload it
Note Retain the same file name ldquoactOffdatrdquo during file upload
Copyright copy 2016 Guidanz Inc 26
9 Click ldquoActivaterdquo button to activate license
10 Click ldquoAbortrdquo button to abort your offline activation
Copyright copy 2016 Guidanz Inc 27
9 Move skedler with license from one server toanotherTo move skedler with license from one server to another follow the steps mention inDeactivate skedler with License section and continue with the steps given below
1 Stop skedler in old server
2 Copy skedler to new server
3 Give necessary permissions to skedler_home directory as follows
sudo chmod -R 765 skedler_home
4 Verify the necessary pre-requisites in the new server as given in Prerequisites section
5 Start skedler in new server using the following command
cd skedler_home
binskedler
Copyright copy 2016 Guidanz Inc 28
6 Activate license with the same key which was used to activate skedler on the oldserver and use the same details to fill the form
If you find any issues during the process contact skelder supportskedlercom
10 Deactivate Skedler with LicenseSkedler license is bound to the computer where you activated it Until you deactivate theskedler license key you cannot use it on another machine Deactivation remove licensedata from the current machine so that you can activate the skedler license key on anothermachine
You can deactivate skedler license key either Online or Offline
NOTE Trial edition cannot be deactivated
Deactivate skedler license key Online
Online deactivation requires an Internet connection To deactivate skedler license keynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate online
Deactivate skedler license key Offline
Offline deactivation does not require an Internet connection To deactivate skedler licensekeynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate offline
It will generate a text file in skedler_homeskedler_offline_deactivation_requesttxt pathwhich you must send to supportskedlercom
Copyright copy 2016 Guidanz Inc 29
11 Shield ConfigurationScenario 1
Kibana managers need access to dataindex 1 and 2
Kibana Users should have access only to dataindex 1
Skedler generates reports based on user permission for dataindex and Skedler needspermission to lsquokibanarsquo index for discovery
Assuming shield is configured for kibana as follows
1 For example if you have kibana_manager and kibana_user roles and skedlerindex configured for both the roles
2 Once the roles have full permission to access the dataindex configured for the roleSkedler can discover all the dashboards and searches from kibana And you canpreview or a generate report for dashboards and search for the configureddataindex
3 In case(a) kibana_manager role has full permission to access lsquokibanarsquodataindex1 dataindex2 and lsquoskedlerrsquo index Skedler can discover all thedashboards and searches from kibana And you can preview or generate report forall dashboards and search from dataindex1 and dataindex2
a) The required permissions for kibana_manager
kibana_manager
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
Copyright copy 2016 Guidanz Inc 30
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
dataindex2
- indicesadminexists
- indicesadminmappingsfieldsget
Copyright copy 2016 Guidanz Inc 31
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
4 In case(b) kibana_user role have full permission to access lsquokibanarsquodataindex1and lsquoskedlerrsquo index Skedler can discover all the dashboards and
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 13
6 To start the skedler as service in normal mode execute this command$sudo service skedler_debian start
7 To start skedler as service in debug mode$sudo service skedler_debian start debug
For Ubuntu 1601To start skedler as a service
1 Copy skedler_homebinservicescriptsskedler_debian file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_debianchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$update-rcd skedler_debian defaults 97 8$ systemctl daemon-reload
6 To start the skedler as service in normal mode execute this command$sudo service skedler_debian start
7 To start skedler as service in debug mode$sudo service skedler_debian start debug
For CentosRedhat1 Copy skedler_homebinservicescriptsskedler_redhat file to etcinitd location2 Give executable permission with the following command
$sudo chmod u+x etcinitdskedler_redhatchange the SKEDLER_BIN path in the file
3 Change the SKEDLER_BIN path to point to skedler_homebin path (absolutepath)
4 Add the following line to include LD_LIBRARY_PATHexport LD_LIBRARY_PATH =$JAVA_HOMEjrelibamd64ltyour_java_pathgtjrelibamd64server
5 Execute this command in terminal$ chkconfig --add skedler_rehat$ chkconfig --level 2345 skedler_redhat on
6 To start the skedler as service in normal mode execute this command$sudo service skedler_redhat start
7 To start skedler as service in debug mode
Copyright copy 2016 Guidanz Inc 14
$sudo service skedler_redhat start debug
6 Access Skedler
1 Skedler can be accessed from the following URL httpltyourServergt3000 Ifeverything is installed fine you will see the Email configuration pagea) If you do not require your reports to be mailed you can disable your mail
settings using switch ldquooffrdquob) If you require reports to be mailed configure the outgoing mail settings and
email id (from which all the reports will be sent) If the SMTP server hasany authentication then check ldquoEnable Passwordrdquo and fill the passwordfield After setting the configuration click ldquoSaverdquo button
c) Update time zone for scheduling your report using ldquoTimeZone Settingrdquo andclick ldquoUpdaterdquo
Copyright copy 2016 Guidanz Inc 15
2 Optionally you can upload default logo for your generated PDF report byuploading image using ldquoSelect imagerdquo and click ldquoSaverdquo To reset image clickldquoResetrdquo
3 Click ldquoHomerdquo icon and you will be taken to the home page of Skedler Toschedule a report follow the User Guide
Copyright copy 2016 Guidanz Inc 16
7 How to embed Skedler in your applicationTo embed Skedler UI in your application without the Skedler header and footer followthe steps given below
1 If your application does not require Authentication
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreports
ii Filters - httpltyourServergtfilters
iii Eamil - httpltyourServergtemail
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltyourServergtreportsquery=rdquocitycastrordquo
2 If you application requires Authentication - Admin user can set the emailconfiguration details
Copyright copy 2016 Guidanz Inc 17
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreportsid=ltauthenticationIDgt
ii Filters - httpltyourServergtfiltersid=ltauthenticationIDgt
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltgtreportsid=ltauthenticationIDgtampquery=rdquocitycastrordquo
NOTE authenticationID can be username or ID wich is used to login your application
authenticationID for admin user is ldquoadminrdquo
8 Activate LicenseWhen Skedler is installed it operates in Free Edition with limited functionality Pleasenote the following features that are available when running Skedler in Free Edition
radic You can create and delete a report
radic Preview the report with different Time Window
radic Mail the report
Skedler license can be activated in two ways Online Activation and Offline ActivationFollow the steps given in each section for successful activation If you have not yetinstalled Skedler please refer to the Skedler Installation Guide
You can activate license by clicking ldquoAboutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 18
To activate license key click ldquoActivate Licenserdquo button
The following screenshot displays the License Activation Page
Copyright copy 2016 Guidanz Inc 19
License KeyOnline and Offline activation both require a 25 character alphanumeric license key oractivation code
Typically you would receive the license key along with the product downloadinformation If you have any questions or need help with the license key please contactus at supportskedlercom
Skedler provides different Editions
Trial Edition ndash Typically valid for 21days When the trial period expires Skedlerswitches to Free Edition
NOTE Trial Edition is not available for Offline Activation
Standard Edition
Advanced Edition
Premium Edition
a) Online Trial License Activation
Trial key is packed with Skedler by default
To activate your trial license key online you will need an Internet connection
1 Fill the fields NameEmail and Company name with required values
Copyright copy 2016 Guidanz Inc 20
2 You will find the License Key filled with a Skedler Trial Key
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 21
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
Copyright copy 2016 Guidanz Inc 22
b) Online Product License ActivationTo activate your license online you will need an Internet connection
Fill the required details in License Activation Page
You must have a license key for the edition you requested
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 23
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo to activate the license
c) Offline Product License ActivationFill the required details in License Activation Page
You must have a license key for the edition you requested
Copyright copy 2016 Guidanz Inc 24
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 Offline Activation does not require proxy setting
4 Read and click the Terms and Conditions
5 Click ldquoOffline Activationrdquo link
6 On clicking it will generate a producttxt file Use the steps given below to generatethe licensing file(actOffdat)
Copyright copy 2016 Guidanz Inc 25
a) Open the generated producttxt file
b) Copy the contenttext inside the producttxt file
c) Use the following curl command to generate the licensing file(actOffdat) replace theSTRING_FROM_THE_FILE with the copied content from producttxt file
curl -XPOST httpsskedlercomOfflineActivationphp -drequestData=STRING_FROM_THE_FILE gt actOffdat
Note Make sure the contenttext which you copy paste to the curl command inrequestData is same as in the generated producttxt file
d) Open the terminal that has an Internet connection and run the curl command Aresponse license file (actOffdat) is generated Copy the response license file(actOffdat) to a server location where Skedler runs
7 After generating the license file (actOffdat) using the curl command Click ldquoAboutrdquoicon in Skedler home page
8 Click ldquoLicense informationrdquo button Edition type and the license key is automaticallyfilled Click ldquoSelect Filerdquo find the license file ldquoactOffdatrdquo on your computer andupload it
Note Retain the same file name ldquoactOffdatrdquo during file upload
Copyright copy 2016 Guidanz Inc 26
9 Click ldquoActivaterdquo button to activate license
10 Click ldquoAbortrdquo button to abort your offline activation
Copyright copy 2016 Guidanz Inc 27
9 Move skedler with license from one server toanotherTo move skedler with license from one server to another follow the steps mention inDeactivate skedler with License section and continue with the steps given below
1 Stop skedler in old server
2 Copy skedler to new server
3 Give necessary permissions to skedler_home directory as follows
sudo chmod -R 765 skedler_home
4 Verify the necessary pre-requisites in the new server as given in Prerequisites section
5 Start skedler in new server using the following command
cd skedler_home
binskedler
Copyright copy 2016 Guidanz Inc 28
6 Activate license with the same key which was used to activate skedler on the oldserver and use the same details to fill the form
If you find any issues during the process contact skelder supportskedlercom
10 Deactivate Skedler with LicenseSkedler license is bound to the computer where you activated it Until you deactivate theskedler license key you cannot use it on another machine Deactivation remove licensedata from the current machine so that you can activate the skedler license key on anothermachine
You can deactivate skedler license key either Online or Offline
NOTE Trial edition cannot be deactivated
Deactivate skedler license key Online
Online deactivation requires an Internet connection To deactivate skedler license keynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate online
Deactivate skedler license key Offline
Offline deactivation does not require an Internet connection To deactivate skedler licensekeynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate offline
It will generate a text file in skedler_homeskedler_offline_deactivation_requesttxt pathwhich you must send to supportskedlercom
Copyright copy 2016 Guidanz Inc 29
11 Shield ConfigurationScenario 1
Kibana managers need access to dataindex 1 and 2
Kibana Users should have access only to dataindex 1
Skedler generates reports based on user permission for dataindex and Skedler needspermission to lsquokibanarsquo index for discovery
Assuming shield is configured for kibana as follows
1 For example if you have kibana_manager and kibana_user roles and skedlerindex configured for both the roles
2 Once the roles have full permission to access the dataindex configured for the roleSkedler can discover all the dashboards and searches from kibana And you canpreview or a generate report for dashboards and search for the configureddataindex
3 In case(a) kibana_manager role has full permission to access lsquokibanarsquodataindex1 dataindex2 and lsquoskedlerrsquo index Skedler can discover all thedashboards and searches from kibana And you can preview or generate report forall dashboards and search from dataindex1 and dataindex2
a) The required permissions for kibana_manager
kibana_manager
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
Copyright copy 2016 Guidanz Inc 30
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
dataindex2
- indicesadminexists
- indicesadminmappingsfieldsget
Copyright copy 2016 Guidanz Inc 31
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
4 In case(b) kibana_user role have full permission to access lsquokibanarsquodataindex1and lsquoskedlerrsquo index Skedler can discover all the dashboards and
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 14
$sudo service skedler_redhat start debug
6 Access Skedler
1 Skedler can be accessed from the following URL httpltyourServergt3000 Ifeverything is installed fine you will see the Email configuration pagea) If you do not require your reports to be mailed you can disable your mail
settings using switch ldquooffrdquob) If you require reports to be mailed configure the outgoing mail settings and
email id (from which all the reports will be sent) If the SMTP server hasany authentication then check ldquoEnable Passwordrdquo and fill the passwordfield After setting the configuration click ldquoSaverdquo button
c) Update time zone for scheduling your report using ldquoTimeZone Settingrdquo andclick ldquoUpdaterdquo
Copyright copy 2016 Guidanz Inc 15
2 Optionally you can upload default logo for your generated PDF report byuploading image using ldquoSelect imagerdquo and click ldquoSaverdquo To reset image clickldquoResetrdquo
3 Click ldquoHomerdquo icon and you will be taken to the home page of Skedler Toschedule a report follow the User Guide
Copyright copy 2016 Guidanz Inc 16
7 How to embed Skedler in your applicationTo embed Skedler UI in your application without the Skedler header and footer followthe steps given below
1 If your application does not require Authentication
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreports
ii Filters - httpltyourServergtfilters
iii Eamil - httpltyourServergtemail
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltyourServergtreportsquery=rdquocitycastrordquo
2 If you application requires Authentication - Admin user can set the emailconfiguration details
Copyright copy 2016 Guidanz Inc 17
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreportsid=ltauthenticationIDgt
ii Filters - httpltyourServergtfiltersid=ltauthenticationIDgt
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltgtreportsid=ltauthenticationIDgtampquery=rdquocitycastrordquo
NOTE authenticationID can be username or ID wich is used to login your application
authenticationID for admin user is ldquoadminrdquo
8 Activate LicenseWhen Skedler is installed it operates in Free Edition with limited functionality Pleasenote the following features that are available when running Skedler in Free Edition
radic You can create and delete a report
radic Preview the report with different Time Window
radic Mail the report
Skedler license can be activated in two ways Online Activation and Offline ActivationFollow the steps given in each section for successful activation If you have not yetinstalled Skedler please refer to the Skedler Installation Guide
You can activate license by clicking ldquoAboutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 18
To activate license key click ldquoActivate Licenserdquo button
The following screenshot displays the License Activation Page
Copyright copy 2016 Guidanz Inc 19
License KeyOnline and Offline activation both require a 25 character alphanumeric license key oractivation code
Typically you would receive the license key along with the product downloadinformation If you have any questions or need help with the license key please contactus at supportskedlercom
Skedler provides different Editions
Trial Edition ndash Typically valid for 21days When the trial period expires Skedlerswitches to Free Edition
NOTE Trial Edition is not available for Offline Activation
Standard Edition
Advanced Edition
Premium Edition
a) Online Trial License Activation
Trial key is packed with Skedler by default
To activate your trial license key online you will need an Internet connection
1 Fill the fields NameEmail and Company name with required values
Copyright copy 2016 Guidanz Inc 20
2 You will find the License Key filled with a Skedler Trial Key
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 21
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
Copyright copy 2016 Guidanz Inc 22
b) Online Product License ActivationTo activate your license online you will need an Internet connection
Fill the required details in License Activation Page
You must have a license key for the edition you requested
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 23
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo to activate the license
c) Offline Product License ActivationFill the required details in License Activation Page
You must have a license key for the edition you requested
Copyright copy 2016 Guidanz Inc 24
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 Offline Activation does not require proxy setting
4 Read and click the Terms and Conditions
5 Click ldquoOffline Activationrdquo link
6 On clicking it will generate a producttxt file Use the steps given below to generatethe licensing file(actOffdat)
Copyright copy 2016 Guidanz Inc 25
a) Open the generated producttxt file
b) Copy the contenttext inside the producttxt file
c) Use the following curl command to generate the licensing file(actOffdat) replace theSTRING_FROM_THE_FILE with the copied content from producttxt file
curl -XPOST httpsskedlercomOfflineActivationphp -drequestData=STRING_FROM_THE_FILE gt actOffdat
Note Make sure the contenttext which you copy paste to the curl command inrequestData is same as in the generated producttxt file
d) Open the terminal that has an Internet connection and run the curl command Aresponse license file (actOffdat) is generated Copy the response license file(actOffdat) to a server location where Skedler runs
7 After generating the license file (actOffdat) using the curl command Click ldquoAboutrdquoicon in Skedler home page
8 Click ldquoLicense informationrdquo button Edition type and the license key is automaticallyfilled Click ldquoSelect Filerdquo find the license file ldquoactOffdatrdquo on your computer andupload it
Note Retain the same file name ldquoactOffdatrdquo during file upload
Copyright copy 2016 Guidanz Inc 26
9 Click ldquoActivaterdquo button to activate license
10 Click ldquoAbortrdquo button to abort your offline activation
Copyright copy 2016 Guidanz Inc 27
9 Move skedler with license from one server toanotherTo move skedler with license from one server to another follow the steps mention inDeactivate skedler with License section and continue with the steps given below
1 Stop skedler in old server
2 Copy skedler to new server
3 Give necessary permissions to skedler_home directory as follows
sudo chmod -R 765 skedler_home
4 Verify the necessary pre-requisites in the new server as given in Prerequisites section
5 Start skedler in new server using the following command
cd skedler_home
binskedler
Copyright copy 2016 Guidanz Inc 28
6 Activate license with the same key which was used to activate skedler on the oldserver and use the same details to fill the form
If you find any issues during the process contact skelder supportskedlercom
10 Deactivate Skedler with LicenseSkedler license is bound to the computer where you activated it Until you deactivate theskedler license key you cannot use it on another machine Deactivation remove licensedata from the current machine so that you can activate the skedler license key on anothermachine
You can deactivate skedler license key either Online or Offline
NOTE Trial edition cannot be deactivated
Deactivate skedler license key Online
Online deactivation requires an Internet connection To deactivate skedler license keynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate online
Deactivate skedler license key Offline
Offline deactivation does not require an Internet connection To deactivate skedler licensekeynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate offline
It will generate a text file in skedler_homeskedler_offline_deactivation_requesttxt pathwhich you must send to supportskedlercom
Copyright copy 2016 Guidanz Inc 29
11 Shield ConfigurationScenario 1
Kibana managers need access to dataindex 1 and 2
Kibana Users should have access only to dataindex 1
Skedler generates reports based on user permission for dataindex and Skedler needspermission to lsquokibanarsquo index for discovery
Assuming shield is configured for kibana as follows
1 For example if you have kibana_manager and kibana_user roles and skedlerindex configured for both the roles
2 Once the roles have full permission to access the dataindex configured for the roleSkedler can discover all the dashboards and searches from kibana And you canpreview or a generate report for dashboards and search for the configureddataindex
3 In case(a) kibana_manager role has full permission to access lsquokibanarsquodataindex1 dataindex2 and lsquoskedlerrsquo index Skedler can discover all thedashboards and searches from kibana And you can preview or generate report forall dashboards and search from dataindex1 and dataindex2
a) The required permissions for kibana_manager
kibana_manager
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
Copyright copy 2016 Guidanz Inc 30
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
dataindex2
- indicesadminexists
- indicesadminmappingsfieldsget
Copyright copy 2016 Guidanz Inc 31
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
4 In case(b) kibana_user role have full permission to access lsquokibanarsquodataindex1and lsquoskedlerrsquo index Skedler can discover all the dashboards and
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 15
2 Optionally you can upload default logo for your generated PDF report byuploading image using ldquoSelect imagerdquo and click ldquoSaverdquo To reset image clickldquoResetrdquo
3 Click ldquoHomerdquo icon and you will be taken to the home page of Skedler Toschedule a report follow the User Guide
Copyright copy 2016 Guidanz Inc 16
7 How to embed Skedler in your applicationTo embed Skedler UI in your application without the Skedler header and footer followthe steps given below
1 If your application does not require Authentication
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreports
ii Filters - httpltyourServergtfilters
iii Eamil - httpltyourServergtemail
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltyourServergtreportsquery=rdquocitycastrordquo
2 If you application requires Authentication - Admin user can set the emailconfiguration details
Copyright copy 2016 Guidanz Inc 17
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreportsid=ltauthenticationIDgt
ii Filters - httpltyourServergtfiltersid=ltauthenticationIDgt
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltgtreportsid=ltauthenticationIDgtampquery=rdquocitycastrordquo
NOTE authenticationID can be username or ID wich is used to login your application
authenticationID for admin user is ldquoadminrdquo
8 Activate LicenseWhen Skedler is installed it operates in Free Edition with limited functionality Pleasenote the following features that are available when running Skedler in Free Edition
radic You can create and delete a report
radic Preview the report with different Time Window
radic Mail the report
Skedler license can be activated in two ways Online Activation and Offline ActivationFollow the steps given in each section for successful activation If you have not yetinstalled Skedler please refer to the Skedler Installation Guide
You can activate license by clicking ldquoAboutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 18
To activate license key click ldquoActivate Licenserdquo button
The following screenshot displays the License Activation Page
Copyright copy 2016 Guidanz Inc 19
License KeyOnline and Offline activation both require a 25 character alphanumeric license key oractivation code
Typically you would receive the license key along with the product downloadinformation If you have any questions or need help with the license key please contactus at supportskedlercom
Skedler provides different Editions
Trial Edition ndash Typically valid for 21days When the trial period expires Skedlerswitches to Free Edition
NOTE Trial Edition is not available for Offline Activation
Standard Edition
Advanced Edition
Premium Edition
a) Online Trial License Activation
Trial key is packed with Skedler by default
To activate your trial license key online you will need an Internet connection
1 Fill the fields NameEmail and Company name with required values
Copyright copy 2016 Guidanz Inc 20
2 You will find the License Key filled with a Skedler Trial Key
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 21
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
Copyright copy 2016 Guidanz Inc 22
b) Online Product License ActivationTo activate your license online you will need an Internet connection
Fill the required details in License Activation Page
You must have a license key for the edition you requested
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 23
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo to activate the license
c) Offline Product License ActivationFill the required details in License Activation Page
You must have a license key for the edition you requested
Copyright copy 2016 Guidanz Inc 24
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 Offline Activation does not require proxy setting
4 Read and click the Terms and Conditions
5 Click ldquoOffline Activationrdquo link
6 On clicking it will generate a producttxt file Use the steps given below to generatethe licensing file(actOffdat)
Copyright copy 2016 Guidanz Inc 25
a) Open the generated producttxt file
b) Copy the contenttext inside the producttxt file
c) Use the following curl command to generate the licensing file(actOffdat) replace theSTRING_FROM_THE_FILE with the copied content from producttxt file
curl -XPOST httpsskedlercomOfflineActivationphp -drequestData=STRING_FROM_THE_FILE gt actOffdat
Note Make sure the contenttext which you copy paste to the curl command inrequestData is same as in the generated producttxt file
d) Open the terminal that has an Internet connection and run the curl command Aresponse license file (actOffdat) is generated Copy the response license file(actOffdat) to a server location where Skedler runs
7 After generating the license file (actOffdat) using the curl command Click ldquoAboutrdquoicon in Skedler home page
8 Click ldquoLicense informationrdquo button Edition type and the license key is automaticallyfilled Click ldquoSelect Filerdquo find the license file ldquoactOffdatrdquo on your computer andupload it
Note Retain the same file name ldquoactOffdatrdquo during file upload
Copyright copy 2016 Guidanz Inc 26
9 Click ldquoActivaterdquo button to activate license
10 Click ldquoAbortrdquo button to abort your offline activation
Copyright copy 2016 Guidanz Inc 27
9 Move skedler with license from one server toanotherTo move skedler with license from one server to another follow the steps mention inDeactivate skedler with License section and continue with the steps given below
1 Stop skedler in old server
2 Copy skedler to new server
3 Give necessary permissions to skedler_home directory as follows
sudo chmod -R 765 skedler_home
4 Verify the necessary pre-requisites in the new server as given in Prerequisites section
5 Start skedler in new server using the following command
cd skedler_home
binskedler
Copyright copy 2016 Guidanz Inc 28
6 Activate license with the same key which was used to activate skedler on the oldserver and use the same details to fill the form
If you find any issues during the process contact skelder supportskedlercom
10 Deactivate Skedler with LicenseSkedler license is bound to the computer where you activated it Until you deactivate theskedler license key you cannot use it on another machine Deactivation remove licensedata from the current machine so that you can activate the skedler license key on anothermachine
You can deactivate skedler license key either Online or Offline
NOTE Trial edition cannot be deactivated
Deactivate skedler license key Online
Online deactivation requires an Internet connection To deactivate skedler license keynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate online
Deactivate skedler license key Offline
Offline deactivation does not require an Internet connection To deactivate skedler licensekeynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate offline
It will generate a text file in skedler_homeskedler_offline_deactivation_requesttxt pathwhich you must send to supportskedlercom
Copyright copy 2016 Guidanz Inc 29
11 Shield ConfigurationScenario 1
Kibana managers need access to dataindex 1 and 2
Kibana Users should have access only to dataindex 1
Skedler generates reports based on user permission for dataindex and Skedler needspermission to lsquokibanarsquo index for discovery
Assuming shield is configured for kibana as follows
1 For example if you have kibana_manager and kibana_user roles and skedlerindex configured for both the roles
2 Once the roles have full permission to access the dataindex configured for the roleSkedler can discover all the dashboards and searches from kibana And you canpreview or a generate report for dashboards and search for the configureddataindex
3 In case(a) kibana_manager role has full permission to access lsquokibanarsquodataindex1 dataindex2 and lsquoskedlerrsquo index Skedler can discover all thedashboards and searches from kibana And you can preview or generate report forall dashboards and search from dataindex1 and dataindex2
a) The required permissions for kibana_manager
kibana_manager
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
Copyright copy 2016 Guidanz Inc 30
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
dataindex2
- indicesadminexists
- indicesadminmappingsfieldsget
Copyright copy 2016 Guidanz Inc 31
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
4 In case(b) kibana_user role have full permission to access lsquokibanarsquodataindex1and lsquoskedlerrsquo index Skedler can discover all the dashboards and
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 16
7 How to embed Skedler in your applicationTo embed Skedler UI in your application without the Skedler header and footer followthe steps given below
1 If your application does not require Authentication
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreports
ii Filters - httpltyourServergtfilters
iii Eamil - httpltyourServergtemail
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltyourServergtreportsquery=rdquocitycastrordquo
2 If you application requires Authentication - Admin user can set the emailconfiguration details
Copyright copy 2016 Guidanz Inc 17
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreportsid=ltauthenticationIDgt
ii Filters - httpltyourServergtfiltersid=ltauthenticationIDgt
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltgtreportsid=ltauthenticationIDgtampquery=rdquocitycastrordquo
NOTE authenticationID can be username or ID wich is used to login your application
authenticationID for admin user is ldquoadminrdquo
8 Activate LicenseWhen Skedler is installed it operates in Free Edition with limited functionality Pleasenote the following features that are available when running Skedler in Free Edition
radic You can create and delete a report
radic Preview the report with different Time Window
radic Mail the report
Skedler license can be activated in two ways Online Activation and Offline ActivationFollow the steps given in each section for successful activation If you have not yetinstalled Skedler please refer to the Skedler Installation Guide
You can activate license by clicking ldquoAboutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 18
To activate license key click ldquoActivate Licenserdquo button
The following screenshot displays the License Activation Page
Copyright copy 2016 Guidanz Inc 19
License KeyOnline and Offline activation both require a 25 character alphanumeric license key oractivation code
Typically you would receive the license key along with the product downloadinformation If you have any questions or need help with the license key please contactus at supportskedlercom
Skedler provides different Editions
Trial Edition ndash Typically valid for 21days When the trial period expires Skedlerswitches to Free Edition
NOTE Trial Edition is not available for Offline Activation
Standard Edition
Advanced Edition
Premium Edition
a) Online Trial License Activation
Trial key is packed with Skedler by default
To activate your trial license key online you will need an Internet connection
1 Fill the fields NameEmail and Company name with required values
Copyright copy 2016 Guidanz Inc 20
2 You will find the License Key filled with a Skedler Trial Key
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 21
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
Copyright copy 2016 Guidanz Inc 22
b) Online Product License ActivationTo activate your license online you will need an Internet connection
Fill the required details in License Activation Page
You must have a license key for the edition you requested
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 23
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo to activate the license
c) Offline Product License ActivationFill the required details in License Activation Page
You must have a license key for the edition you requested
Copyright copy 2016 Guidanz Inc 24
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 Offline Activation does not require proxy setting
4 Read and click the Terms and Conditions
5 Click ldquoOffline Activationrdquo link
6 On clicking it will generate a producttxt file Use the steps given below to generatethe licensing file(actOffdat)
Copyright copy 2016 Guidanz Inc 25
a) Open the generated producttxt file
b) Copy the contenttext inside the producttxt file
c) Use the following curl command to generate the licensing file(actOffdat) replace theSTRING_FROM_THE_FILE with the copied content from producttxt file
curl -XPOST httpsskedlercomOfflineActivationphp -drequestData=STRING_FROM_THE_FILE gt actOffdat
Note Make sure the contenttext which you copy paste to the curl command inrequestData is same as in the generated producttxt file
d) Open the terminal that has an Internet connection and run the curl command Aresponse license file (actOffdat) is generated Copy the response license file(actOffdat) to a server location where Skedler runs
7 After generating the license file (actOffdat) using the curl command Click ldquoAboutrdquoicon in Skedler home page
8 Click ldquoLicense informationrdquo button Edition type and the license key is automaticallyfilled Click ldquoSelect Filerdquo find the license file ldquoactOffdatrdquo on your computer andupload it
Note Retain the same file name ldquoactOffdatrdquo during file upload
Copyright copy 2016 Guidanz Inc 26
9 Click ldquoActivaterdquo button to activate license
10 Click ldquoAbortrdquo button to abort your offline activation
Copyright copy 2016 Guidanz Inc 27
9 Move skedler with license from one server toanotherTo move skedler with license from one server to another follow the steps mention inDeactivate skedler with License section and continue with the steps given below
1 Stop skedler in old server
2 Copy skedler to new server
3 Give necessary permissions to skedler_home directory as follows
sudo chmod -R 765 skedler_home
4 Verify the necessary pre-requisites in the new server as given in Prerequisites section
5 Start skedler in new server using the following command
cd skedler_home
binskedler
Copyright copy 2016 Guidanz Inc 28
6 Activate license with the same key which was used to activate skedler on the oldserver and use the same details to fill the form
If you find any issues during the process contact skelder supportskedlercom
10 Deactivate Skedler with LicenseSkedler license is bound to the computer where you activated it Until you deactivate theskedler license key you cannot use it on another machine Deactivation remove licensedata from the current machine so that you can activate the skedler license key on anothermachine
You can deactivate skedler license key either Online or Offline
NOTE Trial edition cannot be deactivated
Deactivate skedler license key Online
Online deactivation requires an Internet connection To deactivate skedler license keynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate online
Deactivate skedler license key Offline
Offline deactivation does not require an Internet connection To deactivate skedler licensekeynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate offline
It will generate a text file in skedler_homeskedler_offline_deactivation_requesttxt pathwhich you must send to supportskedlercom
Copyright copy 2016 Guidanz Inc 29
11 Shield ConfigurationScenario 1
Kibana managers need access to dataindex 1 and 2
Kibana Users should have access only to dataindex 1
Skedler generates reports based on user permission for dataindex and Skedler needspermission to lsquokibanarsquo index for discovery
Assuming shield is configured for kibana as follows
1 For example if you have kibana_manager and kibana_user roles and skedlerindex configured for both the roles
2 Once the roles have full permission to access the dataindex configured for the roleSkedler can discover all the dashboards and searches from kibana And you canpreview or a generate report for dashboards and search for the configureddataindex
3 In case(a) kibana_manager role has full permission to access lsquokibanarsquodataindex1 dataindex2 and lsquoskedlerrsquo index Skedler can discover all thedashboards and searches from kibana And you can preview or generate report forall dashboards and search from dataindex1 and dataindex2
a) The required permissions for kibana_manager
kibana_manager
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
Copyright copy 2016 Guidanz Inc 30
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
dataindex2
- indicesadminexists
- indicesadminmappingsfieldsget
Copyright copy 2016 Guidanz Inc 31
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
4 In case(b) kibana_user role have full permission to access lsquokibanarsquodataindex1and lsquoskedlerrsquo index Skedler can discover all the dashboards and
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 17
a) Embed the following URL in your application using iframe tag
i Reports - httpltyourServergtreportsid=ltauthenticationIDgt
ii Filters - httpltyourServergtfiltersid=ltauthenticationIDgt
b) If a query filter needs to be applied globally to all the dashboards then passthe parameter query in the URL For examplehttpltgtreportsid=ltauthenticationIDgtampquery=rdquocitycastrordquo
NOTE authenticationID can be username or ID wich is used to login your application
authenticationID for admin user is ldquoadminrdquo
8 Activate LicenseWhen Skedler is installed it operates in Free Edition with limited functionality Pleasenote the following features that are available when running Skedler in Free Edition
radic You can create and delete a report
radic Preview the report with different Time Window
radic Mail the report
Skedler license can be activated in two ways Online Activation and Offline ActivationFollow the steps given in each section for successful activation If you have not yetinstalled Skedler please refer to the Skedler Installation Guide
You can activate license by clicking ldquoAboutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 18
To activate license key click ldquoActivate Licenserdquo button
The following screenshot displays the License Activation Page
Copyright copy 2016 Guidanz Inc 19
License KeyOnline and Offline activation both require a 25 character alphanumeric license key oractivation code
Typically you would receive the license key along with the product downloadinformation If you have any questions or need help with the license key please contactus at supportskedlercom
Skedler provides different Editions
Trial Edition ndash Typically valid for 21days When the trial period expires Skedlerswitches to Free Edition
NOTE Trial Edition is not available for Offline Activation
Standard Edition
Advanced Edition
Premium Edition
a) Online Trial License Activation
Trial key is packed with Skedler by default
To activate your trial license key online you will need an Internet connection
1 Fill the fields NameEmail and Company name with required values
Copyright copy 2016 Guidanz Inc 20
2 You will find the License Key filled with a Skedler Trial Key
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 21
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
Copyright copy 2016 Guidanz Inc 22
b) Online Product License ActivationTo activate your license online you will need an Internet connection
Fill the required details in License Activation Page
You must have a license key for the edition you requested
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 23
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo to activate the license
c) Offline Product License ActivationFill the required details in License Activation Page
You must have a license key for the edition you requested
Copyright copy 2016 Guidanz Inc 24
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 Offline Activation does not require proxy setting
4 Read and click the Terms and Conditions
5 Click ldquoOffline Activationrdquo link
6 On clicking it will generate a producttxt file Use the steps given below to generatethe licensing file(actOffdat)
Copyright copy 2016 Guidanz Inc 25
a) Open the generated producttxt file
b) Copy the contenttext inside the producttxt file
c) Use the following curl command to generate the licensing file(actOffdat) replace theSTRING_FROM_THE_FILE with the copied content from producttxt file
curl -XPOST httpsskedlercomOfflineActivationphp -drequestData=STRING_FROM_THE_FILE gt actOffdat
Note Make sure the contenttext which you copy paste to the curl command inrequestData is same as in the generated producttxt file
d) Open the terminal that has an Internet connection and run the curl command Aresponse license file (actOffdat) is generated Copy the response license file(actOffdat) to a server location where Skedler runs
7 After generating the license file (actOffdat) using the curl command Click ldquoAboutrdquoicon in Skedler home page
8 Click ldquoLicense informationrdquo button Edition type and the license key is automaticallyfilled Click ldquoSelect Filerdquo find the license file ldquoactOffdatrdquo on your computer andupload it
Note Retain the same file name ldquoactOffdatrdquo during file upload
Copyright copy 2016 Guidanz Inc 26
9 Click ldquoActivaterdquo button to activate license
10 Click ldquoAbortrdquo button to abort your offline activation
Copyright copy 2016 Guidanz Inc 27
9 Move skedler with license from one server toanotherTo move skedler with license from one server to another follow the steps mention inDeactivate skedler with License section and continue with the steps given below
1 Stop skedler in old server
2 Copy skedler to new server
3 Give necessary permissions to skedler_home directory as follows
sudo chmod -R 765 skedler_home
4 Verify the necessary pre-requisites in the new server as given in Prerequisites section
5 Start skedler in new server using the following command
cd skedler_home
binskedler
Copyright copy 2016 Guidanz Inc 28
6 Activate license with the same key which was used to activate skedler on the oldserver and use the same details to fill the form
If you find any issues during the process contact skelder supportskedlercom
10 Deactivate Skedler with LicenseSkedler license is bound to the computer where you activated it Until you deactivate theskedler license key you cannot use it on another machine Deactivation remove licensedata from the current machine so that you can activate the skedler license key on anothermachine
You can deactivate skedler license key either Online or Offline
NOTE Trial edition cannot be deactivated
Deactivate skedler license key Online
Online deactivation requires an Internet connection To deactivate skedler license keynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate online
Deactivate skedler license key Offline
Offline deactivation does not require an Internet connection To deactivate skedler licensekeynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate offline
It will generate a text file in skedler_homeskedler_offline_deactivation_requesttxt pathwhich you must send to supportskedlercom
Copyright copy 2016 Guidanz Inc 29
11 Shield ConfigurationScenario 1
Kibana managers need access to dataindex 1 and 2
Kibana Users should have access only to dataindex 1
Skedler generates reports based on user permission for dataindex and Skedler needspermission to lsquokibanarsquo index for discovery
Assuming shield is configured for kibana as follows
1 For example if you have kibana_manager and kibana_user roles and skedlerindex configured for both the roles
2 Once the roles have full permission to access the dataindex configured for the roleSkedler can discover all the dashboards and searches from kibana And you canpreview or a generate report for dashboards and search for the configureddataindex
3 In case(a) kibana_manager role has full permission to access lsquokibanarsquodataindex1 dataindex2 and lsquoskedlerrsquo index Skedler can discover all thedashboards and searches from kibana And you can preview or generate report forall dashboards and search from dataindex1 and dataindex2
a) The required permissions for kibana_manager
kibana_manager
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
Copyright copy 2016 Guidanz Inc 30
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
dataindex2
- indicesadminexists
- indicesadminmappingsfieldsget
Copyright copy 2016 Guidanz Inc 31
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
4 In case(b) kibana_user role have full permission to access lsquokibanarsquodataindex1and lsquoskedlerrsquo index Skedler can discover all the dashboards and
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 18
To activate license key click ldquoActivate Licenserdquo button
The following screenshot displays the License Activation Page
Copyright copy 2016 Guidanz Inc 19
License KeyOnline and Offline activation both require a 25 character alphanumeric license key oractivation code
Typically you would receive the license key along with the product downloadinformation If you have any questions or need help with the license key please contactus at supportskedlercom
Skedler provides different Editions
Trial Edition ndash Typically valid for 21days When the trial period expires Skedlerswitches to Free Edition
NOTE Trial Edition is not available for Offline Activation
Standard Edition
Advanced Edition
Premium Edition
a) Online Trial License Activation
Trial key is packed with Skedler by default
To activate your trial license key online you will need an Internet connection
1 Fill the fields NameEmail and Company name with required values
Copyright copy 2016 Guidanz Inc 20
2 You will find the License Key filled with a Skedler Trial Key
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 21
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
Copyright copy 2016 Guidanz Inc 22
b) Online Product License ActivationTo activate your license online you will need an Internet connection
Fill the required details in License Activation Page
You must have a license key for the edition you requested
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 23
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo to activate the license
c) Offline Product License ActivationFill the required details in License Activation Page
You must have a license key for the edition you requested
Copyright copy 2016 Guidanz Inc 24
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 Offline Activation does not require proxy setting
4 Read and click the Terms and Conditions
5 Click ldquoOffline Activationrdquo link
6 On clicking it will generate a producttxt file Use the steps given below to generatethe licensing file(actOffdat)
Copyright copy 2016 Guidanz Inc 25
a) Open the generated producttxt file
b) Copy the contenttext inside the producttxt file
c) Use the following curl command to generate the licensing file(actOffdat) replace theSTRING_FROM_THE_FILE with the copied content from producttxt file
curl -XPOST httpsskedlercomOfflineActivationphp -drequestData=STRING_FROM_THE_FILE gt actOffdat
Note Make sure the contenttext which you copy paste to the curl command inrequestData is same as in the generated producttxt file
d) Open the terminal that has an Internet connection and run the curl command Aresponse license file (actOffdat) is generated Copy the response license file(actOffdat) to a server location where Skedler runs
7 After generating the license file (actOffdat) using the curl command Click ldquoAboutrdquoicon in Skedler home page
8 Click ldquoLicense informationrdquo button Edition type and the license key is automaticallyfilled Click ldquoSelect Filerdquo find the license file ldquoactOffdatrdquo on your computer andupload it
Note Retain the same file name ldquoactOffdatrdquo during file upload
Copyright copy 2016 Guidanz Inc 26
9 Click ldquoActivaterdquo button to activate license
10 Click ldquoAbortrdquo button to abort your offline activation
Copyright copy 2016 Guidanz Inc 27
9 Move skedler with license from one server toanotherTo move skedler with license from one server to another follow the steps mention inDeactivate skedler with License section and continue with the steps given below
1 Stop skedler in old server
2 Copy skedler to new server
3 Give necessary permissions to skedler_home directory as follows
sudo chmod -R 765 skedler_home
4 Verify the necessary pre-requisites in the new server as given in Prerequisites section
5 Start skedler in new server using the following command
cd skedler_home
binskedler
Copyright copy 2016 Guidanz Inc 28
6 Activate license with the same key which was used to activate skedler on the oldserver and use the same details to fill the form
If you find any issues during the process contact skelder supportskedlercom
10 Deactivate Skedler with LicenseSkedler license is bound to the computer where you activated it Until you deactivate theskedler license key you cannot use it on another machine Deactivation remove licensedata from the current machine so that you can activate the skedler license key on anothermachine
You can deactivate skedler license key either Online or Offline
NOTE Trial edition cannot be deactivated
Deactivate skedler license key Online
Online deactivation requires an Internet connection To deactivate skedler license keynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate online
Deactivate skedler license key Offline
Offline deactivation does not require an Internet connection To deactivate skedler licensekeynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate offline
It will generate a text file in skedler_homeskedler_offline_deactivation_requesttxt pathwhich you must send to supportskedlercom
Copyright copy 2016 Guidanz Inc 29
11 Shield ConfigurationScenario 1
Kibana managers need access to dataindex 1 and 2
Kibana Users should have access only to dataindex 1
Skedler generates reports based on user permission for dataindex and Skedler needspermission to lsquokibanarsquo index for discovery
Assuming shield is configured for kibana as follows
1 For example if you have kibana_manager and kibana_user roles and skedlerindex configured for both the roles
2 Once the roles have full permission to access the dataindex configured for the roleSkedler can discover all the dashboards and searches from kibana And you canpreview or a generate report for dashboards and search for the configureddataindex
3 In case(a) kibana_manager role has full permission to access lsquokibanarsquodataindex1 dataindex2 and lsquoskedlerrsquo index Skedler can discover all thedashboards and searches from kibana And you can preview or generate report forall dashboards and search from dataindex1 and dataindex2
a) The required permissions for kibana_manager
kibana_manager
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
Copyright copy 2016 Guidanz Inc 30
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
dataindex2
- indicesadminexists
- indicesadminmappingsfieldsget
Copyright copy 2016 Guidanz Inc 31
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
4 In case(b) kibana_user role have full permission to access lsquokibanarsquodataindex1and lsquoskedlerrsquo index Skedler can discover all the dashboards and
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 19
License KeyOnline and Offline activation both require a 25 character alphanumeric license key oractivation code
Typically you would receive the license key along with the product downloadinformation If you have any questions or need help with the license key please contactus at supportskedlercom
Skedler provides different Editions
Trial Edition ndash Typically valid for 21days When the trial period expires Skedlerswitches to Free Edition
NOTE Trial Edition is not available for Offline Activation
Standard Edition
Advanced Edition
Premium Edition
a) Online Trial License Activation
Trial key is packed with Skedler by default
To activate your trial license key online you will need an Internet connection
1 Fill the fields NameEmail and Company name with required values
Copyright copy 2016 Guidanz Inc 20
2 You will find the License Key filled with a Skedler Trial Key
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 21
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
Copyright copy 2016 Guidanz Inc 22
b) Online Product License ActivationTo activate your license online you will need an Internet connection
Fill the required details in License Activation Page
You must have a license key for the edition you requested
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 23
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo to activate the license
c) Offline Product License ActivationFill the required details in License Activation Page
You must have a license key for the edition you requested
Copyright copy 2016 Guidanz Inc 24
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 Offline Activation does not require proxy setting
4 Read and click the Terms and Conditions
5 Click ldquoOffline Activationrdquo link
6 On clicking it will generate a producttxt file Use the steps given below to generatethe licensing file(actOffdat)
Copyright copy 2016 Guidanz Inc 25
a) Open the generated producttxt file
b) Copy the contenttext inside the producttxt file
c) Use the following curl command to generate the licensing file(actOffdat) replace theSTRING_FROM_THE_FILE with the copied content from producttxt file
curl -XPOST httpsskedlercomOfflineActivationphp -drequestData=STRING_FROM_THE_FILE gt actOffdat
Note Make sure the contenttext which you copy paste to the curl command inrequestData is same as in the generated producttxt file
d) Open the terminal that has an Internet connection and run the curl command Aresponse license file (actOffdat) is generated Copy the response license file(actOffdat) to a server location where Skedler runs
7 After generating the license file (actOffdat) using the curl command Click ldquoAboutrdquoicon in Skedler home page
8 Click ldquoLicense informationrdquo button Edition type and the license key is automaticallyfilled Click ldquoSelect Filerdquo find the license file ldquoactOffdatrdquo on your computer andupload it
Note Retain the same file name ldquoactOffdatrdquo during file upload
Copyright copy 2016 Guidanz Inc 26
9 Click ldquoActivaterdquo button to activate license
10 Click ldquoAbortrdquo button to abort your offline activation
Copyright copy 2016 Guidanz Inc 27
9 Move skedler with license from one server toanotherTo move skedler with license from one server to another follow the steps mention inDeactivate skedler with License section and continue with the steps given below
1 Stop skedler in old server
2 Copy skedler to new server
3 Give necessary permissions to skedler_home directory as follows
sudo chmod -R 765 skedler_home
4 Verify the necessary pre-requisites in the new server as given in Prerequisites section
5 Start skedler in new server using the following command
cd skedler_home
binskedler
Copyright copy 2016 Guidanz Inc 28
6 Activate license with the same key which was used to activate skedler on the oldserver and use the same details to fill the form
If you find any issues during the process contact skelder supportskedlercom
10 Deactivate Skedler with LicenseSkedler license is bound to the computer where you activated it Until you deactivate theskedler license key you cannot use it on another machine Deactivation remove licensedata from the current machine so that you can activate the skedler license key on anothermachine
You can deactivate skedler license key either Online or Offline
NOTE Trial edition cannot be deactivated
Deactivate skedler license key Online
Online deactivation requires an Internet connection To deactivate skedler license keynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate online
Deactivate skedler license key Offline
Offline deactivation does not require an Internet connection To deactivate skedler licensekeynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate offline
It will generate a text file in skedler_homeskedler_offline_deactivation_requesttxt pathwhich you must send to supportskedlercom
Copyright copy 2016 Guidanz Inc 29
11 Shield ConfigurationScenario 1
Kibana managers need access to dataindex 1 and 2
Kibana Users should have access only to dataindex 1
Skedler generates reports based on user permission for dataindex and Skedler needspermission to lsquokibanarsquo index for discovery
Assuming shield is configured for kibana as follows
1 For example if you have kibana_manager and kibana_user roles and skedlerindex configured for both the roles
2 Once the roles have full permission to access the dataindex configured for the roleSkedler can discover all the dashboards and searches from kibana And you canpreview or a generate report for dashboards and search for the configureddataindex
3 In case(a) kibana_manager role has full permission to access lsquokibanarsquodataindex1 dataindex2 and lsquoskedlerrsquo index Skedler can discover all thedashboards and searches from kibana And you can preview or generate report forall dashboards and search from dataindex1 and dataindex2
a) The required permissions for kibana_manager
kibana_manager
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
Copyright copy 2016 Guidanz Inc 30
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
dataindex2
- indicesadminexists
- indicesadminmappingsfieldsget
Copyright copy 2016 Guidanz Inc 31
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
4 In case(b) kibana_user role have full permission to access lsquokibanarsquodataindex1and lsquoskedlerrsquo index Skedler can discover all the dashboards and
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 20
2 You will find the License Key filled with a Skedler Trial Key
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 21
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
Copyright copy 2016 Guidanz Inc 22
b) Online Product License ActivationTo activate your license online you will need an Internet connection
Fill the required details in License Activation Page
You must have a license key for the edition you requested
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 23
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo to activate the license
c) Offline Product License ActivationFill the required details in License Activation Page
You must have a license key for the edition you requested
Copyright copy 2016 Guidanz Inc 24
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 Offline Activation does not require proxy setting
4 Read and click the Terms and Conditions
5 Click ldquoOffline Activationrdquo link
6 On clicking it will generate a producttxt file Use the steps given below to generatethe licensing file(actOffdat)
Copyright copy 2016 Guidanz Inc 25
a) Open the generated producttxt file
b) Copy the contenttext inside the producttxt file
c) Use the following curl command to generate the licensing file(actOffdat) replace theSTRING_FROM_THE_FILE with the copied content from producttxt file
curl -XPOST httpsskedlercomOfflineActivationphp -drequestData=STRING_FROM_THE_FILE gt actOffdat
Note Make sure the contenttext which you copy paste to the curl command inrequestData is same as in the generated producttxt file
d) Open the terminal that has an Internet connection and run the curl command Aresponse license file (actOffdat) is generated Copy the response license file(actOffdat) to a server location where Skedler runs
7 After generating the license file (actOffdat) using the curl command Click ldquoAboutrdquoicon in Skedler home page
8 Click ldquoLicense informationrdquo button Edition type and the license key is automaticallyfilled Click ldquoSelect Filerdquo find the license file ldquoactOffdatrdquo on your computer andupload it
Note Retain the same file name ldquoactOffdatrdquo during file upload
Copyright copy 2016 Guidanz Inc 26
9 Click ldquoActivaterdquo button to activate license
10 Click ldquoAbortrdquo button to abort your offline activation
Copyright copy 2016 Guidanz Inc 27
9 Move skedler with license from one server toanotherTo move skedler with license from one server to another follow the steps mention inDeactivate skedler with License section and continue with the steps given below
1 Stop skedler in old server
2 Copy skedler to new server
3 Give necessary permissions to skedler_home directory as follows
sudo chmod -R 765 skedler_home
4 Verify the necessary pre-requisites in the new server as given in Prerequisites section
5 Start skedler in new server using the following command
cd skedler_home
binskedler
Copyright copy 2016 Guidanz Inc 28
6 Activate license with the same key which was used to activate skedler on the oldserver and use the same details to fill the form
If you find any issues during the process contact skelder supportskedlercom
10 Deactivate Skedler with LicenseSkedler license is bound to the computer where you activated it Until you deactivate theskedler license key you cannot use it on another machine Deactivation remove licensedata from the current machine so that you can activate the skedler license key on anothermachine
You can deactivate skedler license key either Online or Offline
NOTE Trial edition cannot be deactivated
Deactivate skedler license key Online
Online deactivation requires an Internet connection To deactivate skedler license keynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate online
Deactivate skedler license key Offline
Offline deactivation does not require an Internet connection To deactivate skedler licensekeynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate offline
It will generate a text file in skedler_homeskedler_offline_deactivation_requesttxt pathwhich you must send to supportskedlercom
Copyright copy 2016 Guidanz Inc 29
11 Shield ConfigurationScenario 1
Kibana managers need access to dataindex 1 and 2
Kibana Users should have access only to dataindex 1
Skedler generates reports based on user permission for dataindex and Skedler needspermission to lsquokibanarsquo index for discovery
Assuming shield is configured for kibana as follows
1 For example if you have kibana_manager and kibana_user roles and skedlerindex configured for both the roles
2 Once the roles have full permission to access the dataindex configured for the roleSkedler can discover all the dashboards and searches from kibana And you canpreview or a generate report for dashboards and search for the configureddataindex
3 In case(a) kibana_manager role has full permission to access lsquokibanarsquodataindex1 dataindex2 and lsquoskedlerrsquo index Skedler can discover all thedashboards and searches from kibana And you can preview or generate report forall dashboards and search from dataindex1 and dataindex2
a) The required permissions for kibana_manager
kibana_manager
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
Copyright copy 2016 Guidanz Inc 30
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
dataindex2
- indicesadminexists
- indicesadminmappingsfieldsget
Copyright copy 2016 Guidanz Inc 31
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
4 In case(b) kibana_user role have full permission to access lsquokibanarsquodataindex1and lsquoskedlerrsquo index Skedler can discover all the dashboards and
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 21
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo button to activate Skedler Trial License
NOTE Do not modify the License key unless you update your Skedler Edition
Copyright copy 2016 Guidanz Inc 22
b) Online Product License ActivationTo activate your license online you will need an Internet connection
Fill the required details in License Activation Page
You must have a license key for the edition you requested
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 23
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo to activate the license
c) Offline Product License ActivationFill the required details in License Activation Page
You must have a license key for the edition you requested
Copyright copy 2016 Guidanz Inc 24
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 Offline Activation does not require proxy setting
4 Read and click the Terms and Conditions
5 Click ldquoOffline Activationrdquo link
6 On clicking it will generate a producttxt file Use the steps given below to generatethe licensing file(actOffdat)
Copyright copy 2016 Guidanz Inc 25
a) Open the generated producttxt file
b) Copy the contenttext inside the producttxt file
c) Use the following curl command to generate the licensing file(actOffdat) replace theSTRING_FROM_THE_FILE with the copied content from producttxt file
curl -XPOST httpsskedlercomOfflineActivationphp -drequestData=STRING_FROM_THE_FILE gt actOffdat
Note Make sure the contenttext which you copy paste to the curl command inrequestData is same as in the generated producttxt file
d) Open the terminal that has an Internet connection and run the curl command Aresponse license file (actOffdat) is generated Copy the response license file(actOffdat) to a server location where Skedler runs
7 After generating the license file (actOffdat) using the curl command Click ldquoAboutrdquoicon in Skedler home page
8 Click ldquoLicense informationrdquo button Edition type and the license key is automaticallyfilled Click ldquoSelect Filerdquo find the license file ldquoactOffdatrdquo on your computer andupload it
Note Retain the same file name ldquoactOffdatrdquo during file upload
Copyright copy 2016 Guidanz Inc 26
9 Click ldquoActivaterdquo button to activate license
10 Click ldquoAbortrdquo button to abort your offline activation
Copyright copy 2016 Guidanz Inc 27
9 Move skedler with license from one server toanotherTo move skedler with license from one server to another follow the steps mention inDeactivate skedler with License section and continue with the steps given below
1 Stop skedler in old server
2 Copy skedler to new server
3 Give necessary permissions to skedler_home directory as follows
sudo chmod -R 765 skedler_home
4 Verify the necessary pre-requisites in the new server as given in Prerequisites section
5 Start skedler in new server using the following command
cd skedler_home
binskedler
Copyright copy 2016 Guidanz Inc 28
6 Activate license with the same key which was used to activate skedler on the oldserver and use the same details to fill the form
If you find any issues during the process contact skelder supportskedlercom
10 Deactivate Skedler with LicenseSkedler license is bound to the computer where you activated it Until you deactivate theskedler license key you cannot use it on another machine Deactivation remove licensedata from the current machine so that you can activate the skedler license key on anothermachine
You can deactivate skedler license key either Online or Offline
NOTE Trial edition cannot be deactivated
Deactivate skedler license key Online
Online deactivation requires an Internet connection To deactivate skedler license keynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate online
Deactivate skedler license key Offline
Offline deactivation does not require an Internet connection To deactivate skedler licensekeynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate offline
It will generate a text file in skedler_homeskedler_offline_deactivation_requesttxt pathwhich you must send to supportskedlercom
Copyright copy 2016 Guidanz Inc 29
11 Shield ConfigurationScenario 1
Kibana managers need access to dataindex 1 and 2
Kibana Users should have access only to dataindex 1
Skedler generates reports based on user permission for dataindex and Skedler needspermission to lsquokibanarsquo index for discovery
Assuming shield is configured for kibana as follows
1 For example if you have kibana_manager and kibana_user roles and skedlerindex configured for both the roles
2 Once the roles have full permission to access the dataindex configured for the roleSkedler can discover all the dashboards and searches from kibana And you canpreview or a generate report for dashboards and search for the configureddataindex
3 In case(a) kibana_manager role has full permission to access lsquokibanarsquodataindex1 dataindex2 and lsquoskedlerrsquo index Skedler can discover all thedashboards and searches from kibana And you can preview or generate report forall dashboards and search from dataindex1 and dataindex2
a) The required permissions for kibana_manager
kibana_manager
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
Copyright copy 2016 Guidanz Inc 30
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
dataindex2
- indicesadminexists
- indicesadminmappingsfieldsget
Copyright copy 2016 Guidanz Inc 31
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
4 In case(b) kibana_user role have full permission to access lsquokibanarsquodataindex1and lsquoskedlerrsquo index Skedler can discover all the dashboards and
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 22
b) Online Product License ActivationTo activate your license online you will need an Internet connection
Fill the required details in License Activation Page
You must have a license key for the edition you requested
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 If your internet connection requires a proxy server you can enter the details byclicking the ldquoSettingsrdquo icon in License Activation Page By default no proxy optionis enabled
4 You can specify the protocol server name or proxy IP and port If your proxy settingrequires user authentication fill the Username and Password fields else leave thefields empty and click ldquoSaverdquo button
Copyright copy 2016 Guidanz Inc 23
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo to activate the license
c) Offline Product License ActivationFill the required details in License Activation Page
You must have a license key for the edition you requested
Copyright copy 2016 Guidanz Inc 24
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 Offline Activation does not require proxy setting
4 Read and click the Terms and Conditions
5 Click ldquoOffline Activationrdquo link
6 On clicking it will generate a producttxt file Use the steps given below to generatethe licensing file(actOffdat)
Copyright copy 2016 Guidanz Inc 25
a) Open the generated producttxt file
b) Copy the contenttext inside the producttxt file
c) Use the following curl command to generate the licensing file(actOffdat) replace theSTRING_FROM_THE_FILE with the copied content from producttxt file
curl -XPOST httpsskedlercomOfflineActivationphp -drequestData=STRING_FROM_THE_FILE gt actOffdat
Note Make sure the contenttext which you copy paste to the curl command inrequestData is same as in the generated producttxt file
d) Open the terminal that has an Internet connection and run the curl command Aresponse license file (actOffdat) is generated Copy the response license file(actOffdat) to a server location where Skedler runs
7 After generating the license file (actOffdat) using the curl command Click ldquoAboutrdquoicon in Skedler home page
8 Click ldquoLicense informationrdquo button Edition type and the license key is automaticallyfilled Click ldquoSelect Filerdquo find the license file ldquoactOffdatrdquo on your computer andupload it
Note Retain the same file name ldquoactOffdatrdquo during file upload
Copyright copy 2016 Guidanz Inc 26
9 Click ldquoActivaterdquo button to activate license
10 Click ldquoAbortrdquo button to abort your offline activation
Copyright copy 2016 Guidanz Inc 27
9 Move skedler with license from one server toanotherTo move skedler with license from one server to another follow the steps mention inDeactivate skedler with License section and continue with the steps given below
1 Stop skedler in old server
2 Copy skedler to new server
3 Give necessary permissions to skedler_home directory as follows
sudo chmod -R 765 skedler_home
4 Verify the necessary pre-requisites in the new server as given in Prerequisites section
5 Start skedler in new server using the following command
cd skedler_home
binskedler
Copyright copy 2016 Guidanz Inc 28
6 Activate license with the same key which was used to activate skedler on the oldserver and use the same details to fill the form
If you find any issues during the process contact skelder supportskedlercom
10 Deactivate Skedler with LicenseSkedler license is bound to the computer where you activated it Until you deactivate theskedler license key you cannot use it on another machine Deactivation remove licensedata from the current machine so that you can activate the skedler license key on anothermachine
You can deactivate skedler license key either Online or Offline
NOTE Trial edition cannot be deactivated
Deactivate skedler license key Online
Online deactivation requires an Internet connection To deactivate skedler license keynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate online
Deactivate skedler license key Offline
Offline deactivation does not require an Internet connection To deactivate skedler licensekeynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate offline
It will generate a text file in skedler_homeskedler_offline_deactivation_requesttxt pathwhich you must send to supportskedlercom
Copyright copy 2016 Guidanz Inc 29
11 Shield ConfigurationScenario 1
Kibana managers need access to dataindex 1 and 2
Kibana Users should have access only to dataindex 1
Skedler generates reports based on user permission for dataindex and Skedler needspermission to lsquokibanarsquo index for discovery
Assuming shield is configured for kibana as follows
1 For example if you have kibana_manager and kibana_user roles and skedlerindex configured for both the roles
2 Once the roles have full permission to access the dataindex configured for the roleSkedler can discover all the dashboards and searches from kibana And you canpreview or a generate report for dashboards and search for the configureddataindex
3 In case(a) kibana_manager role has full permission to access lsquokibanarsquodataindex1 dataindex2 and lsquoskedlerrsquo index Skedler can discover all thedashboards and searches from kibana And you can preview or generate report forall dashboards and search from dataindex1 and dataindex2
a) The required permissions for kibana_manager
kibana_manager
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
Copyright copy 2016 Guidanz Inc 30
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
dataindex2
- indicesadminexists
- indicesadminmappingsfieldsget
Copyright copy 2016 Guidanz Inc 31
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
4 In case(b) kibana_user role have full permission to access lsquokibanarsquodataindex1and lsquoskedlerrsquo index Skedler can discover all the dashboards and
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 23
5 Read and click the Terms and Conditions
6 Click ldquoOnline Activationrdquo to activate the license
c) Offline Product License ActivationFill the required details in License Activation Page
You must have a license key for the edition you requested
Copyright copy 2016 Guidanz Inc 24
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 Offline Activation does not require proxy setting
4 Read and click the Terms and Conditions
5 Click ldquoOffline Activationrdquo link
6 On clicking it will generate a producttxt file Use the steps given below to generatethe licensing file(actOffdat)
Copyright copy 2016 Guidanz Inc 25
a) Open the generated producttxt file
b) Copy the contenttext inside the producttxt file
c) Use the following curl command to generate the licensing file(actOffdat) replace theSTRING_FROM_THE_FILE with the copied content from producttxt file
curl -XPOST httpsskedlercomOfflineActivationphp -drequestData=STRING_FROM_THE_FILE gt actOffdat
Note Make sure the contenttext which you copy paste to the curl command inrequestData is same as in the generated producttxt file
d) Open the terminal that has an Internet connection and run the curl command Aresponse license file (actOffdat) is generated Copy the response license file(actOffdat) to a server location where Skedler runs
7 After generating the license file (actOffdat) using the curl command Click ldquoAboutrdquoicon in Skedler home page
8 Click ldquoLicense informationrdquo button Edition type and the license key is automaticallyfilled Click ldquoSelect Filerdquo find the license file ldquoactOffdatrdquo on your computer andupload it
Note Retain the same file name ldquoactOffdatrdquo during file upload
Copyright copy 2016 Guidanz Inc 26
9 Click ldquoActivaterdquo button to activate license
10 Click ldquoAbortrdquo button to abort your offline activation
Copyright copy 2016 Guidanz Inc 27
9 Move skedler with license from one server toanotherTo move skedler with license from one server to another follow the steps mention inDeactivate skedler with License section and continue with the steps given below
1 Stop skedler in old server
2 Copy skedler to new server
3 Give necessary permissions to skedler_home directory as follows
sudo chmod -R 765 skedler_home
4 Verify the necessary pre-requisites in the new server as given in Prerequisites section
5 Start skedler in new server using the following command
cd skedler_home
binskedler
Copyright copy 2016 Guidanz Inc 28
6 Activate license with the same key which was used to activate skedler on the oldserver and use the same details to fill the form
If you find any issues during the process contact skelder supportskedlercom
10 Deactivate Skedler with LicenseSkedler license is bound to the computer where you activated it Until you deactivate theskedler license key you cannot use it on another machine Deactivation remove licensedata from the current machine so that you can activate the skedler license key on anothermachine
You can deactivate skedler license key either Online or Offline
NOTE Trial edition cannot be deactivated
Deactivate skedler license key Online
Online deactivation requires an Internet connection To deactivate skedler license keynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate online
Deactivate skedler license key Offline
Offline deactivation does not require an Internet connection To deactivate skedler licensekeynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate offline
It will generate a text file in skedler_homeskedler_offline_deactivation_requesttxt pathwhich you must send to supportskedlercom
Copyright copy 2016 Guidanz Inc 29
11 Shield ConfigurationScenario 1
Kibana managers need access to dataindex 1 and 2
Kibana Users should have access only to dataindex 1
Skedler generates reports based on user permission for dataindex and Skedler needspermission to lsquokibanarsquo index for discovery
Assuming shield is configured for kibana as follows
1 For example if you have kibana_manager and kibana_user roles and skedlerindex configured for both the roles
2 Once the roles have full permission to access the dataindex configured for the roleSkedler can discover all the dashboards and searches from kibana And you canpreview or a generate report for dashboards and search for the configureddataindex
3 In case(a) kibana_manager role has full permission to access lsquokibanarsquodataindex1 dataindex2 and lsquoskedlerrsquo index Skedler can discover all thedashboards and searches from kibana And you can preview or generate report forall dashboards and search from dataindex1 and dataindex2
a) The required permissions for kibana_manager
kibana_manager
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
Copyright copy 2016 Guidanz Inc 30
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
dataindex2
- indicesadminexists
- indicesadminmappingsfieldsget
Copyright copy 2016 Guidanz Inc 31
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
4 In case(b) kibana_user role have full permission to access lsquokibanarsquodataindex1and lsquoskedlerrsquo index Skedler can discover all the dashboards and
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 24
1 Enter the required information Name Email and Company
2 Enter the 25-digit alphanumeric license key or activation code
3 Offline Activation does not require proxy setting
4 Read and click the Terms and Conditions
5 Click ldquoOffline Activationrdquo link
6 On clicking it will generate a producttxt file Use the steps given below to generatethe licensing file(actOffdat)
Copyright copy 2016 Guidanz Inc 25
a) Open the generated producttxt file
b) Copy the contenttext inside the producttxt file
c) Use the following curl command to generate the licensing file(actOffdat) replace theSTRING_FROM_THE_FILE with the copied content from producttxt file
curl -XPOST httpsskedlercomOfflineActivationphp -drequestData=STRING_FROM_THE_FILE gt actOffdat
Note Make sure the contenttext which you copy paste to the curl command inrequestData is same as in the generated producttxt file
d) Open the terminal that has an Internet connection and run the curl command Aresponse license file (actOffdat) is generated Copy the response license file(actOffdat) to a server location where Skedler runs
7 After generating the license file (actOffdat) using the curl command Click ldquoAboutrdquoicon in Skedler home page
8 Click ldquoLicense informationrdquo button Edition type and the license key is automaticallyfilled Click ldquoSelect Filerdquo find the license file ldquoactOffdatrdquo on your computer andupload it
Note Retain the same file name ldquoactOffdatrdquo during file upload
Copyright copy 2016 Guidanz Inc 26
9 Click ldquoActivaterdquo button to activate license
10 Click ldquoAbortrdquo button to abort your offline activation
Copyright copy 2016 Guidanz Inc 27
9 Move skedler with license from one server toanotherTo move skedler with license from one server to another follow the steps mention inDeactivate skedler with License section and continue with the steps given below
1 Stop skedler in old server
2 Copy skedler to new server
3 Give necessary permissions to skedler_home directory as follows
sudo chmod -R 765 skedler_home
4 Verify the necessary pre-requisites in the new server as given in Prerequisites section
5 Start skedler in new server using the following command
cd skedler_home
binskedler
Copyright copy 2016 Guidanz Inc 28
6 Activate license with the same key which was used to activate skedler on the oldserver and use the same details to fill the form
If you find any issues during the process contact skelder supportskedlercom
10 Deactivate Skedler with LicenseSkedler license is bound to the computer where you activated it Until you deactivate theskedler license key you cannot use it on another machine Deactivation remove licensedata from the current machine so that you can activate the skedler license key on anothermachine
You can deactivate skedler license key either Online or Offline
NOTE Trial edition cannot be deactivated
Deactivate skedler license key Online
Online deactivation requires an Internet connection To deactivate skedler license keynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate online
Deactivate skedler license key Offline
Offline deactivation does not require an Internet connection To deactivate skedler licensekeynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate offline
It will generate a text file in skedler_homeskedler_offline_deactivation_requesttxt pathwhich you must send to supportskedlercom
Copyright copy 2016 Guidanz Inc 29
11 Shield ConfigurationScenario 1
Kibana managers need access to dataindex 1 and 2
Kibana Users should have access only to dataindex 1
Skedler generates reports based on user permission for dataindex and Skedler needspermission to lsquokibanarsquo index for discovery
Assuming shield is configured for kibana as follows
1 For example if you have kibana_manager and kibana_user roles and skedlerindex configured for both the roles
2 Once the roles have full permission to access the dataindex configured for the roleSkedler can discover all the dashboards and searches from kibana And you canpreview or a generate report for dashboards and search for the configureddataindex
3 In case(a) kibana_manager role has full permission to access lsquokibanarsquodataindex1 dataindex2 and lsquoskedlerrsquo index Skedler can discover all thedashboards and searches from kibana And you can preview or generate report forall dashboards and search from dataindex1 and dataindex2
a) The required permissions for kibana_manager
kibana_manager
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
Copyright copy 2016 Guidanz Inc 30
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
dataindex2
- indicesadminexists
- indicesadminmappingsfieldsget
Copyright copy 2016 Guidanz Inc 31
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
4 In case(b) kibana_user role have full permission to access lsquokibanarsquodataindex1and lsquoskedlerrsquo index Skedler can discover all the dashboards and
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 25
a) Open the generated producttxt file
b) Copy the contenttext inside the producttxt file
c) Use the following curl command to generate the licensing file(actOffdat) replace theSTRING_FROM_THE_FILE with the copied content from producttxt file
curl -XPOST httpsskedlercomOfflineActivationphp -drequestData=STRING_FROM_THE_FILE gt actOffdat
Note Make sure the contenttext which you copy paste to the curl command inrequestData is same as in the generated producttxt file
d) Open the terminal that has an Internet connection and run the curl command Aresponse license file (actOffdat) is generated Copy the response license file(actOffdat) to a server location where Skedler runs
7 After generating the license file (actOffdat) using the curl command Click ldquoAboutrdquoicon in Skedler home page
8 Click ldquoLicense informationrdquo button Edition type and the license key is automaticallyfilled Click ldquoSelect Filerdquo find the license file ldquoactOffdatrdquo on your computer andupload it
Note Retain the same file name ldquoactOffdatrdquo during file upload
Copyright copy 2016 Guidanz Inc 26
9 Click ldquoActivaterdquo button to activate license
10 Click ldquoAbortrdquo button to abort your offline activation
Copyright copy 2016 Guidanz Inc 27
9 Move skedler with license from one server toanotherTo move skedler with license from one server to another follow the steps mention inDeactivate skedler with License section and continue with the steps given below
1 Stop skedler in old server
2 Copy skedler to new server
3 Give necessary permissions to skedler_home directory as follows
sudo chmod -R 765 skedler_home
4 Verify the necessary pre-requisites in the new server as given in Prerequisites section
5 Start skedler in new server using the following command
cd skedler_home
binskedler
Copyright copy 2016 Guidanz Inc 28
6 Activate license with the same key which was used to activate skedler on the oldserver and use the same details to fill the form
If you find any issues during the process contact skelder supportskedlercom
10 Deactivate Skedler with LicenseSkedler license is bound to the computer where you activated it Until you deactivate theskedler license key you cannot use it on another machine Deactivation remove licensedata from the current machine so that you can activate the skedler license key on anothermachine
You can deactivate skedler license key either Online or Offline
NOTE Trial edition cannot be deactivated
Deactivate skedler license key Online
Online deactivation requires an Internet connection To deactivate skedler license keynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate online
Deactivate skedler license key Offline
Offline deactivation does not require an Internet connection To deactivate skedler licensekeynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate offline
It will generate a text file in skedler_homeskedler_offline_deactivation_requesttxt pathwhich you must send to supportskedlercom
Copyright copy 2016 Guidanz Inc 29
11 Shield ConfigurationScenario 1
Kibana managers need access to dataindex 1 and 2
Kibana Users should have access only to dataindex 1
Skedler generates reports based on user permission for dataindex and Skedler needspermission to lsquokibanarsquo index for discovery
Assuming shield is configured for kibana as follows
1 For example if you have kibana_manager and kibana_user roles and skedlerindex configured for both the roles
2 Once the roles have full permission to access the dataindex configured for the roleSkedler can discover all the dashboards and searches from kibana And you canpreview or a generate report for dashboards and search for the configureddataindex
3 In case(a) kibana_manager role has full permission to access lsquokibanarsquodataindex1 dataindex2 and lsquoskedlerrsquo index Skedler can discover all thedashboards and searches from kibana And you can preview or generate report forall dashboards and search from dataindex1 and dataindex2
a) The required permissions for kibana_manager
kibana_manager
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
Copyright copy 2016 Guidanz Inc 30
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
dataindex2
- indicesadminexists
- indicesadminmappingsfieldsget
Copyright copy 2016 Guidanz Inc 31
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
4 In case(b) kibana_user role have full permission to access lsquokibanarsquodataindex1and lsquoskedlerrsquo index Skedler can discover all the dashboards and
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 26
9 Click ldquoActivaterdquo button to activate license
10 Click ldquoAbortrdquo button to abort your offline activation
Copyright copy 2016 Guidanz Inc 27
9 Move skedler with license from one server toanotherTo move skedler with license from one server to another follow the steps mention inDeactivate skedler with License section and continue with the steps given below
1 Stop skedler in old server
2 Copy skedler to new server
3 Give necessary permissions to skedler_home directory as follows
sudo chmod -R 765 skedler_home
4 Verify the necessary pre-requisites in the new server as given in Prerequisites section
5 Start skedler in new server using the following command
cd skedler_home
binskedler
Copyright copy 2016 Guidanz Inc 28
6 Activate license with the same key which was used to activate skedler on the oldserver and use the same details to fill the form
If you find any issues during the process contact skelder supportskedlercom
10 Deactivate Skedler with LicenseSkedler license is bound to the computer where you activated it Until you deactivate theskedler license key you cannot use it on another machine Deactivation remove licensedata from the current machine so that you can activate the skedler license key on anothermachine
You can deactivate skedler license key either Online or Offline
NOTE Trial edition cannot be deactivated
Deactivate skedler license key Online
Online deactivation requires an Internet connection To deactivate skedler license keynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate online
Deactivate skedler license key Offline
Offline deactivation does not require an Internet connection To deactivate skedler licensekeynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate offline
It will generate a text file in skedler_homeskedler_offline_deactivation_requesttxt pathwhich you must send to supportskedlercom
Copyright copy 2016 Guidanz Inc 29
11 Shield ConfigurationScenario 1
Kibana managers need access to dataindex 1 and 2
Kibana Users should have access only to dataindex 1
Skedler generates reports based on user permission for dataindex and Skedler needspermission to lsquokibanarsquo index for discovery
Assuming shield is configured for kibana as follows
1 For example if you have kibana_manager and kibana_user roles and skedlerindex configured for both the roles
2 Once the roles have full permission to access the dataindex configured for the roleSkedler can discover all the dashboards and searches from kibana And you canpreview or a generate report for dashboards and search for the configureddataindex
3 In case(a) kibana_manager role has full permission to access lsquokibanarsquodataindex1 dataindex2 and lsquoskedlerrsquo index Skedler can discover all thedashboards and searches from kibana And you can preview or generate report forall dashboards and search from dataindex1 and dataindex2
a) The required permissions for kibana_manager
kibana_manager
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
Copyright copy 2016 Guidanz Inc 30
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
dataindex2
- indicesadminexists
- indicesadminmappingsfieldsget
Copyright copy 2016 Guidanz Inc 31
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
4 In case(b) kibana_user role have full permission to access lsquokibanarsquodataindex1and lsquoskedlerrsquo index Skedler can discover all the dashboards and
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 27
9 Move skedler with license from one server toanotherTo move skedler with license from one server to another follow the steps mention inDeactivate skedler with License section and continue with the steps given below
1 Stop skedler in old server
2 Copy skedler to new server
3 Give necessary permissions to skedler_home directory as follows
sudo chmod -R 765 skedler_home
4 Verify the necessary pre-requisites in the new server as given in Prerequisites section
5 Start skedler in new server using the following command
cd skedler_home
binskedler
Copyright copy 2016 Guidanz Inc 28
6 Activate license with the same key which was used to activate skedler on the oldserver and use the same details to fill the form
If you find any issues during the process contact skelder supportskedlercom
10 Deactivate Skedler with LicenseSkedler license is bound to the computer where you activated it Until you deactivate theskedler license key you cannot use it on another machine Deactivation remove licensedata from the current machine so that you can activate the skedler license key on anothermachine
You can deactivate skedler license key either Online or Offline
NOTE Trial edition cannot be deactivated
Deactivate skedler license key Online
Online deactivation requires an Internet connection To deactivate skedler license keynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate online
Deactivate skedler license key Offline
Offline deactivation does not require an Internet connection To deactivate skedler licensekeynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate offline
It will generate a text file in skedler_homeskedler_offline_deactivation_requesttxt pathwhich you must send to supportskedlercom
Copyright copy 2016 Guidanz Inc 29
11 Shield ConfigurationScenario 1
Kibana managers need access to dataindex 1 and 2
Kibana Users should have access only to dataindex 1
Skedler generates reports based on user permission for dataindex and Skedler needspermission to lsquokibanarsquo index for discovery
Assuming shield is configured for kibana as follows
1 For example if you have kibana_manager and kibana_user roles and skedlerindex configured for both the roles
2 Once the roles have full permission to access the dataindex configured for the roleSkedler can discover all the dashboards and searches from kibana And you canpreview or a generate report for dashboards and search for the configureddataindex
3 In case(a) kibana_manager role has full permission to access lsquokibanarsquodataindex1 dataindex2 and lsquoskedlerrsquo index Skedler can discover all thedashboards and searches from kibana And you can preview or generate report forall dashboards and search from dataindex1 and dataindex2
a) The required permissions for kibana_manager
kibana_manager
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
Copyright copy 2016 Guidanz Inc 30
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
dataindex2
- indicesadminexists
- indicesadminmappingsfieldsget
Copyright copy 2016 Guidanz Inc 31
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
4 In case(b) kibana_user role have full permission to access lsquokibanarsquodataindex1and lsquoskedlerrsquo index Skedler can discover all the dashboards and
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 28
6 Activate license with the same key which was used to activate skedler on the oldserver and use the same details to fill the form
If you find any issues during the process contact skelder supportskedlercom
10 Deactivate Skedler with LicenseSkedler license is bound to the computer where you activated it Until you deactivate theskedler license key you cannot use it on another machine Deactivation remove licensedata from the current machine so that you can activate the skedler license key on anothermachine
You can deactivate skedler license key either Online or Offline
NOTE Trial edition cannot be deactivated
Deactivate skedler license key Online
Online deactivation requires an Internet connection To deactivate skedler license keynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate online
Deactivate skedler license key Offline
Offline deactivation does not require an Internet connection To deactivate skedler licensekeynavigate to skedler_home directory and run the following command
cd skedler_home
bindeactivate offline
It will generate a text file in skedler_homeskedler_offline_deactivation_requesttxt pathwhich you must send to supportskedlercom
Copyright copy 2016 Guidanz Inc 29
11 Shield ConfigurationScenario 1
Kibana managers need access to dataindex 1 and 2
Kibana Users should have access only to dataindex 1
Skedler generates reports based on user permission for dataindex and Skedler needspermission to lsquokibanarsquo index for discovery
Assuming shield is configured for kibana as follows
1 For example if you have kibana_manager and kibana_user roles and skedlerindex configured for both the roles
2 Once the roles have full permission to access the dataindex configured for the roleSkedler can discover all the dashboards and searches from kibana And you canpreview or a generate report for dashboards and search for the configureddataindex
3 In case(a) kibana_manager role has full permission to access lsquokibanarsquodataindex1 dataindex2 and lsquoskedlerrsquo index Skedler can discover all thedashboards and searches from kibana And you can preview or generate report forall dashboards and search from dataindex1 and dataindex2
a) The required permissions for kibana_manager
kibana_manager
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
Copyright copy 2016 Guidanz Inc 30
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
dataindex2
- indicesadminexists
- indicesadminmappingsfieldsget
Copyright copy 2016 Guidanz Inc 31
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
4 In case(b) kibana_user role have full permission to access lsquokibanarsquodataindex1and lsquoskedlerrsquo index Skedler can discover all the dashboards and
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 29
11 Shield ConfigurationScenario 1
Kibana managers need access to dataindex 1 and 2
Kibana Users should have access only to dataindex 1
Skedler generates reports based on user permission for dataindex and Skedler needspermission to lsquokibanarsquo index for discovery
Assuming shield is configured for kibana as follows
1 For example if you have kibana_manager and kibana_user roles and skedlerindex configured for both the roles
2 Once the roles have full permission to access the dataindex configured for the roleSkedler can discover all the dashboards and searches from kibana And you canpreview or a generate report for dashboards and search for the configureddataindex
3 In case(a) kibana_manager role has full permission to access lsquokibanarsquodataindex1 dataindex2 and lsquoskedlerrsquo index Skedler can discover all thedashboards and searches from kibana And you can preview or generate report forall dashboards and search from dataindex1 and dataindex2
a) The required permissions for kibana_manager
kibana_manager
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
Copyright copy 2016 Guidanz Inc 30
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
dataindex2
- indicesadminexists
- indicesadminmappingsfieldsget
Copyright copy 2016 Guidanz Inc 31
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
4 In case(b) kibana_user role have full permission to access lsquokibanarsquodataindex1and lsquoskedlerrsquo index Skedler can discover all the dashboards and
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 30
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
dataindex2
- indicesadminexists
- indicesadminmappingsfieldsget
Copyright copy 2016 Guidanz Inc 31
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
4 In case(b) kibana_user role have full permission to access lsquokibanarsquodataindex1and lsquoskedlerrsquo index Skedler can discover all the dashboards and
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 31
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
4 In case(b) kibana_user role have full permission to access lsquokibanarsquodataindex1and lsquoskedlerrsquo index Skedler can discover all the dashboards and
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 32
searches from kibana And you can preview or generate report for all dashboardsand search from dataindex1
b) The required permissions for kibana_user
kibana_user
cluster
- clustermonitornodesinfo
- clustermonitorhealth
- clustermonitorstate
indices
- indicesdatareadfield_stats
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
dataindex1
- indicesadminexists
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 33
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadmincreate
- indicesadminget
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawriteindex
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesadminget
- indicesadmincreate
- indicesdatareadcount
- indicesdatareadmsearch
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
5 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 34
6 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forkibana_manager or kibana_user role as required
Scenario 2
1 Create a Role for skedler and it must have full access to ldquoskedlerrdquo index andldquokibanardquo index So include the below content for the for skedler role in rolesymlFor eg for the role Skedler the configuration added in rolesyml should be as givenbelow (kibana index skedler index and the dataindex)
skedler
cluster
- clustermonitornodesinfo
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 35
- clustermonitorhealth
- clustermonitorstate
indices
- indicesadminmappingsfieldsget
- indicesadminvalidatequery
- indicesdatareadsearch
- indicesdatareadmsearch
- indicesadminget
kibana
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
skedler
- indicesadminexists
- indicesadminmappingput
- indicesadminmappingsfieldsget
- indicesadminrefresh
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 36
- indicesadminvalidatequery
- indicesdatareadget
- indicesdatareadmget
- indicesdatareadsearch
- indicesdatareadcount
- indicesdatawritedelete
- indicesdatawriteindex
- indicesdatawriteupdate
- indicesadmincreate
2 Create a user for the role skedler using the command below
elasticsearchbinshieldesusers roles skedler username -a skedler
3 Set the skedler_elasticsearch_username and skedler_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
4 Set the kibana_elasticsearch_username and kibana_elasticsearch_passwordproperties in reportingyml with the Shield username and password created forskedler role as shown
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 37
12 Kibana Shield Plugin ConfigurationIf you have installed Shield Plugin in Kibana you will find the login page when youaccess Kibana as shown below
To make Shield Plugin in Kibana work in Skedler
You can enable the variable kibana_shield_plugin to ldquoyesrdquo inskedler_homeconfigreportingyml By default the variable value is set to ldquonordquo
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 38
Shield Configuration variable must be set To set the shield variables follow the steps insection Shield Configuration
Once the shield variables are set correctly you will see the following page on your start
1 Fill the fields with required values and click ldquoLoginrdquo button
2 To logout click ldquoLogoutrdquo icon in Skedler home page
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 39
13 Ngnix Configuration1 If kibana is configured behind Nginx please configure the Nginx username
and password for kibana in reportingyml as shown
2 If Nginx is configured as a reverse proxy for elasticsearch Please configureNginx username and password for elasticsearch here as shown
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
Copyright copy 2016 Guidanz Inc 40
14 FeedbackWe welcome and appreciate your feedback regarding the skedler Please email usat infoskedlercom with your feedback
