packstack/releasenotes/notes/add-parameter-messages-47d9cf6996f58230.yaml
Alfredo Moralejo ceeefe64ad Add options to display parameter specific messages
This patch introduces MESSAGE and MESSSAGE_VALUES to
parameters. When a user selects a value included in
MESSAGE_VALUES for a parameter with MESSAGE option,
this message will be shown to users at the end
of packstack execution.

Example use case is showing a note alerting that a service
will be removed in next release if user enables it.

Change-Id: I1331de921e1f5f1aecf991cb83fa1509f29b3ee7
2017-02-03 11:51:48 -05:00

25 lines
1018 B
YAML

---
features:
- |
Packstack can display parameter specific messages when a MESSAGE option
is added to the parameter. If MESSAGE_VALUES exist for the parameter, the
message will only be shown if the value provided by the user is included
in MESSAGE_VALUES. Example:
{"CMD_OPTION": "example-service-install",
"OPTION_LIST": ["y", "n"],
"VALIDATORS": [validators.validate_options],
"DEFAULT_VALUE": 'n',
"MASK_INPUT": False,
"LOOSE_VALIDATION": False,
"CONF_NAME": "CONFIG_EXAMPLE_SERVICE_INSTALL",
"USE_DEFAULT": False,
"NEED_CONFIRM": False,
"CONDITION": False,
"MESSAGE_VALUES": ["y"],
"MESSAGE": "Example service installation will be removed from packstack in Pike"}
In this case, if the user enable installation of example service, a message
will be displayed at the end of packstack execution with content "Example
service installation will be removed from packstack in Pike"