Surveys for job templates and workflows, and how to use them
Surveys are a way to capture user input for job templates and workflows. Each question has a set variable that is populated for use by playbooks. This is also useful when users are using the API, roles, or modules. Surveys allow users to input fields as extra variables into the job. When using only surveys this limits users to only the extra variables defined in the survey. Those fields must match the data type set in the survey, which adds a level of data validation. With that capability in mind, the next section reviews how to define surveys.
Survey definitions
The top-level options for surveys in modules and roles for job templates and workflows are the following (survey_spec
):
name
: The name of the survey – this does not show up in the GUI.description
: The description of the survey – this does not show up in the GUI.spec
: A list of survey questions.
All three of these are required...