search

lanl / BEE

Other
13 stars 3 forks source link

Beeflow connect - A REST API for BEEflow itself. #837

Open aquan9 opened 1 month ago

aquan9 commented 1 month ago

This PR, adds components to BEEflow to support a REST API for the BEEflow client itself.

Using this API users can remotely submit jobs to BEEflow by doing the following:

  1. Making a request to /droppoint to get the location of the droppoint on the remote system.
  2. Copying a workflow tarball, and workdir to that droppoint using SCP
  3. Making a request to /submit_long with the name of the workflow to start the workflow.

Documentation has been added to the sphinx docs directory.

aquan9 commented 1 month ago

After meeting with Pat, she mentioned that we should have a way to turn on the remote API without it being on by default. I'm working on this now.

aquan9 commented 1 month ago

The other thing was that we needed to do was put an option in the beeconfig to choose what port to use during startup for the remote api.

pagrubel commented 1 month ago

By default could the port be generated similarly to the others that use the user id in some fashion?