Skip to content

Call Ingredients from Kitchen Wizard

With an ingredient variation declared, you can call it:

  • During kitchen creation or kitchen deletion.
  • Within a variation, or from other recipes, as a recipe ingredient node.

Most often, ingredients are called during kitchen creation and deletion processes to create infrastructure for a kitchen, then later delete that infrastructure with kitchen teardown.

Prerequisites

  1. The ingredient must be declared.

Warning

2. The kitchen wizard must be configured from the command line.

Ingredients must be added to the wizard before they can be used in the kitchen creation and deletion processes. A user with the appropriate access must update the kitchen-settings.json file from the command line.

See Kitchen Settings for more information.

Note

3. Ingredients reside in specific kitchens for creation and deletion.

  • Ingredient variations intended for use in the create kitchen process must exist in recipes in the parent kitchen so they can be copied and used when creating the child kitchen.
    • Note that the ingredients run in the child kitchen during the create process, not in the parent kitchen.
  • Ingredient variations that will run during the delete kitchen process must exist in the kitchen being deleted.

Use an ingredient when creating a kitchen

  1. Start the process to create a kitchen. Do not click Skip Optionals.
  2. In Step 4: Select Ingredients, select an ingredient from the list.
  3. Check Run this ingredient.

    Note, ingredients can be configured as mandatory. In that case, the checkbox will be pre-checked and not editable.

  4. Enter information in any fields present for inflowing variables. Required fields must be completed.

  5. Optional. Repeat this process to select and run additional ingredients.
  6. Click Next and finish the kitchen creation process.

Visual example in Automation

(Screenshot of create kitchen step 4)

Use an ingredient when deleting a kitchen

  1. Start the process to delete a kitchen.
  2. In the Delete Kitchen wizard, check Select ingredients to run during the delete kitchen process.
  3. Click Next until the Execute Rollback step.
  4. Select an ingredient you want to run during the kitchen delete, then check Run this ingredient.

    Note, a rollback ingredient associated with a mandatory create-kitchen ingredient is marked as mandatory during the delete process.

  5. Optional. Repeat as needed for other ingredients.

  6. Click Next and finish the kitchen delete process.

Visual example in Automation

(Screenshot of delete kitchen execute rollback)

Kitchen role requirements

Kitchen roles is a feature that uses custom roles to define kitchen access on a per-user level.

To call ingredients from the kitchen wizard, a user must have the appropriate permissions assigned to their role.

  • Create kitchen: the user must have the permissions Run orders and Edit kitchen override variables in the kitchen being created.
  • Delete kitchen: the user must have the permission Run orders on the kitchen being deleted.