Jira (BOLT-1400) Add 'run_command' endpoint to bolt-server

[Casey Williams (JIRA)]

Title: Message Title

Casey Williams updated an issue   Puppet Task Runner / BOLT-1400 Add 'run_command' endpoint to bolt-server Change By: Casey Williams *Background* When told to run a task on some nodes, a PE master typically contacts the nodes over the PCP protocol. It sends a formatted request over PCP to the pxp-agent service running on the nodes, directing them to run the task locally. But if the nodes don't have a pxp-agent service running, the PE master must contact them via SSH or WinRM instead. For these cases, the PE master runs a "pe-bolt-server" service, which is a sinatra application that waits for post requests to /ssh/run_task or /winrm/run_task, then runs the task via an instance of the bolt executor, just like bolt does when you run a task via the CLI. Basically, it's a thin REST API wrapper around normal bolt "task run" operations that the PE master can use when there's no PXP agent to talk to over PCP. In PE Kearney, "task run" is the only supported action over PCP, so it follows that the only endpoints in the bolt-server REST API are for "task run". For other typical bolt actions ("command run", "file upload", "script run"), PCP operations are handled by wrapping any non-task action in an ephemeral task in order to use the "task run" endpoints. PCP-867 and ORCH-2304 describe process of enabling "command run" without a task wrapper over PCP on the agent and server. This ticket describes the new endpoint on bolt-server that will support "command run" when there is no PCP transport available. *Requirements* Changes will be made to the [bolt server app|https://github.com/puppetlabs/bolt/tree/master/lib/bolt_server]: * The app follows the [json schema specification|https://json-schema.org/specification.html]. Add a description of the JSON schema for data passed to the new endpoints [here|https://github.com/puppetlabs/bolt/tree/master/lib/bolt_server/schemas]. This schema should match the one defined for the command action in PCP-867, that is: {code}{     "type": "object",     "properties": {         "command": {             "type": "string"         }     } } {code} * Add new POST endpoints in the transport sinatra app [here|https://github.com/puppetlabs/bolt/blob/master/lib/bolt_server/transport_app.rb] to support running a command via SSH and WinRM, using the new JSON schema. * Document the new endpoints in the [developer-docs|https://github.com/puppetlabs/bolt/blob/master/developer-docs/]. *Testing* * Write RSpec tests for the changes to bolt [here|https://github.com/puppetlabs/bolt/tree/master/spec/bolt_server]. * Acceptance/integration tests on the orchestrator side exist for this code [here|https://github.com/puppetlabs/orchestrator/blob/lovejoy/test/puppetlabs/orchestrator/integration/bolt_server.clj], but updating them is *out of scope* for this ticket. *Do* run a quick manual test that the API endpoints work as expected on a running PE master, but making changes orchestrator to make use of the endpoints should be done as part of an ORCH ticket. Add Comment   This message was sent by Atlassian JIRA (v7.7.1#77002-sha1:e75ca93) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. To view this discussion on the web visit https://groups.google.com/d/msgid/puppet-bugs/JIRA.312869.1560800327000.50137.1560805560141%40Atlassian.JIRA. For more options, visit https://groups.google.com/d/optout.