Declare Ingredients

The first step required to use any ingredient is to declare a recipe variation as an ingredient variation.

Declare an ingredient variation

From the Recipes page

1. Click for the relevant variation.
2. Select Edit.
3. Check Use variation as ingredient.
4. Enter a name for the ingredient in the Ingredient Title field.
5. Select Add notes for changelog , describe the changes, then click Update.
6. Optional. Add ingredient details:
   1. Select the variation name to open the Variation page.
   2. Select the Ingredient Settings tab.
   3. Enter a description.
   4. Select a rollback ingredient.
   5. Add inflowing variables.
   6. Add outflowing variables.
7. Select Add notes for changelog , describe the changes, then click Update.

From the Variation page

1. Select the Ingredient Settings tab.
2. Check Use variation as ingredient.
3. Enter a name for the ingredient in the Ingredient Title field.
4. Optional. Add ingredient details:
   1. Enter a description.
   2. Select a rollback ingredient.
   3. Add inflowing variables.
   4. Add outflowing variables.
5. Select Add notes for changelog , describe the changes, then click Update.

Considerations and details

• The only required field when creating an ingredient is the Ingredient Title. Ingredient details are optional, though recommended.
  • The ingredient title is stored in the variations.json file as the value for "short-description".
  • The ingredient title is used only for display in the UI and is not referenced by the system. The system references the ingredient-definition and ingredient-name values stored in variations.json. These values are derived from the name of the variation and must always match each other. Do not change the value in these two fields, because any edit will break all references to the ingredient wherever it is used including when the ingredient is called from ingredient nodes or used in a create kitchen process.
• A description is useful when selecting ingredients to use during the create kitchen process.
• If the ingredient variation runs during the kitchen creation process, a rollback ingredient can be used to reverse the action during the kitchen deletion process. The rollback ingredient must be another ingredient variation in the same recipe.
  • If the create-kitchen ingredient is set as mandatory, its associated rollback ingredient will also be mandatory during the delete process. See Kitchen Settings for more information.
• You can build an ingredient so that it performs a reversible action, like creating an AWS Redshift schema. The reversed action to remove the schema can be built into another Ingredient. These two ingredients can be coupled by defining the second ingredient as the first's rollback ingredient.
• If the ingredient is used during the create kitchen process, these variables are included as fields for user entry. You can set any inflowing variable as required. See Inflowing Variable Validations for more information.
• Outflowing variables are variables produced when an ingredient runs.
• When declaring a recipe variation as an ingredient, ensure that the variation's schedule is set to run once (in variations.json, the setting is "schedule": "now"). Ingredients with cron settings may not execute properly when called from other variations. Other schedule settings for providing adequate RAM and disk space for the ingredient to run or for annotations are approved for ingredient variations

Next steps

Now that the recipe variation has been declared as an ingredient, it can be reused within another variation by referencing it in an ingredient node or during the kitchen create or delete process.

Continue with Call Ingredients from Recipe Nodes for use within a variation or Call Ingredients from Kitchen Wizard for the create/delete process.