-
Notifications
You must be signed in to change notification settings - Fork 12
Fixes #9375: Add documentation on new API to start remote agent run #37
Conversation
Close, do not merge now, it does not build |
Fixed! |
Commit modified |
bf8d4a3
to
4fe48ff
Compare
src/api_v2/node.md
Outdated
|
||
@apiParam (Multi) {class} classes Set class passed as parameter to make it available during agent run. | ||
|
||
@apiDescription This API allows to trigger an agent run on the target node. Response content a json stating if agent has started on each node. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You need to be more precise on the behavior of the api regarding node answer: what exactly the api is waiting for to build the json answer ?
src/api_v2/node.md
Outdated
@apiUse nodeId | ||
@apiParam (Multi) {class} classes Set class passed as parameter to make it available during agent run. | ||
|
||
@apiDescription This API allows to trigger an agent run on the target node. Response is not a json but the actual agent output on the node. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This API allows to trigger an agent run on the target node. Response is the streamed agent output directly from the node (and so not in JSON).
@VinceMacBuche This needs to be rebased. |
ping @VinceMacBuche |
PR rebased |
4fe48ff
to
f21699f
Compare
Commit modified |
f21699f
to
e3618e1
Compare
Changes treated, Alexis will review again
src/api_v2/nodes.md
Outdated
|
||
@apiParam (Multi) {class} classes Set class passed as parameter to make it available during agent run. | ||
|
||
@apiDescription This API allows to trigger an agent run on the target node. Response content a json stating if agent could be started on each node, but not if the run went fine and do not display any output from it. You cann see the result of the run in rudder web interface or in the each agent logs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
cann -> can
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
rudder -> Rudder
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
content -> contains
Commit modified |
e3618e1
to
7788cfa
Compare
OK, merging this PR |
https://www.rudder-project.org/redmine/issues/9375