From 3a3a217f923e90a199c69bc4e8726f90c6c99565 Mon Sep 17 00:00:00 2001 From: Ezhilarasi Date: Mon, 15 Jul 2019 21:08:56 +0530 Subject: Remove unwanted files from docs folder Change-Id: I7b2fad9d9fbc156c6ae7e3c514a8a161f16f63f1 Issue-ID: CCSDK-1453 Signed-off-by: Ezhilarasi --- docs/bluePrintsProcessorMS.rst | 73 --------------------------- docs/controllerBlueprintStudioProcessorMS.rst | 32 ------------ 2 files changed, 105 deletions(-) delete mode 100644 docs/bluePrintsProcessorMS.rst delete mode 100644 docs/controllerBlueprintStudioProcessorMS.rst (limited to 'docs') diff --git a/docs/bluePrintsProcessorMS.rst b/docs/bluePrintsProcessorMS.rst deleted file mode 100644 index 3f308138f..000000000 --- a/docs/bluePrintsProcessorMS.rst +++ /dev/null @@ -1,73 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons. -.. Copyright (C) 2019 IBM. - -Blueprints Processor -==================== - -.. toctree:: - :maxdepth: 1 - :titlesonly: - -Micro service to Manage Controller Blueprint Models, such as Resource Dictionary, Service Models, Velocity Templates etc, which will serve service for Controller Design Studio and Controller runtimes. - -This microservice is used to deploy Controller Blueprint Archive file in Run time database. This also helps to test the Valid Blueprint. - -Architecture: -------------- - -|image0| - -.. |image0| image:: images/blueprintprocessor.jpg - :height: 600px - :width: 800px - -Running Blueprints Processor Microservice Locally: --------------------------------------------------- - -The purpose of this page is to show how to run the Blueprints Processor microservice locally, using the docker-compose.yaml file provided in the project. - -Check out the CDS' code: - -Check out the latest code from Gerrit: https://gerrit.onap.org/r/#/admin/projects/ccsdk/cds - -Build CDS locally: -In the checked out directory, type - - mvn clean install -DskipTests=true -Dmaven.test.skip=true -Dmaven.javadoc.skip=true -Dadditionalparam=-Xdoclint:none - -Create the needed Docker images: - -The Blueprints Processor microservice project has a module, called distribution, that provides a docker-compose.yaml file that can be used to spin up Docker containers to run this microservice. - -The first step is to create any custom image needed, by building the distribution module. From the CDS home directory (where the code was checked out), navigate to the module: - - cd ms/blueprintsprocessor/distribution/ -Build it using the Maven profile called Docker: - - mvn clean install -Pdocker - -Start Docker containers using docker-composer: ----------------------------------------------- - -Navigate to the docker-compose file in the distribution module: - - cd src/main/dc/ - -From there, start the containers: - - docker-compose up -d -This will spin the Docker containers declared inside the docker-compose.yaml file in the background. - - -To verify the logs generated by docker-composer, type: - - docker-compose logs -f - - -Testing the environment: ------------------------- - -Point your browser to http://localhost:8000/api/v1/execution-service/ping (please note that the port is 8000, not 8080) - -To authenticate, use ccsdkapps / ccsdkapps as login / password. \ No newline at end of file diff --git a/docs/controllerBlueprintStudioProcessorMS.rst b/docs/controllerBlueprintStudioProcessorMS.rst deleted file mode 100644 index 6f3152d20..000000000 --- a/docs/controllerBlueprintStudioProcessorMS.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons. -.. Copyright (C) 2019 IBM. - -Controller Blueprints Studio Processor -====================================== - -The Controller Blueprint Archive is the overall service design, fully model-driven, intent based package needed for SELF SERVICE provisioning and configuration management automation. - -The CBA is .zip file which is saved in Controller Blueprint Database. - -Dynamic API: ------------- - -The nature of the API request and response is meant to be model driven and dynamic. They both share the same definition. - -The actionName, under the actionIdentifiers refers to the name of a Workflow (see workflow) - -The content of the payload is what is fully dynamic / model driven. - -The first top level element will always be either $actionName-request for a request or $actionName-response for a response. - -Then the content within this element is fully based on the workflow input and output. - - -Enrichment: ------------ - -Helps to generate complete valid CBA file. - - - \ No newline at end of file -- cgit 1.2.3-korg