<aside> 💡 Part of the Dataland Learning Roadmap

</aside>

Objective

This guide walks through how to deploy a module from your local machine to your Dataland Cloud workspace.

By the end of this guide, you’ll be able to deploy modules from the Dataland module examples repository (https://github.com/dataland-io/dataland-examples), which has modules like Postgres Sync, MySQL Sync, Airtable Sync, Stripe Sync, etc.

Prerequisites

• You have a Dataland workspace. (To complete this, go to this link and follow steps 1-4).
• Make sure that you’re on the latest version of the Dataland CLI! Upgrade to the latest version by running brew update && brew upgrade in your terminal.

Instructions

Method 1: Publish the module via CLI, then install module in the Dataland UI

Video tutorial

https://www.youtube.com/watch?v=qwUonbkZ0uM

<aside> 💡 Note: These instructions show how you can deploy the Airtable module from the Dataland examples repo. The same instructions work for other modules as well. Just run steps 1-4 under the module subdirectory, i.e:

• **Postgres Sync - dataland-examples/postgres-sync**
• **MySQL Sync - dataland-examples/mysql-sync**
• **Stripe Sync - dataland-exampels/stripe-fetch** </aside>

Written tutorial

1. Grab the code for the Airtable module by running the below commands in your terminal.

   git clone <https://github.com/dataland-io/dataland-examples>
   cd dataland-examples/airtable-table-sync
   npm install
   

   You’ll see that the Airtable module is stored as a subdirectory called airtable-table-sync in the dataland-examples folder.

2. Configure the Dataland CLI with your secret access key, and select the workspace you’re working in:

   dataland config init
   

   If you need to get a new access key, go to this link and follow steps 1-4 first.

3. Run the following command:

   # From the /airtable-table-sync folder
   dataland module build && dataland module publish
   

   On success, you’ll see this at the end of the response in your terminal:

   module publish successful: airtable-table-sync (af3d5c7a8b89d1affe669c1ed275682f12a0c27afd2bd899ae5b6a4f3d397b9e)
   

4. In the UI, navigate your Dataland workspace, and click on the “Modules” icon. You’ll see that your Airtable module will be published. NOTE: You may need to refresh the page first.

   

5. Click on the Airtable module, and then click Install. You’ll need to provide several required parameters. Parameter descriptions are in the Readme on the right of the page.

Complete the form, and then hit the Install button again to complete the module deployment.