feat: add option to disable inputs on creation #1510
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hetangmodi-crest
requested review from
artemrys,
sgoral-splunk and
kkedziak-splunk
docs/inputs/index.md
Outdated
| @@ -43,6 +43,7 @@ provided, a dropdown field will appear on the Inputs page. In contrast, a button | |||
| | [restHandlerModule](../advanced/custom_rest_handler.md) | string | It specify name of the REST handler script that implements the custom actions to be performed on CRUD operations for the given input. (Use with restHandlerClass) | | |||
| | [restHandlerClass](../advanced/custom_rest_handler.md) | string | It specify name of the class present in the restHandlerModule, which implements methods like handleCreate, handleEdit, handleList, handleDelete and is child class of splunktaucclib.rest_handler.admin_external.AdminExternalHandler. (Use with restHandlerModule) | | |||
| | hideForPlatform | string | Defines for which platform element should be hidden from UI perspective. Currently only two platforms are supported `cloud` or `enterprise`. | | |||
| | disabled | boolean | Specifies whether a service should be disabled by default or not. If set to `True`, any new input created from the service will remain disabled until manually enabled by the user. | | |||
There was a problem hiding this comment.
What is the default?
There was a problem hiding this comment.
Default is set to false. I'll add it in the docs.
| @@ -1,4 +1,7 @@ | |||
| {% for input_name in input_names %} | |||
| {{ "[" ~ input_name ~ "]"}} | |||
| python.version = python3 | |||
| {% if disabled and service_name == input_name%} | |||
There was a problem hiding this comment.
I see there is this comparison. Wouldn't it be easier to edit input's rest handler and use default in the RestField?
field.RestField(
'disabled',
required=False,
validator=None,
default={{ disabled }}
)
There was a problem hiding this comment.
Adding it in the RH file would require the disabled property to be explicitly sent in the payload. Moreover, to enable or disable inputs, they have a dedicated endpoint which triggers the enabling and disabling of the input, hence we'd require to set it in inputs.conf as to define the nature of newly created inputs.
hetangmodi-crest
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue number: ADDON-75879
PR Type
What kind of change does this PR introduce?
Summary
Added a new argument so that users can disable their newly created input of a service.
Changes
Introduced a new argument (
disableNewInput) in services, so that users can specify whether a service's new input should be disabled on creation or not.User experience
Users can now have disabled inputs on creation, If they mention
disableNewInput = Truein their globalConfig.Checklist
If an item doesn't apply to your changes, leave it unchecked.