diff options
| -rw-r--r-- | docs/CBA/index.rst | 31 | ||||
| -rw-r--r-- | docs/CBA/media/image0.PNG | bin | 111684 -> 93418 bytes | |||
| -rw-r--r-- | docs/CBA/media/image1.PNG | bin | 0 -> 111684 bytes | |||
| -rw-r--r-- | docs/CBA/media/image2.PNG (renamed from docs/CBA/media/functional_decomposition.PNG) | bin | 77925 -> 77925 bytes | |||
| -rw-r--r-- | docs/index.rst | 18 |
5 files changed, 27 insertions, 22 deletions
diff --git a/docs/CBA/index.rst b/docs/CBA/index.rst index bc39ca392..71ef527ff 100644 --- a/docs/CBA/index.rst +++ b/docs/CBA/index.rst @@ -2,18 +2,25 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright (C) 2019 IBM. -CONTROLLER DESIGN STUDIO DOCUMENTATION REPOSITORY -------------------------------------------------- +Controller Blueprint Archived Tool(.cba) +---------------------------------------- .. 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. +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. -Sections +The CBA is .zip file, comprised of the following folder structure, the files may vary: + +|image0| + +.. |image0| image:: media/image0.png + :width: 7.88889in + :height: 4.43750in + + +Sections: ======== .. toctree:: @@ -24,22 +31,20 @@ Sections sections/installation/index sections/configuration/index sections/development/index - sections/logging - sections/release-notes - + Data Flow: ========== -|image0| +|image1| -.. |image0| image:: media/image0.png +.. |image1| image:: media/image1.png :width: 7.88889in :height: 4.43750in Functional Decomposition: ========================= -|image1| +|image2| -.. |image1| image:: media/functional_decomposition.png +.. |image2| image:: media/image2.png :width: 7.88889in :height: 4.43750in diff --git a/docs/CBA/media/image0.PNG b/docs/CBA/media/image0.PNG Binary files differindex 7a4b96d5c..1c5d8c5ff 100644 --- a/docs/CBA/media/image0.PNG +++ b/docs/CBA/media/image0.PNG 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/functional_decomposition.PNG b/docs/CBA/media/image2.PNG Binary files differindex e6a0cf8d3..e6a0cf8d3 100644 --- a/docs/CBA/media/functional_decomposition.PNG +++ b/docs/CBA/media/image2.PNG diff --git a/docs/index.rst b/docs/index.rst index 8669ffea1..c16fee5af 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,8 +2,8 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright (C) 2019 IBM. -CONTROLLER DESIGN STUDIO DOCUMENTATION REPOSITORY -------------------------------------------------- +CONTROLLER DESIGN STUDIO (CDS) +------------------------------ .. toctree:: :maxdepth: 1 @@ -14,7 +14,7 @@ Self service is a completely new way of delivering services. It removes the dep This makes SERVICE PROVIDER(S) more responsive to its customers and able to deliver products that more closely match the needs of its customers. Design tools: -============= +------------- .. toctree:: :maxdepth: 1 :glob: @@ -33,16 +33,16 @@ 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. @@ -58,7 +58,7 @@ ${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: @@ -69,8 +69,8 @@ A mapping is comprised of: - dictionary-name - dictionary-source -dependencies: -------------- +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. |
