Skip to main content

Getting started

Let's take a look at how you can start your journey by creating a Data Product in Witboost.


As this is only an introductory overview, you do not need to take any action during this walkthrough. But in general, to start using the platform, you should already:

  • Be able to log in to Witboost through your credentials or authentication provider
  • Have configured Git credentials in your settings OR a global access token has been configured for all Witboost users
  • Have at least one Domain defined in the platform

Creating your first Data Product

To create a Data Product, we start with the Builder module

  1. Go to Builder > Templates to get the list of available Builder templates.

Witboost Menu

  1. Choose the Data Product template. this is the most important template in Witboost, and you will always find it in the list.

Templates page

  1. Fill the form with the information required, by following the wizard. If you have doubts about how to fill Choose a location section, you can take a look here

Template Data Product wizard

  1. At the end of the wizard, you can review some of the information filled in the fields. Let's click on Create. This will start the scaffolding process that will create a new repository will all needed files.

Detailed information about each field can be found on the Data Product Specification page

Remember that you are not required to fill in all the metadata right away, since you can always edit it later:

  • by using the edit wizard if defined;
  • by accessing the catalog-info.yaml file directly from the repository and edit it there.

Details can be found on Update Data Product Metadata page

The data product is now listed on the My Data Products page. When opening its details page, you should be able to see its generic information, and the dependencies between that entity and the other ones (e.g. domain, user, etc).

Creating Output Ports for the Data Product

Let's make the Data Product consumable by other domains and users. We will do so by creating an output port.

  1. Get back to the list of templates by clicking on Builder > Templates. From there, select any of the listed templates. For the sake of the example, we will select Dremio SQL Output Port.

Templates selection

  1. Again, let's fill in all the needed information, as we did before. This time, make sure to link the Output Port to the right Data Product:

Link component

  1. After following all the steps in the wizard, click on Create

If you now go back to your Data Product (Builder > My Data Products > <Your Data Product>), you will see in the Components panel that there will be an Output Port attached to it. In our case, this Output Port will be a Dremio SQL Output Port:

Relations panel

In the example shown in the picture, there were already other components attached to the data product.


If you need to import metadata from an infrastructure service like AWS into your output port, the Reverse Provisioning feature provides a convenient solution. It enables you to effortlessly integrate the desired metadata, potentially saving you a significant amount of time. You can find more information about it in the Reverse Provisioning documentation.

Test the Data Product

After implementing all necessary logic, configurations, and documentation, it's now time to set up our first Data Product for deployment.

We may also want to get a full descriptor preview and eventually check if the Data Product is compliant with all the governance policies defined in the platform.

Let's start by taking a look at a full preview descriptor, to do so:

  1. Go to Builder > My Data Products > <Your data product> > Edit and Test tab
  2. Select a target environment, for this example, we want to deploy our Data Product in our development environment
  3. After selecting an environment you will see the full preview descriptor in the Editor panel:

preview descriptor

On the left, you can see the structure of the Data Product, with all its components.

If you didn't notice any typos or errors in the descriptor, it's time to test it against governance policies!

To do so, open the Test panel on the right:

  1. Click on the Test button and let's see the results:

policies all ok

In our case, all the tests performed are OK! Great.

This means our Data Product is compliant with our organization's Governance Policies and we can proceed to the Deploy step.

If instead there is any failing check, you will notice a red mark describing the status of the test. To inspect the error, click on the test and you will get a list of policy checks performed. The policy checks marked in red as KO means they failed. For each one, click on the failing check to get the details of the error, then fix it.

Deploying the Data Product

To deploy a Data Product, you will first need a deployment unit: a Release.

Let's see how we can do so and finally deploy our Data Product:

  1. Still from the Edit and Test tab (Builder > My Data Products > <Your data product> > Edit and Test)

  2. Check if the Data Product is ok (by looking at the descriptor and by testing it)

  3. In the Deployment panel, click on New Draft Release. This will create a new draft release right away:

new snapshot

  1. Now you can see the newly created release in the same tab

  2. Now you can try to deploy it and see if everything works: click on the menu of the release and select Deploy. Then choose the desired environment for the deployment: this will start the deployment operation, and redirects you to the release detail page

deploy button

In the deployment section, some circles will appear: each circle represents the deployment status of a step (initialization, finalization, provisioning for each component, including the data product itself, etc)

deploy running

  1. If everything goes right, you will see all circles turning green, with a checkmark.

deploy success

If the deployment is successful, the data product gets published to the marketplace, and it's available to be consumed by other domains: you can click on the link that appears on the About card to see it on the marketplace directly.

If you are not happy with your current release of the Data Product, or you deployed something misconfigured, or simply you want to change some logic, you will need to first make changes on the components or to the data product itself, then, you should update the deployment unit before deploying it again. To update the release, just make your changes, and then click on Update draft release.

If you want more details about releases and update operations, take a look at the deployment guide

Consuming Data Products

We have briefly seen how to build and work with a Data Product from scratch. Then we understood that after a deployment is performed, our data product is published in the marketplace to be consumed by other data teams within the organization.

How can we consume a Data Product in witboost?

To do so, we will use the Marketplace module:

  1. Go to Marketplace > Data Product Catalog. This page contains a list of all published Data Products within the organization. You can filter them by environment or by typing some search keywords in the top-right corner.

Marketplace catalog


  1. Go to Marketplace > Data Product Graph. The graph visualization shows all relationships between the data products published within your organization.

Marketplace graph

  1. Click on the data product you are interested in. In this example, we will consider the Finance Customer data product for the production environment.

marketplace dp page

From this page, you will have a set of useful information like general information, dependencies, reviews, questions and answers and available output ports.

We are interested in consuming this data product. Let's get some information about the available output ports. To do so:

  1. Scroll down to the Output Ports panel, here you will see the list of available output ports for the data product.

list of output ports

  1. To get some details on any output port, just click on it. You will land on the output port's details page, with some insightful information.

details page

  1. We decided to consume this output port. To do so, let's request access to it, by clicking on the Request access button:

access request

  1. You will be prompted to insert some data to let the Data Product owner be able to grant access to you or your team in case the request is accepted:

access request modal

  1. Click Send to finalize the request!

Visualizing our Data Mesh

Graph visualization

The marketplace module gives you the possibility to visualize, in the form of a Graph, all relationships between data products published in the Marketplace. This graph visualization is available in Marketplace > Data Product Graph.

Marketplace graph

Each node of the graph represents a data product. Each circle, instead, is a domain. A circle can then contain other circles (i.e. sub-domains) or nodes (i.e. data products).

As you can notice, no relationship is represented in the graph yet, hence there is no edge connecting one or more nodes.

Now, click on any node:

nodes relationships

In the example image, Customer Invoice shows that it consumes an output port from Power Generation Plant and one from Finance Customer, while it is consumed by Global Customer. This underlines a possible circular dependency between the two that should be investigated further.

Meanwhile, the navigation panel on the right side, helps us to now lose track of where we are when navigating the graph visualization.

Mesh Supervision

Mesh Supervision is another tool to inspect how Data Mesh is going inside our organization. It provides a dashboard for the board of directors to make informed decisions through the visualization of KPIs. As well as to inform the Platform Team about the quality that Data Teams are bringing into the Data Mesh. Mesh Supervision can be found in Marketplace > Mesh Supervision.

mesh supervision