docs/CBA/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
   5 Controller Blueprint Archived Designer Tool(CBA)
   6 ------------------------------------------------
   7 .. toctree::
   8    :maxdepth: 1
   9
  10 Introduction:
  11 =============
  12 The Controller Blueprint Archived is the overall service design, fully model-driven, package needed to automate the resolution of resources for instantiation and any config provisioning operation, such as day0, day1 or day2 configuration.
  13
  14 The CBA is .zip file, comprised of the following folder structure, the files may vary:
  15
  16 |image0|
  17
  18 .. |image0| image:: media/image0.jpg
  19    :width: 7.88889in
  20    :height: 4.43750in
  21
  22 Architecture:
  23 =============
  24
  25 |image3|
  26
  27 .. |image3| image:: media/CDS_architecture.jpg
  28    :height: 4.43750in
  29    :width: 7.88889in
  30
  31 Installation:
  32 =============
  33
  34 Building client html and js files
  35 =================================
  36
  37         * FROM alpine:3.8 as builder
  38
  39         * RUN apk add --no-cache npm
  40
  41         * WORKDIR /opt/cds-ui/client/
  42
  43         * COPY client/package.json /opt/cds-ui/client/
  44
  45         * RUN npm install
  46
  47         * COPY client /opt/cds-ui/client/
  48
  49         * RUN npm run build
  50
  51
  52 Building and creating server
  53 ============================
  54
  55         * FROM alpine:3.8
  56
  57         * WORKDIR /opt/cds-ui/
  58
  59         * RUN apk add --no-cache npm
  60
  61         * COPY server/package.json /opt/cds-ui/
  62
  63         * RUN npm install
  64
  65         * COPY server /opt/cds-ui/
  66
  67         * COPY --from=builder /opt/cds-ui/server/public /opt/cds-ui/public
  68
  69         * RUN npm run build
  70
  71         * EXPOSE 3000
  72
  73         * CMD [ "npm", "start" ]
  74
  75 Development:
  76 =============
  77
  78 Pre-requiste:
  79 =============
  80         Visual Studio code editor
  81         Git bash
  82         Node.js & npm
  83         loopback 4 cli
  84
  85
  86 Steps
  87 =====
  88    To compile CDS code:
  89
  90    1. Make sure your local Maven settings file ($HOME/.m2/settings.xml) contains
  91     references to the ONAP repositories and OpenDaylight repositories.
  92    2. git clone https://(LFID)@gerrit.onap.org/r/a/ccsdk/cds
  93    3. cd cds ; mvn clean install ; cd ..
  94    4. Open the cds-ui/client code for development
  95
  96 Data Flow:
  97 ==========
  98 |image1|
  99
 100 .. |image1| image:: media/image1.jpg
 101    :width: 7.88889in
 102    :height: 4.43750in
 103
 104 Functional Decomposition:
 105 =========================
 106 |image2|
 107
 108 .. |image2| image:: media/image2.jpg
 109    :width: 7.88889in
 110    :height: 4.43750in
 111
 112 Controller design Studio Presentation:
 113 ======================================
 114
 115 Details about CDS Architecture and Design detail, Please click the link.
 116 :download:`CDS_Architecture_Design.pptx`