Once you have configured the Amazon MSK permissions, you can establish a connection between Atlan and Amazon MSK. (If you are also using a private network for Amazon MSK, you will need to set that up first, too.)
To crawl metadata from Amazon MSK, review the order of operations and then complete the following steps.
Select the source
To select Amazon MSK as your source:
- In the top right of any screen in Atlan, navigate to +New and click New workflow.
- From the Marketplace page, click Amazon MSK Assets.
- In the right panel, click Setup Workflow.
Provide credentials
To enter your Amazon MSK credentials:
- For Extraction method, Direct is the default selection.
- For Bootstrap servers, enter the hostname(s) (or PrivateLink cluster connection string) of your Amazon MSK broker(s) — for multiple hostnames, separate each entry with a comma
,or semicolon;. - For Authentication, IAM Role is the default authentication method.
- For Deployment Type, Provisioned is the default deployment type.
- For Security protocol, SASL_SSL is the default security protocol.
- For AWS Role ARN, enter the ARN of the IAM role you created in your AWS account.
- For AWS Region, enter the AWS region of your Amazon MSK cluster.
- Click the Test Authentication button to confirm connectivity to Amazon MSK.
- Once authentication is successful, navigate to the bottom of the screen and click Next.
Configure the connection
To complete the Amazon MSK connection configuration:
- Provide a Connection Name that represents your source environment. For example, you might use values like
production,development,gold, oranalytics. - (Optional) To change the users who are able to manage this connection, change the users or groups listed under Connection Admins.
🚨 Careful! If you do not specify any user or group, no one will be able to manage the connection — not even admins.
- Navigate to the bottom of the screen and click Next to proceed.
Configure the crawler
Before running the Amazon MSK crawler, you can further configure it.
On the Metadata page, you can override the defaults for any of these options:
- For Skip internal topics, keep the default option Yes to skip internal Apache Kafka topics or click No to enable crawling them.
- To have the crawler ignore topics based on a naming convention, specify a regular expression in the Exclude topic regex field.
- To have the crawler include topics based on a naming convention, specify a regular expression in the Include topic regex field.
💪 Did you know? If an asset appears in both the include and exclude filters, the exclude filter takes precedence.
Run the crawler
To run the Amazon MSK crawler, after completing the steps above:
- To check for any permissions or other configuration issues before running the crawler, click Preflight checks.
- You can either:
- To run the crawler once immediately, at the bottom of the screen, click the Run button.
- To schedule the crawler to run hourly, daily, weekly, or monthly, at the bottom of the screen, click the Schedule & Run button.
Once the crawler has completed running, you will see the assets on Atlan's asset page! 🎉