Release 5.0.1
Page tree


Support | Blog | Contact Us 

Release 5.0.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 Amazon Marketplace.

Product Limitations

  • 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.
  • 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.

Assumptions

This document assumes that you are setting up  Designer Cloud Enterprise Edition 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.

 

Designer Cloud Enterprise Edition also supports the following authentication methods:

  • System mode - All users of  Designer Cloud Enterprise Edition 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.

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.

Sizemax recommended users

Avg. size of jobs on Alteryx Server (GB)

Small55 GB
Medium1520 GB
Large3040 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. S3 bucket. Please create an S3 bucket to store Alteryx assets. In the bucket, the platform stores metadata in the following location:

    <S3_bucket_name>/trifacta

    See https://s3.console.aws.amazon.com/s3/home.

  3. 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
  4. EC2 instance role. Create an EC2 instance role for this policy. See https://console.aws.amazon.com/iam/home#/roles.

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.

Install Steps

  1. Launch  Data Preparation for Amazon Redshift and S3 from AMI.
  2. In the EC2 Console:
    1. Instance size: Select the instance size. See Sizing Guide.
    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

Please complete the instructions in this section if you are upgrading from a previous version of  Data Preparation for Amazon Redshift and S3. 

NOTE: These instructions apply only to Data Preparation for Amazon Redshift and S3 available the Amazon Marketplace. If you are upgrading Designer Cloud Enterprise Edition, please follow the upgrade instructions provided to you by your Alteryx representative.

 

Backup data from platform instance

Before you begin, you should backup your current instance.

  1. SSH to your current Marketplace AMI instance. See instructions in the Install section.

  2. Stop the Designer Cloud Powered by Trifacta platform on your current Marketplace AMI instance:

    sudo service trifacta stop
  3. Update the backup script with a more current version.

    1. Download 5.0.0 backup script from the following location:

      https://raw.githubusercontent.com/trifacta/trifacta-utils/release/5.0/trifacta-backup-config-and-db.sh

    2. Example command to download the script:

      curl --output trifacta-backup-config-and-db.sh https://raw.githubusercontent.com/trifacta/trifacta-utils/release/5.0/trifacta-backup-config-and-db.sh

    3. Overwrite the downloaded script to the following location:

      /opt/trifacta/bin/setup-utils/trifacta-backup-config-and-db.sh

    4. Verify that this script is executable: 

      sudo chmod 775 /opt/trifacta/bin/setup-utils/trifacta-backup-config-and-db.sh

  4. Run the backup script:

    sudo /opt/trifacta/bin/setup-utils/trifacta-backup-config-and-db.sh

     

    1. When the script is complete, the output identifies the location of the backup. Example:

      /opt/trifacta-backups/trifacta-backup-4.2.1+126.20171217124021.a8ed455-20180514213601.tgz

  5. Store the backup in a safe location. If needed, you can store this backup in the S3 bucket used by the platform. Example:

    aws s3 cp /opt/trifacta-backups/trifacta-backup-4.2.1+126.20171217124021.a8ed455-20180514213601.tgz s3://<my-trifacta-s3-bucket>/trifacta-backups/

Spin up upgraded platform instance and restore data

In this section, you spin up the upgraded instance and then restore the data that you have backed up into the instance.

Steps:

  1. Spin up the new instance from the Amazon Marketplace AMI. For more information on installation, please see the instructions earlier in this document.
  2. Verify that the instance has successfully started. If you can connect to the login page, the platform has started.
  3. SSH to the new Amazon Marketplace AMI instance. See previous instructions in the Install section.

  4. Stop the Designer Cloud Powered by Trifacta platform on the instance:

    sudo service trifacta stop

  5. Download the restore script from the following location:

    https://raw.githubusercontent.com/trifacta/trifacta-utils/release/5.0/trifacta-restore-from-backup.sh

    1. Example command to download the script:

      curl --output trifacta-restore-from-backup.sh https://raw.githubusercontent.com/trifacta/trifacta-utils/release/5.0/trifacta-restore-from-backup.sh

    2. Place the restore script in the following location in the instance:

      /opt/trifacta/bin/setup-utils/trifacta-restore-from-backup.sh

    3. Verify that this script is executable:

      sudo chmod 775 /opt/trifacta/bin/setup-utils/trifacta-restore-from-backup.sh

  6. Download the backup from your storage location and extract its contents. Example:

    NOTE: Below, some values are too long for a single line. Single lines that overflow to additional lines are marked with a \. The backslash should not be included if the line is used as input.

    sudo mkdir -p /root/trifacta-restore-files
sudo cd /root/trifacta-restore-files
sudo aws s3 cp \
  s3://<my-trifacta-s3-bucket>/trifacta-backups/trifacta-backup-4.2.1+126.20171217124021.a8ed455-20180514213601.tgz .
sudo tar xzf trifacta-backup-4.2.1+126.20171217124021.a8ed455-20180514213601.tgz

  7. The backup contents should be located in a directory with a path similar to the following:

    /root/trifacta-restore-files/trifacta-backup-4.2.1+126.20171217124021.a8ed455-20180514213601

  8. Execute the restore script. Pass in the path to your unzipped backup as a parameter, as in the following example:

    NOTE: Below, some values are too long for a single line. Single lines that overflow to additional lines are marked with a \. The backslash should not be included if the line is used as input.

    sudo /opt/trifacta/bin/setup-utils/trifacta-restore-from-backup.sh \
  -r /root/trifacta-restore-files/trifacta-backup-4.2.1+126.20171217124021.a8ed455-20180514213601

Verify 

The upgrade is complete. To verify:

Steps:

  1. Restart the platform:

    sudo service trifacta start
  2. Run a simple job with profiling. 
  3. Verify that the job has successfully completed. 
    1. In the Jobs page, locate the job results. See Jobs Page.
    2. Click View Details next to the job to review the profile.

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 Amazon Marketplace:

Send Feedback

This page has no comments.

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