AWS Plug-in Guide

QlikSense
1.1
Copyright1993-2015QlikTechInternationalAB.Allrightsreserved.
Copyright 1993-2015 QlikTech International AB. All rights reserved.

Qlik, QlikTech, Qlik Sense, QlikView, Sense and the Qlik logo are trademarks which have been
registered in multiple countries or otherwise used as trademarks by QlikTech International AB. Other
trademarks referenced herein are the trademarks of their respective owners.
 Contents
1 Introduction 4
1.1Supportservices 4
1.2AWSplug-inconventions 5
Stylecoding 5
Environmentvariables 5
1.3Additionaldocumentation 5
2 AWS plug-in requirements 6
2.1QlikDeploymentConsole 6
2.2AmazonWebServicesaccount 6
Platformsupport 6
Securitygrouprules 6
AmazonSimpleStorageServicebucket 7
3 AWS plug-in configuration 8
3.1Configurationsummary 8
3.2Templateconfigurationsummary 9
3.3Createnewsitewizard 10
Credentials 10
Instanceinformation 11
Subnetselection 12
3.4Createnewtemplatewizard 12
Credentials 13
Instanceinformation 13
Subnetselection 14
4 AWS object types 15
4.1AWScredentialsobjecttype 15
4.2AWSserviceuserobjecttype 15

AWS Plug-in Guide - Qlik Sense, 1.1 3

 1 Introduction

1 Introduction
ThisguidedescribestheAmazonWebServices(AWS)plug-infortheQlikDeploymentConsole(QDC).

ThisdocumentisderivedfromtheonlinehelpforQlikSense.Itisintendedforthosewhowanttoreadparts
ofthehelpofflineorprintpageseasily,anddoesnotincludeanyadditionalinformationcomparedwiththe
onlinehelp.

Aplug-inisa.zipfilethatcontainsall.dllfilesneededtodeployQlikSensesitesinaspecificcloud
computingenvironment.

Aplug-intypicallyincludesfunctionalityfor:

l Configuringthecloudcomputingenvironmentandfetchingstatusinformationfromit
l Settingandgettingthenameandadescription
l Verifyingtheversionoftheenvironment
l Gettingdatafromtheenvironment
l Creatinganddeletingsitesandinstances(thatis,nodes)
l Uploadingfiles
l Gettingnetworkinformationandhandlingcertificatesforcommunication
l SettingtheQlikSenselicense
l Scalingsitesandinstances(thatis,nodes)
l Handlingerrorsandlogging
l Handlingupgrades

Plug-ins are developed outside of the Qlik Deployment Console (QDC).

1.1 Supportservices
ContactQlikifproductsupport,additionaltraining,orconsultationconcerningapplicationdevelopmentis
needed.ConsulttheQlikhomepageforcurrentinformationonhowtogetintouchwiththesupportservices:

www.qlik.com

Global headquarters Qlik

150N.RadnorChesterRoad

SuiteE220

Radnor,PA19087

USA

Phone +1(888)828-9768

Fax +1(610)975-5987

AWS Plug-in Guide - Qlik Sense, 1.1 4

 1 Introduction

Forotherlocations,visittheQlikhomepage(seeabove).

1.2 AWSplug-inconventions
ThefollowingconventionsareusedinthedescriptionoftheAmazonWebServices(AWS)plug-in.

Stylecoding
l Menucommandsanddialogoptionsarewritteninbold.
l Filenamesandpathsarewritteninitalic.
l SamplecodeiswritteninLucida Console.

Environmentvariables
ThepathsusedinthedescriptionoftheAWSplug-inmayuseenvironmentvariables.Thevariablesandthe
equivalentpathsintheMicrosoftWindowsoperatingsystemarelistedbelow.

Environment variable Microsoft Windows

%LocalAppData% C:\Users\<username>\AppData\Local

%ProgramData% C:\ProgramData

%ProgramFiles% C:\Program Files

%UserProfile% C:\Users\<username>

1.3 Additionaldocumentation
Besidesthisdocument,thefollowingdocumentationisavailablefortheAmazonWebServices(AWS)plug-
in:

l QlikDeploymentConsoleGuide:DescribeshowtodeployandmanageQlikSensesitesincloud
computingenvironmentsusingtheQlikDeploymentConsole(QDC).
l ServerDeploymentandConfiguration:DescribesQlikSenseandprovidesreferenceinformationon
thearchitecture,security,logging,andlicensing.

AWS Plug-in Guide - Qlik Sense, 1.1 5

 2 AWS plug-in requirements

2 AWSplug-inrequirements
ThissectionliststherequirementsthatmustbefulfilledtosuccessfullyusetheAmazonWebServices
(AWS)plug-in.

2.1 QlikDeploymentConsole
TheQlikDeploymentConsole(QDC)mustbeinstalledonthetargetmachineandthefollowingitemsmust
beavailableandconfiguredintheQDC:

l QlikSensesetupfile
l QlikSenselicenseobject

l AWSserviceuserobject

2.2 AmazonWebServicesaccount
AnAWSaccount(https://console.aws.amazon.com)isneeded.

It is recommended to configure the AWS account so that only certain allowed IP addresses
can access it.

Platformsupport
TheAWSplug-insupportstheEC2-VPCplatformforlaunchingofQlikSensesitesandinstances(thatis,
nodes).

The AWS plug-in does not support the EC2-Classic platform.

Securitygrouprules
Everyinstanceislaunchedinasecuritygroup,whichactsasafirewallandcontrolsthetrafficforoneormore
instances.Instanceswithinthesamesecuritygrouphaveunrestrictednetworkaccesstoeachother.
Instancesrejectnetworkaccessattemptsfrominstancesinothersecuritygroups.

TheruleslistedinthefollowingtablemustbeaddedtothesecuritygroupfortheAWSaccount.

Type Protocol Port range Source

HTTP TCP 80 0.0.0.0/0

HTTPS TCP 443 0.0.0.0/0

RDP TCP 3389 <IPaddress>

AWS Plug-in Guide - Qlik Sense, 1.1 6

 2 AWS plug-in requirements

CustomTCPrule TCP 4242 0.0.0.0/0

CustomTCPrule TCP 4244 0.0.0.0/0

CustomTCPrule TCP 5050 0.0.0.0/0

CustomTCPrule TCP 5051 0.0.0.0/0

AmazonSimpleStorageServicebucket
TheAWSaccountmusthaveanAmazonSimpleStorageService(S3)bucket.

TheS3bucketmustcontainthefollowingfiles,whichareavailablein
%ProgramFiles%\Qlik\DeploymentConsole\Client\S3afterinstallationoftheQDC:

l AWSCentralNodeService.exe
l AWSCentralNodeService.exe.config
l AWSRimNodeService.exe
l AWSRimNodeService.exe.config
l AWSSDK.dll
l Common.dll

See also:

p AWS service user object type (page 15)

AWS Plug-in Guide - Qlik Sense, 1.1 7

 3 AWS plug-in configuration

3 AWSplug-inconfiguration
ThissectiondescribesthefunctionalityintheQlikDeploymentConsole(QDC)thatisprovidedbythe
AmazonWebServices(AWS)plug-in.

3.1 Configurationsummary
ThefirstfieldsintheConfiguration summaryforacentralnodeintheSitesviewintheQlikDeployment
Console(QDC)arecommontoallplug-ins.

Created Thedateandtimewhentheinstance(thatis,node)wascreated.

Environment name Thenameoftheplug-inthatwasusedtodeploythesite.

Public IP TheIPnumberofthemachineonwhichtheinstance(thatis,node)isdeployed.

Public DNS TheDNSofthemachineonwhichtheinstance(thatis,node)isdeployed.

ThefollowingfieldsareonlydisplayedforsitesthathavebeencreatedusingtheQDC.

Site name Thenameofthesite.

License ThenameoftheQlikSenselicenseobjectused.

Qlik Sense version ThefileversionoftheQlikSensesetupfilethatisusedforthesite.

TherestofthefieldsareprovidedbytheAmazonWebServices(AWS)plug-in.

Credentials ThesecuritycredentialsareusedtoauthenticateandauthorizecallstotheAWS.

Service user Theserviceuseris:

l CreatedonthemachinethatisclonedinAWS
l ConfiguredtobeRootAdmininQlikSenseontheclonedmachine

Region TheregionalendpointisusedtoreducedatalatencyinAWSapplicationsandrequests.
endpoint AnendpointisaURLthatistheentrypointforawebservice.

Image Animagecontainsasoftwareconfiguration,includinganoperatingsystem,thatdefines
theoperatingenvironmentfortheQlikSensesite.

Instance Aninstanceisavirtualserverthatcanrunapplications.
type

Key pair AWSinstancesuseapublic/privatekeypairtologinratherthanapassword.Thepublic

keyhalfofthepairisembeddedintheinstanceandallowsyoutousetheprivatekeyto
loginsecurelywithoutapassword.

AWS Plug-in Guide - Qlik Sense, 1.1 8

 3 AWS plug-in configuration

Security Everyinstanceislaunchedinasecuritygroup,whichactsasafirewallandcontrolsthe
group trafficforoneormoreinstances.Instanceswithinthesamesecuritygrouphave
unrestrictednetworkaccesstoeachother.Instancesrejectnetworkaccessattempts
frominstancesinothersecuritygroups.

S3 folder AmazonSimpleStorageService(S3)providesawebservicesinterfacethatcanbeused
tostoreandretrievedataontheweb.

Subnet Subnetsareusedtodivideanetworkintotwoormorenetworks.Thismeansthata
subnetisalogicallyvisiblesubdivisionofanIPnetwork.

3.2 Templateconfigurationsummary
ThefirstfieldsintheTemplate configuration summaryforacentralnodeintheSitesviewintheQlik
DeploymentConsole(QDC)arecommontoallplug-ins.

Date created Thedateandtimewhenthetemplatewascreated.

Environment Thenameoftheplug-inthatwasusedtocreatethetemplate.
name

Services TheQlikSenseservicesthatareincludedininstances(thatis,nodes)basedonthe
template:

l Repository(mandatory)
l Engine(mandatory)
l Proxy(optional)
l Scheduler(optional)

Template name Thenameofthetemplate.

Repository WhetherornottheQlikSenseRepositoryService(QRS)hasbeenselectedfor
inclusioninthetemplate.

Engine WhetherornottheQlikSenseEngineService(QES)hasbeenselectedforinclusion
inthetemplate.

Proxy WhetherornottheQlikSenseProxyService(QPS)hasbeenselectedforinclusionin
thetemplate.

Scheduler WhetherornottheQlikSenseSchedulerService(QSS)hasbeenselectedfor
inclusioninthetemplate.

TherestofthefieldsareprovidedbytheAmazonWebServices(AWS)plug-in.

Credentials ThesecuritycredentialsareusedtoauthenticateandauthorizecallstotheAWS.

Service user Theserviceuseris:

l CreatedonthemachinethatisclonedinAWS
l ConfiguredtobeRootAdmininQlikSenseontheclonedmachine

AWS Plug-in Guide - Qlik Sense, 1.1 9

 3 AWS plug-in configuration

Region TheregionalendpointisusedtoreducedatalatencyinAWSapplicationsandrequests.
endpoint AnendpointisaURLthatistheentrypointforawebservice.

Image Animagecontainsasoftwareconfiguration,includinganoperatingsystem,thatdefines
theoperatingenvironmentfortheQlikSensesite.

Instance Aninstanceisavirtualserverthatcanrunapplications.
type

Key pair AWSinstancesuseapublic/privatekeypairtologinratherthanapassword.Thepublic

keyhalfofthepairisembeddedintheinstanceandallowsyoutousetheprivatekeyto
loginsecurelywithoutapassword.

Security Everyinstanceislaunchedinasecuritygroup,whichactsasafirewallandcontrolsthe
group trafficforoneormoreinstances.Instanceswithinthesamesecuritygrouphave
unrestrictednetworkaccesstoeachother.Instancesrejectnetworkaccessattempts
frominstancesinothersecuritygroups.

S3 folder AmazonSimpleStorageService(S3)providesawebservicesinterfacethatcanbeused
tostoreandretrievedataontheweb.

Subnet Subnetsareusedtodivideanetworkintotwoormorenetworks.Thismeansthata
subnetisalogicallyvisiblesubdivisionofanIPnetwork.

3.3 Createnewsitewizard
ThissectiondescribesthestepsintheCreatenewsitewizardintheQlikDeploymentConsole(QDC)thatare
providedbytheAmazonWebServices(AWS)plug-in.

TheCreatenewsitewizardstartsimmediatelywhenyouclickthePCreate sitebuttonandselecttheAWS
plug-inintheQDC.

Credentials
ProceedasfollowstofillinthefieldsintheCredentialsstepoftheCreatenewsitewizard.

AWS Plug-in Guide - Qlik Sense, 1.1 10

 3 AWS plug-in configuration

Credentials ThesecuritycredentialsareusedtoauthenticateandauthorizecallstotheAWS.

Selectacredentialsobjectinthedrop-downlist.

Ifthelistisemptyorifyouwanttoaddanewcredentialsobject,click.
TheAWSaccesskeysareusedtosignprogrammaticrequeststotheAWSandconsistof
anaccesskeyandasecretaccesskey.

Name Enteranameforthecredentialsobject.

Key EntertheAWSaccesskey.

Secret key EntertheAWSsecretaccesskey.

ClickSavetosavetheobject.ClickCanceltoexitwithoutsaving.

Service Theserviceuseris:
user
l CreatedonthemachinethatisclonedinAWS
l ConfiguredtobeRootAdmininQlikSenseontheclonedmachine

Selectaserviceuserobjectinthedrop-downlist.

Ifthelistisemptyorifyouwanttoaddanewserviceuserobject,click.
User name Enteranamefortheserviceuser.

Password Enterapasswordfortheserviceuser.

ClickSavetosavetheobject.ClickCanceltoexitwithoutsaving.

Region TheregionalendpointisusedtoreducedatalatencyinAWSapplicationsandrequests.
endpoint AnendpointisaURLthatistheentrypointforawebservice.

Selectaregionendpointinthedrop-downlist.

ClickNexttoproceedtothenextstep.ClickPrevioustoreturntothepreviousstep.ClickCanceltoexitthe
wizard.

Instanceinformation
ProceedasfollowstofillinthefieldsintheInstance informationstepoftheCreatenewsitewizard.

Image Animagecontainsasoftwareconfiguration,includinganoperatingsystem,thatdefinesthe
operatingenvironmentfortheQlikSensesite.

Selectanimageinthedrop-downlist(forexample,Windows_Server-2012-RTM-English-
64Bit-Base-2014.12.10).

AWS Plug-in Guide - Qlik Sense, 1.1 11

 3 AWS plug-in configuration

Instance Aninstanceisavirtualserverthatcanrunapplications.
type
TheinstancetypemustfulfillthesystemrequirementsforQlikSenseinstances.Forexample,
thec1.mediumandm1.mediuminstancetypesfulfilltherequirements,whereasthe
t1.microinstancetypedoesnot.Forinformationonthesystemrequirements,seetheQlik
DeploymentConsoleGuide.

Selectaninstancetypeinthedrop-downlist.

Key pair AWSinstancesuseapublic/privatekeypairtologinratherthanapassword.Thepublickey

halfofthepairisembeddedintheinstanceandallowsyoutousetheprivatekeytologin
securelywithoutapassword.

Selectakeypairinthedrop-downlist.

Security Everyinstanceislaunchedinasecuritygroup,whichactsasafirewallandcontrolsthetraffic
group foroneormoreinstances.Instanceswithinthesamesecuritygrouphaveunrestrictednetwork
accesstoeachother.Instancesrejectnetworkaccessattemptsfrominstancesinother
securitygroups.

Selectasecuritygroupinthedrop-downlist.

S3 AmazonSimpleStorageService(S3)providesawebservicesinterfacethatcanbeusedto
folder storeandretrievedataontheweb.

SelectanS3folderinthedrop-downlist.

ClickNexttoproceedtothenextstep.ClickPrevioustoreturntothepreviousstep.ClickCanceltoexitthe
wizard.

Subnetselection
ProceedasfollowstofillinthefieldsintheSubnet selectionstepoftheCreatenewsitewizard.

Subnet Subnetsareusedtodivideanetworkintotwoormorenetworks.Thismeansthatasubnetisa
logicallyvisiblesubdivisionofanIPnetwork.

Selectasubnet(onwhichtohosttheQlikSensesite)inthedrop-downlist.

ClickNexttoproceedtothenextstep.ClickPrevioustoreturntothepreviousstep.ClickCanceltoexitthe
wizard.

3.4 Createnewtemplatewizard
ThissectiondescribesthestepsintheCreatenewtemplatewizardintheQlikDeploymentConsole(QDC)
thatareprovidedbytheAmazonWebServices(AWS)plug-in.

TheCreatenewtemplatewizardstartsimmediatelywhenyouclickthePCreate new instance template

buttonandselecttheAWSplug-inintheQDC.

AWS Plug-in Guide - Qlik Sense, 1.1 12

 3 AWS plug-in configuration

Credentials
ProceedasfollowstofillinthefieldsintheCredentialsstepoftheCreatenewtemplatewizard.

Credentials ThesecuritycredentialsareusedtoauthenticateandauthorizecallstotheAWS.

Selectacredentialsobjectinthedrop-downlist.

Ifthelistisemptyorifyouwanttoaddanewcredentialsobject,click.
TheAWSaccesskeysareusedtosignprogrammaticrequeststotheAWSandconsistof
anaccesskeyandasecretaccesskey.

Name Enteranameforthecredentialsobject.

Key EntertheAWSaccesskey.

Secret key EntertheAWSsecretaccesskey.

ClickSavetosavetheobject.ClickCanceltoexitwithoutsaving.

Service Theserviceuseris:
user
l CreatedonthemachinethatisclonedinAWS
l ConfiguredtobeRootAdmininQlikSenseontheclonedmachine

Selectaserviceuserobjectinthedrop-downlist.

Ifthelistisemptyorifyouwanttoaddanewserviceuserobject,click.
User name Enteranamefortheserviceuser.

Password Enterapasswordfortheserviceuser.

ClickSavetosavetheobject.ClickCanceltoexitwithoutsaving.

Region TheregionalendpointisusedtoreducedatalatencyinAWSapplicationsandrequests.
endpoint AnendpointisaURLthatistheentrypointforawebservice.

Selectaregionendpointinthedrop-downlist.

ClickNexttoproceedtothenextstep.ClickPrevioustoreturntothepreviousstep.ClickCanceltoexitthe
wizard.

Instanceinformation
ProceedasfollowstofillinthefieldsintheInstance informationstepoftheCreatenewtemplatewizard.

AWS Plug-in Guide - Qlik Sense, 1.1 13

 3 AWS plug-in configuration

Image Animagecontainsasoftwareconfiguration,includinganoperatingsystem,thatdefinesthe
operatingenvironmentfortheQlikSensesite.

Selectanimageinthedrop-downlist(forexample,Windows_Server-2012-RTM-English-
64Bit-Base-2014.12.10).

Instance Aninstanceisavirtualserverthatcanrunapplications.
type
TheinstancetypemustfulfillthesystemrequirementsforQlikSenseinstances.Forexample,
thec1.mediumandm1.mediuminstancetypesfulfilltherequirements,whereasthe
t1.microinstancetypedoesnot.Forinformationonthesystemrequirements,seetheQlik
DeploymentConsoleGuide.

Selectaninstancetypeinthedrop-downlist.

Key pair AWSinstancesuseapublic/privatekeypairtologinratherthanapassword.Thepublickey

halfofthepairisembeddedintheinstanceandallowsyoutousetheprivatekeytologin
securelywithoutapassword.

Selectakeypairinthedrop-downlist.

Security Everyinstanceislaunchedinasecuritygroup,whichactsasafirewallandcontrolsthetraffic
group foroneormoreinstances.Instanceswithinthesamesecuritygrouphaveunrestrictednetwork
accesstoeachother.Instancesrejectnetworkaccessattemptsfrominstancesinother
securitygroups.

Selectasecuritygroupinthedrop-downlist.

S3 AmazonSimpleStorageService(S3)providesawebservicesinterfacethatcanbeusedto
folder storeandretrievedataontheweb.

SelectanS3folderinthedrop-downlist.

ClickNexttoproceedtothenextstep.ClickPrevioustoreturntothepreviousstep.ClickCanceltoexitthe
wizard.

Subnetselection
ProceedasfollowstofillinthefieldsintheSubnet selectionstepoftheCreatenewtemplatewizard.

Subnet Subnetsareusedtodivideanetworkintotwoormorenetworks.Thismeansthatasubnetisa
logicallyvisiblesubdivisionofanIPnetwork.

Selectasubnet(onwhichtohosttheQlikSensesite)inthedrop-downlist.

ClickNexttoproceedtothenextstep.ClickPrevioustoreturntothepreviousstep.ClickCanceltoexitthe
wizard.

AWS Plug-in Guide - Qlik Sense, 1.1 14

 4 AWS object types

4 AWSobjecttypes
Anobjectisusedtoholdacertaintypeofinformationrelatedtoaspecificplug-inorcloudcomputing
environment.

ThissectionprovidesinformationontheobjecttypesthatareprovidedbytheAmazonWebServices(AWS)
plug-in.

4.1 AWScredentialsobjecttype
TheAmazonWebServices(AWS)plug-inprovidestheAWScredentialsobjecttypeintheQlikDeployment
Console(QDC).TheobjecttypeisusedtoholdAWSaccesskeys.

TheAWSaccesskeysareusedtosignprogrammaticrequeststotheAWSandconsistofanaccesskeyand
asecretaccesskey.

ProceedasfollowstofillinthefieldsforanAWScredentialsobject.

Name Enteranameforthecredentialsobject.

Key EntertheAWSaccesskey.

Secret key EntertheAWSsecretaccesskey.

4.2 AWSserviceuserobjecttype
TheAmazonWebServices(AWS)plug-inprovidestheAWSserviceuserobjecttypeintheQlikDeployment
Console(QDC).Theobjecttypeisusedtoholdserviceusers.

Theserviceuseris:

l CreatedonthemachinethatisclonedinAWS
l ConfiguredtobeRootAdmininQlikSenseontheclonedmachine

ProceedasfollowstofillinthefieldsforanAWSserviceuserobject.

User name Enteranamefortheserviceuser.

Password Enterapasswordfortheserviceuser.

AWS Plug-in Guide - Qlik Sense, 1.1 15