| 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 | |
| Ezhilarasi | 6cd7d6b | 2019-04-16 15:30:19 +0530 | [diff] [blame] | 7 | Controller Blueprint Archived Designer Tool(CBA) |
| andreasgeissler | 6642a72 | 2019-05-31 12:23:38 +0200 | [diff] [blame] | 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 | ------------ |
| 14 | The Controller Blueprint Archived is the overall service design, fully |
| 15 | model-driven, package needed to automate the resolution of resources for |
| 16 | instantiation and any config provisioning operation, such as day0, |
| 17 | day1 or day2 configuration. |
| 18 | |
| 19 | The CBA is .zip file, comprised of the following folder structure, the |
| 20 | files may vary: |
| Ezhilarasi | 0f15309 | 2019-03-14 12:54:09 +0530 | [diff] [blame] | 21 | |
| 22 | |image0| |
| 23 | |
| Ezhilarasi | 0f15309 | 2019-03-14 12:54:09 +0530 | [diff] [blame] | 24 | |
| andreasgeissler | 6642a72 | 2019-05-31 12:23:38 +0200 | [diff] [blame] | 25 | Architecture |
| 26 | ------------ |
| Ezhilarasi | 0f15309 | 2019-03-14 12:54:09 +0530 | [diff] [blame] | 27 | |
| Ezhilarasi | 91e8342 | 2019-03-15 14:30:05 +0530 | [diff] [blame] | 28 | |image3| |
| 29 | |
| andreasgeissler | 6642a72 | 2019-05-31 12:23:38 +0200 | [diff] [blame] | 30 | |
| 31 | Installation |
| 32 | ------------ |
| 33 | |
| 34 | Building client html and js files |
| 35 | ................................. |
| 36 | |
| 37 | * FROM alpine:3.8 as builder |
| 38 | * RUN apk add --no-cache npm |
| 39 | * WORKDIR /opt/cds-ui/client/ |
| 40 | * COPY client/package.json /opt/cds-ui/client/ |
| 41 | * RUN npm install |
| 42 | * COPY client /opt/cds-ui/client/ |
| 43 | * RUN npm run build |
| 44 | |
| 45 | Building and creating server |
| 46 | ............................ |
| 47 | |
| 48 | * FROM alpine:3.8 |
| 49 | * WORKDIR /opt/cds-ui/ |
| 50 | * RUN apk add --no-cache npm |
| 51 | * COPY server/package.json /opt/cds-ui/ |
| 52 | * RUN npm install |
| 53 | * COPY server /opt/cds-ui/ |
| 54 | * COPY --from=builder /opt/cds-ui/server/public /opt/cds-ui/public |
| 55 | * RUN npm run build |
| 56 | * EXPOSE 3000 |
| 57 | * CMD [ "npm", "start" ] |
| 58 | |
| 59 | Development |
| 60 | ----------- |
| 61 | |
| 62 | Pre-requiste |
| 63 | ............ |
| 64 | * Visual Studio code editor |
| 65 | * Git bash |
| 66 | * Node.js & npm |
| 67 | * loopback 4 cl |
| 68 | |
| 69 | Steps |
| 70 | ..... |
| 71 | To compile CDS code: |
| 72 | |
| 73 | 1. Make sure your local Maven settings file ($HOME/.m2/settings.xml) |
| 74 | contains references to the ONAP repositories and OpenDaylight |
| 75 | repositories. |
| 76 | 2. git clone https://(LFID)@gerrit.onap.org/r/a/ccsdk/cds |
| 77 | 3. cd cds ; mvn clean install ; cd .. |
| 78 | 4. Open the cds-ui/client code for development |
| 79 | |
| 80 | Functional Decomposition |
| 81 | ------------------------ |
| 82 | |image2| |
| 83 | |
| 84 | .. |image0| image:: media/image0.jpg |
| 85 | :width: 7.88889in |
| 86 | :height: 4.43750in |
| 87 | |
| 88 | .. |image2| image:: media/image2.jpg |
| 89 | :width: 7.88889in |
| 90 | :height: 4.43750in |
| 91 | |
| Ezhilarasi | 91e8342 | 2019-03-15 14:30:05 +0530 | [diff] [blame] | 92 | .. |image3| image:: media/CDS_architecture.jpg |
| 93 | :height: 4.43750in |
| 94 | :width: 7.88889in |