summaryrefslogtreecommitdiffstats
path: root/mod/bpgenerator/README.md
diff options
context:
space:
mode:
authorRavi Mantena <rx908f@att.com>2020-10-21 15:47:38 -0400
committerRavi Mantena <rx908f@att.com>2020-11-19 12:44:18 -0500
commit55dcf3197958c76b1622a0c26489e68fe77e0314 (patch)
tree1abf70007833878c5e60a4e112d68fe6d5cb5636 /mod/bpgenerator/README.md
parentc8d244d826cc1d9b2ad7aeb0ca0874e321ad4577 (diff)
Blueprint Generator Refactored Code Issue-ID: DCAEGEN2-2472
Change-Id: I2ade7fb3b4196554eb4ecadd918fd45cb6ba8a52 Signed-off-by: Ravi Mantena <rx908f@att.com>
Diffstat (limited to 'mod/bpgenerator/README.md')
-rw-r--r--mod/bpgenerator/README.md13
1 files changed, 8 insertions, 5 deletions
diff --git a/mod/bpgenerator/README.md b/mod/bpgenerator/README.md
index d6b6f7d..eb35aff 100644
--- a/mod/bpgenerator/README.md
+++ b/mod/bpgenerator/README.md
@@ -27,14 +27,17 @@ OPTIONS:
- -d: Onvoke the dmaap plugin (optional)
- -o: The service component name override (optional)
-
it will look like this:
```bash
-java -jar target/blueprint-generator-1.4.0-SNAPSHOT-executable.jar blueprint -p Blueprints -i ComponentSpecs/TestComponentSpec.json -n HelloWorld -d
+ java -jar target/<JAR Filename>.jar app ONAP -i componentspec -p OutputBlueprintPath -n Blueprintname -d
```
-This command will create a blueprint from the component spec TestComponentSpec. The blueprint file name will be called HelloWorld.yaml and it will be in the directory Blueprints. The blueprint will also contain the DMaaP plugin.
+This command will create a blueprint from the component spec. The blueprint file name will be called Blueprintname.yaml and it will be in the directory OutputBlueprintPath. The blueprint will also contain the DMaaP plugin.
+
+
+
+
## Extra information:
- 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
@@ -53,9 +56,9 @@ OPTIONS:
- -p: The output path for all of the models (required)
it will look like this:
-
+
```bash
-java -jar target/blueprint-generator-1.4.0-SNAPSHOT-executable.jar policy -p models -i ComponentSpecs/TestComponentSpec.json
+ java -jar target/<JAR Filename>.jar app ONAP -type policycreate -i componentspec -p OutputPolicyPath
```
This command will create a directory called models and put the policy models created from the component spec given in that directory. (A component spec may generate multiple policy models) \ No newline at end of file