hyperglass
hyperglass copied to clipboard
thatmattlove
Directive examples in documentation does not work as expected
Deployment Type
Docker
Version
v2.0.4
Steps to Reproduce
- Copy contents of example from documentation into /etc/hyperglass/directives.yaml
- Start container and check logs
One example:
show-bgp-summary:
name: BGP Summary
rules:
- condition: null
command: show bgp all summary
field: null
Expected Behavior
The directive should be parsed correctly and not throw errors.
Observed Behavior
Error shown. Defining/undefining the directive on the device does not matter, same error.
Have tried many different custom directive configs but one way or another it throws a validation error.
Configuration
No response
Devices
No response
Logs
╭─────────────────────────────── locals ────────────────────────────────╮ │
│ │ data = { │ │
│ │ │ 'id': 'show-bgp-summary', │ │
│ │ │ 'name': 'BGP Summary', │ │
│ │ │ 'rules': [ │ │
│ │ │ │ { │ │
│ │ │ │ │ 'condition': None, │ │
│ │ │ │ │ 'command': 'show bgp all summary' │ │
│ │ │ │ } │ │
│ │ │ ], │ │
│ │ │ 'field': None │ │
│ │ } │ │
│ │ self = Directive() │ │
│ ╰───────────────────────────────────────────────────────────────────────╯ │
╰──────────────────────────────────────────────────────────────────────────────╯
ValidationError: 3 validation errors for Directive
rules.condition
Input should be a valid string [type=string_type, input_value=None,
input_type=NoneType]
For further information visit https://errors.pydantic.dev/2.8/v/string_type
field.Text
Input should be a valid dictionary or instance of Text [type=model_type,
input_value=None, input_type=NoneType]
For further information visit https://errors.pydantic.dev/2.8/v/model_type
field.Select
Input should be a valid dictionary or instance of Select [type=model_type,
input_value=None, input_type=NoneType]
For further information visit https://errors.pydantic.dev/2.8/v/model_type
This works for me
show-ip-bgp-summary:
name: Show BGP Neighbor Summary
rules:
- condition: ""
commands: show ip bgp summary
field:
description: ""
options:
- value: ""
for FRR
show-ip-bgp-summary:
name: Show BGP Neighbor Summary
rules:
- condition: ""
commands: vtysh -c "show ip bgp summary"
field:
description: ""
options:
- value: ""
The way you did it worked. The documentation has errors because look: you used "commands" and in the documentation it says "command". Another detail is how the "field" is defined. It only worked defining it the way you did.
I still have an issue with this.
show-ip-bgp-summary: name: Show BGP Neighbor Summary rules: - condition: "" commands: show ip bgp summary field: description: "" options: - value: ""
This will still require entering a value in the GUI for me and as no values are declared I cant enter one. The command doesnt require any inputs or fields.
