<aside> đź’ˇ Part of the Dataland Learning Roadmap

</aside>

Objective

This guide walks through how to install a built-in module in the Dataland UI.

Prerequisites

Instructions

  1. Login to your Dataland workspace, and click on the modules icon on the lefthand sidebar. You’ll see several available built-in modules. At the time of writing, it shows three — postgres-replicator, Postgres, and MySQL.

    CleanShot 2022-11-29 at 17.39.34.gif

  2. To install a module, click on the blue Install button.

    Untitled

  3. Fill out the installation form with the required parameters. Usually, you can read the Readme on the righthand side to understand what the parameter are.

  4. The module will running immediately on Install. If the module does any sort of data sync, then you should see new tables appear back in the Data tab of Dataland.

    Untitled

  5. If you don’t see any new data, this usually means that you configured the module incorrectly, or that Dataland can’t establish a connection with your external data source.

    <aside> 💡 If you’re using Dataland’s built-in modules to connect to a database in your own private VPC, you may need to additionally Dataland IPs — see https://docs.dataland.io/guides/worker-ip-addresses.html

    </aside>

    Looking at the logs here is most helpful. To do this, first make sure that you’re authenticated to your workspace (follow steps 1-4 here), and then run the command dataland tail in your terminal.

  6. If you need to change the parameters used or reinstall the module, you can go back to the modules page, click Edit → Uninstall module on the individual module page, and the re-install the module.