update readem file

add sections
* important links
* release notes
* compilation
* local CSAR execution

Change-Id: I23a05cb28213d12b48073d5d6ec2e1ceb1f8839c
Issue-ID: SDC-1599
Signed-off-by: Michael Lando <ml636r@att.com>
2 files changed
tree: a44e50315c18fc5ffe621d2eb18b3edbaf0d676f
  1. docs/
  2. src/
  3. .gitignore
  4. .gitreview
  5. INFO.yaml
  6. LICENSE.TXT
  7. pom.xml
  8. README.md
  9. version.properties
README.md

ONAP SDC-Tosca



Introduction

ONAP SDC-Tosca is delivered as helper JAR that can be used by clients that work with SDC TOSCA CSAR files. It parses the CSAR and returns the model object which represents the CSAR contents, through designated function calls with SDC flavour. It uses the underlying generic JTOSCA parser.

Compiling ONAP JTOSCA

ONAP SDC-Tosca can be compiled easily using maven command: mvn clean install The result is JAR file under "target" folder

Testing a CSAR locally

to run the parser locally you can use the MyTest Junit test to easily execute the parser on your own input.

  1. to run it place your csar in sdc-tosca\src\test\resources\csars

  2. Go to the test class located at sdc-tosca\src\test\java\org\onap\sdc\impl\MyTest.java

  3. un comment the logic ther and update the csar name you plced in the step above:

SdcToscaParserFactory factory = SdcToscaParserFactory.getInstance();
ISdcCsarHelper = getCsarHelper("csars/<your csar name example my.csar>");

//example of functions
//get node type by name
List<NodeTemplate> serviceNodeTemplatesByType = fdntCsarHelper.getServiceNodeTemplatesByType("org.openecomp.nodes.ForwardingPath");
//get node type property
String target_range = fdntCsarHelper.getNodeTemplatePropertyLeafValue(serviceNodeTemplatesByType.get(0), "target_range");

Getting Help

Mailing list
JIRA
WIKI
TOSCA Prser AID

Release notes

1.4.1

Features:

  1. disable max conformance level validation: until this version the parser had the definition of the max and min conformance level of the CSAR version which it supports. the conformance level is generated by sdc and as a result the two had to be aligned, over wise the CSAR will fail on parsing. from this version the max version will no longer be checked by the parser.
  2. Operations support: add support for parsing the Operations in the tosca models.