andreasgeissler | 6642a72 | 2019-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 |
Ezhilarasi | 5962087 | 2019-03-08 16:17:22 +0530 | [diff] [blame] | 3 | .. Copyright (C) 2019 IBM. |
| 4 | |
andreasgeissler | 6642a72 | 2019-05-31 12:23:38 +0200 | [diff] [blame] | 5 | .. _cds_cba-doc: |
| 6 | |
Singal, Kapil (ks220y) | f1aafc4 | 2020-09-24 12:47:56 -0400 | [diff] [blame] | 7 | Controller Blueprint Archived Designer Tool (CBA) |
| 8 | ================================================= |
Ezhilarasi | 5962087 | 2019-03-08 16:17:22 +0530 | [diff] [blame] | 9 | .. toctree:: |
| 10 | :maxdepth: 1 |
Ezhilarasi | 5962087 | 2019-03-08 16:17:22 +0530 | [diff] [blame] | 11 | |
andreasgeissler | 6642a72 | 2019-05-31 12:23:38 +0200 | [diff] [blame] | 12 | Introduction |
| 13 | ------------ |
andreasgeissler | 6642a72 | 2019-05-31 12:23:38 +0200 | [diff] [blame] | 14 | |
JakobKrieg | b7beaee | 2020-12-01 14:17:11 +0100 | [diff] [blame^] | 15 | .. include:: cba-description.rst |
Ezhilarasi | 0f15309 | 2019-03-14 12:54:09 +0530 | [diff] [blame] | 16 | |
andreasgeissler | 6642a72 | 2019-05-31 12:23:38 +0200 | [diff] [blame] | 17 | Architecture |
| 18 | ------------ |
Singal, Kapil (ks220y) | f1aafc4 | 2020-09-24 12:47:56 -0400 | [diff] [blame] | 19 | |image1| |
Ezhilarasi | 0f15309 | 2019-03-14 12:54:09 +0530 | [diff] [blame] | 20 | |
Singal, Kapil (ks220y) | 51e7c12 | 2020-09-25 17:22:54 -0400 | [diff] [blame] | 21 | |
Singal, Kapil (ks220y) | f1aafc4 | 2020-09-24 12:47:56 -0400 | [diff] [blame] | 22 | Data Flow |
| 23 | --------- |
| 24 | |image2| |
Ezhilarasi | 91e8342 | 2019-03-15 14:30:05 +0530 | [diff] [blame] | 25 | |
andreasgeissler | 6642a72 | 2019-05-31 12:23:38 +0200 | [diff] [blame] | 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 | |
Singal, Kapil (ks220y) | 51e7c12 | 2020-09-25 17:22:54 -0400 | [diff] [blame] | 55 | |
andreasgeissler | 6642a72 | 2019-05-31 12:23:38 +0200 | [diff] [blame] | 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 | |
Singal, Kapil (ks220y) | 51e7c12 | 2020-09-25 17:22:54 -0400 | [diff] [blame] | 77 | |
andreasgeissler | 6642a72 | 2019-05-31 12:23:38 +0200 | [diff] [blame] | 78 | Functional Decomposition |
| 79 | ------------------------ |
Singal, Kapil (ks220y) | f1aafc4 | 2020-09-24 12:47:56 -0400 | [diff] [blame] | 80 | |image3| |
andreasgeissler | 6642a72 | 2019-05-31 12:23:38 +0200 | [diff] [blame] | 81 | |
Singal, Kapil (ks220y) | f1aafc4 | 2020-09-24 12:47:56 -0400 | [diff] [blame] | 82 | .. |image1| image:: media/CDS_Architecture.jpg |
| 83 | :width: 500pt |
andreasgeissler | 6642a72 | 2019-05-31 12:23:38 +0200 | [diff] [blame] | 84 | |
Singal, Kapil (ks220y) | f1aafc4 | 2020-09-24 12:47:56 -0400 | [diff] [blame] | 85 | .. |image2| image:: media/CDS_Data_Flow.jpg |
| 86 | :width: 500pt |
andreasgeissler | 6642a72 | 2019-05-31 12:23:38 +0200 | [diff] [blame] | 87 | |
Singal, Kapil (ks220y) | f1aafc4 | 2020-09-24 12:47:56 -0400 | [diff] [blame] | 88 | .. |image3| image:: media/Functional_Decomposition.jpg |
| 89 | :width: 500pt |
| 90 | |