ug: Add guide for remote actions #886
Conversation
Signed-off-by: Andy Doan <andy@foundries.io>
kprosise
left a comment
kprosise
left a comment
There was a problem hiding this comment.
Suggestions based on Vale linter feedback and changes to code blocks to have them recognized as console output
| ============== | ||
|
|
||
| Remote actions allow you to execute pre-configured scripts on a device and view the results. | ||
| Default LmP builds include: |
There was a problem hiding this comment.
We usually don't say "LmP builds", I think we say "Target"
@kprosise do we have something on this regard on the style guide?
source/user-guide/remote-actions.rst
Outdated
|
|
||
| fioctl devices triggers list-configured <device> | ||
|
|
||
| Triggering an action |
There was a problem hiding this comment.
before going to the "triggering", can we have an example of output?
I would also like to see a list of possible actions available with a description. If you think it does not fit the UG, it could include a link to RN
| Remote actions are sent to the device using :ref:`ref-fioconfig`. | ||
| This means that the action will be run asynchronously and reported once the device has seen and processed the request. | ||
| By default, Fioconfig will check in with the server every 5 minutes. | ||
| The results of the action will be available from the ``fioctl devices tests`` command. |
There was a problem hiding this comment.
the results or the status?
There was a problem hiding this comment.
the status is part of the results?
| How It Works | ||
| ------------ | ||
|
|
||
| The remote actions feature is implemented with Fioconfig. |
There was a problem hiding this comment.
@kprosise do we have a glossary term for Fioconfig? For me it feels like missing a cross reference here
source/user-guide/remote-actions.rst
Outdated
| The remote actions feature is implemented with Fioconfig. | ||
| When Fioconfig starts up, it will look under ``/usr/share/fioconfig/actions`` to find actions it can perform. | ||
| This list will be uploaded to the server if/when it changes. | ||
| You can see this with:: |
There was a problem hiding this comment.
i don't quite understand what you can see? Is it the content of /usr/share/fioconfig/actions? Or what is still local to be uploaded to the server?
There was a problem hiding this comment.
the content of the file is shown below in the example output.
| | reboot | ||
| ... | ||
|
|
||
| This file lets Fioctl know what actions it can trigger. |
There was a problem hiding this comment.
"this file" I assume it's /usr/share/fioconfig/actions
lists the actions fioctl can trigger or will trigger? I mean, the possible actions or the actions that are scheduled?
There was a problem hiding this comment.
no - the file is shown above fio-remote-actions - its the list of actions found under /usr/share/fioconfig/actions. It is what's possible to trigger. We then cover below how one gets triggered
Co-authored-by: Daiane Angolini <angolini@gmail.com> Co-authored-by: Katrina Prosise <katrina.prosise@foundries.io>
3 participants
PR Template and Checklist
Please complete as much as possible to speed up the reviewing process.
You may delete items that are not relevant to your contribution.
Readiness and adding reviewers as appropriate is required.
All PRs should be reviewed by a technical writer/documentation team and a peer.
If effecting customers—which is a majority of content changes—a member of Customer Success must also review.
Readiness
Checklist
make linkcheck, and add redirects for any moved or deleted pages.-s, --signoff).-S, --gpg-sign).Comments
Any thing else that a maintainer/reviewer should know.
This could include potential issues, rational for approach, etc.