konveyor/tackle-container-advisor

Documentation needed to interface with TCA from Tackle Inventory

Opened this issue · 1 comments

djwhatle commented

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

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

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

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

cc @rromannissen @jwmatthews @PhilipCattanach

kaliaanup commented

Hi Derek (@djwhatle)

Thanks for reaching out. You can follow through the following documentation.

  1. https://github.com/konveyor/tackle-container-advisor (this will help you to get started e.g., deploying the API)
  2. https://github.com/konveyor/tackle-container-advisor/tree/main/aca_backend_api (more details on API)

For deployment in openshift, one of our colleagues has worked on it however he has not merged his changes yet.

  1. https://github.com/mihirc-github/tackle-container-advisor/blob/os_kg_utils/deploy.sh

Please let me know if you need anything else.