Set up DataStax Enterprise

🧪 Preview feature! This feature is currently in an experimental phase, and its functionality may change before the final release. We’d love your feedback to refine it. To request access to the DataStax Enterprise connector in your Metadata Marketplace, Atlan Secure Agent Installer, and Secure Agent documentation, create a ticket with Atlan Support.

🤓 Who can do this?

You need your DataStax Enterprise administrator or a user who has create role permissions to run these commands; you may not have access yourself. For more details, refer to the Apache Cassandra documentation on role-based access control.

This guide outlines the steps to configure your DataStax Enterprise instance so Atlan can crawl its metadata.

Prerequisites

Before you begin, ensure you have the following:

• Access to a DataStax Enterprise instance – You need the necessary credentials to connect to your Cassandra instance.
• cqlsh installed – The Cassandra Query Language Shell (cqlsh) is required to execute commands for user and permission management. If cqlsh is not installed, refer to the Apache Cassandra documentation for cqlsh.

Create an Atlan user role

This section guides you through creating a dedicated role in DataStax Enterprise for Atlan.

1. Connect to the DataStax Enterprise instance: Use cqlsh to connect to your DataStax Enterprise instance.

2. Create a dedicated role for Atlan: Run the following command in cqlsh to create a role.

   CREATE ROLE <username> WITH SUPERUSER = false AND LOGIN = true AND PASSWORD = '<password>';

   Replace the placeholders

   • <username>: The username for the Atlan role.
   • <password>: A strong and unique password.

Grant permissions to the Atlan user role

Atlan needs specific permissions to access metadata in DataStax Enterprise Follow these steps to grant the required permissions:

1. Grant DESCRIBE on all keyspaces with:

   GRANT DESCRIBE ON ALL KEYSPACES TO atlan-admin;

2. You may also choose to grant DESCRIBE permission on specific keyspaces by running the following command:

   GRANT DESCRIBE ON KEYSPACE <keyspace_name> TO <username>;

   Replace placeholders:

   • <keyspace_name>: The name of the keyspace.
   • <username>: The username for the Atlan role.

   Run this command for each keyspace you want Atlan to access.