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 upgrading Designer Cloud Enterprise Edition through the AWS Marketplace.
NOTE: For upgrading the product, the new instance must be installed directly through EC2. You cannot install the new version using the CloudFormation template, which overwrites your security roles and policies.
These instructions apply only to Designer Cloud Enterprise Edition with optional integration with EMR, available the AWS Marketplace. For upgrades of Data Preparation for Amazon Redshift and S3 that was installed from the AWS Marketplace, see Upgrade for AWS Marketplace.
Otherwise, please contact your Alteryx representative for upgrade instructions.
Upgrade Path
This upgrade process supports upgrade for the following versions:
Source Version | Target Upgrade Version |
---|---|
Designer Cloud Enterprise Edition 5.0.x | Designer Cloud Enterprise Edition 5.1.x |
If you are upgrading from a version that is earlier than the supported Source Version listed above for this upgrade process, please use the links below to acquire the AMI(s) and documentation to upgrade to the earliest supported Source Version. Then, return to these instructions to complete the upgrade to this version.
Your Version | Target Version | AMI | Documentation |
---|---|---|---|
Designer Cloud Enterprise Edition 4.2.x | Designer Cloud Enterprise Edition 5.0.x | Please see the AWS Marketplace listing for the product. The AMI is accessible from there. | Trifacta Install Guide for AWS Marketplace with EMR v5.0 |
EMR Upgrade
Before you begin, you should verify that your current EMR cluster version and configuration is supported after the upgrade. If it is not, you must plan to upgrade your EMR cluster after you have upgraded the Designer Cloud Powered by Trifacta platform.
Tip: For Release 5.1, EMR 5.15.0 and Spark 2.3.0 are recommended.
For more information, see Configure for EMR.
Back up data from Marketplace instance
Before you begin, you should back up your current Marketplace instance.
SSH to your current Marketplace instance. For more information, see Install from AWS Marketplace with EMR.
Change to the root user:
sudo su
Stop the Designer Cloud Powered by Trifacta platform on your current Marketplace instance:
service trifacta stop
- Update the backup script with the most recent version:
Download the backup script from the following location:
https://raw.githubusercontent.com/trifacta/trifacta-utils/release/5.0/trifacta-backup-config-and-db.sh
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
Overwrite the existing script with the new script you just downloaded:
mv trifacta-backup-config-and-db.sh /opt/trifacta/bin/setup-utils/trifacta-backup-config-and-db.sh
Update the ownership and permissions of this script:
chown trifacta:trifacta /opt/trifacta/bin/setup-utils/trifacta-backup-config-and-db.sh chmod 775 /opt/trifacta/bin/setup-utils/trifacta-backup-config-and-db.sh
Run the backup script:
/opt/trifacta/bin/setup-utils/trifacta-backup-config-and-db.sh
When the script is complete, the output identifies the location of the backup. Example:
/opt/trifacta-backups/trifacta-backup-5.0+126.20171217124021.a8ed455-20180514213601.tgz
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-5.0+126.20171217124021.a8ed455-20180514213601.tgz s3://<my-trifacta-s3-bucket>/trifacta-backups/
Spin up upgraded Marketplace instance and restore data
Now, you spin up the upgraded instance and then restore the data from the pre-upgrade instance into this one.
NOTE: Do not terminate your old instance until your new instance is successfully restored and running properly.
Steps:
Spin up the new instance of Designer Cloud Enterprise Edition from the AWS Marketplace.
Make sure you use all the same settings as your existing Alteryx instance (security groups, IAM role, VPC, subnet, etc).
- For more information, see Install from AWS Marketplace with EMR.
Verify that the instance has successfully started. If you can connect to the login page, the platform has started.
- SSH to the new Alteryx instance. For more information, see Install from AWS Marketplace with EMR.
Change to root user and change to the root home directory:
sudo su cd
Stop the Designer Cloud Powered by Trifacta platform on the instance (should already be stopped):
service trifacta stop
Download the backup from your storage location and extract its contents. Example:
mkdir -p /root/trifacta-restore-files cd /root/trifacta-restore-files aws s3 cp s3://<my-trifacta-s3-bucket>/trifacta-backups/trifacta-backup-5.0+126.20171217124021.a8ed455-20180514213601.tgz . tar xzf trifacta-backup-5.0+126.20171217124021.a8ed455-20180514213601.tgz
The backup contents should now be located in a directory with a path similar to the following:
/root/trifacta-restore-files/trifacta-backup-5.0+126.20171217124021.a8ed455-20180514213601
Execute the restore script. Pass in the path to your unzipped backup as a parameter. Example:
/opt/trifacta/bin/setup-utils/trifacta-restore-from-backup.sh -r /root/trifacta-restore-files/trifacta-backup-5.1+126.20171217124021.a8ed455-20180514213601
The backup is restored into your new installation.
- Users of Designer Cloud Enterprise Edition must update the license file (
license.json
). For more information, see Install from AWS Marketplace with EMR. - After this upgrade is complete, you may upgrade the following:
- EMR cluster version to 5.15.0
Spark version to 2.3.0
NOTE: The Spark version must be inserted as part of the Designer Cloud Powered by Trifacta platform configuration. For more information, see Install from AWS Marketplace with EMR.
Post-upgrade Fixes
Verify migration of EMR settings
If your deployment is integrated with an EMR cluster, after you have completed the upgrade, you may need to manually migrate some EMR cluster settings. Please do the following:
Steps:
- Login to the application as an administrator.
In the Admin Settings page, scroll down to the External Service Settings section. Verify that the values in the section are accurate and current.
- If the values in the above node look correct, you can stop here. Please proceed to the next section.
- If the values are incorrect:
- Edit your
trifacta-conf.json
backup from the earlier release. In
trifacta-conf.json
, locate the values for the parameters in the left column. Insert these parameters in the corresponding setting under External Service Settings on the Admin Settings page of the upgraded instance:NOTE: The AWS EMR Cluster ID should migrate automatically. AWS Region was not tracked via parameter in earlier releases.
Pre-upgrade
trifacta-conf.json
settingPost-upgrade External Service setting aws.emr.resource.path
Resource path aws.emr.resource.bucket
Resource bucket Save your changes and restart the platform.
- Verify that you have access to EMR cluster resources.
- Edit your
Verify
The upgrade is complete. To verify:
Steps:
Restart the platform:
service trifacta start
Run a simple job. It can have a single step in the recipe.
NOTE: Please verify that profiling is enabled. If the job fails with profiling, retry it without profiling, which may assist in troubleshooting any issues.
NOTE: This job should be run on all available running environments, including the Alteryx Server and any integrated EMR cluster.
- Verify that the job has successfully completed.
- In the Jobs page, locate the job results. See Jobs Page.
- 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.
This page has no comments.