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

Document explicitly how to connect Fins #89

Open
lucamrgs opened this issue Mar 20, 2024 · 0 comments
Open

Document explicitly how to connect Fins #89

lucamrgs opened this issue Mar 20, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Milestone

Comments

@lucamrgs
Copy link
Collaborator

It is not yet evident from the documentation how and where to implement and connect fins.

The sequence for connecting a fin is roughly:

  1. SOARCA is run with enable_fins to true
  2. SOARCA interfaces an MQTT broker container to which a Fin process should connect
  3. any Fin process connects to the MQTT container, and registers as fin to SOARCA according to protocol (evtl. using our libraries)
  4. Playbooks which use the fin need to specify a soarca-fin agent. The "name" property of such fin agent should be consistent with the name of the Fin registered via protocol
  5. Now all is set to execute playbooks with SOARCA fins

It would be nice to have this process described explicitly in the documentation

@lucamrgs lucamrgs added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 20, 2024
@MaartendeKruijf MaartendeKruijf added this to the SOARCA 1.1 milestone Mar 22, 2024
@MaartendeKruijf MaartendeKruijf added the good first issue Good for newcomers label Jul 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants