AWS Plug-in Guide. Qlik Sense 1.1 Copyright QlikTech International AB. All rights reserved.

Transcription

1 AWS Plug-in Guide Qlik Sense 1.1 Copyright QlikTech International AB. All rights reserved.

2 Copyright 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.

3 Contents 1 Introduction Support services AWS plug-in conventions 5 Style coding 5 Environment variables Additional documentation 5 2 AWS plug-in requirements Qlik Deployment Console Amazon Web Services account 6 Platform support 6 Security group rules 6 Amazon Simple Storage Service bucket 7 3 AWS plug-in configuration Configuration summary Template configuration summary Create new site wizard 10 Credentials 10 Instance information 11 Subnet selection Create new template wizard 12 Credentials 13 Instance information 13 Subnet selection 14 4 AWS object types AWS credentials object type AWS service user object type 15 AWS Plug-in Guide - Qlik Sense, 1.1 3

4 1 Introduction 1 Introduction This guide describes the Amazon Web Services (AWS) plug-in for the Qlik Deployment Console (QDC). This document is derived from the online help for Qlik Sense. It is intended for those who want to read parts of the help offline or print pages easily, and does not include any additional information compared with the online help. A plug-in is a.zip file that contains all.dll files needed to deploy Qlik Sense sites in a specific cloud computing environment. A plug-in typically includes functionality for: Configuring the cloud computing environment and fetching status information from it Setting and getting the name and a description Verifying the version of the environment Getting data from the environment Creating and deleting sites and instances (that is, nodes) Uploading files Getting network information and handling certificates for communication Setting the Qlik Sense license Scaling sites and instances (that is, nodes) Handling errors and logging Handling upgrades Plug-ins are developed outside of the Qlik Deployment Console (QDC). 1.1 Support services Contact Qlik if product support, additional training, or consultation concerning application development is needed. Consult the Qlik homepage for current information on how to get in touch with the support services: Global headquarters Qlik 150 N. Radnor Chester Road Suite E220 Radnor, PA USA Phone +1 (888) Fax +1 (610) AWS Plug-in Guide - Qlik Sense, 1.1 4

5 1 Introduction For other locations, visit the Qlik homepage (see above). 1.2 AWS plug-in conventions The following conventions are used in the description of the Amazon Web Services (AWS) plug-in. Style coding Menu commands and dialog options are written in bold. Filenames and paths are written in italic. Sample code is written in Lucida Console. Environment variables The paths used in the description of the AWS plug-in may use environment variables. The variables and the equivalent paths in the Microsoft Windows operating system are listed below. Environment variable %LocalAppData% %ProgramData% %ProgramFiles% %UserProfile% Microsoft Windows C:\Users\<username>\AppData\Local C:\ProgramData C:\Program Files C:\Users\<username> 1.3 Additional documentation Besides this document, the following documentation is available for the Amazon Web Services (AWS) plugin: Qlik Deployment Console Guide: Describes how to deploy and manage Qlik Sense sites in cloud computing environments using the Qlik Deployment Console (QDC). Server Deployment and Configuration: Describes Qlik Sense and provides reference information on the architecture, security, logging, and licensing. AWS Plug-in Guide - Qlik Sense, 1.1 5

6 2 AWS plug-in requirements 2 AWS plug-in requirements This section lists the requirements that must be fulfilled to successfully use the Amazon Web Services (AWS) plug-in. 2.1 Qlik Deployment Console The Qlik Deployment Console (QDC) must be installed on the target machine and the following items must be available and configured in the QDC: Qlik Sense setup file Qlik Sense license object AWS service user object 2.2 Amazon Web Services account An AWS account ( is needed. It is recommended to configure the AWS account so that only certain allowed IP addresses can access it. Platform support The AWS plug-in supports the EC2-VPC platform for launching of Qlik Sense sites and instances (that is, nodes). The AWS plug-in does not support the EC2-Classic platform. Security group rules Every instance is launched in a security group, which acts as a firewall and controls the traffic for one or more instances. Instances within the same security group have unrestricted network access to each other. Instances reject network access attempts from instances in other security groups. The rules listed in the following table must be added to the security group for the AWS account. Type Protocol Port range Source HTTP TCP /0 HTTPS TCP /0 RDP TCP 3389 <IP address> AWS Plug-in Guide - Qlik Sense, 1.1 6

7 2 AWS plug-in requirements Custom TCP rule TCP /0 Custom TCP rule TCP /0 Custom TCP rule TCP /0 Custom TCP rule TCP /0 Amazon Simple Storage Service bucket The AWS account must have an Amazon Simple Storage Service (S3) bucket. The S3 bucket must contain the following files, which are available in %ProgramFiles%\Qlik\DeploymentConsole\Client\S3 after installation of the QDC: AWSCentralNodeService.exe AWSCentralNodeService.exe.config AWSRimNodeService.exe AWSRimNodeService.exe.config AWSSDK.dll Common.dll See also: p AWS service user object type (page 15) AWS Plug-in Guide - Qlik Sense, 1.1 7

8 3 AWS plug-in configuration 3 AWS plug-in configuration This section describes the functionality in the Qlik Deployment Console (QDC) that is provided by the Amazon Web Services (AWS) plug-in. 3.1 Configuration summary The first fields in the Configuration summary for a central node in the Sites view in the Qlik Deployment Console (QDC) are common to all plug-ins. Created Environment name Public IP Public DNS The date and time when the instance (that is, node) was created. The name of the plug-in that was used to deploy the site. The IP number of the machine on which the instance (that is, node) is deployed. The DNS of the machine on which the instance (that is, node) is deployed. The following fields are only displayed for sites that have been created using the QDC. Site name License Qlik Sense version The name of the site. The name of the Qlik Sense license object used. The file version of the Qlik Sense setup file that is used for the site. The rest of the fields are provided by the Amazon Web Services (AWS) plug-in. Credentials Service user The security credentials are used to authenticate and authorize calls to the AWS. The service user is: Created on the machine that is cloned in AWS Configured to be RootAdmin in Qlik Sense on the cloned machine Region endpoint Image Instance type Key pair The regional endpoint is used to reduce data latency in AWS applications and requests. An endpoint is a URL that is the entry point for a web service. An image contains a software configuration, including an operating system, that defines the operating environment for the Qlik Sense site. An instance is a virtual server that can run applications. AWS instances use a public/private key pair to log in rather than a password. The public key half of the pair is embedded in the instance and allows you to use the private key to log in securely without a password. AWS Plug-in Guide - Qlik Sense, 1.1 8

9 3 AWS plug-in configuration Security group S3 folder Subnet Every instance is launched in a security group, which acts as a firewall and controls the traffic for one or more instances. Instances within the same security group have unrestricted network access to each other. Instances reject network access attempts from instances in other security groups. Amazon Simple Storage Service (S3) provides a web services interface that can be used to store and retrieve data on the web. Subnets are used to divide a network into two or more networks. This means that a subnet is a logically visible subdivision of an IP network. 3.2 Template configuration summary The first fields in the Template configuration summary for a central node in the Sites view in the Qlik Deployment Console (QDC) are common to all plug-ins. Date created Environment name Services The date and time when the template was created. The name of the plug-in that was used to create the template. The Qlik Sense services that are included in instances (that is, nodes) based on the template: Repository (mandatory) Engine (mandatory) Proxy (optional) Scheduler (optional) Template name Repository Engine Proxy Scheduler The name of the template. Whether or not the Qlik Sense Repository Service (QRS) has been selected for inclusion in the template. Whether or not the Qlik Sense Engine Service (QES) has been selected for inclusion in the template. Whether or not the Qlik Sense Proxy Service (QPS) has been selected for inclusion in the template. Whether or not the Qlik Sense Scheduler Service (QSS) has been selected for inclusion in the template. The rest of the fields are provided by the Amazon Web Services (AWS) plug-in. Credentials Service user The security credentials are used to authenticate and authorize calls to the AWS. The service user is: Created on the machine that is cloned in AWS Configured to be RootAdmin in Qlik Sense on the cloned machine AWS Plug-in Guide - Qlik Sense, 1.1 9

10 3 AWS plug-in configuration Region endpoint Image Instance type Key pair Security group S3 folder Subnet The regional endpoint is used to reduce data latency in AWS applications and requests. An endpoint is a URL that is the entry point for a web service. An image contains a software configuration, including an operating system, that defines the operating environment for the Qlik Sense site. An instance is a virtual server that can run applications. AWS instances use a public/private key pair to log in rather than a password. The public key half of the pair is embedded in the instance and allows you to use the private key to log in securely without a password. Every instance is launched in a security group, which acts as a firewall and controls the traffic for one or more instances. Instances within the same security group have unrestricted network access to each other. Instances reject network access attempts from instances in other security groups. Amazon Simple Storage Service (S3) provides a web services interface that can be used to store and retrieve data on the web. Subnets are used to divide a network into two or more networks. This means that a subnet is a logically visible subdivision of an IP network. 3.3 Create new site wizard This section describes the steps in the Create new site wizard in the Qlik Deployment Console (QDC) that are provided by the Amazon Web Services (AWS) plug-in. The Create new site wizard starts immediately when you click the PCreate site button and select the AWS plug-in in the QDC. Credentials Proceed as follows to fill in the fields in the Credentials step of the Create new site wizard. AWS Plug-in Guide - Qlik Sense,

11 3 AWS plug-in configuration Credentials The security credentials are used to authenticate and authorize calls to the AWS. Select a credentials object in the drop-down list. If the list is empty or if you want to add a new credentials object, click ú. The AWS access keys are used to sign programmatic requests to the AWS and consist of an access key and a secret access key. Name Key Secret key Enter a name for the credentials object. Enter the AWS access key. Enter the AWS secret access key. Click Save to save the object. Click Cancel to exit without saving. Service user The service user is: Created on the machine that is cloned in AWS Configured to be RootAdmin in Qlik Sense on the cloned machine Select a service user object in the drop-down list. If the list is empty or if you want to add a new service user object, click ú. User name Enter a name for the service user. Password Enter a password for the service user. Click Save to save the object. Click Cancel to exit without saving. Region endpoint The regional endpoint is used to reduce data latency in AWS applications and requests. An endpoint is a URL that is the entry point for a web service. Select a region endpoint in the drop-down list. Click Next to proceed to the next step. Click Previous to return to the previous step. Click Cancel to exit the wizard. Instance information Proceed as follows to fill in the fields in the Instance information step of the Create new site wizard. Image An image contains a software configuration, including an operating system, that defines the operating environment for the Qlik Sense site. Select an image in the drop-down list (for example, Windows_Server-2012-RTM-English- 64Bit-Base ). AWS Plug-in Guide - Qlik Sense,

12 3 AWS plug-in configuration Instance type An instance is a virtual server that can run applications. The instance type must fulfill the system requirements for Qlik Sense instances. For example, the c1.medium and m1.medium instance types fulfill the requirements, whereas the t1.micro instance type does not. For information on the system requirements, see the Qlik Deployment Console Guide. Select an instance type in the drop-down list. Key pair AWS instances use a public/private key pair to log in rather than a password. The public key half of the pair is embedded in the instance and allows you to use the private key to log in securely without a password. Select a key pair in the drop-down list. Security group Every instance is launched in a security group, which acts as a firewall and controls the traffic for one or more instances. Instances within the same security group have unrestricted network access to each other. Instances reject network access attempts from instances in other security groups. Select a security group in the drop-down list. S3 folder Amazon Simple Storage Service (S3) provides a web services interface that can be used to store and retrieve data on the web. Select an S3 folder in the drop-down list. Click Next to proceed to the next step. Click Previous to return to the previous step. Click Cancel to exit the wizard. Subnet selection Proceed as follows to fill in the fields in the Subnet selection step of the Create new site wizard. Subnet Subnets are used to divide a network into two or more networks. This means that a subnet is a logically visible subdivision of an IP network. Select a subnet (on which to host the Qlik Sense site) in the drop-down list. Click Next to proceed to the next step. Click Previous to return to the previous step. Click Cancel to exit the wizard. 3.4 Create new template wizard This section describes the steps in the Create new template wizard in the Qlik Deployment Console (QDC) that are provided by the Amazon Web Services (AWS) plug-in. The Create new template wizard starts immediately when you click the PCreate new instance template button and select the AWS plug-in in the QDC. AWS Plug-in Guide - Qlik Sense,

13 3 AWS plug-in configuration Credentials Proceed as follows to fill in the fields in the Credentials step of the Create new template wizard. Credentials The security credentials are used to authenticate and authorize calls to the AWS. Select a credentials object in the drop-down list. If the list is empty or if you want to add a new credentials object, click ú. The AWS access keys are used to sign programmatic requests to the AWS and consist of an access key and a secret access key. Name Key Secret key Enter a name for the credentials object. Enter the AWS access key. Enter the AWS secret access key. Click Save to save the object. Click Cancel to exit without saving. Service user The service user is: Created on the machine that is cloned in AWS Configured to be RootAdmin in Qlik Sense on the cloned machine Select a service user object in the drop-down list. If the list is empty or if you want to add a new service user object, click ú. User name Enter a name for the service user. Password Enter a password for the service user. Click Save to save the object. Click Cancel to exit without saving. Region endpoint The regional endpoint is used to reduce data latency in AWS applications and requests. An endpoint is a URL that is the entry point for a web service. Select a region endpoint in the drop-down list. Click Next to proceed to the next step. Click Previous to return to the previous step. Click Cancel to exit the wizard. Instance information Proceed as follows to fill in the fields in the Instance information step of the Create new template wizard. AWS Plug-in Guide - Qlik Sense,

14 3 AWS plug-in configuration Image An image contains a software configuration, including an operating system, that defines the operating environment for the Qlik Sense site. Select an image in the drop-down list (for example, Windows_Server-2012-RTM-English- 64Bit-Base ). Instance type An instance is a virtual server that can run applications. The instance type must fulfill the system requirements for Qlik Sense instances. For example, the c1.medium and m1.medium instance types fulfill the requirements, whereas the t1.micro instance type does not. For information on the system requirements, see the Qlik Deployment Console Guide. Select an instance type in the drop-down list. Key pair AWS instances use a public/private key pair to log in rather than a password. The public key half of the pair is embedded in the instance and allows you to use the private key to log in securely without a password. Select a key pair in the drop-down list. Security group Every instance is launched in a security group, which acts as a firewall and controls the traffic for one or more instances. Instances within the same security group have unrestricted network access to each other. Instances reject network access attempts from instances in other security groups. Select a security group in the drop-down list. S3 folder Amazon Simple Storage Service (S3) provides a web services interface that can be used to store and retrieve data on the web. Select an S3 folder in the drop-down list. Click Next to proceed to the next step. Click Previous to return to the previous step. Click Cancel to exit the wizard. Subnet selection Proceed as follows to fill in the fields in the Subnet selection step of the Create new template wizard. Subnet Subnets are used to divide a network into two or more networks. This means that a subnet is a logically visible subdivision of an IP network. Select a subnet (on which to host the Qlik Sense site) in the drop-down list. Click Next to proceed to the next step. Click Previous to return to the previous step. Click Cancel to exit the wizard. AWS Plug-in Guide - Qlik Sense,

15 4 AWS object types 4 AWS object types An object is used to hold a certain type of information related to a specific plug-in or cloud computing environment. This section provides information on the object types that are provided by the Amazon Web Services (AWS) plug-in. 4.1 AWS credentials object type The Amazon Web Services (AWS) plug-in provides the AWS credentials object type in the Qlik Deployment Console (QDC). The object type is used to hold AWS access keys. The AWS access keys are used to sign programmatic requests to the AWS and consist of an access key and a secret access key. Proceed as follows to fill in the fields for an AWS credentials object. Name Key Secret key Enter a name for the credentials object. Enter the AWS access key. Enter the AWS secret access key. 4.2 AWS service user object type The Amazon Web Services (AWS) plug-in provides the AWS service user object type in the Qlik Deployment Console (QDC). The object type is used to hold service users. The service user is: Created on the machine that is cloned in AWS Configured to be RootAdmin in Qlik Sense on the cloned machine Proceed as follows to fill in the fields for an AWS service user object. User name Password Enter a name for the service user. Enter a password for the service user. AWS Plug-in Guide - Qlik Sense,