Gitiles
Code Review Sign In
gerrit.nordix.org / onap / ccsdk / cds / 684d27d171546d7d2f90d84f47faea152ce84966 / . / docs / cba / index.rst
blob: 62eb927177ab3e4911e88b29a7a82ecc8ad28bef [file] [log] [blame]
andreasgeissler6642a722019-05-31 12:23:38 +0200[diff] [blame]1.. This work is licensed under a Creative Commons Attribution 4.0
2.. International License. http://creativecommons.org/licenses/by/4.0
Ezhilarasi59620872019-03-08 16:17:22 +0530[diff] [blame]3.. Copyright (C) 2019 IBM.
4
andreasgeissler6642a722019-05-31 12:23:38 +0200[diff] [blame]5.. _cds_cba-doc:
6
Singal, Kapil (ks220y)f1aafc42020-09-24 12:47:56 -0400[diff] [blame]7Controller Blueprint Archived Designer Tool (CBA)
8=================================================
Ezhilarasi59620872019-03-08 16:17:22 +0530[diff] [blame]9.. toctree::
10 :maxdepth: 1
Ezhilarasi59620872019-03-08 16:17:22 +0530[diff] [blame]11
andreasgeissler6642a722019-05-31 12:23:38 +0200[diff] [blame]12Introduction
13------------
andreasgeissler6642a722019-05-31 12:23:38 +0200[diff] [blame]14
JakobKriegb7beaee2020-12-01 14:17:11 +0100[diff] [blame]15.. include:: cba-description.rst
Ezhilarasi0f153092019-03-14 12:54:09 +0530[diff] [blame]16
andreasgeissler6642a722019-05-31 12:23:38 +0200[diff] [blame]17Architecture
18------------
Singal, Kapil (ks220y)f1aafc42020-09-24 12:47:56 -0400[diff] [blame]19|image1|
Ezhilarasi0f153092019-03-14 12:54:09 +0530[diff] [blame]20
Singal, Kapil (ks220y)51e7c122020-09-25 17:22:54 -0400[diff] [blame]21
Singal, Kapil (ks220y)f1aafc42020-09-24 12:47:56 -0400[diff] [blame]22Data Flow
23---------
24|image2|
Ezhilarasi91e83422019-03-15 14:30:05 +0530[diff] [blame]25
andreasgeissler6642a722019-05-31 12:23:38 +0200[diff] [blame]26
27Installation
28------------
29
30Building 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
41Building 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
Singal, Kapil (ks220y)51e7c122020-09-25 17:22:54 -0400[diff] [blame]55
andreasgeissler6642a722019-05-31 12:23:38 +0200[diff] [blame]56Development
57-----------
58
59Pre-requiste
60............
61 * Visual Studio code editor
62 * Git bash
63 * Node.js & npm
64 * loopback 4 cl
65
66Steps
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
Singal, Kapil (ks220y)51e7c122020-09-25 17:22:54 -0400[diff] [blame]77
andreasgeissler6642a722019-05-31 12:23:38 +0200[diff] [blame]78Functional Decomposition
79------------------------
Singal, Kapil (ks220y)f1aafc42020-09-24 12:47:56 -0400[diff] [blame]80|image3|
andreasgeissler6642a722019-05-31 12:23:38 +0200[diff] [blame]81
Singal, Kapil (ks220y)f1aafc42020-09-24 12:47:56 -0400[diff] [blame]82.. |image1| image:: media/CDS_Architecture.jpg
83 :width: 500pt
andreasgeissler6642a722019-05-31 12:23:38 +0200[diff] [blame]84
Singal, Kapil (ks220y)f1aafc42020-09-24 12:47:56 -0400[diff] [blame]85.. |image2| image:: media/CDS_Data_Flow.jpg
86 :width: 500pt
andreasgeissler6642a722019-05-31 12:23:38 +0200[diff] [blame]87
Singal, Kapil (ks220y)f1aafc42020-09-24 12:47:56 -0400[diff] [blame]88.. |image3| image:: media/Functional_Decomposition.jpg
89 :width: 500pt
90