Use the following section to set up your EMR cluster for use with the .- Via AWS EMR UI: This method is assumed in this documentation.
- Via AWS command line interface: For this method, it is assumed that you know the required steps to perform the basic configuration. For custom configuration steps, additional documentation is provided below.
Info |
---|
NOTE: It is recommended that you set up your cluster for exclusive use by the . |
Info |
---|
NOTE: If you are deploying EMR in a highly available environment, you must create each EMR cluster from the command line. For more information, see "Configure for EMR High Availability" below. |
In the Amazon EMR console, click Create Cluster. Click Go to advanced options. Complete the sections listed below. Info |
---|
NOTE: Please be sure to read all of the cluster options before setting up your EMR cluster. |
Info |
---|
NOTE: Please perform your configuration through the Advanced Options workflow. |
For more information on setting up your EMR cluster, see http://docs.aws.amazon.com/cli/latest/reference/emr/create-cluster.html. In the Advanced Options screen, please select the following: Info |
---|
NOTE: Please apply the sizing information for your EMR cluster that was recommended for you. If you have not done so, please contact your . |
- Cluster name: Provide a descriptive name.
- Logging: Enable logging on the cluster.
- Debugging: Enable.
- Termination protection: Enable.
- Tags:
- Additional Options:
- EMRFS consistent view: Do not enable.
- Custom AMI ID: None.
- Bootstrap Actions:
If you performed all of the configuration, including the sections below, you can create the cluster. Info |
---|
NOTE: You must acquire your EMR cluster ID for use in configuration of the . |
The following cluster roles and their permissions are required. For more information on the specifics of these policies, see "Access Policies" below. - EMR Role:
- Read/write access to log bucket
- Read access to resource bucket
- EC2 instance profile:
- If using instance mode:
- EC2 profile should have read/write access for all users.
- EC2 profile should have same permissions as EC2 Edge node role.
- Read/write access to log bucket
- Read access to resource bucket
- Auto-scaling role:
- Read/write access to log bucket
- Read access to resource bucket
- Standard auto-scaling permissions
You can use one of two methods for authenticating the EMR cluster's access to S3: - Role-based IAM authentication (recommended): This method leverages your IAM roles on the EC2 instance.
- Custom credential provider: This method utilizes a custom credential provider JAR file provided with the platform. This custom credential provider is automatically deployed by the during job submission.
You can leverage your IAM roles to provide role-based authentication to the S3 buckets. Info |
---|
NOTE: The IAM role that is assigned to the EMR cluster and to the EC2 instances on the cluster must have access to the data of all users on S3. |
For more information, see Configure for EC2 Role-Based Authentication.
If you are not using IAM roles for access, you can manage access using either of the following: - AWS key and secret values specified in
- AWS user mode
In either scenario, the deploys a custom credential provider JAR file to the EMR before the job is executed. Info |
---|
NOTE: If you are also integrating with AWS Glue, you must provide a separate custom credential JAR file as part of that integration. For more information, see Enable AWS Glue Access. |
You must set up S3 buckets for read and write access. Info |
---|
NOTE: Within the , you must enable use of S3 as the default storage layer. This configuration is described later. |
For more information, see Enable S3 Access.
Info |
---|
NOTE: If you are connecting to a kerberized EMR cluster, please skip to the next section. This section is not required. |
On the EMR cluster, all users of the platform must have access to the following locations:
Location | Description | Required Access |
---|
EMR Resources bucket and path | The S3 bucket and path where resources can be stored by the for execution of Spark jobs on the cluster. The locations are configured separately in the . | Read/Write | EMR Logs bucket and path | The S3 bucket and path where logs are written for cluster job execution. | Read |
These locations are configured on the later. require the following policies to run jobs on the EMR cluster: Code Block |
---|
{
"Statement": [
{
"Effect": "Allow",
"Action": [
"elasticmapreduce:AddJobFlowSteps",
"elasticmapreduce:DescribeStep",
"elasticmapreduce:DescribeCluster",
"elasticmapreduce:ListInstanceGroups",
"elasticmapreduce:CancelSteps"
],
"Resource": [
"*"
]
},
{
"Effect": "Allow",
"Action": [
"s3:*"
],
"Resource": [
"arn:aws:s3:::__EMR_LOG_BUCKET__",
"arn:aws:s3:::__EMR_LOG_BUCKET__/*",
"arn:aws:s3:::__EMR_RESOURCE_BUCKET__",
"arn:aws:s3:::__EMR_RESOURCE_BUCKET__/*"
]
}
]
} |
If the is integrating with a highly available EMR cluster through multiple master nodes, the following permission must be included in the ARN used for accessing EMR: Code Block |
---|
"elasticmapreduce:listInstances", |
Additional configuration is required. See "Configure for EMR High Availability" below. The following policies should be assigned to the EMR roles listed below for read/write access: Code Block |
---|
{
"Effect": "Allow",
"Action": [
"s3:*"
],
"Resource": [
"arn:aws:s3:::__EMR_LOG_BUCKET__",
"arn:aws:s3:::__EMR_LOG_BUCKET__/*",
"arn:aws:s3:::__EMR_RESOURCE_BUCKET__",
"arn:aws:s3:::__EMR_RESOURCE_BUCKET__/*"
]
}
} |
Please complete the following sections to configure the to communicate with the EMR cluster.As soon as you have installed the software, you should login to the application and change the admin password. The initial admin password is the instanceId for the EC2 instance. For more information, see Change Password. EMR integrations requires use of S3 as the base storage layer. Info |
---|
NOTE: The base storage layer must be set during initial installation and set up of the . |
See Set Base Storage Layer. To integrate with S3, additional configuration is required. See Enable S3 Access. Authentication to AWS and to EMR supports the following basic modes: - System: A single set of credentials is used to connect to resources.
- User: Each user has a separate set of credentials. The user can choose to submit key-secret combinations or role-based authentication.
Info |
---|
NOTE: Your method of authentication to AWS should already be configured. For more information, see Configure for AWS. |
The authentication mode for your access to EMR can be configured independently from the base authentication mode for AWS, with the following exception: Info |
---|
NOTE: If aws.emr.authMode is set to user , then aws.mode must also be set to user. |
Authentication mode configuration matrix: AWS mode (aws.mode) | system | user |
---|
EMR mode (aws.emr.authMode) | |
|
---|
system | AWS and EMR use a single key-secret combination. Parameters to set: Code Block |
---|
"aws.s3.key"
"aws.s3.secret" |
See Configure for AWS. | AWS access uses a single key-secret combination. EMR access is governed by per-user credentials. Per-user credentials can be provided from one of several different providers. Info |
---|
NOTE: Per-user access requires additional configuration for EMR. See the following section. |
For more information on configuring per-user access, see Configure for AWS. |
---|
user | Not supported | AWS and EMR use the same per-user credentials for access. Per-user credentials can be provided from one of several different providers. Info |
---|
NOTE: Per-user access requires additional configuration for EMR. See the following section. |
For more information on configuring per-user access, see Configure AWS Per-User Auth for Temporary Credentials. |
---|
Please apply the following configuration to set the EMR authentication mode: Steps: Locate the following settings and apply the appropriate values. See the table below:
Code Block |
---|
"aws.emr.authMode": "user", |
Setting | Description |
---|
aws.emr.authMode | Configure the mode to use to authenticate to the EMR cluster: system - In system mode, the specified AWS key and secret combination are used to authenticate to the EMR cluster. These credentials are used for all users.
user - In user mode, user configuration is retrieved from the database.
Info |
---|
NOTE: User mode for EMR authentication requires that aws.mode be set to user . Additional configuration for EMR is below. |
|
- Save your changes.
If you have enabled per-user authentication for EMR (aws.emr.authMode=user ), you must set the following properties based on the credential provider for your AWS per-user credentials. Authentication method | Properties and values |
---|
Use default credential provider for all including EMR. Info |
---|
NOTE: This method requires the deployment of a custom credential provider JAR. |
|
Code Block |
---|
"aws.credentialProvider":"default",
"aws.emr.forceInstanceRole":false, |
| Use default credential provider for all . However, EC2 role-based IAM authentication is used for EMR. |
Code Block |
---|
"aws.credentialProvider":"default",
"aws.emr.forceInstanceRole":true, |
| EC2 role-based IAM authentication for all |
Code Block |
---|
"aws.credentialProvider":"instance", |
|
for EMR
Info |
---|
NOTE: This section assumes that you are integrating with an EMR cluster that has not been kerberized. If you are integrating with a Kerberized cluster, please skip to "Configure for EMR with Kerberos". |
After you have configured S3 to be the base storage layer, you must enable EMR integration. Steps: Set the following value: Code Block |
---|
"webapp.runInEMR": true, |
Set the following values: Code Block |
---|
"webapp.runWithSparkSubmit": false, |
Verify the following property values: Code Block |
---|
"webapp.runWithSparkSubmit": false,
"webapp.runInDataflow": false, |
Save your changes and restart the platform. To enable , an in-memory running environment for small- to medium-sized jobs, please do the following:In the , navigate to User menu > Admin console > Workspace settings.In the Workspace Settings page, set Photon execution to Enabled . - is available for job execution when you next log in to the .
The must be aware of the EMR cluster to which to connection. Steps: Under External Service Settings, enter your AWS EMR Cluster ID. Click the Save button below the textbox.
For more information, see Admin Settings Page. If you have deployed your EMR cluster on a private sub-net that is accessible outside of AWS, you must enable this property, which permits the extraction of the IP address of the master cluster node through DNS. Info |
---|
NOTE: This feature must be enabled if your EMR is accessible outside of AWS on a private network. |
Steps: Set the following property to true : Code Block |
---|
"emr.extractIPFromDNS": false, |
- Save your changes and restart the platform.
For EMR, you can configure a set of Spark-related properties to manage the integration and its performance. Depending on the version of EMR with which you are integrating, the must be modified to use the appropriate version of Spark to connect to EMR. Info |
---|
NOTE: You should have already acquired the value to apply. See "Supported Spark Versions" above. |
Steps: Locate the following:
Code Block |
---|
"spark.version": "<SparkVersionForMyEMRVersion>", |
- This setting is ignored for EMR:
spark.useVendorSparkLibraries - Save your changes.
The Spark job service is not used for EMR job execution. Please complete the following to disable it: Steps: Locate the following and set it to false : Code Block |
---|
"spark-job-service.enabled": false, |
Locate the following and set it to false : Code Block |
---|
"spark-job-service.enableHiveSupport": false, |
- Save your changes.
Through the Admin Settings page, you can specify the YARN queue to which to submit your Spark jobs. All Spark jobs from the are submitted to this queue.Steps: In platform configuration, locate the following: Code Block |
---|
"spark.props.spark.yarn.queue" |
- Specify the name of the queue.
Save your changes.
The following properties must be passed from the to Spark for proper execution on the EMR cluster. Info |
---|
NOTE: Do not modify these properties through the Admin Settings page. These properties must be added as extra properties through the Spark configuration block. Ignore any references in to these properties and their settings. |
Code Block |
---|
"spark": {
...
"props": {
"spark.dynamicAllocation.enabled": "true",
"spark.shuffle.service.enabled": "true",
"spark.executor.instances": "0",
"spark.executor.memory": "2048M",
"spark.executor.cores": "2",
"spark.driver.maxResultSize": "0"
}
...
} |
Property | Description | Value |
---|
spark.dynamicAllocation.enabled | Enable dynamic allocation on the Spark cluster, which allows Spark to dynamically adjust the number of executors. | true | spark.shuffle.service.enabled | Enable Spark shuffle service, which manages the shuffle data for jobs, instead of the executors. | true | spark.executor.instances | Default count of executor instances. | See Sizing GuideGuidelines. | spark.executor.memory | Default memory allocation of executor instances. | See Sizing GuideGuidelines. | spark.executor.cores | Default count of executor cores. | See Sizing GuideGuidelines. | spark.driver.maxResultSize | Enable serialized results of unlimited size by setting this parameter to zero (0). | 0 |
When profiling is enabled for a Spark job, the transform and profiling tasks are combined by default. As needed, you can separate these two tasks. Publishing behaviors vary depending on the approach. For more information, see Configure for Spark. for EMR with Kerberos Info |
---|
NOTE: This section applies only if you are integrating with a kerberized EMR cluster. If you are not, please skip to "Additional Configuration for EMR". |
When running jobs against a kerberized EMR cluster, you utilize the Spark-submit method of job submission. You must disable the standard EMR integration. Steps: Search for the following setting and set it false : Code Block |
---|
"webapp.runInEMR": false, |
Set the following value: Code Block |
---|
"webapp.runWithSparkSubmit": true, |
Disable use of Hive, which is not supported with EMR: Code Block |
---|
"spark-job-service.enableHiveSupport": false, |
Verify the following property value: Code Block |
---|
"webapp.runInDataflow": false, |
- Save your changes.
To use Spark-submit, the Spark master must be set to use YARN. Steps: Search for the following setting and set it yarn : Code Block |
---|
"spark.master": "yarn", |
Save your changes.
For integrating with an EMR cluster with Kerberos, the EMR cluster site XML configuration files must be downloaded from the EMR master node to the . Info |
---|
NOTE: This step is not required for non-Kerberized EMR clusters. |
Info |
---|
NOTE: When these files change, you must update the local copies. |
- Download the Hadoop Client Configuration files from the EMR master node. The required files are the following:
core-site.xml hdfs-site.xml mapred-site.xml yarn-site.xml
These configuration files must be moved to the . By default, these files are in /etc/hadoop/conf : Code Block |
---|
sudo cp <location>/*.xml /opt/trifacta/conf/hadoop-site/
sudo chown trifacta:trifacta /opt/trifacta/conf/hadoop-site/*.xml |
- (Option) If we want to support impersonate, we also need copy *.keytab from the EMR master node under /etc folder to EC2 instance under same folder.
When integrating with a kerberized EMR cluster, the following are unused:- External Service Settings: In the Admin Settings page, this section of configuration does not apply to EMR with Kerberos.
Unused EMR settings: In the Admin Settings page, the following EMR settings do not apply to EMR with Kerberos: Code Block |
---|
aws.emr.tempfilesCleanupAge
aws.emr.proxyUser
aws.emr.maxLogPollingRetries
aws.emr.jobTagPrefix
aws.emr.getLogsOnFailure
aws.emr.getLogsForAllJobs
aws.emr.extractIPFromDNS
aws.emr.connectToRmEnabled |
By default, a job that is started on EMR cannot be canceled through the application. Optionally, you can enable users to cancel their EMR jobs in progress. Pre-requisites:
The following permission must be added to the IAM role that is used to interact with EMR: Code Block |
---|
elasticmapreduce:CancelSteps |
For more information, See "EC2 instance profile" above. - You should add an additional software setting to the cluster definition through the EMR console. For more information, see "Advanced Options" above.
Steps: Please complete the following configuration changes to enable job cancellation on EMR. Please locate the following parameter and verify that it has been set to true : Info |
---|
NOTE: Enabled by default, this parameter is optional for basic EMR connectivity. This parameter must be enabled for EMR job cancellation. |
Code Block |
---|
"aws.emr.connectToRmEnabled": true, |
- Please verify that the can connect to the EMR master node on port 8088. For more information, see "Create EMR Cluster" above.
Please locate the following parameter and verify that it is set to true : Code Block |
---|
"aws.emr.cancelEnabled": true, |
- Save your changes and restart the platform.
- To verify, launch an EMR job. In the Flow View context menu or in the Jobs page, you should see a Cancel job option.
For smaller datasets, the platform recommends using the running environment.For larger datasets, if the size information is unavailable, the platform recommends by default that you run the job on the Hadoop cluster. For these jobs, the default publishing action for the job is specified to run on the Hadoop cluster, generating the output format defined by this parameter. Publishing actions, including output format, can always be changed as part of the job specification. As needed, you can change this default format. Code Block |
---|
"webapp.defaultHadoopFileFormat": "csv", |
Accepted values: csv , json , avro , pqt For more information, see Run Job Page. If you are publishing using Snappy compression for jobs run on an EMR cluster, you may need to perform the following additional configuration. Steps: SSH into EMR cluster (master) node: Code Block |
---|
ssh <EMR master node> |
Create tarball of native Hadoop libraries: Code Block |
---|
tar -C /usr/lib/hadoop/lib -czvf emr-hadoop-native.tar.gz native |
Copy the tarball to the instance used by the into the /tmp directory: Code Block |
---|
scp -p emr-hadoop-native.tar.gz <EC2 instance>:/tmp |
SSH to instance: Code Block |
---|
ssh <EC2 instance> |
Create path values for libraries: Code Block |
---|
sudo -u trifacta mkdir -p /opt/trifacta/services/batch-job-runner/build/libs |
Untar the tarball to the : Code Block |
---|
sudo -u trifacta tar -C /opt/trifacta/services/batch-job-runner/build/libs -xzf /tmp/emr-hadoop-native.tar.gz |
Verify libhadoop.so* and libsnappy.so* libraries exist and are owned by the : Code Block |
---|
ls -l /opt/trifacta/services/batch-job-runner/build/libs/native/ |
Verify that the /tmp directory has the proper permissions for publication. For more information, see Supported File Formats. - A platform restart is not required.
You can set the following parameters as needed: Steps: Property | Required | Description |
---|
aws.emr.resource.bucket | Y | S3 bucket name where , libraries, and other resources can be stored that are required for Spark execution. | aws.emr.resource.path | Y | S3 path within the bucket where resources can be stored for job execution on the EMR cluster. Info |
---|
NOTE: Do not include leading or trailing slashes for the path value. |
| aws.emr.proxyUser | Y | This value defines the user for the to use for connecting to the cluster. Info |
---|
NOTE: Do not modify this value. |
| aws.emr.maxLogPollingRetries | N | Configure maximum number of retries when polling for log files from EMR after job success or failure. Minimum value is 5 . | aws.emr.tempfilesCleanupAge | N | Defines the number of days that temporary files in the /trifacta/tempfiles directory on EMR HDFS are permitted to age. By default, this value is set to 0 , which means that cleanup is disabled. If needed, you can set this to a positive integer value. During each job run, the platform scans this directory for temp files older than the specified number of days and removes any that are found. This cleanup provides an additional level of system hygiene. Before enabling this secondary cleanup process, please execute the following command to clear the tempfiles directory: Code Block |
---|
hdfs dfs -rm -r -skipTrash /trifacta/tempfiles |
|
For more information on configuring the platform to integrate with Redshift, see Create Redshift Connections. The can be configured to integrate with multiple master EMR nodes, which are deployed in a highly available environment. Warning |
---|
Deploying additional instances of EMR may result in increased costs. |
Integration with EMR high availability is supported for EMR 5.23.0 and later. An additional permission must be added to the ARN used to access EMR. For more information, see "Permissions for EMR high availability" above. For more information, see https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-ha-launch.html. When you create the cluster, you must select the "Use multiple master nodes to improve cluster availability" checkbox. For more information, see "Create Clusters" above. If needed, you can switch to a different EMR cluster through the application. For example, if the original cluster suffers a prolonged outage, you can switch clusters by entering the cluster ID of a new cluster. For more information, see Admin Settings Page. Batch Job Runner manages jobs executed on the EMR cluster. You can modify aspects of how jobs are executed and how logs are collected. For more information, see Configure Batch Job Runner. In environments where the EMR cluster is shared with other job-executing applications, you can review and specify the job tag prefix, which is prepended to job identifiers to avoid conflicts with other applications. Steps: Locate the following and modify if needed: Code Block |
---|
"aws.emr.jobTagPrefix": "TRIFACTA_JOB_", |
- Save your changes and restart the platform.
|