Revisit storing syntax version of interface definitions in XML file
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	jestabro
	Apr 14 2021, 6:13 PM

Description

In T1962, the possibility of storing the component syntax version within the XML file was introduced. It has remained underadvertised and underused due to a question of convenience: the mapping

component <~~> interface definition file

is not 1-to-1, nor should it be (for example system <~> system-*.xml.in; interfaces <~> interface-*.xml.in). This raises the question of in which file to include the XML syntax version element, so as to be least burdensome on the developer. In this task, we will revisit the matter, so as to finally move the component syntax version out of vyatta-cfg-system.

Details

Version: vyos-1,4
Is it a breaking change?: Unspecified (possibly destroys the router)
Issue type: Unspecified (please specify)

Related Objects
Search...

Status	Subtype	Assigned	Task
Resolved	ENHANCEMENT	dmbaturin	T688 Move component versions used for config migration purposes into vyos-1x
Resolved		jestabro	T1950 Store VyOS configuration syntax version data in JSON file
Resolved		jestabro	T1962 Add syntax version to schema
Resolved	BUG	jestabro	T3475 XML dictionary cache unable to process syntaxVersion elements
Resolved		jestabro	T3474 Revisit storing syntax version of interface definitions in XML file
Resolved		jestabro	T3768 Remove early syntaxVersion implementation

Event Timeline

jestabro created this task.Apr 14 2021, 6:13 PM

jestabro triaged this task as Normal priority.

jestabro created this object in space S1 VyOS Public.

jestabro added a parent task: T1962: Add syntax version to schema.

jestabro updated the task description. (Show Details)

jestabro mentioned this in T3475: XML dictionary cache unable to process syntaxVersion elements.Apr 14 2021, 6:28 PM

jestabro added a parent task: T3475: XML dictionary cache unable to process syntaxVersion elements.Apr 14 2021, 6:30 PM

pasik subscribed.Apr 14 2021, 6:41 PM

The suggested resolution is to define an include file with the syntaxVersion element. The syntaxVersion element contains the component name and version number; the including interface definition file corresponds to the conf_mode script. Hence, this defines a mapping

conf_mode script --> component name. In addition, the workflow is not burdensome:

old workflow: update interface definition/conf mode script; write migration script; update vyatta-cfg-system curver_data
new workflow: update interface definition/conf mode script; write migration script; update version number in interface_definitions/include/version

Al the processing scripts are already in place in 1.3/1.4. An example is here:

https://github.com/vyos/vyos-1x/compare/current...jestabro:syntaxVersion

jestabro changed the task status from Open to In progress.Aug 4 2021, 4:37 PM

jestabro mentioned this in rVYOSONEX40f5359d2d34: xml: T3474: add syntaxVersion processing to python xml lib.Aug 19 2021, 2:41 PM

jestabro mentioned this in T3768: Remove early syntaxVersion implementation.Aug 19 2021, 3:35 PM

jestabro added a subtask: T3768: Remove early syntaxVersion implementation.

jestabro closed subtask T3768: Remove early syntaxVersion implementation as Resolved.Aug 30 2021, 1:46 PM

jestabro mentioned this in T688: Move component versions used for config migration purposes into vyos-1x.Aug 30 2021, 1:53 PM

https://github.com/vyos/vyos-1x/pull/1225

Restricted Repository Identity mentioned this in rVYOSONEXe66879f71da3: Merge pull request #1225 from jestabro/component-version.Feb 17 2022, 3:31 PM

jestabro mentioned this in rVYOSONEX425f8f16caa7: xml: T3474: get component version dictionary from xml cache, not legacy.Feb 17 2022, 3:31 PM

jestabro mentioned this in rVYOSONEXd9a1f8deceec: xml: T3474: add smoketest to check xml component versions are maintained.