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

JTAF API mode for binding to a webserver #7

Open
davedotdev opened this issue Jul 26, 2021 · 0 comments
Open

JTAF API mode for binding to a webserver #7

davedotdev opened this issue Jul 26, 2021 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@davedotdev
Copy link
Contributor

This issue proposes an enhancement to JTAF, building on: #6, to introduce "REST API mode".

There is a plan to create a web UI for JTAF, in which a user instantiates JTAF with said web UI in a Docker container. For this container to issue work against JTAF, provide UI updates to the user and feel responsive, it's important that the UI can post information and retrieve updates and display them to the user, as well as provide download and upload facilities for input configuration and output binary download.

This proposal specifically focussed on a proposed REST API mode, invoked by starting the JTAF binary with an -api flag. In the config file a port should be presentable through a field for the API.

The API itself will provide utility for:

  1. Uploading configuration, which will in essence be mapped to XML inputs into JTAF.
  2. Selecting YANG models (the container when it's built will have them locally) through picking the platform and version
  3. Select the CPU and OS architecture for the provider
  4. Processing the provider
  5. Receiving updates from the processing stages
  6. Download the provider

A simple React web UI is proposed which connects to the JTAF REST API, not covered in this issue.

Let's discuss here.

@davedotdev davedotdev added the enhancement New feature or request label Jul 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants