Skip to main content

Set up Dremio

Configure your Dremio instance to enable Atlan to connect and crawl your data lakehouse assets. This guide covers creating service accounts, setting up authentication, and configuring network access.

Prerequisites​

Before you begin, make sure you have:

  • Admin access to your Dremio instance
  • Dremio version 4.0 or later with REST API enabled
Version Requirement

Dremio version 4.0 or later is required for the Atlan connector to function properly. This version includes the necessary REST API endpoints and features that the connector relies on.

  • Valid SSL certificate configured on your Dremio instance (required for HTTPS connections)
  • Network connectivity from Atlan to your Dremio instance:
    • Host: Your Dremio server hostname or IP address

Create service account​

Create a dedicated service account and configure authentication for Atlan to access your Dremio instance.

  1. Log in to your Dremio instance as an administrator.

  2. Navigate to Admin → Users → Add User.

  3. Create a dedicated service account for Atlan:

    • Username: atlan-service
    • Email: [email protected]
    • Password: Generate a strong password
    • Role: Assign User role

  4. Navigate to Admin → Advanced → Security.

  5. Enable REST API access:

    • Check Enable REST API
    • Set REST API Port to 443 (Dremio Cloud) or 9047 (Dremio on-premises)

Grant permissions to user​

Grant the atlan-service user appropriate permissions to access the data sources and spaces you want to crawl.

  1. In Dremio, navigate to Admin → Users → atlan-service.

  2. Assign appropriate permissions:

    • Data Sources: Read access to all data sources you want to crawl
    • Spaces: Read access to spaces containing your datasets

  3. For each data source you want to crawl:

    • Navigate to the data source settings
    • Add atlan-service user with Read permissions
    • Verify the user can access all required schemas and tables

Choose authentication method​

Dremio supports multiple authentication methods for API access. Choose the method that best fits your security requirements:

Basic Authentication - Use the service account credentials directly.

  1. In Dremio, navigate to Admin → Users → atlan-service
  2. Verify the user account is active and has appropriate permissions
  3. Use the atlan-service username and password created earlier
  4. This method is suitable for development and testing environments

Next steps​