docs/cba/index.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0
   2 .. International License. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright (C) 2019 IBM.
   4
   5 .. _cds_cba-doc:
   6
   7 Controller Blueprint Archived Designer Tool (CBA)
   8 =================================================
   9 .. toctree::
  10    :maxdepth: 1
  11
  12 Introduction
  13 ------------
  14
  15 .. include:: cba-description.rst
  16
  17 Architecture
  18 ------------
  19 |image1|
  20
  21
  22 Data Flow
  23 ---------
  24 |image2|
  25
  26
  27 Installation
  28 ------------
  29
  30 Building client html and js files
  31 .................................
  32
  33    * FROM alpine:3.8 as builder
  34    * RUN apk add --no-cache npm
  35    * WORKDIR /opt/cds-ui/client/
  36    * COPY client/package.json /opt/cds-ui/client/
  37    * RUN npm install
  38    * COPY client /opt/cds-ui/client/
  39    * RUN npm run build
  40
  41 Building and creating server
  42 ............................
  43
  44    * FROM alpine:3.8
  45    * WORKDIR /opt/cds-ui/
  46    * RUN apk add --no-cache npm
  47    * COPY server/package.json /opt/cds-ui/
  48    * RUN npm install
  49    * COPY server /opt/cds-ui/
  50    * COPY --from=builder /opt/cds-ui/server/public /opt/cds-ui/public
  51    * RUN npm run build
  52    * EXPOSE 3000
  53    * CMD [ "npm", "start" ]
  54
  55
  56 Development
  57 -----------
  58
  59 Pre-requiste
  60 ............
  61    * Visual Studio code editor
  62    * Git bash
  63    * Node.js & npm
  64    * loopback 4 cl
  65
  66 Steps
  67 .....
  68    To compile CDS code:
  69
  70    1. Make sure your local Maven settings file ($HOME/.m2/settings.xml)
  71       contains references to the ONAP repositories and OpenDaylight
  72       repositories.
  73    2. git clone https://(LFID)@gerrit.onap.org/r/a/ccsdk/cds
  74    3. cd cds ; mvn clean install ; cd ..
  75    4. Open the cds-ui/client code for development
  76
  77
  78 Functional Decomposition
  79 ------------------------
  80 |image3|
  81
  82 .. |image1| image:: media/CDS_Architecture.jpg
  83    :width: 500pt
  84
  85 .. |image2| image:: media/CDS_Data_Flow.jpg
  86    :width: 500pt
  87
  88 .. |image3| image:: media/Functional_Decomposition.jpg
  89    :width: 500pt
  90