diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/CBA/index.rst | 64 | ||||
| -rw-r--r-- | docs/CBA/resourceassignment.rst | 73 | ||||
| -rw-r--r-- | docs/CBA/sections/development/index.rst | 26 | ||||
| -rw-r--r-- | docs/CBA/sections/installation/index.rst | 47 | ||||
| -rw-r--r-- | docs/datadictionary/index.rst | 38 | ||||
| -rw-r--r-- | docs/index.rst | 68 |
6 files changed, 151 insertions, 165 deletions
diff --git a/docs/CBA/index.rst b/docs/CBA/index.rst index 06d902a74..3bc6aca95 100644 --- a/docs/CBA/index.rst +++ b/docs/CBA/index.rst @@ -31,20 +31,64 @@ Architecture: Installation: ============= -.. toctree:: - :maxdepth: 1 - :glob: - - sections/installation/index +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: ============= -.. toctree:: - :maxdepth: 1 - :glob: - - sections/development/index +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: ========== 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 diff --git a/docs/CBA/sections/development/index.rst b/docs/CBA/sections/development/index.rst deleted file mode 100644 index dc61a238c..000000000 --- a/docs/CBA/sections/development/index.rst +++ /dev/null @@ -1,26 +0,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. - -Development ------------- -.. toctree:: - :maxdepth: 1 - -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 - - - diff --git a/docs/CBA/sections/installation/index.rst b/docs/CBA/sections/installation/index.rst deleted file mode 100644 index eb7676d08..000000000 --- a/docs/CBA/sections/installation/index.rst +++ /dev/null @@ -1,47 +0,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. - -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" ]
\ No newline at end of file diff --git a/docs/datadictionary/index.rst b/docs/datadictionary/index.rst index 3243fd23f..83c6e47b8 100644 --- a/docs/datadictionary/index.rst +++ b/docs/datadictionary/index.rst @@ -2,44 +2,44 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright (C) 2019 IBM. -Data Dictionary ----------------- +Resource Definition +------------------- .. toctree:: :maxdepth: 1 Introduction: ============= -A data dictionary defines a specifc resource that can be resolved using the bellow supported sources. +A Resource Definition defines a specifc resource that can be resolved using the bellow supported sources. -A data dictionary can support multiple sources. +A Resource Definition can support multiple sources. -The main goal of data dictionary is to define generic entity that could be shared accross services. +The main goal of Resource Definition is to define generic entity that could be shared accross services. Resolution sources: =================== - Input - Default - DB - REST - Capability + * Input + * Default + * DB + * REST + * Capability Artifacts: ========== - artifact-mapping-resource - artifact-template-velocity - artifact-directed-graph - + * artifact-mapping-resource + * artifact-template-velocity + * artifact-directed-graph Node type: ========== - component-resource-resolution - component-jython-executor - component-netconf-executor - component-restconf-executor + + * component-resource-resolution + * component-jython-executor + * component-netconf-executor + * component-restconf-executor Data type: ========== - vnf-netconf-device
\ No newline at end of file + * vnf-netconf-device
\ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index b5a9576da..f46653ab6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -32,69 +32,11 @@ The GUI handles direct user input and allows for displaying both design time and Resource assignment: ===================== -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 +.. toctree:: + :maxdepth: 1 + :glob: + + resourceassignment ResolutionHelper: ================= |