search

konveyor / tackle-diva

Tackle Data-intensive Validity Analyzer
Apache License 2.0
39 stars 20 forks source link

Documentation needed to interface with tackle-diva from Tackle Inventory #29

Open djwhatle opened 3 years ago

djwhatle commented 3 years ago

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

(Note: I'm not sure if tackle-diva is meant to be integrated with tackle-inventory or if it's more tied to windup. Looking for information on this)

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-diva (TD) so that we can get an idea of how TD this would tie in with Tackle Inventory, and what changes might be needed to the Tackle Inventory data model:

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

cc @rromannissen @jwmatthews @PhilipCattanach

YasuKatsuno commented 3 years ago

Hi @djwhatle thank you for contacting us.

We are now having active discussions/works with @PhilipCattanach @rromannissen @mrizzi to integrate into windup. https://github.com/konveyor/tackle-diva/tree/main/windup https://github.com/akihikot/windup/tree/diva

Please find out answers.

Expected inputs / outputs of TD (examples would be useful)

Input: directory path that contains a set of application source codes Output: 6 files about data-centric analysis results: contexts.yml, transaction.json, transaction_summary.dot, database.json transaction.yml, transaction_summary.pdf.

Please check the blog article for the details. https://opensource.com/article/21/6/tackle-diva-kubernetes

Methods for invoking TD (REST? CLI? Java API? Something else?)

CLI and REST

Is there a Quay.io container auto-build set up so we can consume TD easily running as a Pod on OpenShift?

TD is built as a Docker image and executed as a Docker container. It's easy to build/run it.

Is there a deploy YAML available with a deployment definition for TD and any required auxiliary OpenShift resources

The Dockerfile is ready, although YAML files for OpenShift are not yet.

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

You can easily try Tackle-DiVA, following the "Getting Started" section in README. The prerequisite is the only Docker runnable environment like macOS.

PhilipCattanach commented 3 years ago

@djwhatle There is no direct link between the Application Inventory and DIVA. The plan is to integrate DIVA into the Application Analysis tool (WINDUP/MTA).

djwhatle commented 3 years ago

Thanks for the info @YasuKatsuno @PhilipCattanach . Follow-up question: is there intent to integrate App Inventory and MTA/Windup?