Skip to main content

Dry run functionality and validation in the toolkit

  • May 12, 2025
  • 3 replies
  • 54 views
S
Committed

Hi

I am looking into using the toolkit more actively for deploying resources to CDF. One question that was raised when researching how to use the toolkit is what kind of validations actually happens when doing a dry run for deploying data modeling resources. 

I do not really have any specific issue I want answered, but rather want to learn more about the tool so prepare for a lot of questions from my notes:)

Does it test that the configuration of views and containers work together?

Does a successful dry run mean that I can be sure that the deployment will always work?

Are there anything I need to consider even after getting a successful dry run?

What kind of responses do I get if the dry run finds that something is wrong? Do I get any hints about how to fix an issue?

Does it consider what is already deployed into the CDF environment?

Will it tell me about any issues that can happen with new breaking changes?

 

Appreciate all kinds of insights and experiences around this topic :)

Sebastian

Mithila Jayalath
H

3 replies

Anders Albert
Seasoned Practitioner
Forum|alt.badge.img
  • Anders Albert
  • Seasoned Practitioner
  • May 12, 2025

Dry-run compares CDF to the resources you are about to deploy. It classifies them as either create (does not exist in CDF), unchanged (it is identical to what is in CDF) and changed (there is a deviation between CDF and local - can be printed with a --verbose flag). 

When running deploy Toolkit does not validate anything other than the resources follows the spec in the API. In the build command Toolkit validate your local YAML files and gives warning if there are potential issues with the warning that may cause issues with deployment.

When it comes to data modeling, we do not do anything extra validation there. This is a complex API and there is, for example, tool like neat, https://thisisneat.io/, that is dedicated to validating data models in CDF.

 

S
S
Committed

Thanks, this clarifies a lot:) If I would use neat, could I read the toolkit yaml files with the YamlReadAPI and get some additional validation features?

Anders Albert
Seasoned Practitioner
Forum|alt.badge.img
  • Anders Albert
  • Seasoned Practitioner
  • May 12, 2025

Yes, Neat and Toolkits are compatible. Neat can also produce the YAML files that Toolkit expects. 

Terms & ConditionsCookie SettingsAccessibility statement