diff options
| -rw-r--r-- | docs/CBA/index.rst | 140 | ||||
| -rw-r--r-- | docs/index.rst | 151 | ||||
| -rw-r--r-- | docs/media/CDS_architecture.jpg (renamed from docs/CDS_architecture.JPG) | bin | 140539 -> 140539 bytes | |||
| -rw-r--r-- | docs/media/tosca_model.jpg (renamed from docs/image0.jpg) | bin | 84320 -> 84320 bytes |
4 files changed, 157 insertions, 134 deletions
diff --git a/docs/CBA/index.rst b/docs/CBA/index.rst index 27d69b086..c29eca8d9 100644 --- a/docs/CBA/index.rst +++ b/docs/CBA/index.rst @@ -1,104 +1,94 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 +.. This work is licensed under a Creative Commons Attribution 4.0 +.. International License. http://creativecommons.org/licenses/by/4.0 .. Copyright (C) 2019 IBM. +.. _cds_cba-doc: + Controller Blueprint Archived Designer Tool(CBA) ------------------------------------------------- +================================================ .. toctree:: :maxdepth: 1 - -Introduction: -============= -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. -The CBA is .zip file, comprised of the following folder structure, the files may vary: +Introduction +------------ +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. + +The CBA is .zip file, comprised of the following folder structure, the +files may vary: |image0| -.. |image0| image:: media/image0.jpg - :width: 7.88889in - :height: 4.43750in -Architecture: -============= +Architecture +------------ |image3| -.. |image3| image:: media/CDS_architecture.jpg - :height: 4.43750in - :width: 7.88889in - -Installation: -============= - -Building client html and js files -================================= - - * FROM alpine:3.8 as builder - - * RUN apk add --no-cache npm - - * WORKDIR /opt/cds-ui/client/ - - * COPY client/package.json /opt/cds-ui/client/ - - * RUN npm install - * COPY client /opt/cds-ui/client/ +Installation +------------ - * RUN npm run build +Building client html and js files +................................. + * FROM alpine:3.8 as builder + * RUN apk add --no-cache npm + * WORKDIR /opt/cds-ui/client/ + * COPY client/package.json /opt/cds-ui/client/ + * RUN npm install + * COPY client /opt/cds-ui/client/ + * RUN npm run build Building and creating server -============================ - - * FROM alpine:3.8 - - * WORKDIR /opt/cds-ui/ - - * RUN apk add --no-cache npm - - * COPY server/package.json /opt/cds-ui/ - - * RUN npm install - - * COPY server /opt/cds-ui/ - - * COPY --from=builder /opt/cds-ui/server/public /opt/cds-ui/public - - * RUN npm run build - - * EXPOSE 3000 - - * CMD [ "npm", "start" ] - -Development: -============= - -Pre-requiste: -============= - Visual Studio code editor - Git bash - Node.js & npm - loopback 4 cli - +............................ + + * FROM alpine:3.8 + * WORKDIR /opt/cds-ui/ + * RUN apk add --no-cache npm + * COPY server/package.json /opt/cds-ui/ + * RUN npm install + * COPY server /opt/cds-ui/ + * COPY --from=builder /opt/cds-ui/server/public /opt/cds-ui/public + * RUN npm run build + * EXPOSE 3000 + * CMD [ "npm", "start" ] + +Development +----------- + +Pre-requiste +............ + * Visual Studio code editor + * Git bash + * Node.js & npm + * loopback 4 cl Steps -===== +..... To compile CDS code: - 1. Make sure your local Maven settings file ($HOME/.m2/settings.xml) contains - references to the ONAP repositories and OpenDaylight repositories. + 1. Make sure your local Maven settings file ($HOME/.m2/settings.xml) + contains references to the ONAP repositories and OpenDaylight + repositories. 2. git clone https://(LFID)@gerrit.onap.org/r/a/ccsdk/cds 3. cd cds ; mvn clean install ; cd .. 4. Open the cds-ui/client code for development - - -Functional Decomposition: -========================= + +Functional Decomposition +------------------------ |image2| +.. |image0| image:: media/image0.jpg + :width: 7.88889in + :height: 4.43750in + .. |image2| image:: media/image2.jpg - :width: 7.88889in + :width: 7.88889in :height: 4.43750in - + +.. |image3| image:: media/CDS_architecture.jpg + :height: 4.43750in + :width: 7.88889in diff --git a/docs/index.rst b/docs/index.rst index 15463643e..3a509670e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,38 +1,51 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 +.. This work is licensed under a Creative Commons Attribution 4.0 +.. International License. http://creativecommons.org/licenses/by/4.0 .. Copyright (C) 2019 IBM. -CONTROLLER DESIGN STUDIO (CDS) ------------------------------- +.. _cds_main-doc: + +CONTROLLER DESIGN STUDIO (CDS) +============================== .. toctree:: :maxdepth: 1 - -Introduction: -============= -The system is designed to be self service, which means that users, not just programmers, can reconfigure the software system as needed to meet customer requirements. To accomplish this goal, the system is built around models that provide for real-time changes in how the system operates. Users merely need to change a model to change how a service operates. -Self service is a completely new way of delivering services. It removes the dependence on code releases and the delays they cause and puts the control of services into the hands of the service providers. They can change a model and its parameters and create a new service without writing a single line of code. -This makes SERVICE PROVIDER(S) more responsive to its customers and able to deliver products that more closely match the needs of its customers. - -Modeling Concept: -================= -In Dublin release, the CDS community has contributed a framework to automate the resolution of resources for instantiation and any config provisioning operation, such as day0, day1 or day2 configuration. - -The content of the CBA Package is driven from a catalog of reusable data dictionary, component and workflow, delivering a reusable and simplified self service experience. - -TOSCA based JSON formatted model following standard: http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.2/csd01/TOSCA-Simple-Profile-YAML-v1.2-csd01.html -Most of the TOSCA modeled entity presented in the bellow documentation can be found here: https://github.com/onap/ccsdk-cds/tree/master/components/model-catalog/definition-type/starter-type - -Tosca Model Reference: +Introduction +------------ +The system is designed to be self service, which means that users, not just +programmers, can reconfigure the software system as needed to meet customer +requirements. To accomplish this goal, the system is built around models that +provide for real-time changes in how the system operates. Users merely need +to change a model to change how a service operates. +Self service is a completely new way of delivering services. It removes the +dependence on code releases and the delays they cause and puts the control of +services into the hands of the service providers. They can change a model and +its parameters and create a new service without writing a single line of code. +This makes SERVICE PROVIDER(S) more responsive to its customers and able to +deliver products that more closely match the needs of its customers. + +Modeling Concept +---------------- +In Dublin release, the CDS community has contributed a framework to automate +the resolution of resources for instantiation and any config provisioning +operation, such as day0, day1 or day2 configuration. + +The content of the CBA Package is driven from a catalog of reusable data +dictionary, component and workflow, delivering a reusable and simplified +self service experience. + +TOSCA based JSON formatted model following standard: +http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.2/csd01/TOSCA-Simple-Profile-YAML-v1.2-csd01.html + +Most of the TOSCA modeled entity presented in the bellow documentation can +be found here: +https://github.com/onap/ccsdk-cds/tree/master/components/model-catalog/definition-type/starter-type + +Tosca Model Reference: |image0| -.. |image0| image:: image0.jpg - :width: 7.88889in - :height: 4.43750in - -Design tools: -============= +Design tools +------------ .. toctree:: :maxdepth: 1 :glob: @@ -40,51 +53,71 @@ Design tools: CBA/index datadictionary/index -MicroServices: -============== +MicroServices +------------- .. toctree:: :maxdepth: 1 - - controllerBlueprintStudioProcessorMS - bluePrintsProcessorMS - -Architecture: -============= -The Controller Design Studio is composed of two major components: - * The GUI (or frontend) - * The Run Time (or backend) -The GUI handles direct user input and allows for displaying both design time and run time activities. For design time, it allows for the creation of controller blueprint, from selecting the DGs to be included, to incorporating the artifact templates, to adding necessary components. For run time, it allows the user to direct the system to resolve the unresolved elements of the controller blueprint and download the resulting configuration into a VNF. At a more basic level, it allows for creation of data dictionaries, capabilities catalogs, and controller blueprint, the basic elements that are used to generate a configuration. The essential function of the Controller Design Studio is to create and populate a controller blueprint, create a configuration file from this Controller blueprint, and download this configuration file (configlet) to a VNF/PNF. - -|image0| - -.. |image0| image:: CDS_architecture.jpg - :height: 4.43750in - :width: 7.88889in -User Guide: -=========== + controllerBlueprintStudioProcessorMS + bluePrintsProcessorMS + +Architecture +------------ +The Controller Design Studio is composed of two major components: + * The GUI (or frontend) + * The Run Time (or backend) + +The GUI handles direct user input and allows for displaying both design time +and run time activities. For design time, it allows for the creation of +controller blueprint, from selecting the DGs to be included, to incorporating +the artifact templates, to adding necessary components. For run time, it +allows the user to direct the system to resolve the unresolved elements of the +controller blueprint and download the resulting configuration into a VNF. +At a more basic level, it allows for creation of data dictionaries, +capabilities catalogs, and controller blueprint, the basic elements that are +used to generate a configuration. The essential function of the Controller +Design Studio is to create and populate a controller blueprint, create a +configuration file from this Controller blueprint, and download this +configuration file (configlet) to a VNF/PNF. + +|image1| + +User Guide +---------- .. toctree:: :maxdepth: 1 - + userguide - -Dynamic API: -============ + +Dynamic API +----------- .. toctree:: :maxdepth: 1 - + dynamicapi - -Controller design Studio Presentation: -====================================== + +Controller Design Studio Presentation +------------------------------------- Details about CDS Architecture and Design detail, Please click the link. :download:`CDS_Architecture_Design.pptx` -ResolutionHelper: -================= -When executing a component executor script, designer might want to perform resource resolution along with template meshing directly from the script itself. +ResolutionHelper +---------------- +When executing a component executor script, designer might want to perform +resource resolution along with template meshing directly from the script +itself. + +The helper can be find here: https://github.com/onap/ccsdk-apps/blob/master/components/scripts/python/ccsdk_netconf/common.py + +.. |image0| image:: media/tosca_model.jpg + :width: 7.88889in + :height: 4.43750in + +.. |image1| image:: media/CDS_architecture.jpg + :height: 4.43750in + :width: 7.88889in + -The helper can be find here: https://github.com/onap/ccsdk-apps/blob/master/components/scripts/python/ccsdk_netconf/common.py
\ No newline at end of file diff --git a/docs/CDS_architecture.JPG b/docs/media/CDS_architecture.jpg Binary files differindex c8528ac1e..c8528ac1e 100644 --- a/docs/CDS_architecture.JPG +++ b/docs/media/CDS_architecture.jpg diff --git a/docs/image0.jpg b/docs/media/tosca_model.jpg Binary files differindex dce3cee25..dce3cee25 100644 --- a/docs/image0.jpg +++ b/docs/media/tosca_model.jpg |
