Release 5.1
Page tree


Support | Blog | Contact Us 

Release 5.1

Contents:

Expand all   Collapse all

   

Contents:

This documentation applies to installation from a supported Marketplace. Please use the installation instructions provided with your deployment.


If you are installing or upgrading a Marketplace deployment, please use the available PDF content. You must use the install and configuration PDF available through the Marketplace listing.

This guide steps through the requirements and process for installing  Data Preparation for Amazon Redshift and S3 through the AWS Marketplace.

Product Limitations

  • Connectivity to sources other than S3 and Redshift is not supported.
  • Jobs must be executed on the Alteryx Server. No other running environment integrations are supported.
  • Anomaly and stratified sampling are not supported in this deployment.
  • When publishing single files to S3, you cannot apply an append publishing action.

  • Data Preparation for Amazon Redshift and S3 must be deployed into an existing Virtual Private Cloud (VPC). 

  • The EC2 instance, S3 buckets, and any connected Redshift databases must be located in the same Amazon region. Cross-region integrations are not supported at this time.

    NOTE: HDFS integration is not supported for Amazon AMI installations.

  • The S3 bucket automatically created by the Marketplace CloudFormation template is not automatically deleted when you delete the stack in CloudFormation. You must empty the bucket and delete it, which can be done through the AWS Console.

Install and Upgrade Methods

You can install the software using either of the following methods:

  1. CloudFormation Template: This method of installation utilizes an Amazon CloudFormation template to install and configure a working system that includes:
    1. EC2 instance
    2. Alteryx node and software
    3. S3 bucket with supporting policies

  2. EC2 installation: This method allows you to set up the EC2 instance according to your enterprise requirements, including its sizing and policies.

Data Preparation for Amazon Redshift and S3 on AWS

Through EC2 with AMI IDThrough CloudFormation template
Install

If you know the AMI ID for Data Preparation for Amazon Redshift and S3, you can install the product through EC2.

NOTE: Please verify that the additional pre-requisites have been met. See below.

 Supported. Instructions are provided below.

Tip: Using the CloudFormation template is the recommended method of installing the product.

Upgrade Supported. See Upgrade for AWS Marketplace.

NOTE: This method of upgrading the product is not supported. Using the CloudFormation template will overwrite all security groups and policies.

Pre-requisites

This document assumes that you are setting up the product to use Amazon's preferred EC2 role-based authentication for access to AWS resources. 

Tip: Using EC2 role-based authentication is recommended by AWS. For more information, see https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#use-roles-with-ec2.

This product also supports the following authentication methods:

  • System mode - All users of the product use the same key and secret combination to access resources.
  • User mode - Each user has a separately specified key and secret combination to access resources.

If you are using one of these two access methods, please do the following:

  1. Specify an EC2 role without any permissions. Specifically, it should have no data access permissions, as this role cannot be changed at a later time. 
  2. Complete the following sequence through the Install Steps. Specify the above EC2 role as part of the configuration. 
  3. When you launch the product, you can specify the appropriate access mode through the platform. For more information, see Configure for AWS in the Install Guide.
    1. This content is also available through the online Documentation referenced at the end of this document.
  4. Complete any related configuration through AWS as needed.

Tip: If you want to use EC2 roles at a later time, you can just apply AWS policies to the empty role you created here. Additional configuration is required in the platform to use this role.

Internet access

From AWS, the Designer Cloud Powered by Trifacta platform requires Internet access for the following services:

NOTE: Depending on your AWS deployment, some of these services may not be required.

 

  • AWS S3
  • Key Management System [KMS] (if sse-kms server side encryption is enabled)
  • Secure Token Service [STS] (if temporary credential provider is used)
  • EMR (if integration with EMR cluster is enabled)

NOTE: If the Designer Cloud Powered by Trifacta platform is hosted in a VPC where Internet access is restricted, access to S3, KMS and STS services must be provided by creating a VPC endpoint. If the platform is accessing an EMR cluster, a proxy server can be configured to provide access to the AWS ElasticMapReduce regional endpoint.

SELinux

By default,  Data Preparation for Amazon Redshift and S3 is installed on a server with SELinux enabled. Security-enhanced Linux (SELinux) provides a set of security features for, among other things, managing access controls. 

Tip: The following may be applied to other deployments of the Designer Cloud Powered by Trifacta platform on servers where SELinux has been enabled.

 

In some cases, SELinux can interfere with normal operations of platform software. If you are experiencing connectivity problems related to SELinux, you can do either one of the following:

  1. Disable SELinux on the server. For more information, please see the CentOS documentation.
  2. Apply the following commands on the server, as root:
    1. Open ports on the server for listening. 

      1. By default, the Designer Cloud application listens on port 3005. The following opens that port when SELinux is enabled:

        semanage port -a -t http_port_t -p tcp 3005
      2. Repeat the above step for any other ports that you wish to open on the server.

    2. Permit nginx, the proxy on the Alteryx node, to open websockets:

      setsebool -P httpd_can_network_connect 1

Install

Desktop Requirements

  • All desktop users of the platform must have the latest version of Google Chrome installed on their desktops.
    • Google Chrome must have the PNaCl client installed and enabled.
    • PNaCl Version:  0.50.x.y or later
  • All desktop users must be able to connect to the EC2 instance through the enterprise infrastructure.

Sizing Guide

NOTE: The following guidelines apply only to Data Preparation for Amazon Redshift and S3.

Use the following guidelines to select your instance size:

NOTE: Data Preparation for Amazon Redshift and S3 enforces a maximum limit of 30 users.

Instance TypeMax users

Avg. size of jobs on Alteryx Server (GB)

m4.4xlarge520 GB

Pre-requisites

Before you install the platform, please verify that the following steps have been completed.

  1. EULA. Before you begin, please review the End-User License Agreement. See End-User License Agreement.

  2. SSH Key-pair. Please verify that there is an SSH key pair available to assign to the Alteryx server.

Additional pre-requisites for EC2 installation

If you are installing the product through EC2, please verify that the following additional requirements are met:

  1. IAM policies. Create IAM policies for access to the S3 bucket. Required permissions are the following: 

    • The system account or individual user accounts must have full permissions for the S3 bucket:

      Delete*, Get*, List*, Put*, Replicate*, Restore*

    • These policies must apply to the bucket and its contents. Example:

      "arn:aws:s3:::my-trifacta-bucket-name"
"arn:aws:s3:::my-trifacta-bucket-name/*"
    • See https://console.aws.amazon.com/iam/home#/policies
  2. EC2 instance role. Create an EC2 instance role for this policy. See https://console.aws.amazon.com/iam/home#/roles.

Install Steps - CloudFormation template

This install process creates the following:

  • Alteryx node on an EC2 node
  • S3 bucket
  • IAM roles and policies to access the S3 bucket from the Alteryx node

Steps:

  1. In the Marketplace listing, click Deploy into an existing VPC.
  2. Select Template: The template path is automatically populated for you.
  3. Specify Details:

    1. Stack Name: Display name of the application

      NOTE: Each instance of the Designer Cloud Powered by Trifacta platform should have a separate name.

    2. Instance Type: Please select the appropriate instance depending on the number of users and data volumes of your environment. For more information, see the Sizing Guide above.

    3. Key Pair: Select the SSH pair to use for Alteryx Instance access.

    4. Allowed HTTP Source: Please specify the IP address or range of address from which HTTP/HTTPS connections to the application are permitted.

    5. Allowed SSH Source: Please specify the IP address or range of address from which SSH connections to the application are permitted.

  4. Options: None of these is required for installation. Specify your options as needed for your environment.
  5. Review: Review your installation and configured options.
    1. Select the checkbox at the end of the page.
    2. To launch the configured instance, click Create.
  6. In the Stacks list, select the name of your application. Click the Outputs tab and collect the following information. Instructions in how to use this information is provided later.

     

    ParameterDescriptionUse
    TrifactaUrl value

    URL and port number to which to connect to the Alteryx application

    		Users must connect to this IP address and port number to access.
    TrifactaBucketThe address of the default S3 bucketThis value must be applied through the application.
    TrifactaInstanceIdThe identifier for the instance of the platform

    This value is the default password for the admin account.

    NOTE: This password must be changed immediately.

  7. When the instance is spinning up for the first time, performance may be slow. When the instance is up, please navigate to the TrifactaUrl location:

    http://<public_hostname>:3005
  8. When the login screen appears, enter the following:
    1. Username: admin@trifacta.local

    2. Password: (the TrifactaInstanceId value)

      NOTE: As soon as you login as an admin for the first time, you should immediately change the password. In the left side bar, click the Settings menu at the bottom. Then, click Settings >User Profile. Change the password and click Save to restart the platform.

  9. From the application menu, select the Settings menu. Then, click Settings >Admin Settings. 
  10. In the Admin Settings page, you can configure many aspects of the platform, including user management tasks, and perform restarts to apply the changes.

    1. In the Search bar, enter the following:

      aws.s3.bucket.name

    2. Set the value of this setting to be the TrifactaBucket value that you collected from the Outputs tab.

  11. The following setting must be specified.

    "aws.mode":"system",

    You can set the above value to either of the following:

    aws.mode valueDescription
    systemSet the mode to system to enable use of EC2 instance-based authentication for access.
    userSet the mode to user to utilize user-based credentials. This mode requires additional configuration.

    Details on the above configuration are described later.

  12. Click Save.

  13. When the platform restarts, you can begin using the product.

Install Steps - EC2 instance

  1. Launch  Data Preparation for Amazon Redshift and S3 using the AWS AMI ID for the product.
  2. In the EC2 Console:
    1. Instance size: Select the instance size.
    2. Network: Configure the VPC, subnet, firewall and other configuration settings necessary to communicate with the instance. 
    3. Auto-assigned Public IP: You must create a public IP to access the Designer Cloud Powered by Trifacta platform.
    4. EC2 role: Select the EC2 role that you created.

    5. Local storage: Select a local EBS volume. The default volume includes 100GB storage.

      NOTE: The local storage environment contains the Alteryx databases, the product installation, and its log files. No source data is ever stored within Data Preparation for Amazon Redshift and S3.

    6. Security group: Use a security group that exposes access to port 3005, which is the default port for the platform. 
    7. Create an AWS key-pair for access:This key is used to provide SSH access to the platform, which may be required for some admin tasks. Save key file to your local computer for later use.
    8. Save your changes.

  3. Launch the configured version of  Data Preparation for Amazon Redshift and S3.

    NOTE: From the EC2 Console, please acquire the instanceId, which is needed in a later step.

  4. When the instance is spinning up for the first time, performance may be slow. When the instance is up, please navigate to the following:

    http://<public_hostname>:3005
  5. When the login screen appears, enter the following:
    1. Username: admin@trifacta.local

    2. Password: (the instanceId value)

      NOTE: As soon as you login as an admin for the first time, you should immediately change the password. Select the User Profile menu item in the upper-right corner. Change the password and click Save to restart the platform.

  6. From the application menu, select Settings menu > Admin Settings. 
  7. In the Admin Settings page, you can configure many aspects of the platform, including user management tasks, and perform restarts to apply the changes.

    1. In the Search bar, enter the following:

      aws.s3.bucket.name

    2. Set the value of this setting to be the bucket that you created for  Data Preparation for Amazon Redshift and S3.

  8. The following setting must be specified.

    "aws.mode":"system",

    You can set the above value to either of the following:

    aws.mode valueDescription
    systemSet the mode to system to enable use of EC2 instance-based authentication for access.
    userSet the mode to user to utilize user-based credentials. This mode requires additional configuration.

    Details on the above configuration are described later.

  9. Click Save.

  10. When the platform restarts, you can begin using the product.

SSH Access

If you need to SSH to the Alteryx node, you can use the following command:

ssh -i <path_to_key_file> <userId>@<tri_node_DNS_or_IP>
ParameterDescription
<path_to_key_file>

Path to the key file stored on your local computer.

<userId>The user ID is always centos.
<tri_node_DNS_or_IP>

DNS or IP address of the Alteryx node

Upgrade

For more information, see Upgrade for AWS Marketplace.

Documentation

You can access complete product documentation online and in PDF format. From within the product, select Help menu > Product Docs.

Related Topics

See Also for Install from AWS Marketplace:

Send Feedback

This page has no comments.

© 2013-2023 Alteryx® Inc Privacy Policy  |  Terms of Use