KPD closed beta Sign inRequest access

Quick start: your first pipeline

Build a small change-data-capture pipeline, check it and export it. It takes about ten minutes.

Want the full tour?The Hello World tutorial goes further, step by step with pictures: domains, environments, governance, access, data quality, exports and notes, on one small data product pipeline.

You will design: a PostgreSQL CDC source writing to an orders topic, a Flink SQL statement that enriches the orders, an output topic, and a Snowflake sink with a dead letter topic for its failures.

1. Create a project

  1. Choose File → New project…
  2. Type a project name; it is the only required field. Add the client if you like.
  3. Keep Blank project for this tutorial. (Data Product (DPCF) starts you with governance tags, a naming rule and a three-layer pipeline.)
  4. Optionally add a Kafka cluster (environment, name, type, cloud, region) and a Flink compute pool. You can add them later from the explorer.
  5. Choose Create project. KPD creates the project folder.
  6. A new blank project opens in Storyboard mode, for sketching the story first. This tutorial builds the pipeline itself, so click Engineer at the far left of the toolbar, then New pipeline, and give it a name.
The New project dialog. Only the name is required.
The New project dialog. Only the name is required.

2. Add the first assets

  1. A new pipeline opens with a Start your pipeline card. (To begin with the database itself, click Start from a system; see Starting from the system.) Click Add a source, type postgres and choose PostgreSQL CDC Source V2. (You can also drag it from the Palettes panel on the right.)
  2. Select it. A + appears beside its output: click it and choose Topic. KPD places the topic beside the source, already connected. This is quick add.
  3. With the topic selected, click its + and choose Flink SQL, then add a second Topic after the statement, and a Snowflake Sink after that.
  4. Select the sink: its red + is the error output. Choose Dead Letter to route failed records to a dead letter topic.
Quick add suggests what usually comes next, and only offers assets that can really connect.
Quick add suggests what usually comes next, and only offers assets that can really connect.

3. Describe the assets

Click an asset and use the properties panel underneath the canvas. Its tabs come from the asset's palette.

A topic selected: its warning badge, and the General tab in the properties panel.
A topic selected: its warning badge, and the General tab in the properties panel.

4. Check it

KPD validates continuously. Badges on assets and the count in the status bar show errors (red) and warnings (orange); the Problems tab lists them, and clicking one selects the asset. The toolbar Validate button checks the whole project, and says whether Terraform would generate. Typical first warnings: a topic name that doesn't match the naming rule, a topic without a schema, a pipeline without a cluster. See Properties and validation.

5. Save and export

  1. Save with Ctrl/⌘+S. Pipelines are files in the project's pipelines/ folder.
  2. Export PNG (toolbar) writes a transparent picture with a legend, ready for a document or slide.
  3. Export → Technical export gives a Markdown or CSV table of every asset and its settings.
  4. Export → Export to Detailed Design Template writes a full design document for the whole project.
  5. Once a cluster and its ids are set, Export → Terraform… generates the infrastructure as code.
TipPress D to add a design decision or A for an assumption while you design. They are numbered (D1, A1) so documents can cite them. See Design decisions and assumptions.