diff options
Diffstat (limited to 'docs/CBA')
-rw-r--r-- | docs/CBA/CDS_Architecture_Design.pptx | bin | 0 -> 1226310 bytes | |||
-rw-r--r-- | docs/CBA/index.rst | 113 | ||||
-rw-r--r-- | docs/CBA/media/CDS_architecture.jpg | bin | 0 -> 102560 bytes | |||
-rw-r--r-- | docs/CBA/media/image0.PNG | bin | 0 -> 93418 bytes | |||
-rw-r--r-- | docs/CBA/media/image0.jpg | bin | 0 -> 150033 bytes | |||
-rw-r--r-- | docs/CBA/media/image1.PNG | bin | 0 -> 111684 bytes | |||
-rw-r--r-- | docs/CBA/media/image1.jpg | bin | 0 -> 167601 bytes | |||
-rw-r--r-- | docs/CBA/media/image2.PNG | bin | 0 -> 77925 bytes | |||
-rw-r--r-- | docs/CBA/media/image2.jpg | bin | 0 -> 114351 bytes | |||
-rw-r--r-- | docs/CBA/resourceassignment.rst | 73 |
10 files changed, 186 insertions, 0 deletions
diff --git a/docs/CBA/CDS_Architecture_Design.pptx b/docs/CBA/CDS_Architecture_Design.pptx Binary files differnew file mode 100644 index 000000000..a6c158d8d --- /dev/null +++ b/docs/CBA/CDS_Architecture_Design.pptx diff --git a/docs/CBA/index.rst b/docs/CBA/index.rst new file mode 100644 index 000000000..3bc6aca95 --- /dev/null +++ b/docs/CBA/index.rst @@ -0,0 +1,113 @@ +.. 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 Blueprint Archived 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: + +|image0| + +.. |image0| image:: media/image0.jpg + :width: 7.88889in + :height: 4.43750in + +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/ + + * 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 + +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. + 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 + +Data Flow: +========== +|image1| + +.. |image1| image:: media/image1.jpg + :width: 7.88889in + :height: 4.43750in + +Functional Decomposition: +========================= +|image2| + +.. |image2| image:: media/image2.jpg + :width: 7.88889in + :height: 4.43750in + +Controller design Studio Presentation: +====================================== + +Details about CDS Architecture and Design detail, Please click the link. +:download:`CDS_Architecture_Design.pptx`
\ No newline at end of file diff --git a/docs/CBA/media/CDS_architecture.jpg b/docs/CBA/media/CDS_architecture.jpg Binary files differnew file mode 100644 index 000000000..6401e6bbd --- /dev/null +++ b/docs/CBA/media/CDS_architecture.jpg diff --git a/docs/CBA/media/image0.PNG b/docs/CBA/media/image0.PNG Binary files differnew file mode 100644 index 000000000..1c5d8c5ff --- /dev/null +++ b/docs/CBA/media/image0.PNG diff --git a/docs/CBA/media/image0.jpg b/docs/CBA/media/image0.jpg Binary files differnew file mode 100644 index 000000000..8e53a2d98 --- /dev/null +++ b/docs/CBA/media/image0.jpg diff --git a/docs/CBA/media/image1.PNG b/docs/CBA/media/image1.PNG Binary files differnew file mode 100644 index 000000000..7a4b96d5c --- /dev/null +++ b/docs/CBA/media/image1.PNG diff --git a/docs/CBA/media/image1.jpg b/docs/CBA/media/image1.jpg Binary files differnew file mode 100644 index 000000000..9a5cd63e4 --- /dev/null +++ b/docs/CBA/media/image1.jpg diff --git a/docs/CBA/media/image2.PNG b/docs/CBA/media/image2.PNG Binary files differnew file mode 100644 index 000000000..e6a0cf8d3 --- /dev/null +++ b/docs/CBA/media/image2.PNG diff --git a/docs/CBA/media/image2.jpg b/docs/CBA/media/image2.jpg Binary files differnew file mode 100644 index 000000000..20fc26250 --- /dev/null +++ b/docs/CBA/media/image2.jpg diff --git a/docs/CBA/resourceassignment.rst b/docs/CBA/resourceassignment.rst new file mode 100644 index 000000000..be8b08e25 --- /dev/null +++ b/docs/CBA/resourceassignment.rst @@ -0,0 +1,73 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright (C) 2019 IBM. + +Resource Assignment +=================== +.. toctree:: + :maxdepth: 1 + + +Component executor: +=================== +Workflow: +========= + +A workflow defines an overall action to be taken for the service; it can be composed of a set of sub-actions to execute. Currently, workflows are backed by Directed Graph engine. + +A CBA can have as many workflow as needed. + +Template: +========= + +A template is an artifact. + +A template is parameterized and each parameter must be defined in a corresponding mapping file. + +In order to know which mapping correlate to which template, the file name must start with an artifact-prefix, serving as identifier to the overall template + mapping. + +The requirement is as follow: + +${artifact-prefix}-template +${artifact-prefix}-mapping + +A template can represent anything, such as device config, payload to interact with 3rd party systems, resource-accumulator template, etc... + +Mapping: +======== +Defines the contract of each resource to be resolved. Each placeholder in the template must have a corresponding mapping definition. + +A mapping is comprised of: + +- name +- required / optional +- type (support complex type) +- dictionary-name +- dictionary-source + +Dependencies: +============= + +This allows to make sure given resources get resolved prior the resolution of the resources defining the dependency. +The dictionary fields reference to a specific data dictionary. + +Resource accumulator: +===================== + +In order to resolve HEAT environment variables, resource accumulator templates are being in used for Dublin. + +These templates are specific to the pre-instantiation scenario, and relies on GR-API within SDNC. + +It is composed of the following sections: + +resource-accumulator-resolved-data: defines all the resources that can be resolved directly from the context. It expresses a direct mapping between the name of the resource and its value. + +capability-data: defines what capability to use to create a specific resource, along with the ingredients required to invoke the capability and the output mapping. + +- Scripts +- Library +- NetconfClient + +In order to facilitate NETCONF interaction within scripts, a python NetconfClient binded to our Kotlin implementation is made available. This NetconfClient can be used when using the netconf-component-executor. + +The client can be find here: https://github.com/onap/ccsdk-apps/blob/master/components/scripts/python/ccsdk_netconf/netconfclient.py
\ No newline at end of file |