Blame - docs/CBA/index.rst - onap/ccsdk/cds

blob: c7b219f5c0b01c7c4bffc114e5d417746720ce33 [file] [log] [blame]

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
Ezhilarasi	2da6f4a	2019-03-21 20:07:15 +0530	[diff] [blame]	18	.. \|image0\| image:: media/image0.jpg
Ezhilarasi	0f15309	2019-03-14 12:54:09 +0530	[diff] [blame]	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
Arundathi Patil	8a3bac6	2019-03-28 15:29:46 +0530	[diff] [blame^]	82	Node.js & npm
				83	loopback 4 cli
				84
Ezhilarasi	9c710f4	2019-03-19 16:27:52 +0530	[diff] [blame]	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
Ezhilarasi	0f15309	2019-03-14 12:54:09 +0530	[diff] [blame]	95
Ezhilarasi	5962087	2019-03-08 16:17:22 +0530	[diff] [blame]	96	Data Flow:
				97	==========
Ezhilarasi	0f15309	2019-03-14 12:54:09 +0530	[diff] [blame]	98	\|image1\|
Ezhilarasi	5962087	2019-03-08 16:17:22 +0530	[diff] [blame]	99
Ezhilarasi	2da6f4a	2019-03-21 20:07:15 +0530	[diff] [blame]	100	.. \|image1\| image:: media/image1.jpg
Ezhilarasi	5962087	2019-03-08 16:17:22 +0530	[diff] [blame]	101	:width: 7.88889in
				102	:height: 4.43750in
				103
				104	Functional Decomposition:
				105	=========================
Ezhilarasi	0f15309	2019-03-14 12:54:09 +0530	[diff] [blame]	106	\|image2\|
Ezhilarasi	5962087	2019-03-08 16:17:22 +0530	[diff] [blame]	107
Ezhilarasi	2da6f4a	2019-03-21 20:07:15 +0530	[diff] [blame]	108	.. \|image2\| image:: media/image2.jpg
Ezhilarasi	5962087	2019-03-08 16:17:22 +0530	[diff] [blame]	109	:width: 7.88889in
				110	:height: 4.43750in
				111
				112	Controller design Studio Presentation:
				113	======================================
				114
Ezhilarasi	91e8342	2019-03-15 14:30:05 +0530	[diff] [blame]	115	Details about CDS Architecture and Design detail, Please click the link.
Ezhilarasi	5962087	2019-03-08 16:17:22 +0530	[diff] [blame]	116	:download:`CDS_Architecture_Design.pptx`