diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/index.rst | 49 | ||||
| -rw-r--r-- | docs/microservices/bluePrintsProcessor.rst | 10 | ||||
| -rw-r--r-- | docs/microservices/controllerBlueprintStudioProcessor.rst | 10 | ||||
| -rw-r--r-- | docs/microservices/neng.rst | 10 | ||||
| -rw-r--r-- | docs/microservices/vlanTag.rst | 10 | ||||
| -rw-r--r-- | docs/release-notes.rst | 14 |
6 files changed, 97 insertions, 6 deletions
diff --git a/docs/index.rst b/docs/index.rst index 16f86845..2c7d9ab9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,13 +1,50 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright (C) 2019 IBM. CCSDK APPS DOCUMENTATION REPOSITORY ------------------------------------------------ .. toctree:: :maxdepth: 1 - Architecture - Installation - Configuration - Development - Logging - Release Notes +Introduction: +============= +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. + +Microservices: +============= + +Controller BluePrints Studio Processor +Blueprints processor +NetworkElementNameGen (NENG) +Vlan Tag API + + +Installation: +============= + +Steps +----- +To compile this code: + +1. Make sure your local Maven settings file ($HOME/.m2/settings.xml) contains +references to the ONAP repositories and OpenDaylight repositories. + +2. To compile all of CCSDK apps code + - git clone https://(LFID)@gerrit.onap.org/r/a/ccsdk/apps + - cd apps ; mvn clean install ; cd .. + + + +Logging: +============= +CCSDK uses slf4j to log messages to the standard OpenDaylight karaf.log +log file. + +Where to Access Information +--------------------------- +Logs are found within the SDNC docker container, in the directory +/opt/opendaylight/current/data/logs. +Release Notes diff --git a/docs/microservices/bluePrintsProcessor.rst b/docs/microservices/bluePrintsProcessor.rst new file mode 100644 index 00000000..adde1107 --- /dev/null +++ b/docs/microservices/bluePrintsProcessor.rst @@ -0,0 +1,10 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons. +.. Copyright (C) 2019 IBM. + +Blueprints Processor +==================== + +.. toctree:: + :maxdepth: 1 + :titlesonly:
\ No newline at end of file diff --git a/docs/microservices/controllerBlueprintStudioProcessor.rst b/docs/microservices/controllerBlueprintStudioProcessor.rst new file mode 100644 index 00000000..fc911229 --- /dev/null +++ b/docs/microservices/controllerBlueprintStudioProcessor.rst @@ -0,0 +1,10 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons. +.. Copyright (C) 2019 IBM. + +Controller Blueprints Studio Processor +====================================== + +.. toctree:: + :maxdepth: 1 + :titlesonly:
\ No newline at end of file diff --git a/docs/microservices/neng.rst b/docs/microservices/neng.rst new file mode 100644 index 00000000..b5461988 --- /dev/null +++ b/docs/microservices/neng.rst @@ -0,0 +1,10 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons. +.. Copyright (C) 2019 IBM. + +NetworkElementNameGen (NENG) +============================ + +.. toctree:: + :maxdepth: 1 + :titlesonly:
\ No newline at end of file diff --git a/docs/microservices/vlanTag.rst b/docs/microservices/vlanTag.rst new file mode 100644 index 00000000..c1d2fbef --- /dev/null +++ b/docs/microservices/vlanTag.rst @@ -0,0 +1,10 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons. +.. Copyright (C) 2019 IBM. + +Vlan Tag API +============ + +.. toctree:: + :maxdepth: 1 + :titlesonly:
\ No newline at end of file diff --git a/docs/release-notes.rst b/docs/release-notes.rst new file mode 100644 index 00000000..174c4422 --- /dev/null +++ b/docs/release-notes.rst @@ -0,0 +1,14 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. Copyright (C) 2019 IBM. + +Release Notes +############# + +Version: 0.4.1 +************** + +:Release Date: 2018-11-30 + +Quick Links: + + Wiki Release note<https://wiki.onap.org/display/DW/CCSDK+%3A+Dublin%3A+Release+Planning+Template>
\ No newline at end of file |