| Ezhilarasi | 5962087 | 2019-03-08 16:17:22 +0530 | [diff] [blame] | 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 | |
| Ezhilarasi | 91e8342 | 2019-03-15 14:30:05 +0530 | [diff] [blame] | 5 | Controller Blueprint Archived Tool(CBA) |
| Ezhilarasi | 0f15309 | 2019-03-14 12:54:09 +0530 | [diff] [blame] | 6 | ---------------------------------------- |
| Ezhilarasi | 5962087 | 2019-03-08 16:17:22 +0530 | [diff] [blame] | 7 | .. toctree:: |
| 8 | :maxdepth: 1 |
| 9 | |
| 10 | Introduction: |
| 11 | ============= |
| Ezhilarasi | 0f15309 | 2019-03-14 12:54:09 +0530 | [diff] [blame] | 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. |
| Ezhilarasi | 5962087 | 2019-03-08 16:17:22 +0530 | [diff] [blame] | 13 | |
| Ezhilarasi | 0f15309 | 2019-03-14 12:54:09 +0530 | [diff] [blame] | 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.png |
| 19 | :width: 7.88889in |
| 20 | :height: 4.43750in |
| 21 | |
| Ezhilarasi | 91e8342 | 2019-03-15 14:30:05 +0530 | [diff] [blame] | 22 | Architecture: |
| 23 | ============= |
| Ezhilarasi | 0f15309 | 2019-03-14 12:54:09 +0530 | [diff] [blame] | 24 | |
| Ezhilarasi | 91e8342 | 2019-03-15 14:30:05 +0530 | [diff] [blame] | 25 | |image3| |
| 26 | |
| 27 | .. |image3| image:: media/CDS_architecture.jpg |
| 28 | :height: 4.43750in |
| 29 | :width: 7.88889in |
| 30 | |
| 31 | Installation: |
| 32 | ============= |
| Ezhilarasi | 5962087 | 2019-03-08 16:17:22 +0530 | [diff] [blame] | 33 | |
| Ezhilarasi | 9c710f4 | 2019-03-19 16:27:52 +0530 | [diff] [blame^] | 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" ] |
| Ezhilarasi | 91e8342 | 2019-03-15 14:30:05 +0530 | [diff] [blame] | 74 | |
| 75 | Development: |
| 76 | ============= |
| 77 | |
| Ezhilarasi | 9c710f4 | 2019-03-19 16:27:52 +0530 | [diff] [blame^] | 78 | Pre-requiste: |
| 79 | ============= |
| 80 | Visual Studio code editor |
| 81 | Git bash |
| 82 | |
| 83 | Steps |
| 84 | ===== |
| 85 | To compile CDS code: |
| 86 | |
| 87 | 1. Make sure your local Maven settings file ($HOME/.m2/settings.xml) contains |
| 88 | references to the ONAP repositories and OpenDaylight repositories. |
| 89 | 2. git clone https://(LFID)@gerrit.onap.org/r/a/ccsdk/cds |
| 90 | 3. cd cds ; mvn clean install ; cd .. |
| 91 | 4. Open the cds-ui/client code for development |
| Ezhilarasi | 0f15309 | 2019-03-14 12:54:09 +0530 | [diff] [blame] | 92 | |
| Ezhilarasi | 5962087 | 2019-03-08 16:17:22 +0530 | [diff] [blame] | 93 | Data Flow: |
| 94 | ========== |
| Ezhilarasi | 0f15309 | 2019-03-14 12:54:09 +0530 | [diff] [blame] | 95 | |image1| |
| Ezhilarasi | 5962087 | 2019-03-08 16:17:22 +0530 | [diff] [blame] | 96 | |
| Ezhilarasi | 0f15309 | 2019-03-14 12:54:09 +0530 | [diff] [blame] | 97 | .. |image1| image:: media/image1.png |
| Ezhilarasi | 5962087 | 2019-03-08 16:17:22 +0530 | [diff] [blame] | 98 | :width: 7.88889in |
| 99 | :height: 4.43750in |
| 100 | |
| 101 | Functional Decomposition: |
| 102 | ========================= |
| Ezhilarasi | 0f15309 | 2019-03-14 12:54:09 +0530 | [diff] [blame] | 103 | |image2| |
| Ezhilarasi | 5962087 | 2019-03-08 16:17:22 +0530 | [diff] [blame] | 104 | |
| Ezhilarasi | 0f15309 | 2019-03-14 12:54:09 +0530 | [diff] [blame] | 105 | .. |image2| image:: media/image2.png |
| Ezhilarasi | 5962087 | 2019-03-08 16:17:22 +0530 | [diff] [blame] | 106 | :width: 7.88889in |
| 107 | :height: 4.43750in |
| 108 | |
| 109 | Controller design Studio Presentation: |
| 110 | ====================================== |
| 111 | |
| Ezhilarasi | 91e8342 | 2019-03-15 14:30:05 +0530 | [diff] [blame] | 112 | Details about CDS Architecture and Design detail, Please click the link. |
| Ezhilarasi | 5962087 | 2019-03-08 16:17:22 +0530 | [diff] [blame] | 113 | :download:`CDS_Architecture_Design.pptx` |