Minimal setup for cloud storage

This minimal secure setup uses one S3 bucket for each Data Lake, and multiple IAM roles and policies.

The example setup includes:

  • One S3 bucket with a sub-directory named after your data lake such as s3a://my-bucket/my-dl.
  • Four IAM roles and two instance profiles:
    • IDBROKER_ROLE role and instance profile
    • LOG_ROLE role and instance profile
    • RANGER_AUDIT_ROLE
    • DATALAKE_ADMIN_ROLE
  • Nine IAM policies:
    • One AssumeRole ipolicy (idbroker-assume-role) that can be used by the IDBroker component of the data lake cluster to assume each of the following roles: RANGER_AUDIT_ROLE and DATALAKE_ADMIN_ROLE.
    • Two shared policies for accessing S3 and DynamoDB:
      • aws-cdp-bucket-access-policy
      • aws-cdp-dynamodb-policy - Only required when using Runtime earlier than 7.2.2
    • Five (or six) policies for specific bucket directory access:
      • Log storage (aws-cdp-log-policy)
      • Ranger audit (aws-cdp-ranger-audit-s3-policy)
      • Data Lake admin (aws-cdp-datalake-admin-s3-policy)
      • Data Lake backups (aws-datalake-backup-policy)
      • Data Lake restore (of backups) (aws-datalake-restore-policy)
        Draft comment:
        added restore policy here
      • (Optional) FreeIPA backup storage - if using a separate bucket (aws-cdp-backup-policy)
    • Two trust policies:
      • aws-cdp-ec2-role-trust-policy
      • aws-cdp-idbroker-role-trust-policy

Required cloud storage

One S3 bucket with a sub-directory named after your data lake such as s3a://my-bucket/my-dl is required for this setup.

During Data Lake creation, CDP automatically creates a location for Ranger audits, Data Lake, Data Hub and FreeIPA logs, and FreeIPA and Data Lake backups. The location for each of these depends on the supplied storage location base and logs location base. The directory structure is created automatically by CDP within these base directories:

Storage Location Base examples
s3a://my-bucket/ s3a://my-bucket/my-dl
Ranger Audit Logs s3a://my-bucket/ranger/audit s3a://my-bucket/my-dl/ranger/audit
Logs Location Base examples
s3a://my-bucket/ s3a://my-bucket/my-dl
FreeIPA Logs s3a://my-bucket/cluster-logs/freeipa s3a://my-bucket/my-dl/cluster-logs/freeipa

If your environment was created prior to February 2021, this is s3a://my-bucket/my-dl/freeipa

Backup Location Base examples

s3a://my-bucket/ s3a://my-bucket/my-dl
FreeIPA Backup s3a://my-bucket/cluster-backups/freeipa s3a://my-bucket/my-dl/cluster-backups/freeipa

Required IAM resources

The following table lists the IAM roles and IAM policies that need to be created on AWS, and describes which policies should be assigned to which roles (as presented in the diagram, in some cases policies should be assigned to multiple roles). The policy definitions are provided in IAM policy definitions:

Role Permissions policy Trust policy Description
IDBROKER_ROLE

aws-cdp-idbroker-assume-role-policy

aws-cdp-log-policy

aws-cdp-ec2-role-trust-policy The assume role permissions policy must, at a minimum, allow the IDBROKER_ROLE to assume the RANGER_AUDIT_ROLE and the DATALAKE_ADMIN_ROLE. This policy must also allow the IDBROKER_ROLE to assume any other role for which a user or group mapping exists in the IDBroker.

Furthermore, the IDBROKER_ROLE needs the same permissions policy as the LOG_ROLE so that it can access the Logs Location Base.

The trust policy allows the role to be assumed by the IDBroker EC2 instance.

LOG_ROLE

aws-cdp-log-policy

aws-datalake-restore-policy

Draft comment:
added restore policy here

aws-cdp-backup-policy (Optional)

aws-cdp-ec2-role-trust-policy This role uses the aws-cdp-log-policy permissions policy to provide CDP with access to the specific location called Logs Location Base for logs.

If your Backup Location Base is in a separate bucket, you also need to provide the aws-cdp-backup-policy.

The trust policy allows the role to be assumed by EC2 instances in the cluster.

The aws-datalake-restore-policy is required for both upgrading a Data Lake and restoring a Data Lake backup.

Draft comment:
added line about restore policy
RANGER_AUDIT_ROLE

aws-cdp-ranger-audit-s3-policy

aws-cdp-bucket-access-policy

aws-datalake-backup-policy

aws-datalake-restore-policy

aws-cdp-dynamodb-policy (Runtime < 7.2.2)

aws-cdp-idbroker-role-trust-policy This role uses the four permissions policies to provide write access to the Ranger audit sub-directory that CDP creates within the Storage Location Base.

The aws-cdp-dynamodb-policy is only required when using Runtime < 7.2.2.

The trust policy allows the role to be assumed by IDBroker.

The aws-datalake-backup-policy is required for both upgrading a Data Lake and backing up a Data Lake.

The aws-datalake-restore-policy is required for both upgrading a Data Lake and restoring a Data Lake backup.

Draft comment:
added line about backup policy, added restore policy
DATALAKE_ADMIN_ROLE

aws-cdp-datalake-admin-s3-policy

aws-cdp-bucket-access-policy

aws-datalake-backup-policy

aws-datalake-restore-policy

aws-cdp-dynamodb-policy (Runtime < 7.2.2)

aws-cdp-idbroker-role-trust-policy This role uses the four permissions policies to provide the Data Lake admin with full access to the whole Storage Location Base.

Additionally, if you choose to configure Fine-grained access control, RAZ uses this role to orchestrate the access control.

The aws-cdp-dynamodb-policy is only required when using Runtime < 7.2.2.

The trust policy allows the role to be assumed by IDBroker.

The aws-datalake-backup-policy is required for both upgrading a Data Lake and backing up a Data Lake.

The aws-datalake-restore-policy is required for both upgrading a Data Lake and restoring a Data Lake backup.

Draft comment:
added line about backup policy, added restore policy

The following diagram summarizes the roles, policies, and S3 bucket directories in this example setup:



Draft comment:
see email for new diagram
Use the following documentation in order to create the required S3 bucket and IAM resources, and provide them in CDP. The steps involve:
  1. Creating an S3 bucket if you don't have one already
  2. Creating permissions policies for the minimal setup
  3. Creating the required IAM roles and their associated trust policies
  4. Providing the parameters in the CDP UI

Create an S3 bucket

You need to provide an S3 location that CDP can use for logs and data storage. If you don't already have an S3 bucket, you can create one from the AWS S3 console or AWS CLI.

Steps

  1. In the AWS web interface, navigate to the S3 console.
  2. Click on Create bucket.
  3. Enter bucket name.
  4. Select the region where the bucket should be created.
  5. Edit additional settings if needed. For example:
    • Enable encryption
    • Add tags if required by your organization.
  6. Click on Create bucket.
Use the following command to create an S3 bucket:
aws s3api create-bucket --bucket <BUCKET-NAME>

See AWS documentation linked below for more information.

Create permissions policies for the minimal setup

You need to create permissions policies that can be assigned to specific roles required by CDP. You can create these IAM permissions policies from the AWS IAM console or AWS CLI.

Before you begin

Obtain the relevant IAM policy definitions from IAM policy definitions. You need to replace all the placeholders in the policy with actual values.

Steps

  1. In the AWS web interface, navigate to the AIM console.
  2. From the navigation pane, select Policies and then click on Create Policy
  3. Choose the JSON tab.
  4. Paste the appropriate JSON policy document.
  5. Click Next.
  6. Add tags if required by your organization.
  7. Click Next.
  8. Type a Name and an optional Description.
  9. Click Create policy.
Use the following command to create permissions policies:
aws iam create-policy --policy-name <NAME> --policy-document <JSON-DOCUMENT> 

Repeat these steps for all permissions policies that need to be created. For more detailed instructions on how to create IAM policies, refer to the AWS documentation linked below.

Create the IAM roles and establish trust relationships: IDBROKER_ROLE and LOG_ROLE

You can create the IDBROKER_ROLE and LOG_ROLE IAM roles from the IAM console or AWS CLI.

Before you begin

Review the minimal setup for cloud storage outlined above and make sure that you understand which policies you need to attach to which roles.

Steps

  1. In the AWS web interface, navigate to the IAM console.
  2. From the navigation pane, select Roles.
  3. Click on Create Role.
  4. Under "Select type of trusted entity" select AWS service.
  5. Under "Choose a use case" select EC2.
  6. Click Next.
  7. Attach the permissions policies required for the role that you are creating. Make sure to attach all required policies.
  8. Click Next.
  9. Add tags if required by your organization.
  10. Click Next.
  11. Provide a name and an optional description for your role, and verify that you have attached all required permissions policies.
  12. Click on Create role. This creates an IAM role and instance profile.
  13. Click on the role to see its details.
  14. Verify that the "Instance Profile ARN" is present:
  15. Click on the Trust relationships tab.
  16. Click on Edit trust relationship.
  17. Verify that the JSON declaring a trust policy is the same as described in the minimal setup. If it isn't, replace it with the correct trust policy definition.
  18. Click on Update trust policy.

Repeat these steps to create both roles.

Use these commands to create the required IAM roles and instance profiles via AWS CLI:

aws iam create-role --role name <ROLE-NAME> --assume-role-policy-document <TRUST-POLICY>
aws iam attach-role-policy --role name <ROLE-NAME> --policy-arn <PERMISSIONS-POLICY-ARN> 
aws iam create-instance-profile --instance-profile-name <IP-NAME>
aws iam add-role-to-instance-profile --instance-profile-name <IP-NAME> --role-name <ROLE-NAME>

You should assign the appropriate policies described in the minimal setup. Note that the aws iam attach-role-policy command needs to be executed separately for each policy that needs to be attached.

Create the IAM roles and establish trust relationships: RANGER_AUDIT_ROLE and DATALAKE_ADMIN_ROLE

Use the following steps to create the RANGER_AUDIT_ROLE and DATALAKE_ADMIN_ROLE.

Before you begin

Review the minimal setup for cloud storage outlined above and make sure that you understand which policies you need to attach to which roles.

Steps

  1. In the AWS web interface, navigate to the IAM console.
  2. From the navigation pane, select Roles.
  3. Click on Create Role.
  4. Under "Select type of trusted entity" select Another AWS account.
  5. Under "Account ID", enter your AWS account ID. You can obtain it by clicking on your user name in the top bar.
  6. Click Next.
  7. Attach the permissions policies required for the role that you are creating. Make sure to attach all required policies described in the minimal setup
  8. Click Next.
  9. Add tags if required by your organization.
  10. Click Next.
  11. Provide a name and an optional description for your role, and verify that you have attached all required permissions policies.
  12. Click on Create role. This creates an IAM role. No instance profile is created in this case.
  13. Click on the role to see its details.
  14. Click on the Trust relationships tab.
  15. Click on Edit trust relationship.
  16. Paste the JSON declaring a trust policy in place of the default policy. Use the appropriate policy described in the minimal setup.
  17. Click on Update trust policy.

Repeat these steps for both roles.

Use these commands to create the required IAM roles via AWS CLI:

aws iam create-role --role name <ROLE-NAME> --assume-role-policy-document <TRUST-POLICY>
aws iam attach-role-policy --role name <ROLE-NAME> --policy-arn <PERMISSIONS-POLICY-ARN> 
Note that the aws iam attach-role-policy command needs to be repeated if there are multiple policies to attach. You should assign the appropriate policies described in the minimal setup.

Providing the parameters in the CDP UI

Once you’ve created the S3 bucket and the required IAM policies, roles, and instance profiles, provide the information related to these resources in the Register Environment wizard.

Parameter

Description

Example
Data Access and Audit
Assumer Instance Profile Select the IDBROKER_ROLE instance profile created earlier during IDBROKER_ROLE role creation. IDBROKER_ROLE
Storage Location Base Enter the Storage Location Base S3 bucket location created earlier. my-bucket/my-dl
Data Access Role Select the DATALAKE_ADMIN_ROLE created earlier. DATALAKE_ADMIN_ROLE
Ranger Audit Role Select the RANGER_AUDIT_ROLE created earlier. RANGER_AUDIT_ROLE
Logs
Logger Instance Profile Select the LOG_ROLE instance profile created earlier during LOG_ROLE role creation. LOG_ROLE
Logs Location Base Enter the Logs Location Base S3 bucket location created earlier. my-bucket-/my-dl
Backup Location Base (Optional) If you created it, enter the Backup Location Base S3 bucket location. This is optional. If you don't provide this, FreeIPA and Data Lake backups will be stored in the Logs Location Base. my-bucket-/my-dl