Documentation needed to interface with tackle-test-generator from Tackle Inventory

[djwhatle]

Hi @rachelt44 , @sinha108 , I'm onboarding to the Tackle project along with @jortel and @mansam right now.

(Note: I see that this repo has some nice documentation already on using the tool, thanks for that! I am asking these questions across all tackle repos that inventory will interface with to hopefully get a standardized list of responses with up to date info)

We are working to learn how the Tackle App Inventory can interface with other tools in the Tackle suite, and trying to define the requirements of the App Inventory data model.

It would be helpful to have a reference doc on the public interface of tackle-test-generator (TTG) so that we can get an idea of how TTG this would tie in with Tackle Inventory, and what changes might be needed to the Tackle Inventory data model:

• Expected inputs / outputs of TTG (examples would be useful)
• Methods for invoking TTG (REST? CLI? Something else?)
• Is there a Quay.io container auto-build set up so we can consume TTG easily running as a Pod on OpenShift?
• Is there a deploy YAML available with a deployment definition for TTG and any required auxiliary OpenShift resources (e.g. namespaces, services, routes). This would let us quickly play around with TTG using other info provided. We may be able to assist here if needed.

Do documents detailing the public interface of TTG exist? Even some simple examples would be useful to get started.

cc @rromannissen @jwmatthews @PhilipCattanach

[rachelt44]

@djwhatle

1+2: We have a readme file and a user guide (under the doc directory) that include documentation of our cli, and also point to an example input that is located inside the repo. However, in our documentation we do not explicitly list all inputs and all outputs - we will update our user guide to include this information.
3: Currently we don't have a Quay.io container, we have a docker file but we don't publish images anywhere. Issue #90 refers to the same requirement. We will make that update soon.
4: No we don't have a deploy YAML yet, and any help or guidance will be appreciated.