Define Kitchen Override Variables

You can define a kitchen override variables set from the Configure Kitchen page or from the command line. These overrides do not appear within recipe files; they are maintained outside of version control. Note that child kitchens inherit kitchen-level variables.

Warning

Variables follow a hierarchy. Variables defined at the kitchen level override the same variables in both the recipe's base and override variable sets.

Variable requirements

• Variables larger than 1 MB in size are not supported.
• Variable names must adhere to DataKitchen's naming conventions. They are case-sensitive, can include alphanumeric and underscore characters, cannot start with numbers, and cannot contain hyphens or dashes.
  • Do not use the names reserved for system variables to define custom variables, as this can create conflicts and errors in recipes.

Add kitchen overrides

1. Use one of the following to navigate to the Configure Kitchen page:
   • From the Kitchens page, click Configure Kitchen next to a kitchen name.
   • From the Recipes page, click Configure Kitchen next to the kitchen name in the green navigation bar.
2. Select the Overrides tab.
3. Click Add Variable.
4. Enter a variable name, variable type, and value.
5. Optional. Repeat steps 3 and 4 to add more variables to the variable set.
6. Click Update.

Variables for secrets

Variables can be configured to include sensitive values. For example, toolchain credentials that have been stored securely as secrets. These variables are almost always defined at the kitchen level to support deployments to different environments using different infrastructures.

When defining variables with secret values, a special syntax is used: "key": "#{vault://connection/item}"

For example, in the case of the connection properties defined in kitchen-level variables for an MS SQL database source or sink, the password can be stored as: "password": "#vault://mssql/password}"

Visual example in Automation