No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.settings
configfiles/config
src
.gitignore
Catalogapi_tables_Schema.sql
Contribution.txt
License.txt
README.md
buildProject.sh
pom.xml

README.md

Overview

The Catalog API microService is part of a model-management service which can be used for:

  • Implemented for model catalog meta-data storage
  • Listing all model meta-data
  • Retrieving model meta-data based on modelKey and modelType and projectKey
  • Inserting/updating model catalog meta-data via MySQL
  • Deleting unwanted catalogs based on modelKey and projectKey

Requirements

Required Environment

  • Linux

Required Software

  • Maven 3.x.x
  • Java 8
  • MariaDB

Required Applications

Other Requirements

  • Jenkins Job Base
  • Email Host
  • Kubernetes Namespace

Build

  1. Install and configure Maven and Java. Many robust installation guides exist for both products and there is not a need for an additional guide here.
  2. Clone the CatalogAPI repository.
  3. Install and configure MariaDB. Create the database schema by running Catalogapi_tables_Schema.sql.
  4. Follow the installation and deployment instructions for AAF (here). CatalogAPI is dependent on AAF. Be sure to create a namespace in AAF.
  5. Navigate to the project in a terminal and run mvn install using the settings.xml file provided with the project.

Run

  1. Configure CatalogAPI by filling out the configuration files src/main/resources/system.properties, src/main/resources/application.properties, src/main/resources/cadi.properties, and etc/cadi.properties. Fields are preset with default values, localhost addresses, or the dummy text "changeme".
  2. Generate a new keyfile and use it to replace the dummy file in etc/aafkeystore.
  3. Create a run configuration with com.att.ajsc.catalogapi.Application as the main class
  4. Launch with the run configuration.

NOTE

More details can be found in the wiki for this project