Re: [tosca] YAML v1.2: CSAR zip without TOSCA-Metadata directory clarification

[Calin Curescu <calin.curescu@ericsson.com>]

Hi shitao,

 

The CSAR-version is used to describe both the structure of the CSAR (i.e. the zip iself) and the structure of the TOSCA.meta file. Of course, in the case of the no TOSCA.meta it is only the structure of the CSAR.

 

Now, as we relaxed the structure of the CSAR there are not many requirements left in the current CSAR version, but still there are the following (as presented in the specification):

• The CSAR is a zip file.
• The CSAR MUST contain either:
• One and only one TOSCA.meta file in the root of the archive or inside a TOSCA-Metadata directory.
• A yaml file at the root of the archive, the yaml file being a valid tosca definition template.
• A CSAR MAY contain other directories and files with arbitrary names and contents.

 

An orchestrator can detect if one of the above requirements is not fulfilled and signal that the CSAR is not valid. But it has to understand what is the version of the CSAR. For example in the future for some reasons we might put other requirements (e.g. in CSAR-version 3.0, that it might contain a file with its own checksum). Now, we need to understand that this version of the CSAR is not a faulty 3.0 version but a correct 2.0 version.

 

As we expect the CSAR structure version to change much slower than the TOSCA version, we can peg the CSAR-version to the TOSCA version for the case when TOSCA.meta does not exist. So we say in the specification: â â The CSAR-Version is inferred from the tosca_definitions_version keyword in the Entry-Definitions file. For tosca_definitions_version: tosca_2_0 and onwards, the corresponding CSAR-version is 2.0 unless further defined ââ

 

Btw: actually there is a difference between v1.3 and v2.0: the TOSCA.meta can be in the root directory or in the TOSCA-Metadata, so the TOSCA-Metadata directory is not mandatory in v2.0.

 

BR,

/Calin

 

From: <tosca@lists.oasis-open.org> on behalf of Lishitao <lishitao@huawei.com>
Date: Wednesday, 10 July 2019 at 04:08
To: Calin Curescu <calin.curescu@ericsson.com>, "Nguyenphu, Thinh (Nokia - US/Dallas)" <thinh.nguyenphu@nokia.com>, "tosca@lists.oasis-open.org" <tosca@lists.oasis-open.org>
Subject: RE: [tosca] YAML v1.2: CSAR zip without TOSCA-Metadata directory clarification

 

Hi Calin

 

My comments from yesterday was that in the second case without TOSCA.meta, why CSAR-version is required? In another words, why we need to handle CSAR version with tosca_definitions_version? There is no difference for the CSAR structure in the case without TOSCA.meta between v1.1, v1.2 ,v1.3 and v2.0 , right? Why a TOSCA orchestrator needs to know the CSAR-version is this case?

 

Regards

shitao

åää: tosca@lists.oasis-open.org [mailto:tosca@lists.oasis-open.org] äè Calin Curescu
åéæé: 2019å7æ9æ 21:51
æää: Nguyenphu, Thinh (Nokia - US/Dallas) <thinh.nguyenphu@nokia.com>; tosca@lists.oasis-open.org
äé: Re: [tosca] YAML v1.2: CSAR zip without TOSCA-Metadata directory clarification

 

Hi Thinh,

 

You are right, this is an inherited problem for versions up to v1.3 that has been corrected in v2.0.

 

In v2.0 we use for the version of the CSAR structure and TOSCA.meta file to be the following:

• If there exists a TOSCA.meta then we use the keyword CSAR-Version inside the TOSCA.meta file
• If there is no TOSCA.meta then we infer the CSAR version from the tosca_definitions_version keyword in the Entry-Definitions file (not from the metadata). For tosca_definitions_version: tosca_2_0 and onwards, the corresponding CSAR-version is 2.0 unless further defined.

 

BR,

/Calin

 

From: <tosca@lists.oasis-open.org> on behalf of "Nguyenphu, Thinh (Nokia - US/Dallas)" <thinh.nguyenphu@nokia.com>
Date: Monday, 8 July 2019 at 23:51
To: "tosca@lists.oasis-open.org" <tosca@lists.oasis-open.org>
Subject: [tosca] YAML v1.2: CSAR zip without TOSCA-Metadata directory clarification

 

Hello,

I may discover an inconsistence within TOSCA YAML v1.2 and v1.3

 

https://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.2/os/TOSCA-Simple-Profile-YAML-v1.2-os.html#_Toc528072962

 

states The CSAR-Version is defined by the template_version metadata section. In 6.3

 

6.3 Archive without TOSCA-Metadata

In case the archive doesnât contains a TOSCA-Metadata directory the archive is required to contains a single YAML file at the root of the archive (other templates may exits in sub-directories).

This file must be a valid TOSCA definitions YAML file with the additional restriction that the metadata section (as defined in 3.9.3.2) is required and template_name and template_version metadata are also required.

TOSCA processors should recognized this file as being the CSAR Entry-Definitions file. The CSAR-Version is defined by the template_version metadata section. The Created-By value is defined by the template_author metadata.

6.3.1 Example

The following represents a valid TOSCA template file acting as the CSAR Entry-Definitions file in an archive without TOSCA-Metadata directory.

tosca_definitions_version: tosca_simple_yaml_1_1

 

metadata:

  template_name: my_template

  template_author: OASIS TOSCA TC

  template_version: 1.0

 

but in 3.10.3.5 template_version

This optional metadata keyname can be used to declare a domain specific version of the service template as a single-line string value.

3.10.3.5.3 Example

template_version: 2.0.17

 

 

In YAML v1.2 or 1.3, there is two different version numbers. For the case of Archive without TOSCA-Metadata, the template_version: 1.0. Whereas, CSAR with TOSCA-Metadata directory, the CSAR-Version: 1.1

 

So, what is template_version the CSAR version for both type of CSAR structure?  What is normative requirement and value for template_version?

 

Regards,

Thinh

 

 

Thinh Nguyenphu

Bell Labs CTO

Nokia

thinh.nguyenphu@nokia.com

+1 817-313-5189