Prerequisites

For your data ingest source

A pre-configured Box App under the Box Account owning the resources being accessed (https://app.box.com/developers/console), with the following configuration:

• If you create a new App, select Server Authentication (with JWT) authentication method. If you want to use an existing App, choose one with OAuth 2.0 with JSON Web Tokens (Server Authentication) as the Authentication method.
• Make sure the App has a Client ID and a Client Secret.
• Set App Access Level to App + Enterprise Access.
• Enable Write all files and folders in Box for Application Scopes.
• Enable the Advanced Features: Generate user access tokens and Make API calls using the as-user header.
• Generate a Public/Private Keypair under Add and Manage Public Keys and download the configuration JSON file (under App Settings). Set the full path of this file in the Box Config File property.
• After you have made all the above settings, you need to reauthorize the App on the admin page. (Reauthorize App at https://app.box.com/master/custom-apps.) If the app is configured for the first time you need to add it (Add App) before it can be authorized.

For Cloudera DataFlow

• You have enabled Cloudera DataFlow for an environment.

  For information on how to enable Cloudera DataFlow for an environment, see Enabling Cloudera DataFlow for an Environment.

• You have created a Machine User to use as the Cloudera Workload User.

• You have given the Cloudera Workload User the EnvironmentUser role.
  1. From the Management Console, go to the environment for which Cloudera DataFlow is enabled.
  2. From the Actions drop down, click Manage Access.
  3. Identify the user you want to use as a Workload User.
  4. Give that user EnvironmentUser role.

• You have synchronized your user to the Cloudera Public Cloud environment that you enabled for Cloudera DataFlow.

  For information on how to synchronize your user to FreeIPA, see Performing User Sync.

• You have granted your Cloudera user the DFCatalogAdmin and DFFlowAdmin roles to enable your user to add the ReadyFlow to the Catalog and deploy the flow definition.
  1. Give a user permission to add the ReadyFlow to the Catalog.
     1. From the Management Console, click User Management.
     2. Enter the name of the user or group you wish to authorize in the Search field.
     3. Select the user or group from the list that displays.
     4. Click Roles > Update Roles.
     5. From Update Roles, select DFCatalogAdmin and click Update.
  2. Give your user or group permission to deploy flow definitions.
     1. From the Management Console, click Environments to display the Environment List page.
     2. Select the environment to which you want your user or group to deploy flow definitions.
     3. Click Actions > Manage Access to display the Environment Access page.
     4. Enter the name of your user or group you wish to authorize in the Search field.
     5. Select your user or group and click Update Roles.
     6. Select DFFlowAdmin from the list of roles.
     7. Click Update Roles.
  3. Give your user or group access to the Project where the ReadyFlow will be deployed.
     1. Go to DataFlow > Projects.
     2. Select the project where you want to manage access rights and click More > Manage Access.
  4. Start typing the name of the user or group you want to add and select them from the list.
  5. Select the Resource Roles you want to grant.
  6. Click Update Roles.
  7. Click Synchronize Users.

For your ADLS data ingest target

• You have your ADLS container and path into which you want to ingest data.

• You have performed one of the following to configure access to your ADLS folder:

  • You have configured access to the ADLS folders with a RAZ enabled environment.

    It is a best practice to enable RAZ to control access to your object store folders. This allows you to use your Cloudera Public Cloud credentials to access ADLS folders, increases auditability, and makes object store data ingest workflows portable across cloud providers.

    1. Ensure that Fine-grained access control is enabled for your Cloudera DataFlow environment.
    2. From the Ranger UI, navigate to the ADLS repository.
    3. Create a policy to govern access to the ADLS container and path used in your ingest workflow. For example: adls-to-adls-avro-ingest
    4. Add the machine user that you have created for your ingest workflow to ingest the policy you just created.

    For more information, see Ranger policies for RAZ-enabled Azure environment.

  • You have configured access to ADLS folders using ID Broker mapping.

    If your environment is not RAZ-enabled, you can configure access to ADLS folders using ID Broker mapping.

    1. Access IDBroker mappings.
       1. To access IDBroker mappings in your environment, click Actions > Manage Access.
       2. Choose the IDBroker Mappings tab where you can provide mappings for users or groups and click Edit.
    2. Add your Cloudera Workload User and the corresponding Azure role that provides write access to your folder in ADLS to the Current Mappings section by clicking the blue + sign.
    3. Click Save and Sync.

For your S3 data ingest target

• You have your source S3 path and bucket.

• Perform one of the following to configure access to S3 buckets:

  • You have configured access to S3 buckets with a RAZ enabled environment.

    It is a best practice to enable RAZ to control access to your object store buckets. This allows you to use your Cloudera credentials to access S3 buckets, increases auditability, and makes object store data ingest workflows portable across cloud providers.

    1. Ensure that Fine-grained access control is enabled for your Cloudera DataFlow environment.
    2. From the Ranger UI, navigate to the S3 repository.
    3. Create a policy to govern access to the S3 bucket and path used in your ingest workflow.
    4. Add the machine user that you have created for your ingest workflow to the policy you just created.

    For more information, see Creating Ranger policy to use in RAZ-enabled AWS environment.

  • You have configured access to S3 buckets using ID Broker mapping.

    If your environment is not RAZ-enabled, you can configure access to S3 buckets using ID Broker mapping.

    1. Access IDBroker mappings.
       1. To access IDBroker mappings in your environment, click Actions > Manage Access.
       2. Choose the IDBroker Mappings tab where you can provide mappings for users or groups and click Edit.
    2. Add your Cloudera Workload User and the corresponding AWS role that provides write access to your folder in your S3 bucket to the Current Mappings section by clicking the blue + sign.
    3. Click Save and Sync.