Skip to main content

Crawl Aiven Kafka

Once you have configured the Aiven Kafka permissions, you can establish a connection between Atlan and Aiven Kafka.

Offline extraction sunset

The offline extraction method has been sunset and is no longer available. For on-premises or network-restricted environments, use the Agent extraction method with Self-Deployed Runtime.

To crawl metadata from Aiven Kafka, review the order of operations and then complete the following steps.

Select source​

To select Aiven Kafka as your source:

  1. In the top navigation, click Marketplace.
  2. Search for Aiven Kafka Assets and select it.
  3. Click Install.
  4. Once installation completes, click Setup Workflow on the same tile.

If you navigated away before installation completed, go to New > New Workflow and select Aiven Kafka Assets to proceed.

Configure connection​

To complete the Aiven Kafka connection configuration:

  1. Provide a Connection Name that represents your source environment. For example, you might use values like production,development,gold, or analytics.

  2. (Optional) To change the users who are able to manage this connection, change the users or groups listed under Connection Admins.

    warning

    If you don't specify any user or group, no one can manage the connection - not even admins.

  3. Navigate to the bottom of the screen and click Next to proceed.

Configure crawler​

Before running the Aiven Kafka crawler, you can further configure it.

On the Metadata page, you can override the defaults for any of these options:

  • To select the assets you want to exclude from crawling, click Exclude topics regex. (This defaults to no assets, if none specified.)
  • To select the assets you want to include in crawling, click Include topics regex. (This defaults to all assets, if none are specified.)
Did you know?

If an asset appears in both the include and exclude filters, the exclude filter takes precedence.

Run crawler​

To run the Aiven Kafka crawler, after completing the previous steps:

  1. To check for any permissions or other configuration issues before running the crawler, click Preflight checks.
  2. 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, the assets appear on Atlan's asset page! 🎉