Data Catalog Project Setup Alpha

This guide shows you how to set up your project containing the definitions of your Data Catalog resources.

Overview

In the context of the Rudder CLI tool, a data catalog project typically consists of a root directory that contains all the project files. Within this root directory, each YAML file can contain definitions for resources of a particular type, for example, events, properties, custom data types, and tracking plans.

The location and naming of these YAML files is flexible, as you can store the YAML files anywhere within the project’s root directory or subdirectories.

Set up your project

The Rudder CLI tool expects the Data Catalog resources to be described in YAML files present in your system.

If you’re working with a Unix-compatible shell, run the following command to create a tutorial-catalog folder in your home directory, which you can use to populate the Data Catalog resources as YAML files:

mkdir ~/tutorial-catalog

The Rudder CLI tool automatically processes all valid YAML files within the project structure to recognize the defined resources.

Next steps

• Create events
• Create properties
• Create custom types

See Data Catalog YAML Reference for the detailed YAML spec containing the definitions of these Data Catalog resources.

Questions? Contact us by email or on Slack