Skip to content

Kitchen Settings

Certain kitchen configurations are governed by the kitchen-settings.json file, including the Create Kitchen wizard. This file is global to all kitchens within a customer account and is only accessible and editable via the command line for users with admin privileges.

Note

The underlying file for the kitchen wizard is only accessible and editable by authorized users in the DKCloudCommand interface. The UI does not provide this functionality. For more information, see the Kitchen Settings command.

Some settings in this file are no longer used and will be deprecated in future releases.

Access kitchen-settings.json

Authorized users can access the kitchen-settings.json file only using the command line.

Master kitchen alert recipients

Users can—and should—set kitchen-level alerts in the UI, either during the kitchen creation process or from the Alerts tab of the Configure Kitchen page.

It is also possible to set alert recipients for specific order run events in a master kitchen by adding values to the kitchen-settings.json file.

{
    "alerts": {
        "orderrunError": null,
        "orderrunOverDuration": null,
        "orderrunStart": null,
        "orderrunSuccess": null,
        "orderrunWarning": null
    },

Create kitchen wizard settings

Setting deprecation notice: The example below includes the settings that are currently active in this file. Several other keys may appear in the file but are unused. These include agile-tools, variablesets, deleteKitchen, mergeKitchenUp, and mergeKitchenDown.

The kitchenwizard object in kitchen-settings.json contains the keys for customizing the Create Kitchen wizard in the UI. An admin user can modify settings in the wizard to make specific global ingredients available during the create kitchen process in the Select Ingredient step of kitchen creation.

Ingredient substeps can be declared in this file, although rollback substeps are configured in the ingredient provider recipe's variations.json file. If you declare an ingredient for kitchen creation that is configured with a rollback ingredient, you do not need to add the rollback ingredient separately in this file.

  • name: sets the title for the create kitchen wizard.
  • id: system-defined ID.

  • steps: each step is a separate, selectable ingredient in the Create Kitchen wizard.

    These steps are ingredient calls. The order of these steps in the kitchen-settings.json file determines the order in which they appear in the Select Ingredient step of the create kitchen process.

    • params.ingredient: the ingredient to call. This field must match the value of the ingredient-definition field in the ingredient variation's variations.json file.
    • params.recipe: the recipe that contains the ingredient to call.
    • params.required: a Boolean value that sets an ingredient to mandatory (true) or optional (false, default) for the create kitchen process.

    Note

    Mandatory ingredients include rollbacks: If a create-kitchen ingredient is set to mandatory with "required": true and has an associated rollback ingredient, the delete kitchen process treats the rollback ingredient as mandatory.

Kitchen wizard settings in JSON file

{
    "kitchenwizard": {
        "variablesets": [],
        "wizards": [
            {
                "id": "createKitchen",
                "name": "Create A New Kitchen",
                "steps": [
                    {
                        "params": {
                            "ingredient": "ingredient-create-cluster",
                            "recipe": "ingredient-provider-recipe"
                        }
                    },
                    {
                        "params": {
                            "ingredient": "ingredient-create-schema",
                            "recipe": "ingredient-provider-recipe",
                            "required": true
                        }
                    }
                ]
            }
        ]
    }
}

Kitchen backup configuration

Feature deprecated: The Kitchen Backup feature has been removed. The JSON "backup" object in legacy kitchen settings is no longer functional.