Page MenuHomeVyOS Platform
Create Task
Maniphest T5528

Replace legacy loadFile with config_diff
Closed, ResolvedPublicENHANCEMENT
Actions

Description

The possibility of replacing loadFile with config_diff was mentioned in the description in T4295. The generalization of 'diff functions' in the course of T5317 support the plan of defining batch set/delete operations of a cstore instance within a call to diff. One expects performance to be comparable, and the lack of useful error reporting in loadFile can be addressed.

Details

Version
vyos-1.4
Is it a breaking change?
Perfectly compatible
Issue type
Feature (new functionality)

Related Objects
Search...

StatusSubtypeAssignedTask
 In progressFEATURE REQUESTNoneT3355 Remove all remaining legacy Vyatta code
 OpenBUGNoneT4316 Update save-config/load-config
 ResolvedjestabroT4235 Add config tree diff algorithm
 Not ApplicableFEATURE REQUESTjestabroT4295 Use config_tree instead of legacy loadFile in vyos-load-config.py
 ResolvedENHANCEMENTjestabroT5316 configtree: use a single pass of the diff algorithm
 ResolvedENHANCEMENTjestabroT5317 configtree: remove mutable references
 OpenBUGjestabroT6543 Legacy load config ignores validation errors on set, leading to removal of config sections under commit error
 ResolvedENHANCEMENTjestabroT5528 Replace legacy loadFile with config_diff
 ResolvedENHANCEMENTjestabroT5815 Add load_config module
 ResolvedENHANCEMENTjestabroT5400 Move libvyosconfig build out of the Docker image
 ResolvedBUGjestabroT7289 Add libvyosconfig as git submodule of vyos-1x for stream builds
 ResolvedENHANCEMENTjestabroT6717 Add hybrid Cstore manipulation library to replace set/delete/load_config functionality
 ResolvedENHANCEMENTjestabroT6718 Use vyconf daemon for validation of set commands
 ResolvedENHANCEMENTjestabroT6946 Add initial commit algorithm to vyconf
 ResolvedENHANCEMENTjestabroT7121 Set up communication vyconfd <-> vyos-configd
 ResolvedENHANCEMENTjestabroT7272 Vyconf: update in memory config tree on response from vyos-commitd
 OpenENHANCEMENTjestabroT7292 Expose vyconf commit algorithm for CLI and ConfigSession instance
 ResolvedENHANCEMENTjestabroT7302 Implement commit dry-run for vyconfd/vyos-commitd
 ResolvedENHANCEMENTjestabroT7321 Replace legacy operations in configsession.py with vyconf client operations
 OpenENHANCEMENTjestabroT7374 Integrate vyconf config session with CLI config session
 ResolvedENHANCEMENTjestabroT7910 Standardize vyconf session resource management across Python config modules
 ResolvedBUGjestabroT7637 Fix typo in commit algorithm
 ResolvedBUGjestabroT7688 Correct the management of delete paths on vyconfd delete and commit requests
 OpenBUGjestabroT6959 Add support for addons after switch to internal reference tree
 ResolvedENHANCEMENTjestabroT7046 Add utilities for update of reference tree

Event Timeline

jestabro created this task.Aug 30 2023, 8:08 PM
jestabro triaged this task as Normal priority.
jestabro created this object in space S1 VyOS Public.
jestabro added parent tasks: T4295: Use config_tree instead of legacy loadFile in vyos-load-config.py, T5317: configtree: remove mutable references.
jestabro mentioned this in T4295: Use config_tree instead of legacy loadFile in vyos-load-config.py.Aug 30 2023, 8:10 PM
jestabro edited projects, added VyOS 1.5 Circinus; removed VyOS 1.4 Sagitta.Aug 31 2023, 6:23 PM
jestabro added a subtask: T5815: Add load_config module.Dec 10 2023, 7:46 PM
jestabro closed subtask T5815: Add load_config module as Resolved.Dec 12 2023, 2:31 PM
jestabro changed the task status from Open to In progress.Jan 16 2024, 2:41 AM
jestabro added a comment.Feb 1 2024, 3:41 AM

The working implementation is linked below; performance is not yet comparable to the legacy loadFile, though there are obvious points of optimization to be made. The general framework will be submitted for PR to support other development, with load_config as an illustrative example, but not yet a replacement for loadFile.

https://github.com/jestabro/vyos1x-adapter
https://github.com/vyos/vyos1x-config/compare/master...jestabro:vy-adapter
https://github.com/vyos/vyos-1x/compare/current...jestabro:vy-adapter
https://github.com/vyos/vyatta-cfg/compare/current...jestabro:vy-adapter
https://github.com/vyos/libvyosconfig/compare/master...jestabro:vy-adapter

jestabro added a comment.Jul 2 2024, 6:39 PM

This will be readied for PR without adding the external package vyos1x-adapter; that version has already been completed and will be linked below.

jestabro mentioned this in T6543: Legacy load config ignores validation errors on set, leading to removal of config sections under commit error.Jul 3 2024, 3:32 PM
jestabro mentioned this in T5400: Move libvyosconfig build out of the Docker image.Jul 3 2024, 5:24 PM
jestabro added a subtask: T5400: Move libvyosconfig build out of the Docker image.
jestabro added a comment.EditedJul 22 2024, 12:09 PM

Links for PR in preparation:
https://github.com/vyos/vyos1x-config/compare/current...jestabro:vy-adapter
https://github.com/vyos/vyatta-cfg/compare/current...jestabro:vy-adapter
https://github.com/vyos/vyos-1x/compare/current...jestabro:vy-adapter
https://github.com/vyos/libvyosconfig/compare/current...jestabro:vy-adapter

Note that the last will need to be updated with the vyos1x-config commit hash after it is merged, as pinning is now done during the libvyosconfig build.

The suggestion to replace the native C api with ctypes, in order to avoid a build dependency on libvyattta-cfg.so, still requires calling dlopen when building the derived libarary libvyosconfig; the above retains the original approach which provides other advantages.

jestabro mentioned this in T6717: Add hybrid Cstore manipulation library to replace set/delete/load_config functionality.Sep 15 2024, 11:09 PM
jestabro added a comment.Sep 15 2024, 11:11 PM

This work has been generalized and simplified for use with the minimal vyconf daemon:
https://vyos.dev/T6717

This PR will be closed when following completion of T6717.

pasik subscribed.Sep 16 2024, 6:58 AM
syncer edited projects, added VyOS Rolling; removed VyOS 1.5 Circinus.Oct 28 2024, 4:28 AM
syncer moved this task from Need Triage to Backlog - Feature Requests on the VyOS Rolling board.Oct 30 2024, 7:16 PM
syncer added a subscriber: Global Notifications.Nov 1 2024, 9:19 PM
jestabro closed subtask T5400: Move libvyosconfig build out of the Docker image as Resolved.Mar 13 2025, 2:56 PM
jestabro added a subtask: T6717: Add hybrid Cstore manipulation library to replace set/delete/load_config functionality.Apr 8 2025, 6:47 PM
jestabro closed this task as Resolved.Apr 8 2025, 6:51 PM

Subsumed by the work beginning in T6717 and continuing in listed subtasks thereof.

jestabro added a parent task: T6543: Legacy load config ignores validation errors on set, leading to removal of config sections under commit error.Apr 8 2025, 6:52 PM