Skip to main content

Crawl Soda

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

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

Select the source​

To select Soda as your source:

  1. In the top navigation, click Marketplace.
  2. Search for Soda 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 Soda to proceed.

Provide your credentials​

To enter your Soda credentials:

  1. For Host Name, enter the hostname or base URL of your Soda instance to connect to the Soda APIs - for example, cloud.soda.io, cloud.us.soda.io, or demo.soda.io.
  2. For Authentication, API Key Authentication is the default selection.
  3. For API Key ID, enter the API key ID you copied.
  4. For API Secret, enter the API secret you copied.
  5. Click the Test Authentication button to confirm connectivity to Soda.
  6. Once authentication is successful, navigate to the bottom of the screen and click Next.

Configure the connection​

To complete the Soda 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 do not specify any user or group, no one will be able to manage the connection - not even admins.

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

Configure the crawler​

Before running the Soda crawler, you can further configure it.

  1. On the Metadata page, you can override the defaults for any of these options:
  • To select the assets you want to include in crawling, click the Include filter. (This will default to all assets, if none are specified.)
  • To select the assets you want to exclude from crawling, click the Exclude filter. (This will default to no assets, if none specified.)
  1. (Optional) For Advanced Config, keep Default for the default configuration or click Custom to configure the enrichment:
    • To map Soda metadata enrichment to assets from specific connections only, for Include Connections, specify the connections in Atlan, or leave it blank to include all connections. If you have specified any connections, Atlan will map Soda checks only to the assets included in those connections.
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 Soda crawler, after completing the steps above:

  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, you will see the assets on Atlan's asset page! 🎉