Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Blueprint Selector #48

Merged

Conversation

vasilvas99
Copy link
Contributor

@vasilvas99 vasilvas99 commented Sep 7, 2023

Since the handling of desired states is now available in Leda and the blueprints concept is in development, we would like to give the user an easy way to switch between blueprints.

In this PR I propose that we expand the desired state messages with additional metadata, describing the to-be deployed blueprint with this desired state.
Additionally, the Rust-based "blueprint selector" presents the user with a nice TUI for fetching/selecting between existing blueprints.

The "blueprint" files are desired state messages, that have the extension ".blueprint.json" (configurable) and an additional metadata header (required):

{
  "blueprintMetadata": {
    "name": "<NAME>",
    "description": "<Short Description>"
  },
  "activityId": "correlation-id",
  "timestamp": 1235466
  "payload": {} // This is the desired state message
}

The metadata header will be used to construct the list of options presented to the user. You can find example blueprints under the
example_blueprints directory.

More information about the operation of the selector can be found in the README.md file.

Test setup

Integration with meta-leda can be found here:
https://github.com/SoftwareDefinedVehicle/meta-leda-fork/tree/blueprint-selector

And an integration with Leda-distro (ready to be build from/tested), here:
https://github.com/SoftwareDefinedVehicle/leda-distro-fork/tree/blueprint-selector

@vasilvas99 vasilvas99 marked this pull request as ready for review September 7, 2023 11:29
Copy link
Contributor

@stlachev stlachev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@stlachev stlachev merged commit 1f93371 into eclipse-leda:main Sep 8, 2023
1 check passed
@vasilvas99 vasilvas99 deleted the feature/blueprints-selector branch September 11, 2023 11:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants