T7363: Add vyconf aware initialization of Config #4505
Merged
Conversation
This file contains hidden or 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
|
👍 |
This was referenced May 12, 2025
There was a problem hiding this comment.
Pull Request Overview
This PR introduces vyconf-aware initialization of the Config system and provides new utilities to manage configuration sessions and backend setup for smoketests. Key changes include:
- Adding the --legacy-config-path flag to the vyconfd systemd service.
- Implementing new helper scripts for tearing down configuration sessions and enabling/disabling the vyconf backend.
- Updating the vyconf session module and related configuration sources for improved session management and integration with the new vyconf backend.
Reviewed Changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| src/systemd/vyconfd.service | Added a new flag in the ExecStart command to support legacy config. |
| src/helpers/teardown-config-session.py | New utility script for tearing down a vyconf session. |
| src/helpers/set_vyconf_backend.py | New script to toggle the vyconf backend for smoketests with match-case usage. |
| python/vyos/vyconf_session.py | Updated session initialization and added config mode decorators. |
| python/vyos/utils/commit.py | Updated commit lock handling and error message formatting. |
| python/vyos/utils/backend.py | New backend utilities for enabling/disabling vyconf backend. |
| python/vyos/defaults.py | Added a new default for vyconf session directory. |
| python/vyos/configtree.py | Minor update initializing a version string. |
| python/vyos/configsource.py | Introduced a new ConfigSourceVyconfSession for vyconf session integration. |
| python/vyos/configsession.py | Updated config session management to incorporate vyconf session logic. |
| python/vyos/config.py | Updated config source selection based on the new vyconf backend. |
Comments suppressed due to low confidence (1)
python/vyos/utils/commit.py:44
- Consider correcting the error message to 'This function needs to be run as root to return correct results!'
raise OSError('This functions needs to be run as root to return correct results!')
10 tasks
dmbaturin
approved these changes
May 20, 2025
|
Regenerated submodule reference for libvyosconfig update; rebased over current. |
The environment variable _OFR_CONFIGURE is used by bash completion to setup the config mode environment. We check this setting to coordinate vyconf config mode and CLI config mode, independent of the legacy backend Cstore check.
In the absence of Cstore, the env var remains as the sole indication of config mode for the legacy CLI, and its emulation here.
We maintain compatibility with the legacy commit lock file until all other references are resolved; this requires a POSIX-type lock instead of the BSD-type lock of vyos.utils.locking.
|
Now that pr-conflict check workflow is corrected, integration tests can run; this reveals that generated python module files are needed for nosetest import check, so now included in PR. |
|
CI integration 👍 passed! Details
|
github-actions
bot
added
the
mirror-initiated
vyosbot
added
mirror-completed
and removed
mirror-initiated
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.
Change summary
NOTE: this requires PR:
vyos/vyconf#21
and the corresponding update of libvyosconfig/vyos-1x commit hashes.
Add necessary requests and utilities for Config instantiation from vyconfd session data.
This and the supporting PRs provide a basic framework for running smoketests using vyconf.
In addition to what is needed for T7363, this includes the legacy-compatible lock of https://vyos.dev/T7365, and a simple util for enabling the backend during smoketests (cf. vyos/vyos-build#963).
One goal here is to provide the framework for smoketests, to guide remaining integration and the addition of missing features for a full replacement of the backend. Only certain smoketests currently pass; of failures, some are due to known issues, tested but not yet included; some are not yet possible due to the pending conversion of config_mgmt; the remaining are under investigation in subtasks of https://vyos.dev/T7352.
Types of changes
Related Task(s)
Related PR(s)
vyos/vyconf#21
vyos/libvyosconfig#36
How to test / Smoketest result
Checklist: