README.md

   1 <!--
   2   ============LICENSE_START=======================================================
   3    Copyright (C) 2022 Wipro Limited..
   4   ================================================================================
   5   Licensed under the Apache License, Version 2.0 (the "License");
   6   you may not use this file except in compliance with the License.
   7   You may obtain a copy of the License at
   8
   9        http://www.apache.org/licenses/LICENSE-2.0
  10
  11   Unless required by applicable law or agreed to in writing, software
  12   distributed under the License is distributed on an "AS IS" BASIS,
  13   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14   See the License for the specific language governing permissions and
  15   limitations under the License.
  16
  17   SPDX-License-Identifier: Apache-2.0
  18   ============LICENSE_END=========================================================
  19 -->
  20
  21 # ONAP CPS TBDMT(Template Based Data Model Transformer)
  22
  23 This service shall be used to map the erstwhile Config-DB-like REST APIs to appropriate CPS API calls. The purpose of this service is to abstract the details of (possibly multiple, and complex) XPath queries from the users of CPS.
  24 See [wiki for CPS-TBDMT](https://wiki.onap.org/display/DW/R9+TBDMT+Enhancements)
  25
  26 ## Building Java Archive only
  27
  28 Following command builds Java executable jar to `target/cps-tbdmt-x.y.z-SNAPSHOT` JAR file
  29 without generating any docker images:
  30
  31 ```bash
  32 mvn clean install
  33 ```
  34
  35 ## Building Java Archive and local Docker image
  36
  37 Following command builds the JAR file and also generates the Docker image:
  38
  39 ```bash
  40 mvn clean package
  41 ```
  42
  43 ## Running via Docker Compose
  44
  45 `cps-tbdmt/docker-compose/docker-compose.yml` file is provided to be run with `docker-compose` tool and local image previously built.
  46
  47 Execute following command from cps-tbdmt/docker-compose folder to start all services:
  48
  49 ```bash
  50 docker-compose up
  51 ```