commit message for doc

commit message for documentation for bp gen tool, got rid of readme

Change-Id: I816a9742023be95de3078321059335fb24a74721
Issue-ID: DCAEGEN2-1125
Signed-off-by: ms236b <ms236b@att.com>

1 files changed, 54 insertions, 0 deletions

diff --git a/platformdoc/docs/components/dcae-cli/blueprint-generator/blueprint_generator.rst b/platformdoc/docs/components/dcae-cli/blueprint-generator/blueprint_generator.rst
new file mode 100644
index 00000000..06ed5347
--- /dev/null
+++ b/platformdoc/docs/components/dcae-cli/blueprint-generator/blueprint_generator.rst
@@ -0,0 +1,54 @@
+
+
+Blueprint Generator (DCAE)
+=============================================
+
+What is the Blueprint Generator?
+++++++++++++++++++++++++++++++++
+The blueprint generator is a java rewrite of the tosca lab python tool. The point of this tool is to be able to take a component spec for a given micro-service and translate that component spec into a blueprint yaml file that can be used during deployment.
+rin
+
+Steps to run the blueprint generator:
++++++++++++++++++++++++++++++++++++++
+
+1. Download the zip file from maven by clicking `here <https://nexus.onap.org/content/repositories/snapshots/org/onap/dcaegen2/platform/cli/blueprint-generator/1.0.0-SNAPSHOT/blueprint-generator-1.0.0-20190410.212437-1-bundle.tar.gz/>`_ or by going to https://nexus.onap.org/content/repositories/snapshots/org/onap/dcaegen2/platform/cli/blueprint-generator/1.0.0-SNAPSHOT/ and clicking "blueprint-generator-1.0.0-20190410.212437-1-bundle.tar.gz"
+
+2. Unzip the the tar file
+
+3. cd into the folder that gets created. (You should see a lib folder in this directory)
+
+4. If you are in linux run the following command: java -cp blueprint-generator/lib/blueprint-generator-1.0.0-SNAPSHOT.jar:blueprint-generator/lib/* org.onap.blueprintgenerator.core.BlueprintGenerator
+
+5. If you are in wondows run this command java -cp "lib/blueprint-generator-1.0.0-SNAPSHOT.jar;lib/\*" org.onap.blueprintgenerator.core.BlueprintGenerator.
+
+6. These commands mean that it will run java, find a path to the jar that we want to run along with all of the dependencies that we need, then you add the path to the main method. If done correctly you should see a list of all of the flags you can add. 
+
+7. When ready you can run the program again except with the required flags.
+
+8. OPTIONS:
+    -p: The path to where the final blueprint yaml file will be created (Required)
+
+    -i: The path to the JSON spec file (required)
+
+    -n: Name of the blueprint (optional)
+
+    -t: the path to the import yaml file (optional)
+
+9. An example running this program in windows would look like this java -cp "lib/blueprint-generator-onap-0.0.1-SNAPSHOT.jar;lib/\*" org.onap.blueprintgenerator.core.BlueprintGenerator -p Blueprints -i ComponentSpecs/TestComponentSpec.json -n HelloWorld
+
+
+Extra information
+-----------------
+
+1. The component spec must be of the same format as stated in the onap `readthedocs <https://onap.readthedocs.io/en/latest/submodules/dcaegen2.git/docs/sections/components/component-specification/common-specification.html#working-with-component-specs>`_ page
+
+2. If the tag says required then the program will not run without those tags being there
+
+3. If the tag says optional then it is not necessary to run the program with those tags
+
+4. If you do not add a -n tag the blueprint name will default to what it is in the component spec
+
+5. If the directory you specified in the -p tag does not already exist the directory will be created for you
+
+6. The -t flag will override the default imports set for the blueprints. To see an example of how the import yaml file should be structured see the testImports.yaml file under the folder TestCases
+l
\ No newline at end of file