chore(config): make sample configs Keystone templates#139
Merged
Conversation
- Render recorder WebSocket RPC URLs from register context - Render transfer identity and fleet WebSocket URL from register context - Document using the ROS recorder and transfer samples as Keystone templates
There was a problem hiding this comment.
Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here.
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
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.
Pull Request Checklist
Please ensure your PR meets the following requirements:
make testormake docker-test) (targeted tests passed; full gate not run)make format) (N/A: config/docs only)Summary
This PR makes the repository recorder and transfer samples usable as Keystone
recorder.yamlandtransfer.yamltemplates foraxon_config register. It replaces runtime identity and WebSocket endpoints with supported register placeholders while keeping ROS1/ROS2 topic lists as the robot-specific adaptation surface.Motivation
axon_config register.Changes
Modified Files
apps/axon_recorder/config/default_config_ros1.yaml- Treat the ROS1 sample as a Keystonerecorder.yamltemplate, default RPC mode tows_client, and renderrpc.ws_client.urlfrom{{ recorder_rpc_url }}.apps/axon_recorder/config/default_config_ros2.yaml- Apply the same Keystone template behavior to the ROS2 sample.apps/axon_transfer/config/transfer_config.yaml- Renderdevice_id,factory_id, and the transfer WebSocket base URL from registration placeholders.apps/axon_config/README.md- Document which repository samples can be uploaded to Keystone and which fields are filled by registration.apps/axon_recorder/config/README.md- Document the Keystone template workflow and local-only override requirements.apps/axon_transfer/README.md- Document the transfer sample as a Keystone-ready template.Added Files
None
Deleted Files
None
Type of Change
Impact Analysis
Breaking Changes
None expected for the Keystone registration workflow.
Backward Compatibility
The ROS1/ROS2 sample configs now default to Keystone WebSocket client mode and contain
{{ recorder_rpc_url }}until rendered. Local-only users who run these sample files directly should either render/replace the placeholder URL or switchrpc.modeback tohttp_server, as documented in the recorder config README.Testing
Test Environment
Test Cases
Manual Testing Steps
./build/axon_config/test_axon_config./build/axon_recorder/test/test_config_parserruby -e 'require "yaml"; ARGV.each { |path| YAML.load_file(path); puts "#{path}: ok" }' apps/axon_recorder/config/default_config_ros1.yaml apps/axon_recorder/config/default_config_ros2.yaml apps/axon_transfer/config/transfer_config.yamlgit diff --check HEAD~1..HEADFull local CI (
./scripts/ci-all-local.sh) and Docker-backed workflow equivalents were not run, so this PR is opened as a draft.Test Coverage
Screenshots / Recordings
N/A
Performance Impact
Documentation
apps/axon_config/README.mdupdatedapps/axon_recorder/config/README.mdupdatedapps/axon_transfer/README.mdupdatedRelated Issues
N/A
Additional Notes
dist/andscripts/pi2_ros2_bridge.pywere not included in the commit or branch.Reviewers
N/A
Notes for Reviewers
axon_config register:recorder_rpc_url,transfer_ws_url,device_id, andfactory_id.Checklist for Reviewers