docs/index.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright (C) 2019 IBM.
   4 .. _master_index:
   5
   6 CCSDK APPS DOCUMENTATION REPOSITORY
   7 ------------------------------------
   8 .. toctree::
   9    :maxdepth: 1
  10
  11 Introduction:
  12 =============
  13    APPS repository which contains all micro services for CCSDK module. Also these are application that are intended to run outside of OpenDaylight container.Modular feature implementation that is reusable across all controllers.
  14
  15 Microservices:
  16 =============
  17
  18 .. toctree::
  19    :maxdepth: 1
  20
  21    microservices/neng
  22    microservices/vlanTag
  23
  24
  25 Installation:
  26 =============
  27
  28    To compile this code:
  29
  30    1. Make sure your local Maven settings file ($HOME/.m2/settings.xml) contains
  31     references to the ONAP repositories and OpenDaylight repositories.
  32
  33    2. To compile all of CCSDK apps code
  34     - git clone https://(LFID)@gerrit.onap.org/r/a/ccsdk/apps
  35     - cd apps ; mvn clean install ; cd ..
  36
  37
  38 Logging:
  39 ========
  40 CCSDK uses slf4j to log messages to the standard OpenDaylight karaf.log
  41 log file.
  42
  43 Logs are found within the SDNC docker container, in the directory
  44 /opt/opendaylight/current/data/logs
  45
  46 Release Notes:
  47 ==============
  48         release-notes