Contents:
This section describes how to configure the Designer Cloud Powered by Trifacta® platform to integrate with Databricks hosted in Azure.
- Azure Databricks is an Apache Spark implementation that has been optimized for use on the Azure platform. For more information, see https://databricks.com/product/azure.
NOTE: You cannot integrate with existing Azure Databricks clusters.
Pre-requisites
- The Designer Cloud Powered by Trifacta platform must be deployed in Microsoft Azure.
Limitations
NOTE: If you are using Azure AD to integrate with an Azure Databricks cluster, the Azure AD secret value stored in azure.secret
must begin with an alphanumeric character. This is a known issue.
- Supported for Azure Databricks versions 5.3 - 5.5 LTS.
- The Designer Cloud Powered by Trifacta platform must be installed on Microsoft Azure.
Nested folders are not supported when running jobs from Azure Databricks.
NOTE: Avoid including spaces in the paths to your ADLS sources. Spaces in the path value can cause errors during execution on Databricks.
- When a job is started and no cluster is available, a cluster is initiated, which can take up to four minutes. If the job is canceled during cluster startup:
- The job is terminated, and the cluster remains.
- The job is reported in the application as Failed, instead of Canceled.
Azure Databricks integration works with Spark 2.4.x only.
NOTE: The version of Spark for Azure Databricks must be applied to the platform configuration through the
databricks.sparkVersion
property. Details are provided later.- Azure Databricks integration does not work with Hive.
Job counts
By default, the number of jobs permitted on an Azure Databricks cluster is set to 1000
.
- The number of jobs that can be created per workspace in an hour is limited to
1000
. - These limits apply to any jobs run for workspace data on the cluster.
- The number of actively concurrent job runs in a workspace is limited to
150
.
NOTE: To enable retrieval and auditing of job information after a job has been completed, the Designer Cloud Powered by Trifacta platform does not delete jobs from the cluster. As a result, jobs can accumulate over time to exceeded the number of jobs permitted on the cluster. You should periodically delete jobs on your Azure Databricks cluster to prevent reaching these limits and receiving a Quota for number of jobs has been reached
limit.
For more information, see https://docs.databricks.com/user-guide/jobs.html.
Create Cluster
NOTE: Integration with pre-existing Azure Databricks clusters is not supported.
When a user first requests access to Azure Databricks, a new Azure Databricks cluster is created for the user. Access can include a request to run a job or to browse Databricks Tables. Cluster creation may take a few minutes.
A new cluster is also created when a user launches a job after:
- The Azure Databricks configuration properties or Spark properties are changed in platform configuration.
- A JAR file is updated on the Alteryx node
A user's cluster automatically terminates after a configurable time period. A new cluster is automatically created when the user next requests access to Azure Databricks access. See "Configure Platform" below.
Enable
To enable Azure Databricks, please perform the following configuration changes.
Steps:
- You can apply this change through the Admin Settings Page (recommended) or
trifacta-conf.json
. For more information, see Platform Configuration Methods. Locate the following parameters. Set them to the values listed below, which enable the Trifacta Photon (smaller jobs) and Azure Databricks (small to extra-large jobs) running environments:
"webapp.runInTrifactaServer": true, "webapp.runInDatabricks": true, "webapp.runWithSparkSubmit": false, "webapp.runinEMR": false, "webapp.runInDataflow": false,
- Do not save your changes until you have completed the following configuration section.
Configure
Configure Platform
Please review and modify the following configuration settings.
NOTE: When you have finished modifying these settings, save them and restart the platform to apply.
Parameter | Description | Value |
---|---|---|
feature.parameterization.maxNumberOfFilesForExecution.databricksSpark | Maximum number of parameterized source files that are permitted to be executed as part of an Azure Databricks job. | |
feature.parameterization.matchLimitOnSampling.databricksSpark | Maximum number of parameterized source files that are permitted for matching in a single dataset with parameters. | |
databricks.workerNodeType | Type of node to use for the Azure Databricks Workers/Executors. There are 1 or more Worker nodes per cluster. | Default: NOTE: This property is unused when instance pooling is enabled. For more information, see Configure instance pooling below. For more information, see the sizing guide for Azure Databricks. |
databricks.sparkVersion | Azure Databricks cluster version which also includes the Spark Version. | NOTE: Please verify that this value is set to the following: Please do not use other values. For more information, see Configure for Spark. |
databricks.serviceUrl | URL to the Azure Databricks Service where Spark jobs will be run (Example: https://westus2.azuredatabricks.net) | |
databricks.minWorkers | Initial number of Worker nodes in the cluster, and also the minimum number of Worker nodes that the cluster can scale down to during auto-scale-down | Minimum value: Increasing this value can increase compute costs. |
databricks.maxWorkers | Maximum number of Worker nodes the cluster can create during auto scaling | Minimum value: Not less than Increasing this value can increase compute costs. |
databricks.poolId | If you have enabled instance pooling in Azure Databricks, you can specify the pool identifier here. For more information, see Configure instance pooling below. | |
databricks.driverNodeType | Type of node to use for the Azure Databricks Driver. There is only 1 Driver node per cluster. | Default: For more information, see the sizing guide for Databricks. NOTE: This property is unused when instance pooling is enabled. For more information, see Configure instance pooling below. |
databricks.logsDestination | DBFS location that cluster logs will be sent to every 5 minutes | Leave this value as /trifacta/logs . |
databricks.enableAutotermination | Set to true to enable auto-termination of a user cluster after N minutes of idle time, where N is the value of the autoterminationMinutes property. | Unless otherwise required, leave this value as true . |
databricks.clusterStatePollerDelayInSeconds | Number of seconds to wait between polls for Azure Databricks cluster status when a cluster is starting up | |
databricks.clusterStartupWaitTimeInMinutes | Maximum time in minutes to wait for a Cluster to get to Running state before aborting and failing an Azure Databricks job | |
databricks.clusterLogSyncWaitTimeInMinutes | Maximum time in minutes to wait for a Cluster to complete syncing its logs to DBFS before giving up on pulling the cluster logs to the Alteryx node. | Set this to 0 to disable cluster log pulls. |
databricks.clusterLogSyncPollerDelayInSeconds | Number of seconds to wait between polls for a Databricks cluster to sync its logs to DBFS after job completion | |
databricks.autoterminationMinutes | Idle time in minutes before a user cluster will auto-terminate. | Do not set this value to less than the cluster startup wait time value. |
spark.useVendorSparkLibraries | When | Default is NOTE: Set this value to |
Configure instance pooling
Instance pooling reduces cluster node spin-up time by maintaining a set of idle and ready instances. The Designer Cloud Powered by Trifacta platform can be configured to leverage instance pooling on the Azure Databricks cluster.
Pre-requisites:
- All cluster nodes used by the Designer Cloud Powered by Trifacta platform are taken from the pool. If the pool has an insufficient number of nodes, cluster creation fails.
- Each user must have access to the pool and must have at least the
ATTACH_TO
permission. - Each user must have a personal access token from the same Azure Databricks workspace. See Configure personal access token below.
To enable:
- Acquire your pool identifier from Azure Databricks.
- You can apply this change through the Admin Settings Page (recommended) or
trifacta-conf.json
. For more information, see Platform Configuration Methods. Set the following parameter to the Azure Databricks pool identifier:
"databricks.poolId": "<my_pool_id>",
- Save your changes and restart the platform.
NOTE: When instance pooling is enabled, the following parameters are not used:
databricks.driverNodeType
databricks.workerNodeType
For more information, see https://docs.azuredatabricks.net/clusters/instance-pools/index.html.
Configure personal access token
Each user must insert a Databricks Personal Access Token to access Databricks resources. For more information, see Databricks Personal Access Token Page.
Additional Configuration
Enable SSO for Azure Databricks
To enable SSO authentication with Azure Databricks, you enable SSO integration with Azure AD. For more information, see Configure SSO for Azure AD.
Enable Azure Managed Identity access
For enhanced security, you can configure the Designer Cloud Powered by Trifacta platform to use an Azure Managed Identity. When this feature is enabled, the platform queries the Key Vault for the secret holding the applicationId and secret to the service principal that provides access to the Azure services.
NOTE: This feature is supported for Azure Databricks only.
NOTE: Your Azure Key Vault must already be configured, and the applicationId and secret must be available in the Key Vault. See Configure for Azure.
To enable, the following parameters for the Designer Cloud Powered by Trifacta platform must be specified.
You can apply this change through the Admin Settings Page (recommended) or trifacta-conf.json
.
For more information, see Platform Configuration Methods.
Parameter | Description |
---|---|
azure.managedIdentities.enabled | Set to true to enable use of Azure managed identities. |
azure.managedIdentities.keyVaultApplicationidSecretName | Specify the name of the Azure Key Vault secret that holds the service principal Application Id. |
azure.managedIdentities.keyVaultApplicationSecretSecretName | Specify the name of the Key Vault secret that holds the service principal secret. |
Save your changes.
Pass additional Spark properties
As needed, you can pass additional properties to the Spark running environment through the spark.props
configuration area.
NOTE: These properties are passed to Spark for all jobs.
Steps:
- You can apply this change through the Admin Settings Page (recommended) or
trifacta-conf.json
. For more information, see Platform Configuration Methods. - Search for the following property:
spark.props
. Insert new Spark properties. For example, you can specify the
spark.props.spark.executor.memory
property, which changes the memory allocated to the Spark executor on each node by using the following in thespark.props
area:"spark": { ... "props": { "spark.executor.memory": "6GB" } ... }
- Save your changes and restart the platform.
For more information on modifying these settings, see Configure for Spark.
Use
Run job from application
When the above configuration has been completed, you can select the running environment through the application. See Run Job Page.
Run job via API
You can use API calls to execute jobs.
Please make sure that the request body contains the following:
"execution": "databricksSpark",
For more information, see API JobGroups Create v4.
Troubleshooting
Spark job on Azure Databricks fails with "Invalid spark version" error
When running a job using Spark on Azure Databricks, the job may fail with the above invalid version error. In this case, the Databricks version of Spark has been deprecated.
Solution:
Since an Azure Databricks cluster is created for each user, the solution is to identify the cluster version to use, configure the platform to use it, and then restart the platform.
- You can apply this change through the Admin Settings Page (recommended) or
trifacta-conf.json
. For more information, see Platform Configuration Methods. - Acquire the value for
databricks.sparkVersion
. In Azure Databricks, compare your value to the list of supported Azure Databricks version. If your version is unsupported, identify a new version to use.
NOTE: Please make note of the version of Spark supported for the version of Azure Databricks that you have chosen.
- In the Designer Cloud Powered by Trifacta platform configuration:
- Set
databricks.sparkVersion
to the new version to use. - Set
spark.version
to the appropriate version of Spark to use.
- Set
- Restart the Designer Cloud Powered by Trifacta platform.
- The platform is restarted. A new Azure Databricks cluster is created for each user using the specified values, when the user runs a job.
This page has no comments.