答复: Re: [tosca] About TOSCA-Simple-Profile-YAML-1.1, can you please help

Subject: 答复: Re: [tosca] About TOSCA-Simple-Profile-YAML-1.1, can you please help meabout CSAR Metadata, Thx

Hi Matt,

Thanks for your reply. It really helps.

By now, I think we probably need to support metadata for csar package(defined in TOSCA.meta) and descriptor files(defined in yaml files). Certainly, you're right. There should be no confilct between those two places.

There is an example of VNFD below. What if the vendors of VNFD and CSAR package are different? Do we have to set the value of vendor in VNFD metadata and TOSCA.meta? In this case what is TOSCA orchestrator supposed to do? I think the orchestrator should parse both of them, right? It's just a sample to describe the scenario. What I'm trying to say is that maybe we will face some special cases. :)

tosca_definitions_version: tosca_simple_yaml_1_0

description: VNFD TOSCA file demo

metadata:

vnfd_version: 2.1.1

vendor: XXX

冯远兴 fengyuanxing

IT开发工程师 IT Development Engineer
MANO一部/无线研究院/无线产品经营部 MANO DeptⅠ/Wireless Product R＆D Institute/Wireless Product Operation

南京市雨花台区紫荆花路68号中兴通讯二期4A楼

4/F, R&D Building, ZTE Corporation

68 Zijinghua Road, Yuhuatai District, Nanjing, P..R.China, 210012

T: +86 25 xxxxxxxx F:+86 25 xxxxxxxx
M: +86 13913910960
E: feng.yuanxing@zte.com.cn
www.zte.com.cn

原始邮件

发件人： <mrutkows@us.ibm.com>;

收件人：冯远兴10034308;

抄送人： <tosca@lists.oasis-open.org>;张茂鹏10030173;

日期：2017年06月17日 00:29

主题：Re: [tosca] About TOSCA-Simple-Profile-YAML-1.1, can you please help meabout CSAR Metadata, Thx

1. What will happen if we define metadata in both TOSCA.meta file and matadata section in a yaml file? Does tosca parser handle the metadata in two places?

There should be no conflict. TOSCA.meta is used when there are multiple Service Templates in a CSAR to identify the "Entry-Definition" (or primary service template to deploy).

TOSCA-Meta-File-Version: 1.0
CSAR-Version: 1.1
Created-By: OASIS TOSCA TC
Entry-Definitions: definitions/tosca_elk.yaml

whereas, if the CSAR has only 1 Service Template, or if CSAR is not used, their is no need for TOSCA.meta.

The "metadata" information inside the Service Template itself is separate...

metadata:
template_name: my_template
template_author: OASIS TOSCA TC
template_version: 1.0

and describes only (optional) information about the Service Template itself.

TOSCA.meta is used to extract/deploy CSAR (which may have multiple Service Templates) and placed there by the "creator" of the package (which may have brought together many Service Templates from many places); the metadata key (and its map of name/values) inside a Service Template describe optional information about the template (local name, version, author, etc.) and should not have bearing on the topology or its deployment.

2. Are there any restrictions for the metadata in those two places? Say, TOSCA.meta file only has TOSCA-Meta-Version, Entry-Definitions, etc. while metadata section in a yaml file could have template_name, template_version and so on?

TOSCA.meta is not intended to be preserved beyond its use to extract (and then deploy) service templates inside the archive. After an processor/tool/orchestrator extracts it the information need not be preserved. Metadata inside teh Service Template is intended to be preserved within the Service Template (and where it may be stored/reposited, for use by Catalogs and used for "search" features <or> to provide users more information about the template or parts of the topology that do not affect deployment or execution).

In contrast, any "metadata" (keyname) and maps of key-values in the Service Template, Node, Relationship, DataType, or even Property/Attribute (new) are intended for domain-specific uses (not recommended as all configuration information should be exposed as properties), but TOSCA Orchestrators are NOT required to use it during deployment and NOT required to be preserved after deployment). Profiles can declare their own metadata (such as NFV profile) and, by specification, required metadata and subsequent processing for supporting their profile, but this again not required of general TOSCA orchestrators and not best practice.

3. If we choose option 2 defining data in matadata section in a yaml file in the root directory, can we have other metadata sections in other yaml files?

You can place meta data wherever you like, but it will not be normative and will not affect processing (deployment, execution, management, search, etc.) as it willbe considered "extra descriptive information".

Can you provide examples of what metadata you want to add and for what purpose?

Kind regards,
Matt Rutkowski

STSM, Master Inventor, IBM Open Cloud Technologies and Standards
Apache OpenWhisk Incubator Project Lead, Initial Committer
Chair, Lead Editor OASIS TOSCA Simple Profile WG,
Co-Chair OASIS TOSCA Interop. SC,
Founder of DMTF Cloud Audit (CADF) Standard
mrutkows@us.ibm.com, mobile: 512-431-5002

From: <feng.yuanxing@zte.com.cn>
To: <tosca@lists.oasis-open.org>
Cc: <zhang.maopeng1@zte.com.cn>
Date: 06/15/2017 03:00 AM
Subject: [tosca] About TOSCA-Simple-Profile-YAML-1.1, can you please help me about CSAR Metadata, Thx
Sent by: <tosca@lists.oasis-open.org>

Hi TOSCA-teers,

In clause 6 (TOSCA Cloud Service Archive(CSAR) format of TOSCA-Simple-Profile-YAML-1.1), there are 2 options of defining metadata. One way is to create a TOSCA.meta file in TOSCA-Metadata directory, the other is to define data in matadata section in a yaml file in the root directory of csar package without a TOSCA.meta file. I have a few questions below, would you pleas help me out?

1. What will happen if we define metadata in both TOSCA.meta file and matadata section in a yaml file? Does tosca parser handle the metadata in two places?