Add user guides for using Tacker
Add user guides to deploy VNF or CNF by using Tacker.
Issue-ID: SMO-79
Signed-off-by: Ayumu Ueha <ueha.ayumu@jp.fujitsu.com>
Change-Id: Ic93e89707b265cbde7913460b35e1b31caa91f9f
diff --git a/docs/tacker-user-guide-cnf.rst b/docs/tacker-user-guide-cnf.rst
new file mode 100644
index 0000000..a68b05c
--- /dev/null
+++ b/docs/tacker-user-guide-cnf.rst
@@ -0,0 +1,327 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+How to deploy CNF Deployment
+============================
+
+This user guide shows how to deploy CNF (Container Network Function) using Helm via Tacker.
+See the `ETSI NFV-SOL CNF Deployment by Helm chart` for the original procedure.
+
+.. contents::
+ :depth: 3
+ :local:
+
+Prerequisites
+-------------
+
+VIM
+~~~
+Register Kubernetes VIM (Virtualized Infrastructure Manager) by following procedure below.
+
+1. Prepare VIM config file, please change the parameters to suit your environment.
+ If you get bearer_token via INF O2 service, follow the "Use Kubernetes Control Client through O2 DMS profile" section of `INF O2 Service Userguide`_.
+
+ Sample config file:
+
+ .. code:: bash
+
+ $ cat vim_config_k8s.yaml
+ auth_url: "https://192.168.121.170:6443"
+ project_name: "default"
+ bearer_token: "eyJhbGciOiJSUzI1NiIsImtpZCI6InZQOGs5bjhKdExWVkZiRU5reVZRdEtBS0pnYXJFemROcElKNFpIdEFtMXMifQ.eyJpc3MiOiJrdWJlcm5ldGVzL3NlcnZpY2VhY2NvdW50Iiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9uYW1lc3BhY2UiOiJrdWJlLXN5c3RlbSIsImt1YmVybmV0ZXMuaW8vc2VydmljZWFjY291bnQvc2VjcmV0Lm5hbWUiOiJhZG1pbi11c2VyLXRva2VuLTk4am1qIiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9zZXJ2aWNlLWFjY291bnQubmFtZSI6ImFkbWluLXVzZXIiLCJrdWJlcm5ldGVzLmlvL3NlcnZpY2VhY2NvdW50L3NlcnZpY2UtYWNjb3VudC51aWQiOiIzZWJkZmEzZi0wMTA1LTRhN2YtODFjZS1kYjg5ODcxYTBiMDYiLCJzdWIiOiJzeXN0ZW06c2VydmljZWFjY291bnQ6a3ViZS1zeXN0ZW06YWRtaW4tdXNlciJ9.df_mV4RbsRN6oOS2KnkaKid0cJBAvdpautWnK67R0y8PRSm79Vc02NbUCmai0M4QiIF9gKhqtM0OYB5vZYJJng9vkcSNVWFUv6hA4Tvjw8FnEcGWe7TnWE2q-ZywJYiZNHvToRIgP5EH5UuLACEXu8KeeG56LxL3T2qNsUenUYLYaT6EciwKiy5SaEk3H1BB0zvSff0d_6sPvGCtY4xL_Q1pqqdgeL2lwC7tcivwEyRy3rMp1FBRrWOVdyeybww0XiNfEnYOjFyVSI4ED2n2msIdz_2JoHAnphGO7nslpn3MmkO-K1Mnhk7EKiR0kgHboGXwQlcnjW4Cje77PjumPg"
+ type: "kubernetes"
+
+2. Register VIM to Tacker by running following command.
+
+ .. code:: bash
+
+ $ source ${devstack_dir}/openrc admin admin
+ $ openstack vim register --confi-file vim_config_k8s.yaml vim-kubernetes
+
+3. Check the registered VIM status is ``REACHABLE``.
+
+ .. code:: bash
+
+ $ openstack vim list
+ +--------------------------------------+----------------+----------------------------------+------------+------------+-----------+
+ | ID | Name | Tenant_id | Type | Is Default | Status |
+ +--------------------------------------+----------------+----------------------------------+------------+------------+-----------+
+ | 5a5815fa-bf1d-41f4-a824-3e39bbdcebd0 | vim-kubernetes | a51290751e094e608ad1e5e251b8cd39 | kubernetes | True | REACHABLE |
+ +--------------------------------------+----------------+----------------------------------+------------+------------+-----------+
+
+Helm Environment
+~~~~~~~~~~~~~~~~
+Create an executable environment for Helm CLI by following procedure below.
+
+1. Install Helm.
+
+ .. code:: bash
+
+ $ HELM_VERSION="3.10.0" # Change to version that is compatible with your cluster
+ $ wget -P /tmp https://get.helm.sh/helm-v$HELM_VERSION-linux-amd64.tar.gz
+ $ tar zxf /tmp/helm-v$HELM_VERSION-linux-amd64.tar.gz -C /tmp
+ $ sudo mv /tmp/linux-amd64/helm /usr/local/bin/helm
+
+2. Create directory to store Helm chart.
+
+ .. code:: bash
+
+ $ HELM_CHART_DIR="/var/tacker/helm"
+ $ sudo mkdir -p $HELM_CHART_DIR
+
+3. Update Helm Connection Information to VIM DB.
+
+ .. code:: bash
+
+ $ mysql
+ mysql> use tacker;
+ mysql> update vims set extra=json_object(
+ 'helm_info', '{"masternode_ip": ["127.0.0.1"], "masternode_username": "stack", "masternode_password": "******"}')
+ where id="5a5815fa-bf1d-41f4-a824-3e39bbdcebd0";
+ mysql> exit
+
+ .. note::
+
+ The specified user must meet the following criteria:
+ * User can run Helm CLI commands via SSH.
+ * User can access to masternode_ip via ssh with password.
+ * User can execute sudo mkdir/chown/rm command without password.
+
+VNF Package
+~~~~~~~~~~~
+Create and upload the VNF Package that you want to deploy by following procedure below.
+
+1. Prepare VNF Package.
+ The sample VNF Package used in this guide is stored in ``o2/tacker/samples/packages/cnf`` directory.
+
+ .. code:: bash
+
+ $ git clone https://gerrit.o-ran-sc.org/r/smo/o2
+ $ cd o2/tacker/samples/packages/cnf
+ $ ls
+ Definitions Files input_param.json TOSCA-Metadata
+
+ $ zip sample_cnf_package.zip -r Definitions/ Files/ TOSCA-Metadata/
+
+ About details to prepare VNF Package, please refer to `Prepare VNF Package`_.
+
+2. Create and Upload VNF Package.
+
+ .. code:: bash
+
+ $ openstack vnf package create
+ +-------------------+-------------------------------------------------------------------------------------------------+
+ | Field | Value |
+ +-------------------+-------------------------------------------------------------------------------------------------+
+ | ID | 1efcf585-3fea-4813-88dd-bbc93692b51a |
+ | Links | { |
+ | | "self": { |
+ | | "href": "/vnfpkgm/v1/vnf_packages/1efcf585-3fea-4813-88dd-bbc93692b51a" |
+ | | }, |
+ | | "packageContent": { |
+ | | "href": "/vnfpkgm/v1/vnf_packages/1efcf585-3fea-4813-88dd-bbc93692b51a/package_content" |
+ | | } |
+ | | } |
+ | Onboarding State | CREATED |
+ | Operational State | DISABLED |
+ | Usage State | NOT_IN_USE |
+ | User Defined Data | {} |
+ +-------------------+-------------------------------------------------------------------------------------------------+
+
+ $ openstack vnf package upload --path sample_cnf_package.zip 1efcf585-3fea-4813-88dd-bbc93692b51a
+ Upload request for VNF package 1efcf585-3fea-4813-88dd-bbc93692b51a has been accepted.
+
+
+Deployment Procedure
+--------------------
+
+.. note::
+
+ This procedure uses the CLI available by installing python-tackerclient.
+ If you want to process with RESTfull API, see the `API-Docs`_ for more information.
+
+Create
+~~~~~~
+Create a VNF Instance by specifying the VNFD ID. The VNFD ID is the value defined in the VNFD file and can be found in the :command:`openstack vnf package show` command.
+
+.. code:: bash
+
+ $ openstack vnflcm create 37391b92-a1d9-44e5-855a-83644cdc3265
+ +-----------------------------+------------------------------------------------------------------------------------------------------------------+
+ | Field | Value |
+ +-----------------------------+------------------------------------------------------------------------------------------------------------------+
+ | ID | b0915924-7e04-4c16-b229-d3dfcc366eee |
+ | Instantiation State | NOT_INSTANTIATED |
+ | Links | { |
+ | | "self": { |
+ | | "href": "http://localhost:9890/vnflcm/v1/vnf_instances/b0915924-7e04-4c16-b229-d3dfcc366eee" |
+ | | }, |
+ | | "instantiate": { |
+ | | "href": "http://localhost:9890/vnflcm/v1/vnf_instances/b0915924-7e04-4c16-b229-d3dfcc366eee/instantiate" |
+ | | } |
+ | | } |
+ | VNF Configurable Properties | |
+ | VNF Instance Description | None |
+ | VNF Instance Name | vnf-b0915924-7e04-4c16-b229-d3dfcc366eee |
+ | VNF Product Name | Sample CNF |
+ | VNF Provider | Company |
+ | VNF Software Version | 1.0 |
+ | VNFD ID | 37391b92-a1d9-44e5-855a-83644cdc3265 |
+ | VNFD Version | 1.0 |
+ | vnfPkgId | |
+ +-----------------------------+------------------------------------------------------------------------------------------------------------------+
+
+Instantiate
+~~~~~~~~~~~
+Instantiate a VNF by specifying the ID of the created VNF Instance and a file path of input parameters.
+
+.. code:: bash
+
+ $ cat input_param.json
+ {
+ "flavourId": "helmchart",
+ "additionalParams": {
+ "namespace": "default",
+ "use_helm": "true",
+ "using_helm_install_param": [
+ {
+ "exthelmchart": "false",
+ "helmchartfile_path": "Files/kubernetes/localhelm-0.1.0.tgz",
+ "helmreleasename": "tacker-test-vdu"
+ }
+ ],
+ "helm_replica_values": {
+ "vdu1_aspect": "replicaCount"
+ }
+ },
+ "vimConnectionInfo": [
+ {
+ "id": "742f1fc7-7f00-417d-85a6-d4e788353181",
+ "vimId": "5a5815fa-bf1d-41f4-a824-3e39bbdcebd0",
+ "vimType": "kubernetes"
+ }
+ ]
+ }
+
+ $ openstack vnflcm instantiate b0915924-7e04-4c16-b229-d3dfcc366eee input_param.json
+ Instantiate request for VNF Instance b0915924-7e04-4c16-b229-d3dfcc366eee has been accepted.
+
+You can verify that the deployment was successful in the following ways:
+
+1. Verify that the VNF Instance displayed by the command is as follows:
+
+ * ``Instantiation State`` became ``INSTANTIATED``.
+ * Deployed resource information is stored in ``vnfcResourceInfo`` of ``Instantiated Vnf Info``.
+
+ .. code:: bash
+
+ $ openstack vnflcm show b0915924-7e04-4c16-b229-d3dfcc366eee
+ +-----------------------------+----------------------------------------------------------------------------------------------------------------------+
+ | Field | Value |
+ +-----------------------------+----------------------------------------------------------------------------------------------------------------------+
+ | ID | b0915924-7e04-4c16-b229-d3dfcc366eee |
+ | Instantiated Vnf Info | { |
+ | | "flavourId": "helmchart", |
+ | | "vnfState": "STARTED", |
+ | | "scaleStatus": [ |
+ | | { |
+ | | "aspectId": "vdu1_aspect", |
+ | | "scaleLevel": 0 |
+ | | } |
+ | | ], |
+ | | "extCpInfo": [], |
+ | | "vnfcResourceInfo": [ |
+ | | { |
+ | | "id": "df202937-2bb8-40a9-8be0-a8aa5e2ec0ae", |
+ | | "vduId": "VDU1", |
+ | | "computeResource": { |
+ | | "vimConnectionId": null, |
+ | | "resourceId": "tacker-test-vdu-localhelm-7b5489f949-fzmc5", |
+ | | "vimLevelResourceType": "Deployment" |
+ | | }, |
+ | | "storageResourceIds": [] |
+ | | } |
+ | | ], |
+ | | "additionalParams": { |
+ | | "useHelm": "true", |
+ | | "namespace": "default", |
+ | | "helmReplicaValues": { |
+ | | "vdu1Aspect": "replicaCount" |
+ | | }, |
+ | | "usingHelmInstallParam": [ |
+ | | { |
+ | | "exthelmchart": "false", |
+ | | "helmreleasename": "tacker-test-vdu", |
+ | | "helmchartfilePath": "Files/kubernetes/localhelm-0.1.0.tgz" |
+ | | } |
+ | | ] |
+ | | } |
+ | | } |
+ | Instantiation State | INSTANTIATED |
+ | Links | { |
+ | | "self": { |
+ | | "href": "http://localhost:9890/vnflcm/v1/vnf_instances/b0915924-7e04-4c16-b229-d3dfcc366eee" |
+ | | }, |
+ | | "terminate": { |
+ | | "href": "http://localhost:9890/vnflcm/v1/vnf_instances/b0915924-7e04-4c16-b229-d3dfcc366eee/terminate" |
+ | | }, |
+ | | "heal": { |
+ | | "href": "http://localhost:9890/vnflcm/v1/vnf_instances/b0915924-7e04-4c16-b229-d3dfcc366eee/heal" |
+ | | }, |
+ | | "changeExtConn": { |
+ | | "href": "http://localhost:9890/vnflcm/v1/vnf_instances/b0915924-7e04-4c16-b229-d3dfcc366eee/change_ext_conn" |
+ | | } |
+ | | } |
+ | VIM Connection Info | [ |
+ | | { |
+ | | "id": "742f1fc7-7f00-417d-85a6-d4e788353181", |
+ | | "vimId": "5a5815fa-bf1d-41f4-a824-3e39bbdcebd0", |
+ | | "vimType": "kubernetes", |
+ | | "interfaceInfo": {}, |
+ | | "accessInfo": {}, |
+ | | "extra": {} |
+ | | } |
+ | | ] |
+ | VNF Configurable Properties | |
+ | VNF Instance Description | None |
+ | VNF Instance Name | vnf-b0915924-7e04-4c16-b229-d3dfcc366eee |
+ | VNF Product Name | Sample CNF |
+ | VNF Provider | Company |
+ | VNF Software Version | 1.0 |
+ | VNFD ID | 37391b92-a1d9-44e5-855a-83644cdc3265 |
+ | VNFD Version | 1.0 |
+ | metadata | namespace=default |
+ | vnfPkgId | |
+ +-----------------------------+----------------------------------------------------------------------------------------------------------------------+
+
+2. Verify the CNF resources that were actually created as follows:
+
+ .. code:: bash
+
+ $ kubectl get deployment
+ NAME READY UP-TO-DATE AVAILABLE AGE
+ tacker-test-vdu-localhelm 1/1 1 1 20s
+
+ $ kubectl get pod
+ NAME READY STATUS RESTARTS AGE
+ tacker-test-vdu-localhelm-7b5489f949-fzmc5 1/1 Running 0 24s
+
+ $ helm list
+ NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
+ tacker-test-vdu default 1 2022-06-29 14:54:32.20990033 +0000 UTC deployed localhelm-0.1.0 1.16.0
+
+Terminate
+~~~~~~~~~
+Terminate a VNF by specifying the VNF Instance ID.
+
+.. code:: bash
+
+ $ openstack vnflcm terminate b0915924-7e04-4c16-b229-d3dfcc366eee
+ Terminate request for VNF Instance 'b0915924-7e04-4c16-b229-d3dfcc366eee' has been accepted.
+
+
+.. _ETSI NFV-SOL CNF Deployment by Helm chart: https://docs.openstack.org/tacker/latest/user/mgmt_driver_deploy_k8s_and_cnf_with_helm.html#etsi-nfv-sol-cnf-deployment-by-helm-chart
+.. _INF O2 Service Userguide: https://docs.o-ran-sc.org/projects/o-ran-sc-pti-o2/en/latest/user-guide.html
+.. _Prepare VNF Package: https://docs.openstack.org/tacker/latest/user/mgmt_driver_deploy_k8s_and_cnf_with_helm.html#prepare-vnf-package
+.. _API-Docs: https://docs.o-ran-sc.org/projects/o-ran-sc-smo-o2/en/latest/tacker/api-docs.html
diff --git a/docs/tacker-user-guide-vnf.rst b/docs/tacker-user-guide-vnf.rst
new file mode 100644
index 0000000..00e8130
--- /dev/null
+++ b/docs/tacker-user-guide-vnf.rst
@@ -0,0 +1,389 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+How to deploy VNF Deployment
+============================
+
+This user guide shows how to deploy VNF (Virtualized Network Function) via Tacker.
+See the `ETSI NFV-SOL VNF Deployment` for the original procedure.
+
+.. contents::
+ :depth: 3
+ :local:
+
+Prerequisites
+-------------
+
+VIM
+~~~
+Register OpenStack VIM (Virtualized Infrastructure Manager) by following procedure below.
+
+1. Prepare VIM config file, please change the parameters to suit your environment.
+
+ Sample config file:
+
+ .. code:: bash
+
+ $ cat vim_config.yaml
+ auth_url: 'http://192.168.121.170/v3'
+ username: 'admin'
+ password: 'devstack'
+ project_name: 'admin'
+ project_domain_name: 'Default'
+ user_domain_name: 'Default'
+ cert_verify: 'False'
+
+2. Register VIM to Tacker by running following command.
+
+ .. code:: bash
+
+ $ source ${devstack_dir}/openrc admin admin
+ $ openstack vim register --confi-file vim_config.yaml vim-openstack
+
+3. Check the registered VIM status is ``REACHABLE``.
+
+ .. code:: bash
+
+ $ openstack vim list
+ +--------------------------------------+----------------+----------------------------------+------------+------------+-----------+
+ | ID | Name | Tenant_id | Type | Is Default | Status |
+ +--------------------------------------+----------------+----------------------------------+------------+------------+-----------+
+ | d8d886e4-fd98-4493-81e2-0e2b9991d629 | vim-openstack | a51290751e094e608ad1e5e251b8cd39 | openstack | True | REACHABLE |
+ +--------------------------------------+----------------+----------------------------------+------------+------------+-----------+
+
+VNF Package
+~~~~~~~~~~~
+Create and upload the VNF Package that you want to deploy by following procedure below.
+
+1. Prepare VNF Package.
+ The sample VNF Package used in this guide is stored in ``o2/tacker/samples/packages/vnf`` directory.
+
+ .. code:: bash
+
+ $ git clone https://gerrit.o-ran-sc.org/r/smo/o2
+ $ cd o2/tacker/samples/packages/vnf
+ $ ls
+ BaseHOT Definitions Files input_param.json TOSCA-Metadata UserData
+
+ $ wget -P Files/images https://opendev.org/openstack/tacker/raw/branch/master/tacker/tests/etc/samples/etsi/nfv/common/Files/images/cirros-0.5.2-x86_64-disk.img
+
+ $ zip sample_vnf_package.zip -r BaseHOT/ Definitions/ Files/ TOSCA-Metadata/ UserData/
+
+
+ About details to prepare VNF Package, please refer to `Prepare VNF Package`_.
+
+2. Create and Upload VNF Package.
+
+ .. code:: bash
+
+ $ openstack vnf package create
+ +-------------------+-------------------------------------------------------------------------------------------------+
+ | Field | Value |
+ +-------------------+-------------------------------------------------------------------------------------------------+
+ | ID | 9f10134f-90ae-4e71-bfdc-de6593552de8 |
+ | Links | { |
+ | | "self": { |
+ | | "href": "/vnfpkgm/v1/vnf_packages/9f10134f-90ae-4e71-bfdc-de6593552de8" |
+ | | }, |
+ | | "packageContent": { |
+ | | "href": "/vnfpkgm/v1/vnf_packages/9f10134f-90ae-4e71-bfdc-de6593552de8/package_content" |
+ | | } |
+ | | } |
+ | Onboarding State | CREATED |
+ | Operational State | DISABLED |
+ | Usage State | NOT_IN_USE |
+ | User Defined Data | {} |
+ +-------------------+-------------------------------------------------------------------------------------------------+
+
+ $ openstack vnf package upload --path sample_vnf_package.zip 9f10134f-90ae-4e71-bfdc-de6593552de8
+ Upload request for VNF package 9f10134f-90ae-4e71-bfdc-de6593552de8 has been accepted.
+
+Deployment Procedure
+--------------------
+
+.. note::
+
+ This procedure uses the CLI available by installing python-tackerclient.
+ If you want to process with RESTfull API, see the `API-Docs`_ for more information.
+
+Create
+~~~~~~
+Create a VNF Instance by specifying the VNFD ID. The VNFD ID is the value defined in the VNFD file and can be found in the :command:`openstack vnf package show` command.
+
+.. code:: bash
+
+ $ openstack vnflcm create b1bb0ce7-ebca-4fa7-95ed-4840d70a1177
+ +-----------------------------+------------------------------------------------------------------------------------------------------------------+
+ | Field | Value |
+ +-----------------------------+------------------------------------------------------------------------------------------------------------------+
+ | ID | fba5bda0-0b52-4d80-bffb-709200baf1e3 |
+ | Instantiation State | NOT_INSTANTIATED |
+ | Links | { |
+ | | "self": { |
+ | | "href": "http://localhost:9890/vnflcm/v1/vnf_instances/fba5bda0-0b52-4d80-bffb-709200baf1e3" |
+ | | }, |
+ | | "instantiate": { |
+ | | "href": "http://localhost:9890/vnflcm/v1/vnf_instances/fba5bda0-0b52-4d80-bffb-709200baf1e3/instantiate" |
+ | | } |
+ | | } |
+ | VNF Configurable Properties | |
+ | VNF Instance Description | None |
+ | VNF Instance Name | vnf-fba5bda0-0b52-4d80-bffb-709200baf1e3 |
+ | VNF Product Name | Sample VNF |
+ | VNF Provider | Company |
+ | VNF Software Version | 1.0 |
+ | VNFD ID | b1bb0ce7-ebca-4fa7-95ed-4840d70a1177 |
+ | VNFD Version | 1.0 |
+ | vnfPkgId | |
+ +-----------------------------+------------------------------------------------------------------------------------------------------------------+
+
+Instantiate
+~~~~~~~~~~~
+Instantiate a VNF by specifying the ID of the created VNF Instance and a file path of input parameters.
+
+.. note::
+ Please change the parameters in ``input_param.json`` to suite your environment.
+
+.. code:: bash
+
+ $ cat input_param.json
+ {
+ "flavourId": "simple",
+ "extVirtualLinks": [
+ {
+ "id": "test1",
+ "resourceId": "0e1cc46a-6808-4738-8b84-9e99a775c9eb",
+ "extCps": [
+ {
+ "cpdId": "CP1",
+ "cpConfig": [
+ {
+ "cpProtocolData": [
+ {
+ "layerProtocol": "IP_OVER_ETHERNET",
+ "ipOverEthernet": {
+ "ipAddresses": [
+ {
+ "type": "IPV4",
+ "numDynamicAddresses": 1,
+ "subnetId": "309614e6-4aab-4424-977f-fd9c8dfe493e"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ ],
+ "vimConnectionInfo": [
+ {
+ "id": "e24f9796-a8e9-4cb0-85ce-5920dcddafa1",
+ "vimId": "d8d886e4-fd98-4493-81e2-0e2b9991d629",
+ "vimType": "openstack"
+ }
+ ],
+ "additionalParams": {
+ "lcm-operation-user-data": "./UserData/lcm_user_data.py",
+ "lcm-operation-user-data-class": "SampleUserData"
+ }
+ }
+
+ $ openstack vnflcm instantiate b0915924-7e04-4c16-b229-d3dfcc366eee input_param.json
+ Instantiate request for VNF Instance b0915924-7e04-4c16-b229-d3dfcc366eee has been accepted.
+
+You can verify that the deployment was successful in the following ways:
+
+1. Verify that the VNF Instance displayed by :command:`openstack vnflcm show` command is as follows:
+
+ * ``Instantiation State`` became ``INSTANTIATED``.
+ * Deployed resource information is stored in ``vnfcResourceInfo`` of ``Instantiated Vnf Info``.
+
+ .. code:: bash
+
+ $ openstack vnflcm show fba5bda0-0b52-4d80-bffb-709200baf1e3
+ +-----------------------------+----------------------------------------------------------------------------------------------------------------------+
+ | Field | Value |
+ +-----------------------------+----------------------------------------------------------------------------------------------------------------------+
+ | ID | fba5bda0-0b52-4d80-bffb-709200baf1e3 |
+ | Instantiated Vnf Info | { |
+ | | "flavourId": "simple", |
+ | | "vnfState": "STARTED", |
+ | | "extCpInfo": [ |
+ | | { |
+ | | "id": "4e9cda91-f625-4790-8efb-273b3fbd03a1", |
+ | | "cpdId": "CP1", |
+ | | "extLinkPortId": null, |
+ | | "associatedVnfcCpId": "65676b39-1e80-435f-997d-217963d25298", |
+ | | "cpProtocolInfo": [ |
+ | | { |
+ | | "layerProtocol": "IP_OVER_ETHERNET", |
+ | | "ipOverEthernet": { |
+ | | "macAddress": null, |
+ | | "ipAddresses": [ |
+ | | { |
+ | | "type": "IPV4", |
+ | | "subnetId": "309614e6-4aab-4424-977f-fd9c8dfe493e", |
+ | | "isDynamic": true, |
+ | | "addresses": [] |
+ | | } |
+ | | ] |
+ | | } |
+ | | } |
+ | | ] |
+ | | } |
+ | | ], |
+ | | "extVirtualLinkInfo": [ |
+ | | { |
+ | | "id": "test1", |
+ | | "resourceHandle": { |
+ | | "vimConnectionId": null, |
+ | | "resourceId": "0e1cc46a-6808-4738-8b84-9e99a775c9eb", |
+ | | "vimLevelResourceType": null |
+ | | } |
+ | | } |
+ | | ], |
+ | | "vnfcResourceInfo": [ |
+ | | { |
+ | | "id": "65676b39-1e80-435f-997d-217963d25298", |
+ | | "vduId": "VDU1", |
+ | | "computeResource": { |
+ | | "vimConnectionId": "d8d886e4-fd98-4493-81e2-0e2b9991d629", |
+ | | "resourceId": "0f0ee6b9-cf6c-41c7-a36c-78d41fcba99c", |
+ | | "vimLevelResourceType": "OS::Nova::Server" |
+ | | }, |
+ | | "storageResourceIds": [], |
+ | | "vnfcCpInfo": [ |
+ | | { |
+ | | "id": "a3da58ce-039d-42ee-9569-a0e2a9adf9bb", |
+ | | "cpdId": "CP1", |
+ | | "vnfExtCpId": null, |
+ | | "vnfLinkPortId": "d61dcdf1-d5c6-4add-8b0f-0095b00908cd", |
+ | | "cpProtocolInfo": [ |
+ | | { |
+ | | "layerProtocol": "IP_OVER_ETHERNET", |
+ | | "ipOverEthernet": { |
+ | | "macAddress": null, |
+ | | "ipAddresses": [ |
+ | | { |
+ | | "type": "IPV4", |
+ | | "subnetId": "309614e6-4aab-4424-977f-fd9c8dfe493e", |
+ | | "isDynamic": true, |
+ | | "addresses": [] |
+ | | } |
+ | | ] |
+ | | } |
+ | | } |
+ | | ] |
+ | | } |
+ | | ] |
+ | | } |
+ | | ], |
+ | | "vnfVirtualLinkResourceInfo": [ |
+ | | { |
+ | | "id": "006531d5-7bb9-472d-9243-7dd415ca9839", |
+ | | "vnfVirtualLinkDescId": "internalVL1", |
+ | | "networkResource": { |
+ | | "vimConnectionId": null, |
+ | | "resourceId": "", |
+ | | "vimLevelResourceType": null |
+ | | }, |
+ | | "vnfLinkPorts": [ |
+ | | { |
+ | | "id": "11d2a97d-884d-4943-9539-bc6c8e4e9e2b", |
+ | | "resourceHandle": { |
+ | | "vimConnectionId": "d8d886e4-fd98-4493-81e2-0e2b9991d629", |
+ | | "resourceId": "601c9ce5-91df-4636-9fc3-0ae979781d9a", |
+ | | "vimLevelResourceType": "OS::Neutron::Port" |
+ | | }, |
+ | | "cpInstanceId": "a3da58ce-039d-42ee-9569-a0e2a9adf9bb" |
+ | | } |
+ | | ] |
+ | | }, |
+ | | { |
+ | | "id": "3a9607a4-0d5a-42da-aca3-2c471544ee86", |
+ | | "vnfVirtualLinkDescId": "test1", |
+ | | "networkResource": { |
+ | | "vimConnectionId": null, |
+ | | "resourceId": "0e1cc46a-6808-4738-8b84-9e99a775c9eb", |
+ | | "vimLevelResourceType": "OS::Neutron::Net" |
+ | | }, |
+ | | "vnfLinkPorts": [ |
+ | | { |
+ | | "id": "d61dcdf1-d5c6-4add-8b0f-0095b00908cd", |
+ | | "resourceHandle": { |
+ | | "vimConnectionId": null, |
+ | | "resourceId": "", |
+ | | "vimLevelResourceType": null |
+ | | }, |
+ | | "cpInstanceId": "a3da58ce-039d-42ee-9569-a0e2a9adf9bb" |
+ | | } |
+ | | ] |
+ | | } |
+ | | ], |
+ | | "vnfcInfo": [ |
+ | | { |
+ | | "id": "341f2d8c-b53f-4d4b-b7f2-2f1726355803", |
+ | | "vduId": "VDU1", |
+ | | "vnfcState": "STARTED" |
+ | | } |
+ | | ], |
+ | | "additionalParams": { |
+ | | "lcm-operation-user-data": "./UserData/lcm_user_data.py", |
+ | | "lcm-operation-user-data-class": "SampleUserData" |
+ | | } |
+ | | } |
+ | Instantiation State | INSTANTIATED |
+ | Links | { |
+ | | "self": { |
+ | | "href": "http://localhost:9890/vnflcm/v1/vnf_instances/fba5bda0-0b52-4d80-bffb-709200baf1e3" |
+ | | }, |
+ | | "terminate": { |
+ | | "href": "http://localhost:9890/vnflcm/v1/vnf_instances/fba5bda0-0b52-4d80-bffb-709200baf1e3/terminate" |
+ | | }, |
+ | | "heal": { |
+ | | "href": "http://localhost:9890/vnflcm/v1/vnf_instances/fba5bda0-0b52-4d80-bffb-709200baf1e3/heal" |
+ | | }, |
+ | | "changeExtConn": { |
+ | | "href": "http://localhost:9890/vnflcm/v1/vnf_instances/fba5bda0-0b52-4d80-bffb-709200baf1e3/change_ext_conn" |
+ | | } |
+ | | } |
+ | VIM Connection Info | [ |
+ | | { |
+ | | "id": "e24f9796-a8e9-4cb0-85ce-5920dcddafa1", |
+ | | "vimId": "d8d886e4-fd98-4493-81e2-0e2b9991d629", |
+ | | "vimType": "openstack", |
+ | | "interfaceInfo": {}, |
+ | | "accessInfo": {}, |
+ | | "extra": {} |
+ | | } |
+ | | ] |
+ | VNF Configurable Properties | |
+ | VNF Instance Description | None |
+ | VNF Instance Name | vnf-fba5bda0-0b52-4d80-bffb-709200baf1e3 |
+ | VNF Product Name | Sample VNF |
+ | VNF Provider | Company |
+ | VNF Software Version | 1.0 |
+ | VNFD ID | b1bb0ce7-ebca-4fa7-95ed-4840d70a1177 |
+ | VNFD Version | 1.0 |
+ | vnfPkgId | |
+ +-----------------------------+----------------------------------------------------------------------------------------------------------------------+
+
+2. Verify the VM created successfully by :command:`openstack stack list/show` command or OpenStack Dashboard.
+
+Terminate
+~~~~~~~~~
+Terminate a VNF by specifying the VNF Instance ID.
+
+.. code:: bash
+
+ $ openstack vnflcm terminate fba5bda0-0b52-4d80-bffb-709200baf1e3
+ Terminate request for VNF Instance 'fba5bda0-0b52-4d80-bffb-709200baf1e3' has been accepted.
+
+
+.. _ETSI NFV-SOL VNF Deployment: https://docs.openstack.org/tacker/latest/user/etsi_vnf_deployment_as_vm_with_user_data.html
+.. _Prepare VNF Package: https://docs.openstack.org/tacker/latest/user/vnf-package.html
+.. _API-Docs: https://docs.o-ran-sc.org/projects/o-ran-sc-smo-o2/en/latest/tacker/api-docs.html
diff --git a/docs/user-guide.rst b/docs/user-guide.rst
index 3557acb..9a52b6c 100644
--- a/docs/user-guide.rst
+++ b/docs/user-guide.rst
@@ -26,7 +26,16 @@
--------------------
.. Provide enough information that a user will be able to operate the feature on a deployed scenario. content can be added from administration, management, using, Troubleshooting sections perspectives.
+Tacker
+~~~~~~
+An example of the procedure how to deploy VNF or CNF by using Tacker is shown on the following pages.
+If you want to see the other procedure, please refer to `Tacker User Guide`_
+
+.. toctree::
+ :maxdepth: 1
+
+ tacker-user-guide-vnf.rst
+ tacker-user-guide-cnf.rst
-
-
+.. _Tacker User Guide: https://docs.openstack.org/tacker/latest/user/index.html
diff --git a/tacker/samples/packages/cnf/Definitions/etsi_nfv_sol001_common_types.yaml b/tacker/samples/packages/cnf/Definitions/etsi_nfv_sol001_common_types.yaml
new file mode 100644
index 0000000..33864db
--- /dev/null
+++ b/tacker/samples/packages/cnf/Definitions/etsi_nfv_sol001_common_types.yaml
@@ -0,0 +1,202 @@
+tosca_definitions_version: tosca_simple_yaml_1_2
+description: ETSI NFV SOL 001 common types definitions version 2.6.1
+metadata:
+ template_name: etsi_nfv_sol001_common_types
+ template_author: ETSI_NFV
+ template_version: 2.6.1
+
+data_types:
+ tosca.datatypes.nfv.L2AddressData:
+ derived_from: tosca.datatypes.Root
+ description: Describes the information on the MAC addresses to be assigned to a connection point.
+ properties:
+ mac_address_assignment:
+ type: boolean
+ description: Specifies if the address assignment is the responsibility of management and orchestration function or not. If it is set to True, it is the management and orchestration function responsibility
+ required: true
+
+ tosca.datatypes.nfv.L3AddressData:
+ derived_from: tosca.datatypes.Root
+ description: Provides information about Layer 3 level addressing scheme and parameters applicable to a CP
+ properties:
+ ip_address_assignment:
+ type: boolean
+ description: Specifies if the address assignment is the responsibility of management and orchestration function or not. If it is set to True, it is the management and orchestration function responsibility
+ required: true
+ floating_ip_activated:
+ type: boolean
+ description: Specifies if the floating IP scheme is activated on the Connection Point or not
+ required: true
+ ip_address_type:
+ type: string
+ description: Defines address type. The address type should be aligned with the address type supported by the layer_protocols properties of the parent VnfExtCp
+ required: false
+ constraints:
+ - valid_values: [ ipv4, ipv6 ]
+ number_of_ip_address:
+ type: integer
+ description: Minimum number of IP addresses to be assigned
+ required: false
+ constraints:
+ - greater_than: 0
+
+ tosca.datatypes.nfv.AddressData:
+ derived_from: tosca.datatypes.Root
+ description: Describes information about the addressing scheme and parameters applicable to a CP
+ properties:
+ address_type:
+ type: string
+ description: Describes the type of the address to be assigned to a connection point. The content type shall be aligned with the address type supported by the layerProtocol property of the connection point
+ required: true
+ constraints:
+ - valid_values: [ mac_address, ip_address ]
+ l2_address_data:
+ type: tosca.datatypes.nfv.L2AddressData
+ description: Provides the information on the MAC addresses to be assigned to a connection point.
+ required: false
+ l3_address_data:
+ type: tosca.datatypes.nfv.L3AddressData
+ description: Provides the information on the IP addresses to be assigned to a connection point
+ required: false
+
+ tosca.datatypes.nfv.ConnectivityType:
+ derived_from: tosca.datatypes.Root
+ description: describes additional connectivity information of a virtualLink
+ properties:
+ layer_protocols:
+ type: list
+ description: Identifies the protocol a virtualLink gives access to (ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire).The top layer protocol of the virtualLink protocol stack shall always be provided. The lower layer protocols may be included when there are specific requirements on these layers.
+ required: true
+ entry_schema:
+ type: string
+ constraints:
+ - valid_values: [ ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire ]
+ flow_pattern:
+ type: string
+ description: Identifies the flow pattern of the connectivity
+ required: false
+ constraints:
+ - valid_values: [ line, tree, mesh ]
+
+ tosca.datatypes.nfv.LinkBitrateRequirements:
+ derived_from: tosca.datatypes.Root
+ description: describes the requirements in terms of bitrate for a virtual link
+ properties:
+ root:
+ type: integer # in bits per second
+ description: Specifies the throughput requirement in bits per second of the link (e.g. bitrate of E-Line, root bitrate of E-Tree, aggregate capacity of E-LAN).
+ required: true
+ constraints:
+ - greater_or_equal: 0
+ leaf:
+ type: integer # in bits per second
+ description: Specifies the throughput requirement in bits per second of leaf connections to the link when applicable to the connectivity type (e.g. for E-Tree and E LAN branches).
+ required: false
+ constraints:
+ - greater_or_equal: 0
+
+ tosca.datatypes.nfv.CpProtocolData:
+ derived_from: tosca.datatypes.Root
+ description: Describes and associates the protocol layer that a CP uses together with other protocol and connection point information
+ properties:
+ associated_layer_protocol:
+ type: string
+ required: true
+ description: One of the values of the property layer_protocols of the CP
+ constraints:
+ - valid_values: [ ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire ]
+ address_data:
+ type: list
+ description: Provides information on the addresses to be assigned to the CP
+ entry_schema:
+ type: tosca.datatypes.nfv.AddressData
+ required: false
+
+ tosca.datatypes.nfv.VnfProfile:
+ derived_from: tosca.datatypes.Root
+ description: describes a profile for instantiating VNFs of a particular NS DF according to a specific VNFD and VNF DF.
+ properties:
+ instantiation_level:
+ type: string
+ description: Identifier of the instantiation level of the VNF DF to be used for instantiation. If not present, the default instantiation level as declared in the VNFD shall be used.
+ required: false
+ min_number_of_instances:
+ type: integer
+ description: Minimum number of instances of the VNF based on this VNFD that is permitted to exist for this VnfProfile.
+ required: true
+ constraints:
+ - greater_or_equal: 0
+ max_number_of_instances:
+ type: integer
+ description: Maximum number of instances of the VNF based on this VNFD that is permitted to exist for this VnfProfile.
+ required: true
+ constraints:
+ - greater_or_equal: 0
+
+ tosca.datatypes.nfv.Qos:
+ derived_from: tosca.datatypes.Root
+ description: describes QoS data for a given VL used in a VNF deployment flavour
+ properties:
+ latency:
+ type: scalar-unit.time #Number
+ description: Specifies the maximum latency
+ required: true
+ constraints:
+ - greater_than: 0 s
+ packet_delay_variation:
+ type: scalar-unit.time #Number
+ description: Specifies the maximum jitter
+ required: true
+ constraints:
+ - greater_or_equal: 0 s
+ packet_loss_ratio:
+ type: float
+ description: Specifies the maximum packet loss ratio
+ required: false
+ constraints:
+ - in_range: [ 0.0, 1.0 ]
+
+capability_types:
+ tosca.capabilities.nfv.VirtualLinkable:
+ derived_from: tosca.capabilities.Node
+ description: A node type that includes the VirtualLinkable capability indicates that it can be pointed by tosca.relationships.nfv.VirtualLinksTo relationship type
+
+relationship_types:
+ tosca.relationships.nfv.VirtualLinksTo:
+ derived_from: tosca.relationships.DependsOn
+ description: Represents an association relationship between the VduCp and VnfVirtualLink node types
+ valid_target_types: [ tosca.capabilities.nfv.VirtualLinkable ]
+
+node_types:
+ tosca.nodes.nfv.Cp:
+ derived_from: tosca.nodes.Root
+ description: Provides information regarding the purpose of the connection point
+ properties:
+ layer_protocols:
+ type: list
+ description: Identifies which protocol the connection point uses for connectivity purposes
+ required: true
+ entry_schema:
+ type: string
+ constraints:
+ - valid_values: [ ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire ]
+ role: #Name in ETSI NFV IFA011 v0.7.3: cpRole
+ type: string
+ description: Identifies the role of the port in the context of the traffic flow patterns in the VNF or parent NS
+ required: false
+ constraints:
+ - valid_values: [ root, leaf ]
+ description:
+ type: string
+ description: Provides human-readable information on the purpose of the connection point
+ required: false
+ protocol:
+ type: list
+ description: Provides information on the addresses to be assigned to the connection point(s) instantiated from this Connection Point Descriptor
+ required: false
+ entry_schema:
+ type: tosca.datatypes.nfv.CpProtocolData
+ trunk_mode:
+ type: boolean
+ description: Provides information about whether the CP instantiated from this Cp is in Trunk mode (802.1Q or other), When operating in "trunk mode", the Cp is capable of carrying traffic for several VLANs. Absence of this property implies that trunkMode is not configured for the Cp i.e. It is equivalent to boolean value "false".
+ required: false
diff --git a/tacker/samples/packages/cnf/Definitions/etsi_nfv_sol001_vnfd_types.yaml b/tacker/samples/packages/cnf/Definitions/etsi_nfv_sol001_vnfd_types.yaml
new file mode 100644
index 0000000..7514f3e
--- /dev/null
+++ b/tacker/samples/packages/cnf/Definitions/etsi_nfv_sol001_vnfd_types.yaml
@@ -0,0 +1,1465 @@
+tosca_definitions_version: tosca_simple_yaml_1_2
+description: ETSI NFV SOL 001 vnfd types definitions version 2.6.1
+metadata:
+ template_name: etsi_nfv_sol001_vnfd_types
+ template_author: ETSI_NFV
+ template_version: 2.6.1
+
+imports:
+ - ./etsi_nfv_sol001_common_types.yaml
+
+data_types:
+ tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements:
+ derived_from: tosca.datatypes.Root
+ description: Describes requirements on a virtual network interface
+ properties:
+ name:
+ type: string
+ description: Provides a human readable name for the requirement.
+ required: false
+ description:
+ type: string
+ description: Provides a human readable description of the requirement.
+ required: false
+ support_mandatory:
+ type: boolean
+ description: Indicates whether fulfilling the constraint is mandatory (TRUE) for successful operation or desirable (FALSE).
+ required: true
+ network_interface_requirements:
+ type: map
+ description: The network interface requirements. A map of strings that contain a set of key-value pairs that describes the hardware platform specific network interface deployment requirements.
+ required: true
+ entry_schema:
+ type: string
+ nic_io_requirements:
+ type: tosca.datatypes.nfv.LogicalNodeData
+ description: references (couples) the CP with any logical node I/O requirements (for network devices) that may have been created. Linking these attributes is necessary so that so that I/O requirements that need to be articulated at the logical node level can be associated with the network interface requirements associated with the CP.
+ required: false
+
+ tosca.datatypes.nfv.RequestedAdditionalCapability:
+ derived_from: tosca.datatypes.Root
+ description: describes requested additional capability for a particular VDU
+ properties:
+ requested_additional_capability_name:
+ type: string
+ description: Identifies a requested additional capability for the VDU.
+ required: true
+ support_mandatory:
+ type: boolean
+ description: Indicates whether the requested additional capability is mandatory for successful operation.
+ required: true
+ min_requested_additional_capability_version:
+ type: string
+ description: Identifies the minimum version of the requested additional capability.
+ required: false
+ preferred_requested_additional_capability_version:
+ type: string
+ description: Identifies the preferred version of the requested additional capability.
+ required: false
+ target_performance_parameters:
+ type: map
+ description: Identifies specific attributes, dependent on the requested additional capability type.
+ required: true
+ entry_schema:
+ type: string
+
+ tosca.datatypes.nfv.VirtualMemory:
+ derived_from: tosca.datatypes.Root
+ description: supports the specification of requirements related to virtual memory of a virtual compute resource
+ properties:
+ virtual_mem_size:
+ type: scalar-unit.size
+ description: Amount of virtual memory.
+ required: true
+ virtual_mem_oversubscription_policy:
+ type: string
+ description: The memory core oversubscription policy in terms of virtual memory to physical memory on the platform.
+ required: false
+ vdu_mem_requirements:
+ type: map
+ description: The hardware platform specific VDU memory requirements. A map of strings that contains a set of key-value pairs that describes hardware platform specific VDU memory requirements.
+ required: false
+ entry_schema:
+ type: string
+ numa_enabled:
+ type: boolean
+ description: It specifies the memory allocation to be cognisant of the relevant process/core allocation.
+ required: false
+ default: false
+
+ tosca.datatypes.nfv.VirtualCpu:
+ derived_from: tosca.datatypes.Root
+ description: Supports the specification of requirements related to virtual CPU(s) of a virtual compute resource
+ properties:
+ cpu_architecture:
+ type: string
+ description: CPU architecture type. Examples are x86, ARM
+ required: false
+ num_virtual_cpu:
+ type: integer
+ description: Number of virtual CPUs
+ required: true
+ constraints:
+ - greater_than: 0
+ virtual_cpu_clock:
+ type: scalar-unit.frequency
+ description: Minimum virtual CPU clock rate
+ required: false
+ virtual_cpu_oversubscription_policy:
+ type: string
+ description: CPU core oversubscription policy e.g. the relation of virtual CPU cores to physical CPU cores/threads.
+ required: false
+ vdu_cpu_requirements:
+ type: map
+ description: The hardware platform specific VDU CPU requirements. A map of strings that contains a set of key-value pairs describing VDU CPU specific hardware platform requirements.
+ required: false
+ entry_schema:
+ type: string
+ virtual_cpu_pinning:
+ type: tosca.datatypes.nfv.VirtualCpuPinning
+ description: The virtual CPU pinning configuration for the virtualised compute resource.
+ required: false
+
+ tosca.datatypes.nfv.VirtualCpuPinning:
+ derived_from: tosca.datatypes.Root
+ description: Supports the specification of requirements related to the virtual CPU pinning configuration of a virtual compute resource
+ properties:
+ virtual_cpu_pinning_policy:
+ type: string
+ description: 'Indicates the policy for CPU pinning. The policy can take values of "static" or "dynamic". In case of "dynamic" the allocation of virtual CPU cores to logical CPU cores is decided by the VIM. (e.g.: SMT (Simultaneous Multi-Threading) requirements). In case of "static" the allocation is requested to be according to the virtual_cpu_pinning_rule.'
+ required: false
+ constraints:
+ - valid_values: [ static, dynamic ]
+ virtual_cpu_pinning_rule:
+ type: list
+ description: Provides the list of rules for allocating virtual CPU cores to logical CPU cores/threads
+ required: false
+ entry_schema:
+ type: string
+
+ tosca.datatypes.nfv.VnfcConfigurableProperties:
+ derived_from: tosca.datatypes.Root
+ description: Defines the configurable properties of a VNFC
+ # properties:
+ # additional_vnfc_configurable_properties:
+ # type: tosca.datatypes.nfv.VnfcAdditionalConfigurableProperties
+ # description: Describes additional configuration for VNFC that
+ # can be modified using the ModifyVnfInfo operation
+ # required: false
+ # derived types are expected to introduce
+ # additional_vnfc_configurable_properties with its type derived from
+ # tosca.datatypes.nfv.VnfcAdditionalConfigurableProperties
+
+ tosca.datatypes.nfv.VnfcAdditionalConfigurableProperties:
+ derived_from: tosca.datatypes.Root
+ description: VnfcAdditionalConfigurableProperties type is an empty base type for deriving data types for describing additional configurable properties for a given VNFC.
+
+ tosca.datatypes.nfv.VduProfile:
+ derived_from: tosca.datatypes.Root
+ description: describes additional instantiation data for a given Vdu.Compute used in a specific deployment flavour.
+ properties:
+ min_number_of_instances:
+ type: integer
+ description: Minimum number of instances of the VNFC based on this Vdu.Compute that is permitted to exist for a particular VNF deployment flavour.
+ required: true
+ constraints:
+ - greater_or_equal: 0
+ max_number_of_instances:
+ type: integer
+ description: Maximum number of instances of the VNFC based on this Vdu.Compute that is permitted to exist for a particular VNF deployment flavour.
+ required: true
+ constraints:
+ - greater_or_equal: 0
+
+ tosca.datatypes.nfv.VlProfile:
+ derived_from: tosca.datatypes.Root
+ description: Describes additional instantiation data for a given VL used in a specific VNF deployment flavour.
+ properties:
+ max_bitrate_requirements:
+ type: tosca.datatypes.nfv.LinkBitrateRequirements
+ description: Specifies the maximum bitrate requirements for a VL instantiated according to this profile.
+ required: true
+ min_bitrate_requirements:
+ type: tosca.datatypes.nfv.LinkBitrateRequirements
+ description: Specifies the minimum bitrate requirements for a VL instantiated according to this profile.
+ required: true
+ qos:
+ type: tosca.datatypes.nfv.Qos
+ description: Specifies the QoS requirements of a VL instantiated according to this profile.
+ required: false
+ virtual_link_protocol_data:
+ type: list
+ description: Specifies the protocol data for a virtual link.
+ required: false
+ entry_schema:
+ type: tosca.datatypes.nfv.VirtualLinkProtocolData
+
+ tosca.datatypes.nfv.VirtualLinkProtocolData:
+ derived_from: tosca.datatypes.Root
+ description: describes one protocol layer and associated protocol data for a given virtual link used in a specific VNF deployment flavour
+ properties:
+ associated_layer_protocol:
+ type: string
+ description: Identifies one of the protocols a virtualLink gives access to (ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire) as specified by the connectivity_type property.
+ required: true
+ constraints:
+ - valid_values: [ ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire ]
+ l2_protocol_data:
+ type: tosca.datatypes.nfv.L2ProtocolData
+ description: Specifies the L2 protocol data for a virtual link. Shall be present when the associatedLayerProtocol attribute indicates a L2 protocol and shall be absent otherwise.
+ required: false
+ l3_protocol_data:
+ type: tosca.datatypes.nfv.L3ProtocolData
+ description: Specifies the L3 protocol data for this virtual link. Shall be present when the associatedLayerProtocol attribute indicates a L3 protocol and shall be absent otherwise.
+ required: false
+
+ tosca.datatypes.nfv.L2ProtocolData:
+ derived_from: tosca.datatypes.Root
+ description: describes L2 protocol data for a given virtual link used in a specific VNF deployment flavour.
+ properties:
+ name:
+ type: string
+ description: Identifies the network name associated with this L2 protocol.
+ required: false
+ network_type:
+ type: string
+ description: Specifies the network type for this L2 protocol.The value may be overridden at run-time.
+ required: false
+ constraints:
+ - valid_values: [ flat, vlan, vxlan, gre ]
+ vlan_transparent:
+ type: boolean
+ description: Specifies whether to support VLAN transparency for this L2 protocol or not.
+ required: false
+ default: false
+ mtu:
+ type: integer
+ description: Specifies the maximum transmission unit (MTU) value for this L2 protocol.
+ required: false
+ constraints:
+ - greater_than: 0
+
+ tosca.datatypes.nfv.L3ProtocolData:
+ derived_from: tosca.datatypes.Root
+ description: describes L3 protocol data for a given virtual link used in a specific VNF deployment flavour.
+ properties:
+ name:
+ type: string
+ description: Identifies the network name associated with this L3 protocol.
+ required: false
+ ip_version:
+ type: string
+ description: Specifies IP version of this L3 protocol.The value of the ip_version property shall be consistent with the value of the layer_protocol in the connectivity_type property of the virtual link node.
+ required: true
+ constraints:
+ - valid_values: [ ipv4, ipv6 ]
+ cidr:
+ type: string
+ description: Specifies the CIDR (Classless Inter-Domain Routing) of this L3 protocol. The value may be overridden at run-time.
+ required: true
+ ip_allocation_pools:
+ type: list
+ description: Specifies the allocation pools with start and end IP addresses for this L3 protocol. The value may be overridden at run-time.
+ required: false
+ entry_schema:
+ type: tosca.datatypes.nfv.IpAllocationPool
+ gateway_ip:
+ type: string
+ description: Specifies the gateway IP address for this L3 protocol. The value may be overridden at run-time.
+ required: false
+ dhcp_enabled:
+ type: boolean
+ description: Indicates whether DHCP (Dynamic Host Configuration Protocol) is enabled or disabled for this L3 protocol. The value may be overridden at run-time.
+ required: false
+ ipv6_address_mode:
+ type: string
+ description: Specifies IPv6 address mode. May be present when the value of the ipVersion attribute is "ipv6" and shall be absent otherwise. The value may be overridden at run-time.
+ required: false
+ constraints:
+ - valid_values: [ slaac, dhcpv6-stateful, dhcpv6-stateless ]
+
+ tosca.datatypes.nfv.IpAllocationPool:
+ derived_from: tosca.datatypes.Root
+ description: Specifies a range of IP addresses
+ properties:
+ start_ip_address:
+ type: string
+ description: The IP address to be used as the first one in a pool of addresses derived from the cidr block full IP range
+ required: true
+ end_ip_address:
+ type: string
+ description: The IP address to be used as the last one in a pool of addresses derived from the cidr block full IP range
+ required: true
+
+ tosca.datatypes.nfv.InstantiationLevel:
+ derived_from: tosca.datatypes.Root
+ description: Describes the scale level for each aspect that corresponds to a given level of resources to be instantiated within a deployment flavour in term of the number VNFC instances
+ properties:
+ description:
+ type: string
+ description: Human readable description of the level
+ required: true
+ scale_info:
+ type: map # key: aspectId
+ description: Represents for each aspect the scale level that corresponds to this instantiation level. scale_info shall be present if the VNF supports scaling.
+ required: false
+ entry_schema:
+ type: tosca.datatypes.nfv.ScaleInfo
+
+ tosca.datatypes.nfv.VduLevel:
+ derived_from: tosca.datatypes.Root
+ description: Indicates for a given Vdu.Compute in a given level the number of instances to deploy
+ properties:
+ number_of_instances:
+ type: integer
+ description: Number of instances of VNFC based on this VDU to deploy for this level.
+ required: true
+ constraints:
+ - greater_or_equal: 0
+
+ tosca.datatypes.nfv.VnfLcmOperationsConfiguration:
+ derived_from: tosca.datatypes.Root
+ description: Represents information to configure lifecycle management operations
+ properties:
+ instantiate:
+ type: tosca.datatypes.nfv.VnfInstantiateOperationConfiguration
+ description: Configuration parameters for the InstantiateVnf operation
+ required: false
+ scale:
+ type: tosca.datatypes.nfv.VnfScaleOperationConfiguration
+ description: Configuration parameters for the ScaleVnf operation
+ required: false
+ scale_to_level:
+ type: tosca.datatypes.nfv.VnfScaleToLevelOperationConfiguration
+ description: Configuration parameters for the ScaleVnfToLevel operation
+ required: false
+ change_flavour:
+ type: tosca.datatypes.nfv.VnfChangeFlavourOperationConfiguration
+ description: Configuration parameters for the changeVnfFlavourOpConfig operation
+ required: false
+ heal:
+ type: tosca.datatypes.nfv.VnfHealOperationConfiguration
+ description: Configuration parameters for the HealVnf operation
+ required: false
+ terminate:
+ type: tosca.datatypes.nfv.VnfTerminateOperationConfiguration
+ description: Configuration parameters for the TerminateVnf operation
+ required: false
+ operate:
+ type: tosca.datatypes.nfv.VnfOperateOperationConfiguration
+ description: Configuration parameters for the OperateVnf operation
+ required: false
+ change_ext_connectivity:
+ type: tosca.datatypes.nfv.VnfChangeExtConnectivityOperationConfiguration
+ description: Configuration parameters for the changeExtVnfConnectivityOpConfig operation
+ required: false
+
+ tosca.datatypes.nfv.VnfInstantiateOperationConfiguration:
+ derived_from: tosca.datatypes.Root
+ description: represents information that affect the invocation of the InstantiateVnf operation.
+
+ tosca.datatypes.nfv.VnfScaleOperationConfiguration:
+ derived_from: tosca.datatypes.Root
+ description: Represents information that affect the invocation of the ScaleVnf operation
+ properties:
+ scaling_by_more_than_one_step_supported:
+ type: boolean
+ description: Signals whether passing a value larger than one in the numScalingSteps parameter of the ScaleVnf operation is supported by this VNF.
+ required: false
+ default: false
+
+ tosca.datatypes.nfv.VnfScaleToLevelOperationConfiguration:
+ derived_from: tosca.datatypes.Root
+ description: represents information that affect the invocation of the ScaleVnfToLevel operation
+ properties:
+ arbitrary_target_levels_supported:
+ type: boolean
+ description: Signals whether scaling according to the parameter "scaleInfo" is supported by this VNF
+ required: true
+
+ tosca.datatypes.nfv.VnfHealOperationConfiguration:
+ derived_from: tosca.datatypes.Root
+ description: represents information that affect the invocation of the HealVnf operation
+ properties:
+ causes:
+ type: list
+ description: Supported "cause" parameter values
+ required: false
+ entry_schema:
+ type: string
+
+ tosca.datatypes.nfv.VnfTerminateOperationConfiguration:
+ derived_from: tosca.datatypes.Root
+ description: represents information that affect the invocation of the TerminateVnf
+ properties:
+ min_graceful_termination_timeout:
+ type: scalar-unit.time
+ description: Minimum timeout value for graceful termination of a VNF instance
+ required: true
+ max_recommended_graceful_termination_timeout:
+ type: scalar-unit.time
+ description: Maximum recommended timeout value that can be needed to gracefully terminate a VNF instance of a particular type under certain conditions, such as maximum load condition. This is provided by VNF provider as information for the operator facilitating the selection of optimal timeout value. This value is not used as constraint
+ required: false
+
+ tosca.datatypes.nfv.VnfOperateOperationConfiguration:
+ derived_from: tosca.datatypes.Root
+ description: represents information that affect the invocation of the OperateVnf operation
+ properties:
+ min_graceful_stop_timeout:
+ type: scalar-unit.time
+ description: Minimum timeout value for graceful stop of a VNF instance
+ required: true
+ max_recommended_graceful_stop_timeout:
+ type: scalar-unit.time
+ description: Maximum recommended timeout value that can be needed to gracefully stop a VNF instance of a particular type under certain conditions, such as maximum load condition. This is provided by VNF provider as information for the operator facilitating the selection of optimal timeout value. This value is not used as constraint
+ required: false
+
+ tosca.datatypes.nfv.ScaleInfo:
+ derived_from: tosca.datatypes.Root
+ description: Indicates for a given scaleAspect the corresponding scaleLevel
+ properties:
+ scale_level:
+ type: integer
+ description: The scale level for a particular aspect
+ required: true
+ constraints:
+ - greater_or_equal: 0
+
+ tosca.datatypes.nfv.ScalingAspect:
+ derived_from: tosca.datatypes.Root
+ properties:
+ name:
+ type: string
+ required: true
+ description:
+ type: string
+ required: true
+ max_scale_level:
+ type: integer # positiveInteger
+ required: true
+ constraints:
+ - greater_or_equal: 0
+ step_deltas:
+ type: list
+ required: false
+ entry_schema:
+ type: string # Identifier
+
+ tosca.datatypes.nfv.VnfConfigurableProperties:
+ derived_from: tosca.datatypes.Root
+ description: indicates configuration properties for a given VNF (e.g. related to auto scaling and auto healing).
+ properties:
+ is_autoscale_enabled:
+ type: boolean
+ description: It permits to enable (TRUE)/disable (FALSE) the auto-scaling functionality. If the properties is not present for configuring, then VNF property is not supported
+ required: false
+ is_autoheal_enabled:
+ type: boolean
+ description: It permits to enable (TRUE)/disable (FALSE) the auto-healing functionality. If the properties is not present for configuring, then VNF property is not supported
+ required: false
+ # additional_configurable_properties:
+ # description: It provides VNF specific configurable properties that
+ # can be modified using the ModifyVnfInfo operation
+ # required: false
+ # type: tosca.datatypes.nfv.VnfAdditionalConfigurableProperties
+ # derived types are expected to introduce
+ # additional_configurable_properties with its type derived from
+ # tosca.datatypes.nfv.VnfAdditionalConfigurableProperties
+
+ tosca.datatypes.nfv.VnfAdditionalConfigurableProperties:
+ derived_from: tosca.datatypes.Root
+ description: is an empty base type for deriving data types for describing additional configurable properties for a given VNF
+
+ tosca.datatypes.nfv.VnfInfoModifiableAttributes:
+ derived_from: tosca.datatypes.Root
+ description: Describes VNF-specific extension and metadata for a given VNF
+ #properties:
+ #extensions:
+ #type: tosca.datatypes.nfv.VnfInfoModifiableAttributesExtensions
+ #description: "Extension" properties of VnfInfo that are writeable
+ #required: false
+ # derived types are expected to introduce
+ # extensions with its type derived from
+ # tosca.datatypes.nfv.VnfInfoModifiableAttributesExtensions
+ #metadata:
+ #type: tosca.datatypes.nfv.VnfInfoModifiableAttributesMetadata
+ #description: "Metadata" properties of VnfInfo that are writeable
+ #required: false
+ # derived types are expected to introduce
+ # metadata with its type derived from
+ # tosca.datatypes.nfv.VnfInfoModifiableAttributesMetadata
+
+ tosca.datatypes.nfv.VnfInfoModifiableAttributesExtensions:
+ derived_from: tosca.datatypes.Root
+ description: is an empty base type for deriving data types for describing VNF-specific extension
+
+ tosca.datatypes.nfv.VnfInfoModifiableAttributesMetadata:
+ derived_from: tosca.datatypes.Root
+ description: is an empty base type for deriving data types for describing VNF-specific metadata
+
+ tosca.datatypes.nfv.LogicalNodeData:
+ derived_from: tosca.datatypes.Root
+ description: Describes compute, memory and I/O requirements associated with a particular VDU.
+ properties:
+ logical_node_requirements:
+ type: map
+ description: The logical node-level compute, memory and I/O requirements. A map of strings that contains a set of key-value pairs that describes hardware platform specific deployment requirements, including the number of CPU cores on this logical node, a memory configuration specific to a logical node or a requirement related to the association of an I/O device with the logical node.
+ required: false
+ entry_schema:
+ type: string
+
+ tosca.datatypes.nfv.SwImageData:
+ derived_from: tosca.datatypes.Root
+ description: describes information related to a software image artifact
+ properties: # in SOL001 v0.8.0: "properties or metadata:"
+ name:
+ type: string
+ description: Name of this software image
+ required: true
+ version:
+ type: string
+ description: Version of this software image
+ required: true
+ checksum:
+ type: tosca.datatypes.nfv.ChecksumData
+ description: Checksum of the software image file
+ required: true
+ container_format:
+ type: string
+ description: The container format describes the container file format in which software image is provided
+ required: true
+ constraints:
+ - valid_values: [ aki, ami, ari, bare, docker, ova, ovf ]
+ disk_format:
+ type: string
+ description: The disk format of a software image is the format of the underlying disk image
+ required: true
+ constraints:
+ - valid_values: [ aki, ami, ari, iso, qcow2, raw, vdi, vhd, vhdx, vmdk ]
+ min_disk:
+ type: scalar-unit.size # Number
+ description: The minimal disk size requirement for this software image
+ required: true
+ constraints:
+ - greater_or_equal: 0 B
+ min_ram:
+ type: scalar-unit.size # Number
+ description: The minimal RAM requirement for this software image
+ required: false
+ constraints:
+ - greater_or_equal: 0 B
+ size:
+ type: scalar-unit.size # Number
+ description: The size of this software image
+ required: true
+ operating_system:
+ type: string
+ description: Identifies the operating system used in the software image
+ required: false
+ supported_virtualisation_environments:
+ type: list
+ description: Identifies the virtualisation environments (e.g. hypervisor) compatible with this software image
+ required: false
+ entry_schema:
+ type: string
+
+ tosca.datatypes.nfv.VirtualBlockStorageData:
+ derived_from: tosca.datatypes.Root
+ description: VirtualBlockStorageData describes block storage requirements associated with compute resources in a particular VDU, either as a local disk or as virtual attached storage
+ properties:
+ size_of_storage:
+ type: scalar-unit.size
+ description: Size of virtualised storage resource
+ required: true
+ constraints:
+ - greater_or_equal: 0 B
+ vdu_storage_requirements:
+ type: map
+ description: The hardware platform specific storage requirements. A map of strings that contains a set of key-value pairs that represents the hardware platform specific storage deployment requirements.
+ required: false
+ entry_schema:
+ type: string
+ rdma_enabled:
+ type: boolean
+ description: Indicates if the storage support RDMA
+ required: false
+ default: false
+
+ tosca.datatypes.nfv.VirtualObjectStorageData:
+ derived_from: tosca.datatypes.Root
+ description: VirtualObjectStorageData describes object storage requirements associated with compute resources in a particular VDU
+ properties:
+ max_size_of_storage:
+ type: scalar-unit.size
+ description: Maximum size of virtualized storage resource
+ required: false
+ constraints:
+ - greater_or_equal: 0 B
+
+ tosca.datatypes.nfv.VirtualFileStorageData:
+ derived_from: tosca.datatypes.Root
+ description: VirtualFileStorageData describes file storage requirements associated with compute resources in a particular VDU
+ properties:
+ size_of_storage:
+ type: scalar-unit.size
+ description: Size of virtualized storage resource
+ required: true
+ constraints:
+ - greater_or_equal: 0 B
+ file_system_protocol:
+ type: string
+ description: The shared file system protocol (e.g. NFS, CIFS)
+ required: true
+
+ tosca.datatypes.nfv.VirtualLinkBitrateLevel:
+ derived_from: tosca.datatypes.Root
+ description: Describes bitrate requirements applicable to the virtual link instantiated from a particicular VnfVirtualLink
+ properties:
+ bitrate_requirements:
+ type: tosca.datatypes.nfv.LinkBitrateRequirements
+ description: Virtual link bitrate requirements for an instantiation level or bitrate delta for a scaling step
+ required: true
+
+ tosca.datatypes.nfv.VnfOperationAdditionalParameters:
+ derived_from: tosca.datatypes.Root
+ description: Is an empty base type for deriving data type for describing VNF-specific parameters to be passed when invoking lifecycle management operations
+ #properties:
+
+ tosca.datatypes.nfv.VnfChangeFlavourOperationConfiguration:
+ derived_from: tosca.datatypes.Root
+ description: represents information that affect the invocation of the ChangeVnfFlavour operation
+ #properties:
+
+ tosca.datatypes.nfv.VnfChangeExtConnectivityOperationConfiguration:
+ derived_from: tosca.datatypes.Root
+ description: represents information that affect the invocation of the ChangeExtVnfConnectivity operation
+ #properties:
+
+ tosca.datatypes.nfv.VnfMonitoringParameter:
+ derived_from: tosca.datatypes.Root
+ description: Represents information on virtualised resource related performance metrics applicable to the VNF.
+ properties:
+ name:
+ type: string
+ description: Human readable name of the monitoring parameter
+ required: true
+ performance_metric:
+ type: string
+ description: Identifies the performance metric, according to ETSI GS NFV-IFA 027.
+ required: true
+ constraints:
+ - valid_values: [ v_cpu_usage_mean_vnf, v_cpu_usage_peak_vnf, v_memory_usage_mean_vnf, v_memory_usage_peak_vnf, v_disk_usage_mean_vnf, v_disk_usage_peak_vnf, byte_incoming_vnf_ext_cp, byte_outgoing_vnf_ext_cp,
+packet_incoming_vnf_ext_cp, packet_outgoing_vnf_ext_cp ]
+ collection_period:
+ type: scalar-unit.time
+ description: Describes the periodicity at which to collect the performance information.
+ required: false
+ constraints:
+ - greater_than: 0 s
+
+ tosca.datatypes.nfv.VnfcMonitoringParameter:
+ derived_from: tosca.datatypes.Root
+ description: Represents information on virtualised resource related performance metrics applicable to the VNF.
+ properties:
+ name:
+ type: string
+ description: Human readable name of the monitoring parameter
+ required: true
+ performance_metric:
+ type: string
+ description: Identifies the performance metric, according to ETSI GS NFV-IFA 027.
+ required: true
+ constraints:
+ - valid_values: [ v_cpu_usage_mean_vnf, v_cpu_usage_peak_vnf, v_memory_usage_mean_vnf, v_memory_usage_peak_vnf, v_disk_usage_mean_vnf, v_disk_usage_peak_vnf, byte_incoming_vnf_int_cp, byte_outgoing_vnf_int_cp, packet_incoming_vnf_int_cp, packet_outgoing_vnf_int_cp ]
+ collection_period:
+ type: scalar-unit.time
+ description: Describes the periodicity at which to collect the performance information.
+ required: false
+ constraints:
+ - greater_than: 0 s
+
+ tosca.datatypes.nfv.VirtualLinkMonitoringParameter:
+ derived_from: tosca.datatypes.Root
+ description: Represents information on virtualised resource related performance metrics applicable to the VNF.
+ properties:
+ name:
+ type: string
+ description: Human readable name of the monitoring parameter
+ required: true
+ performance_metric:
+ type: string
+ description: Identifies a performance metric derived from those defined in ETSI GS NFV-IFA 027.The packetOutgoingVirtualLink and packetIncomingVirtualLink metrics shall be obtained by aggregation the PacketOutgoing and PacketIncoming measurements defined in clause 7.1 of GS NFV-IFA 027 of all virtual link ports attached to the virtual link to which the metrics apply.
+ required: true
+ constraints:
+ - valid_values: [ packet_outgoing_virtual_link, packet_incoming_virtual_link ]
+ collection_period:
+ type: scalar-unit.time
+ description: Describes the periodicity at which to collect the performance information.
+ required: false
+ constraints:
+ - greater_than: 0 s
+
+ tosca.datatypes.nfv.InterfaceDetails:
+ derived_from: tosca.datatypes.Root
+ description: information used to access an interface exposed by a VNF
+ properties:
+ uri_components:
+ type: tosca.datatypes.nfv.UriComponents
+ description: Provides components to build a Uniform Ressource Identifier (URI) where to access the interface end point.
+ required: false
+ interface_specific_data:
+ type: map
+ description: Provides additional details that are specific to the type of interface considered.
+ required: false
+ entry_schema:
+ type: string
+
+ tosca.datatypes.nfv.UriComponents:
+ derived_from: tosca.datatypes.Root
+ description: information used to build a URI that complies with IETF RFC 3986 [8].
+ properties:
+ scheme:
+ type: string # shall comply with IETF RFC3986
+ description: scheme component of a URI.
+ required: true
+ authority:
+ type: tosca.datatypes.nfv.UriAuthority
+ description: Authority component of a URI
+ required: false
+ path:
+ type: string # shall comply with IETF RFC 3986
+ description: path component of a URI.
+ required: false
+ query:
+ type: string # shall comply with IETF RFC 3986
+ description: query component of a URI.
+ required: false
+ fragment:
+ type: string # shall comply with IETF RFC 3986
+ description: fragment component of a URI.
+ required: false
+
+ tosca.datatypes.nfv.UriAuthority:
+ derived_from: tosca.datatypes.Root
+ description: information that corresponds to the authority component of a URI as specified in IETF RFC 3986 [8]
+ properties:
+ user_info:
+ type: string # shall comply with IETF RFC 3986
+ description: user_info field of the authority component of a URI
+ required: false
+ host:
+ type: string # shall comply with IETF RFC 3986
+ description: host field of the authority component of a URI
+ required: false
+ port:
+ type: string # shall comply with IETF RFC 3986
+ description: port field of the authority component of a URI
+ required: false
+
+ tosca.datatypes.nfv.ChecksumData:
+ derived_from: tosca.datatypes.Root
+ description: Describes information about the result of performing a checksum operation over some arbitrary data
+ properties:
+ algorithm:
+ type: string
+ description: Describes the algorithm used to obtain the checksum value
+ required: true
+ constraints:
+ - valid_values: [sha-224, sha-256, sha-384, sha-512 ]
+ hash:
+ type: string
+ description: Contains the result of applying the algorithm indicated by the algorithm property to the data to which this ChecksumData refers
+ required: true
+
+artifact_types:
+ tosca.artifacts.nfv.SwImage:
+ derived_from: tosca.artifacts.Deployment.Image
+ description: describes the software image which is directly loaded on the virtualisation container realizing of the VDU or is to be loaded on a virtual storage resource.
+
+ tosca.artifacts.Implementation.nfv.Mistral:
+ derived_from: tosca.artifacts.Implementation
+ description: artifacts for Mistral workflows
+ mime_type: application/x-yaml
+ file_ext: [ yaml ]
+
+capability_types:
+ tosca.capabilities.nfv.VirtualBindable:
+ derived_from: tosca.capabilities.Node
+ description: Indicates that the node that includes it can be pointed by a tosca.relationships.nfv.VirtualBindsTo relationship type which is used to model the VduHasCpd association
+
+ tosca.capabilities.nfv.VirtualCompute:
+ derived_from: tosca.capabilities.Node
+ description: Describes the capabilities related to virtual compute resources
+ properties:
+ logical_node:
+ type: map
+ description: Describes the Logical Node requirements
+ required: false
+ entry_schema:
+ type: tosca.datatypes.nfv.LogicalNodeData
+ requested_additional_capabilities:
+ type: map
+ description: Describes additional capability for a particular VDU
+ required: false
+ entry_schema:
+ type: tosca.datatypes.nfv.RequestedAdditionalCapability
+ compute_requirements:
+ type: map
+ required: false
+ entry_schema:
+ type: string
+ virtual_memory:
+ type: tosca.datatypes.nfv.VirtualMemory
+ description: Describes virtual memory of the virtualized compute
+ required: true
+ virtual_cpu:
+ type: tosca.datatypes.nfv.VirtualCpu
+ description: Describes virtual CPU(s) of the virtualized compute
+ required: true
+ virtual_local_storage:
+ type: list
+ description: A list of virtual system disks created and destroyed as part of the VM lifecycle
+ required: false
+ entry_schema:
+ type: tosca.datatypes.nfv.VirtualBlockStorageData
+ description: virtual system disk definition
+
+ tosca.capabilities.nfv.VirtualStorage:
+ derived_from: tosca.capabilities.Root
+ description: Describes the attachment capabilities related to Vdu.Storage
+
+relationship_types:
+ tosca.relationships.nfv.VirtualBindsTo:
+ derived_from: tosca.relationships.DependsOn
+ description: Represents an association relationship between Vdu.Compute and VduCp node types
+ valid_target_types: [ tosca.capabilities.nfv.VirtualBindable ]
+
+ tosca.relationships.nfv.AttachesTo:
+ derived_from: tosca.relationships.Root
+ description: Represents an association relationship between the Vdu.Compute and one of the node types, Vdu.VirtualBlockStorage, Vdu.VirtualObjectStorage or Vdu.VirtualFileStorage
+ valid_target_types: [ tosca.capabilities.nfv.VirtualStorage ]
+
+interface_types:
+ tosca.interfaces.nfv.Vnflcm:
+ derived_from: tosca.interfaces.Root
+ description: This interface encompasses a set of TOSCA operations corresponding to the VNF LCM operations defined in ETSI GS NFV-IFA 007 as well as to preamble and postamble procedures to the execution of the VNF LCM operations.
+ instantiate:
+ description: Invoked upon receipt of an Instantiate VNF request
+ # inputs:
+ # additional_parameters:
+ # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ # required: false
+ # derived types are expected to introduce additional_parameters with
+ # its type derived from
+ # tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ instantiate_start:
+ description: Invoked before instantiate
+ instantiate_end:
+ description: Invoked after instantiate
+ terminate:
+ description: Invoked upon receipt Terminate VNF request
+ # inputs:
+ # additional_parameters:
+ # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ # required: false
+ # derived types are expected to introduce additional_parameters with
+ # its type derived from
+ # tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ terminate_start:
+ description: Invoked before terminate
+ terminate_end:
+ description: Invoked after terminate
+ modify_information:
+ description: Invoked upon receipt of a Modify VNF Information request
+ modify_information_start:
+ description: Invoked before modify_information
+ modify_information_end:
+ description: Invoked after modify_information
+ change_flavour:
+ description: Invoked upon receipt of a Change VNF Flavour request
+ # inputs:
+ # additional_parameters:
+ # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ # required: false
+ # derived types are expected to introduce additional_parameters with
+ # its type derived from
+ # tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ change_flavour_start:
+ description: Invoked before change_flavour
+ change_flavour_end:
+ description: Invoked after change_flavour
+ change_external_connectivity:
+ description: Invoked upon receipt of a Change External VNF Connectivity request
+ # inputs:
+ # additional_parameters:
+ # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ # required: false
+ # derived types are expected to introduce additional_parameters with
+ # its type derived from
+ # tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ change_external_connectivity_start:
+ description: Invoked before change_external_connectivity
+ change_external_connectivity_end:
+ description: Invoked after change_external_connectivity
+ operate:
+ description: Invoked upon receipt of an Operate VNF request
+ # inputs:
+ # additional_parameters:
+ # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ # required: false
+ # derived types are expected to introduce additional_parameters with
+ # its type derived from
+ # tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ operate_start:
+ description: Invoked before operate
+ operate_end:
+ description: Invoked after operate
+ heal:
+ description: Invoked upon receipt of a Heal VNF request
+ # inputs:
+ # additional_parameters:
+ # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ # required: false
+ # derived types are expected to introduce additional_parameters with
+ # its type derived from
+ # tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ heal_start:
+ description: Invoked before heal
+ heal_end:
+ description: Invoked after heal
+ scale:
+ description: Invoked upon receipt of a Scale VNF request
+ # inputs:
+ # additional_parameters:
+ # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ # required: false
+ # derived types are expected to introduce additional_parameters with
+ # its type derived from
+ # tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ scale_start:
+ description: Invoked before scale
+ scale_end:
+ description: Invoked after scale
+ scale_to_level:
+ description: Invoked upon receipt of a Scale VNF to Level request
+ # inputs:
+ # additional_parameters:
+ # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ # required: false
+ # derived types are expected to introduce additional_parameters with
+ # its type derived from
+ # tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ scale_to_level_start:
+ description: Invoked before scale_to_level
+ scale_to_level_end:
+ description: Invoked after scale_to_level
+
+node_types:
+ tosca.nodes.nfv.VNF:
+ derived_from: tosca.nodes.Root
+ description: The generic abstract type from which all VNF specific abstract node types shall be derived to form, together with other node types, the TOSCA service template(s) representing the VNFD
+ properties:
+ descriptor_id: # instead of vnfd_id
+ type: string # GUID
+ description: Globally unique identifier of the VNFD
+ required: true
+ descriptor_version: # instead of vnfd_version
+ type: string
+ description: Identifies the version of the VNFD
+ required: true
+ provider: # instead of vnf_provider
+ type: string
+ description: Provider of the VNF and of the VNFD
+ required: true
+ product_name: # instead of vnf_product_name
+ type: string
+ description: Human readable name for the VNF Product
+ required: true
+ software_version: # instead of vnf_software_version
+ type: string
+ description: Software version of the VNF
+ required: true
+ product_info_name: # instead of vnf_product_info_name
+ type: string
+ description: Human readable name for the VNF Product
+ required: false
+ product_info_description: # instead of vnf_product_info_description
+ type: string
+ description: Human readable description of the VNF Product
+ required: false
+ vnfm_info:
+ type: list
+ required: true
+ description: Identifies VNFM(s) compatible with the VNF
+ entry_schema:
+ type: string
+ constraints:
+ - pattern: (^etsivnfm:v[0-9]?[0-9]\.[0-9]?[0-9]\.[0-9]?[0-9]$)|(^[0-9]+:[a-zA-Z0-9.-]+$)
+ localization_languages:
+ type: list
+ description: Information about localization languages of the VNF
+ required: false
+ entry_schema:
+ type: string #IETF RFC 5646 string
+ default_localization_language:
+ type: string #IETF RFC 5646 string
+ description: Default localization language that is instantiated if no information about selected localization language is available
+ required: false
+ #configurable_properties:
+ #type: tosca.datatypes.nfv.VnfConfigurableProperties
+ #description: Describes the configurable properties of the VNF
+ #required: false
+ # derived types are expected to introduce configurable_properties
+ # with its type derived from
+ # tosca.datatypes.nfv.VnfConfigurableProperties
+ #modifiable_attributes:
+ #type: tosca.datatypes.nfv.VnfInfoModifiableAttributes
+ #description: Describes the modifiable attributes of the VNF
+ #required: false
+ # derived types are expected to introduce modifiable_attributes
+ # with its type derived from
+ # tosca.datatypes.nfv.VnfInfoModifiableAttributes
+ lcm_operations_configuration:
+ type: tosca.datatypes.nfv.VnfLcmOperationsConfiguration
+ description: Describes the configuration parameters for the VNF LCM operations
+ required: false
+ monitoring_parameters:
+ type: list
+ entry_schema:
+ type: tosca.datatypes.nfv.VnfMonitoringParameter
+ description: Describes monitoring parameters applicable to the VNF.
+ required: false
+ flavour_id:
+ type: string
+ description: Identifier of the Deployment Flavour within the VNFD
+ required: true
+ flavour_description:
+ type: string
+ description: Human readable description of the DF
+ required: true
+ vnf_profile:
+ type: tosca.datatypes.nfv.VnfProfile
+ description: Describes a profile for instantiating VNFs of a particular NS DF according to a specific VNFD and VNF DF
+ required: false
+ requirements:
+ - virtual_link:
+ capability: tosca.capabilities.nfv.VirtualLinkable
+ relationship: tosca.relationships.nfv.VirtualLinksTo
+ occurrences: [ 0, 1 ]
+ # Additional requirements shall be defined in the VNF specific node type (deriving from tosca.nodes.nfv.VNF) corresponding to NS virtual links that need to connect to VnfExtCps
+ interfaces:
+ Vnflcm:
+ type: tosca.interfaces.nfv.Vnflcm
+
+ tosca.nodes.nfv.VnfExtCp:
+ derived_from: tosca.nodes.nfv.Cp
+ description: Describes a logical external connection point, exposed by the VNF enabling connection with an external Virtual Link
+ properties:
+ virtual_network_interface_requirements:
+ type: list
+ description: The actual virtual NIC requirements that is been assigned when instantiating the connection point
+ required: false
+ entry_schema:
+ type: tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements
+ requirements:
+ - external_virtual_link:
+ capability: tosca.capabilities.nfv.VirtualLinkable
+ relationship: tosca.relationships.nfv.VirtualLinksTo
+ - internal_virtual_link: #name in ETSI NFV IFA011 v0.7.3: intVirtualLinkDesc
+ capability: tosca.capabilities.nfv.VirtualLinkable
+ relationship: tosca.relationships.nfv.VirtualLinksTo
+
+ tosca.nodes.nfv.Vdu.Compute:
+ derived_from: tosca.nodes.Root
+ description: Describes the virtual compute part of a VDU which is a construct supporting the description of the deployment and operational behavior of a VNFC
+ properties:
+ name:
+ type: string
+ description: Human readable name of the VDU
+ required: true
+ description:
+ type: string
+ description: Human readable description of the VDU
+ required: true
+ boot_order:
+ type: list # explicit index (boot index) not necessary, contrary to IFA011
+ description: References a node template name from which a valid boot device is created
+ required: false
+ entry_schema:
+ type: string
+ nfvi_constraints:
+ type: list
+ description: Describes constraints on the NFVI for the VNFC instance(s) created from this VDU
+ required: false
+ entry_schema:
+ type: string
+ monitoring_parameters:
+ type: list
+ description: Describes monitoring parameters applicable to a VNFC instantiated from this VDU
+ required: false
+ entry_schema:
+ type: tosca.datatypes.nfv.VnfcMonitoringParameter
+ #configurable_properties:
+ #type: tosca.datatypes.nfv.VnfcConfigurableProperties
+ #required: false
+ # derived types are expected to introduce
+ # configurable_properties with its type derived from
+ # tosca.datatypes.nfv.VnfcConfigurableProperties
+ vdu_profile:
+ type: tosca.datatypes.nfv.VduProfile
+ description: Defines additional instantiation data for the VDU.Compute node
+ required: true
+ sw_image_data:
+ type: tosca.datatypes.nfv.SwImageData
+ description: Defines information related to a SwImage artifact used by this Vdu.Compute node
+ required: false # property is required when the node template has an associated artifact of type tosca.artifacts.nfv.SwImage and not required otherwise
+ boot_data:
+ type: string
+ description: Contains a string or a URL to a file contained in the VNF package used to customize a virtualised compute resource at boot time. The bootData may contain variable parts that are replaced by deployment specific values before being sent to the VIM.
+ required: false
+ capabilities:
+ virtual_compute:
+ type: tosca.capabilities.nfv.VirtualCompute
+ occurrences: [ 1, 1 ]
+ virtual_binding:
+ type: tosca.capabilities.nfv.VirtualBindable
+ occurrences: [ 1, UNBOUNDED ]
+ requirements:
+ - virtual_storage:
+ capability: tosca.capabilities.nfv.VirtualStorage
+ relationship: tosca.relationships.nfv.AttachesTo
+ occurrences: [ 0, UNBOUNDED ]
+
+ tosca.nodes.nfv.Vdu.VirtualBlockStorage:
+ derived_from: tosca.nodes.Root
+ description: This node type describes the specifications of requirements related to virtual block storage resources
+ properties:
+ virtual_block_storage_data:
+ type: tosca.datatypes.nfv.VirtualBlockStorageData
+ description: Describes the block storage characteristics.
+ required: true
+ sw_image_data:
+ type: tosca.datatypes.nfv.SwImageData
+ description: Defines information related to a SwImage artifact used by this Vdu.Compute node.
+ required: false # property is required when the node template has an associated artifact of type tosca.artifacts.nfv.SwImage and not required otherwise
+ capabilities:
+ virtual_storage:
+ type: tosca.capabilities.nfv.VirtualStorage
+ description: Defines the capabilities of virtual_storage.
+
+ tosca.nodes.nfv.Vdu.VirtualObjectStorage:
+ derived_from: tosca.nodes.Root
+ description: This node type describes the specifications of requirements related to virtual object storage resources
+ properties:
+ virtual_object_storage_data:
+ type: tosca.datatypes.nfv.VirtualObjectStorageData
+ description: Describes the object storage characteristics.
+ required: true
+ capabilities:
+ virtual_storage:
+ type: tosca.capabilities.nfv.VirtualStorage
+ description: Defines the capabilities of virtual_storage.
+
+ tosca.nodes.nfv.Vdu.VirtualFileStorage:
+ derived_from: tosca.nodes.Root
+ description: This node type describes the specifications of requirements related to virtual file storage resources
+ properties:
+ virtual_file_storage_data:
+ type: tosca.datatypes.nfv.VirtualFileStorageData
+ description: Describes the file storage characteristics.
+ required: true
+ capabilities:
+ virtual_storage:
+ type: tosca.capabilities.nfv.VirtualStorage
+ description: Defines the capabilities of virtual_storage.
+ requirements:
+ - virtual_link:
+ capability: tosca.capabilities.nfv.VirtualLinkable
+ relationship: tosca.relationships.nfv.VirtualLinksTo
+ #description: Describes the requirements for linking to virtual link
+
+ tosca.nodes.nfv.VduCp:
+ derived_from: tosca.nodes.nfv.Cp
+ description: describes network connectivity between a VNFC instance based on this VDU and an internal VL
+ properties:
+ bitrate_requirement:
+ type: integer # in bits per second
+ description: Bitrate requirement in bit per second on this connection point
+ required: false
+ constraints:
+ - greater_or_equal: 0
+ virtual_network_interface_requirements:
+ type: list
+ description: Specifies requirements on a virtual network interface realising the CPs instantiated from this CPD
+ required: false
+ entry_schema:
+ type: tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements
+ order:
+ type: integer
+ description: The order of the NIC on the compute instance (e.g.eth2)
+ required: false
+ constraints:
+ - greater_or_equal: 0
+ vnic_type:
+ type: string
+ description: Describes the type of the virtual network interface realizing the CPs instantiated from this CPD
+ required: false
+ constraints:
+ - valid_values: [ normal, virtio, direct-physical ]
+ requirements:
+ - virtual_link:
+ capability: tosca.capabilities.nfv.VirtualLinkable
+ relationship: tosca.relationships.nfv.VirtualLinksTo
+ - virtual_binding:
+ capability: tosca.capabilities.nfv.VirtualBindable
+ relationship: tosca.relationships.nfv.VirtualBindsTo
+ node: tosca.nodes.nfv.Vdu.Compute
+
+ tosca.nodes.nfv.VnfVirtualLink:
+ derived_from: tosca.nodes.Root
+ description: Describes the information about an internal VNF VL
+ properties:
+ connectivity_type:
+ type: tosca.datatypes.nfv.ConnectivityType
+ description: Specifies the protocol exposed by the VL and the flow pattern supported by the VL
+ required: true
+ description:
+ type: string
+ description: Provides human-readable information on the purpose of the VL
+ required: false
+ test_access:
+ type: list
+ description: Test access facilities available on the VL
+ required: false
+ entry_schema:
+ type: string
+ constraints:
+ - valid_values: [ passive_monitoring, active_loopback ]
+ vl_profile:
+ type: tosca.datatypes.nfv.VlProfile
+ description: Defines additional data for the VL
+ required: true
+ monitoring_parameters:
+ type: list
+ description: Describes monitoring parameters applicable to the VL
+ required: false
+ entry_schema:
+ type: tosca.datatypes.nfv.VirtualLinkMonitoringParameter
+ capabilities:
+ virtual_linkable:
+ type: tosca.capabilities.nfv.VirtualLinkable
+
+group_types:
+ tosca.groups.nfv.PlacementGroup:
+ derived_from: tosca.groups.Root
+ description: PlacementGroup is used for describing the affinity or anti-affinity relationship applicable between the virtualization containers to be created based on different VDUs, or between internal VLs to be created based on different VnfVirtualLinkDesc(s)
+ properties:
+ description:
+ type: string
+ description: Human readable description of the group
+ required: true
+ members: [ tosca.nodes.nfv.Vdu.Compute, tosca.nodes.nfv.VnfVirtualLink ]
+
+policy_types:
+ tosca.policies.nfv.InstantiationLevels:
+ derived_from: tosca.policies.Root
+ description: The InstantiationLevels type is a policy type representing all the instantiation levels of resources to be instantiated within a deployment flavour and including default instantiation level in term of the number of VNFC instances to be created as defined in ETSI GS NFV-IFA 011 [1].
+ properties:
+ levels:
+ type: map # key: levelId
+ description: Describes the various levels of resources that can be used to instantiate the VNF using this flavour.
+ required: true
+ entry_schema:
+ type: tosca.datatypes.nfv.InstantiationLevel
+ constraints:
+ - min_length: 1
+ default_level:
+ type: string # levelId
+ description: The default instantiation level for this flavour.
+ required: false # required if multiple entries in levels
+
+ tosca.policies.nfv.VduInstantiationLevels:
+ derived_from: tosca.policies.Root
+ description: The VduInstantiationLevels type is a policy type representing all the instantiation levels of resources to be instantiated within a deployment flavour in term of the number of VNFC instances to be created from each vdu.Compute. as defined in ETSI GS NFV-IFA 011 [1]
+ properties:
+ levels:
+ type: map # key: levelId
+ description: Describes the Vdu.Compute levels of resources that can be used to instantiate the VNF using this flavour
+ required: true
+ entry_schema:
+ type: tosca.datatypes.nfv.VduLevel
+ constraints:
+ - min_length: 1
+ targets: [ tosca.nodes.nfv.Vdu.Compute ]
+
+ tosca.policies.nfv.VirtualLinkInstantiationLevels:
+ derived_from: tosca.policies.Root
+ description: The VirtualLinkInstantiationLevels type is a policy type representing all the instantiation levels of virtual link resources to be instantiated within a deployment flavour as defined in ETSI GS NFV-IFA 011 [1].
+ properties:
+ levels:
+ type: map # key: levelId
+ description: Describes the virtual link levels of resources that can be used to instantiate the VNF using this flavour.
+ required: true
+ entry_schema:
+ type: tosca.datatypes.nfv.VirtualLinkBitrateLevel
+ constraints:
+ - min_length: 1
+ targets: [ tosca.nodes.nfv.VnfVirtualLink ]
+
+ tosca.policies.nfv.ScalingAspects:
+ derived_from: tosca.policies.Root
+ description: The ScalingAspects type is a policy type representing the scaling aspects used for horizontal scaling as defined in ETSI GS NFV-IFA 011 [1].
+ properties:
+ aspects:
+ type: map # key: aspectId
+ description: Describe maximum scale level for total number of scaling steps that can be applied to a particular aspect
+ required: true
+ entry_schema:
+ type: tosca.datatypes.nfv.ScalingAspect
+ constraints:
+ - min_length: 1
+
+ tosca.policies.nfv.VduScalingAspectDeltas:
+ derived_from: tosca.policies.Root
+ description: The VduScalingAspectDeltas type is a policy type representing the Vdu.Compute detail of an aspect deltas used for horizontal scaling, as defined in ETSI GS NFV-IFA 011 [1].
+ properties:
+ aspect:
+ type: string
+ description: Represents the scaling aspect to which this policy applies
+ required: true
+ deltas:
+ type: map # key: scalingDeltaId
+ description: Describes the Vdu.Compute scaling deltas to be applied for every scaling steps of a particular aspect.
+ required: true
+ entry_schema:
+ type: tosca.datatypes.nfv.VduLevel
+ constraints:
+ - min_length: 1
+ targets: [ tosca.nodes.nfv.Vdu.Compute ]
+
+ tosca.policies.nfv.VirtualLinkBitrateScalingAspectDeltas:
+ derived_from: tosca.policies.Root
+ description: The VirtualLinkBitrateScalingAspectDeltas type is a policy type representing the VnfVirtualLink detail of an aspect deltas used for horizontal scaling, as defined in ETSI GS NFV-IFA 011 [1].
+ properties:
+ aspect:
+ type: string
+ description: Represents the scaling aspect to which this policy applies.
+ required: true
+ deltas:
+ type: map # key: scalingDeltaId
+ description: Describes the VnfVirtualLink scaling deltas to be applied for every scaling steps of a particular aspect.
+ required: true
+ entry_schema:
+ type: tosca.datatypes.nfv.VirtualLinkBitrateLevel
+ constraints:
+ - min_length: 1
+ targets: [ tosca.nodes.nfv.VnfVirtualLink ]
+
+ tosca.policies.nfv.VduInitialDelta:
+ derived_from: tosca.policies.Root
+ description: The VduInitialDelta type is a policy type representing the Vdu.Compute detail of an initial delta used for horizontal scaling, as defined in ETSI GS NFV-IFA 011 [1].
+ properties:
+ initial_delta:
+ type: tosca.datatypes.nfv.VduLevel
+ description: Represents the initial minimum size of the VNF.
+ required: true
+ targets: [ tosca.nodes.nfv.Vdu.Compute ]
+
+ tosca.policies.nfv.VirtualLinkBitrateInitialDelta:
+ derived_from: tosca.policies.Root
+ description: The VirtualLinkBitrateInitialDelta type is a policy type representing the VnfVirtualLink detail of an initial deltas used for horizontal scaling, as defined in ETSI GS NFV-IFA 011 [1].
+ properties:
+ initial_delta:
+ type: tosca.datatypes.nfv.VirtualLinkBitrateLevel
+ description: Represents the initial minimum size of the VNF.
+ required: true
+ targets: [ tosca.nodes.nfv.VnfVirtualLink ]
+
+ tosca.policies.nfv.AffinityRule:
+ derived_from: tosca.policies.Placement
+ description: The AffinityRule describes the affinity rules applicable for the defined targets
+ properties:
+ scope:
+ type: string
+ description: scope of the rule is an NFVI_node, an NFVI_PoP, etc.
+ required: true
+ constraints:
+ - valid_values: [ nfvi_node, zone, zone_group, nfvi_pop ]
+ targets: [ tosca.nodes.nfv.Vdu.Compute, tosca.nodes.nfv.VnfVirtualLink, tosca.groups.nfv.PlacementGroup ]
+
+ tosca.policies.nfv.AntiAffinityRule:
+ derived_from: tosca.policies.Placement
+ description: The AntiAffinityRule describes the anti-affinity rules applicable for the defined targets
+ properties:
+ scope:
+ type: string
+ description: scope of the rule is an NFVI_node, an NFVI_PoP, etc.
+ required: true
+ constraints:
+ - valid_values: [ nfvi_node, zone, zone_group, nfvi_pop ]
+ targets: [ tosca.nodes.nfv.Vdu.Compute, tosca.nodes.nfv.VnfVirtualLink, tosca.groups.nfv.PlacementGroup ]
+
+ tosca.policies.nfv.SecurityGroupRule:
+ derived_from: tosca.policies.Root
+ description: The SecurityGroupRule type is a policy type specified the matching criteria for the ingress and/or egress traffic to/from visited connection points as defined in ETSI GS NFV-IFA 011 [1].
+ properties:
+ description:
+ type: string
+ description: Human readable description of the security group rule.
+ required: false
+ direction:
+ type: string
+ description: The direction in which the security group rule is applied. The direction of 'ingress' or 'egress' is specified against the associated CP. I.e., 'ingress' means the packets entering a CP, while 'egress' means the packets sent out of a CP.
+ required: false
+ constraints:
+ - valid_values: [ ingress, egress ]
+ default: ingress
+ ether_type:
+ type: string
+ description: Indicates the protocol carried over the Ethernet layer.
+ required: false
+ constraints:
+ - valid_values: [ ipv4, ipv6 ]
+ default: ipv4
+ protocol:
+ type: string
+ description: Indicates the protocol carried over the IP layer. Permitted values include any protocol defined in the IANA protocol registry, e.g. TCP, UDP, ICMP, etc.
+ required: false
+ constraints:
+ - valid_values: [ hopopt, icmp, igmp, ggp, ipv4, st, tcp, cbt, egp, igp, bbn_rcc_mon, nvp_ii, pup, argus, emcon, xnet, chaos, udp, mux, dcn_meas, hmp, prm, xns_idp, trunk_1, trunk_2, leaf_1, leaf_2, rdp, irtp, iso_tp4, netblt, mfe_nsp, merit_inp, dccp, 3pc, idpr, xtp, ddp, idpr_cmtp, tp++, il, ipv6, sdrp, ipv6_route, ipv6_frag, idrp, rsvp, gre, dsr, bna, esp, ah, i_nlsp, swipe, narp, mobile, tlsp, skip, ipv6_icmp, ipv6_no_nxt, ipv6_opts, cftp, sat_expak, kryptolan, rvd, ippc, sat_mon, visa, ipcv, cpnx, cphb, wsn, pvp, br_sat_mon, sun_nd, wb_mon, wb_expak, iso_ip, vmtp, secure_vmtp, vines, ttp, iptm, nsfnet_igp, dgp, tcf, eigrp, ospfigp, sprite_rpc, larp, mtp, ax.25, ipip, micp, scc_sp, etherip, encap, gmtp, ifmp, pnni, pim, aris, scps, qnx, a/n, ip_comp, snp, compaq_peer, ipx_in_ip, vrrp, pgm, l2tp, ddx, iatp, stp, srp, uti, smp, sm, ptp, isis, fire, crtp, crudp, sscopmce, iplt, sps, pipe, sctp, fc, rsvp_e2e_ignore, mobility, udp_lite, mpls_in_ip, manet, hip, shim6, wesp, rohc ]
+ default: tcp
+ port_range_min:
+ type: integer
+ description: Indicates minimum port number in the range that is matched by the security group rule. If a value is provided at design-time, this value may be overridden at run-time based on other deployment requirements or constraints.
+ required: false
+ constraints:
+ - greater_or_equal: 0
+ - less_or_equal: 65535
+ default: 0
+ port_range_max:
+ type: integer
+ description: Indicates maximum port number in the range that is matched by the security group rule. If a value is provided at design-time, this value may be overridden at run-time based on other deployment requirements or constraints.
+ required: false
+ constraints:
+ - greater_or_equal: 0
+ - less_or_equal: 65535
+ default: 65535
+ targets: [ tosca.nodes.nfv.VduCp, tosca.nodes.nfv.VnfExtCp ]
+
+ tosca.policies.nfv.SupportedVnfInterface:
+ derived_from: tosca.policies.Root
+ description: this policy type represents interfaces produced by a VNF, the details to access them and the applicable connection points to use to access these interfaces
+ properties:
+ interface_name:
+ type: string
+ description: Identifies an interface produced by the VNF.
+ required: true
+ constraints:
+ - valid_values: [ vnf_indicator, vnf_configuration ]
+ details:
+ type: tosca.datatypes.nfv.InterfaceDetails
+ description: Provide additional data to access the interface endpoint
+ required: false
+ targets: [ tosca.nodes.nfv.VnfExtCp, tosca.nodes.nfv.VduCp ]
+
+
diff --git a/tacker/samples/packages/cnf/Definitions/sample_vnfd_df_helmchart.yaml b/tacker/samples/packages/cnf/Definitions/sample_vnfd_df_helmchart.yaml
new file mode 100644
index 0000000..3bfb6bd
--- /dev/null
+++ b/tacker/samples/packages/cnf/Definitions/sample_vnfd_df_helmchart.yaml
@@ -0,0 +1,105 @@
+tosca_definitions_version: tosca_simple_yaml_1_2
+
+description: Sample CNF with helmchart
+
+imports:
+ - etsi_nfv_sol001_common_types.yaml
+ - etsi_nfv_sol001_vnfd_types.yaml
+ - sample_vnfd_types.yaml
+
+topology_template:
+ inputs:
+ descriptor_id:
+ type: string
+ descriptor_version:
+ type: string
+ provider:
+ type: string
+ product_name:
+ type: string
+ software_version:
+ type: string
+ vnfm_info:
+ type: list
+ entry_schema:
+ type: string
+ flavour_id:
+ type: string
+ flavour_description:
+ type: string
+
+ substitution_mappings:
+ node_type: company.provider.VNF
+ properties:
+ flavour_id: helmchart
+ requirements:
+ virtual_link_external: []
+
+ node_templates:
+ VNF:
+ type: company.provider.VNF
+ properties:
+ flavour_description: A flavour for single resources
+
+ VDU1:
+ type: tosca.nodes.nfv.Vdu.Compute
+ properties:
+ name: tacker-test-vdu-localhelm
+ description: kubernetes resource as VDU1
+ vdu_profile:
+ min_number_of_instances: 1
+ max_number_of_instances: 3
+
+ policies:
+ - scaling_aspects:
+ type: tosca.policies.nfv.ScalingAspects
+ properties:
+ aspects:
+ vdu1_aspect:
+ name: vdu1_aspect
+ description: vdu1 scaling aspect
+ max_scale_level: 2
+ step_deltas:
+ - delta_1
+
+ - vdu1_initial_delta:
+ type: tosca.policies.nfv.VduInitialDelta
+ properties:
+ initial_delta:
+ number_of_instances: 1
+ targets: [ VDU1 ]
+
+ - vdu1_scaling_aspect_deltas:
+ type: tosca.policies.nfv.VduScalingAspectDeltas
+ properties:
+ aspect: vdu1_aspect
+ deltas:
+ delta_1:
+ number_of_instances: 1
+ targets: [ VDU1 ]
+
+ - instantiation_levels:
+ type: tosca.policies.nfv.InstantiationLevels
+ properties:
+ levels:
+ instantiation_level_1:
+ description: Smallest size
+ scale_info:
+ vdu1_aspect:
+ scale_level: 0
+ instantiation_level_2:
+ description: Largest size
+ scale_info:
+ vdu1_aspect:
+ scale_level: 2
+ default_level: instantiation_level_1
+
+ - vdu1_instantiation_levels:
+ type: tosca.policies.nfv.VduInstantiationLevels
+ properties:
+ levels:
+ instantiation_level_1:
+ number_of_instances: 1
+ instantiation_level_2:
+ number_of_instances: 3
+ targets: [ VDU1 ]
diff --git a/tacker/samples/packages/cnf/Definitions/sample_vnfd_top.yaml b/tacker/samples/packages/cnf/Definitions/sample_vnfd_top.yaml
new file mode 100644
index 0000000..7080e8b
--- /dev/null
+++ b/tacker/samples/packages/cnf/Definitions/sample_vnfd_top.yaml
@@ -0,0 +1,31 @@
+tosca_definitions_version: tosca_simple_yaml_1_2
+
+description: Sample CNF with Helm
+
+imports:
+ - etsi_nfv_sol001_common_types.yaml
+ - etsi_nfv_sol001_vnfd_types.yaml
+ - sample_vnfd_types.yaml
+ - sample_vnfd_df_helmchart.yaml
+
+topology_template:
+ inputs:
+ selected_flavour:
+ type: string
+ description: VNF deployment flavour selected by the consumer. It is provided in the API
+
+ node_templates:
+ VNF:
+ type: company.provider.VNF
+ properties:
+ flavour_id: { get_input: selected_flavour }
+ descriptor_id: 37391b92-a1d9-44e5-855a-83644cdc3265
+ provider: Company
+ product_name: Sample CNF
+ software_version: '1.0'
+ descriptor_version: '1.0'
+ vnfm_info:
+ - Tacker
+ requirements:
+ #- virtual_link_external # mapped in lower-level templates
+ #- virtual_link_internal # mapped in lower-level templates
diff --git a/tacker/samples/packages/cnf/Definitions/sample_vnfd_types.yaml b/tacker/samples/packages/cnf/Definitions/sample_vnfd_types.yaml
new file mode 100644
index 0000000..0a607c9
--- /dev/null
+++ b/tacker/samples/packages/cnf/Definitions/sample_vnfd_types.yaml
@@ -0,0 +1,53 @@
+tosca_definitions_version: tosca_simple_yaml_1_2
+
+description: VNF type definition
+
+imports:
+ - etsi_nfv_sol001_common_types.yaml
+ - etsi_nfv_sol001_vnfd_types.yaml
+
+node_types:
+ company.provider.VNF:
+ derived_from: tosca.nodes.nfv.VNF
+ properties:
+ descriptor_id:
+ type: string
+ constraints: [ valid_values: [ 37391b92-a1d9-44e5-855a-83644cdc3265 ] ]
+ default: 37391b92-a1d9-44e5-855a-83644cdc3265
+ descriptor_version:
+ type: string
+ constraints: [ valid_values: [ '1.0' ] ]
+ default: '1.0'
+ provider:
+ type: string
+ constraints: [ valid_values: [ 'Company' ] ]
+ default: 'Company'
+ product_name:
+ type: string
+ constraints: [ valid_values: [ 'Sample CNF' ] ]
+ default: 'Sample CNF'
+ software_version:
+ type: string
+ constraints: [ valid_values: [ '1.0' ] ]
+ default: '1.0'
+ vnfm_info:
+ type: list
+ entry_schema:
+ type: string
+ constraints: [ valid_values: [ Tacker ] ]
+ default: [ Tacker ]
+ flavour_id:
+ type: string
+ constraints: [ valid_values: [ helmchart ] ]
+ default: helmchart
+ flavour_description:
+ type: string
+ default: ""
+ requirements:
+ - virtual_link_external:
+ capability: tosca.capabilities.nfv.VirtualLinkable
+ - virtual_link_internal:
+ capability: tosca.capabilities.nfv.VirtualLinkable
+ interfaces:
+ Vnflcm:
+ type: tosca.interfaces.nfv.Vnflcm
diff --git a/tacker/samples/packages/cnf/Files/kubernetes/localhelm-0.1.0.tgz b/tacker/samples/packages/cnf/Files/kubernetes/localhelm-0.1.0.tgz
new file mode 100644
index 0000000..42c5674
--- /dev/null
+++ b/tacker/samples/packages/cnf/Files/kubernetes/localhelm-0.1.0.tgz
Binary files differ
diff --git a/tacker/samples/packages/cnf/TOSCA-Metadata/TOSCA.meta b/tacker/samples/packages/cnf/TOSCA-Metadata/TOSCA.meta
new file mode 100644
index 0000000..0de4977
--- /dev/null
+++ b/tacker/samples/packages/cnf/TOSCA-Metadata/TOSCA.meta
@@ -0,0 +1,9 @@
+TOSCA-Meta-File-Version: 1.0
+Created-by: dummy_user
+CSAR-Version: 1.1
+Entry-Definitions: Definitions/sample_vnfd_top.yaml
+
+Name: Files/kubernetes/localhelm-0.1.0.tgz
+Content-Type: application/tar+gzip
+Algorithm: SHA-256
+Hash: 837fcfb73e5fc58572851a80a0143373d9d28ec37bd3bdf52c4d7d34b97592d5
diff --git a/tacker/samples/packages/cnf/input_param.json b/tacker/samples/packages/cnf/input_param.json
new file mode 100644
index 0000000..6e8a932
--- /dev/null
+++ b/tacker/samples/packages/cnf/input_param.json
@@ -0,0 +1,24 @@
+{
+ "flavourId": "helmchart",
+ "additionalParams": {
+ "namespace": "default",
+ "use_helm": "true",
+ "using_helm_install_param": [
+ {
+ "exthelmchart": "false",
+ "helmchartfile_path": "Files/kubernetes/localhelm-0.1.0.tgz",
+ "helmreleasename": "tacker-test-vdu"
+ }
+ ],
+ "helm_replica_values": {
+ "vdu1_aspect": "replicaCount"
+ }
+ },
+ "vimConnectionInfo": [
+ {
+ "id": "742f1fc7-7f00-417d-85a6-d4e788353181",
+ "vimId": "5a5815fa-bf1d-41f4-a824-3e39bbdcebd0",
+ "vimType": "kubernetes"
+ }
+ ]
+}
diff --git a/tacker/samples/packages/vnf/BaseHOT/simple/sample_lcm_with_user_data_hot.yaml b/tacker/samples/packages/vnf/BaseHOT/simple/sample_lcm_with_user_data_hot.yaml
new file mode 100644
index 0000000..60d8cfd
--- /dev/null
+++ b/tacker/samples/packages/vnf/BaseHOT/simple/sample_lcm_with_user_data_hot.yaml
@@ -0,0 +1,32 @@
+heat_template_version: 2013-05-23
+description: 'Template for test _generate_hot_from_tosca().'
+
+parameters:
+ nfv:
+ type: json
+
+resources:
+ VDU1:
+ type: OS::Nova::Server
+ properties:
+ flavor:
+ get_resource: VDU1_flavor
+ name: VDU1
+ image: { get_param: [ nfv, VDU, VDU1, image ] }
+ networks:
+ - port:
+ get_resource: CP1
+
+ CP1:
+ type: OS::Neutron::Port
+ properties:
+ network: { get_param: [ nfv, CP, CP1, network ] }
+
+ VDU1_flavor:
+ type: OS::Nova::Flavor
+ properties:
+ ram: { get_param: [ nfv, VDU, VDU1, flavor, ram ] }
+ vcpus: { get_param: [ nfv, VDU, VDU1, flavor, vcpus ] }
+ disk: { get_param: [ nfv, VDU, VDU1, flavor, disk ] }
+
+outputs: {}
diff --git a/tacker/samples/packages/vnf/Definitions/etsi_nfv_sol001_common_types.yaml b/tacker/samples/packages/vnf/Definitions/etsi_nfv_sol001_common_types.yaml
new file mode 100644
index 0000000..15ab39b
--- /dev/null
+++ b/tacker/samples/packages/vnf/Definitions/etsi_nfv_sol001_common_types.yaml
@@ -0,0 +1,202 @@
+tosca_definitions_version: tosca_simple_yaml_1_2
+description: ETSI NFV SOL 001 common types definitions version 2.6.1
+metadata:
+ template_name: etsi_nfv_sol001_common_types
+ template_author: ETSI_NFV
+ template_version: 2.6.1
+
+data_types:
+ tosca.datatypes.nfv.L2AddressData:
+ derived_from: tosca.datatypes.Root
+ description: Describes the information on the MAC addresses to be assigned to a connection point.
+ properties:
+ mac_address_assignment:
+ type: boolean
+ description: Specifies if the address assignment is the responsibility of management and orchestration function or not. If it is set to True, it is the management and orchestration function responsibility
+ required: true
+
+ tosca.datatypes.nfv.L3AddressData:
+ derived_from: tosca.datatypes.Root
+ description: Provides information about Layer 3 level addressing scheme and parameters applicable to a CP
+ properties:
+ ip_address_assignment:
+ type: boolean
+ description: Specifies if the address assignment is the responsibility of management and orchestration function or not. If it is set to True, it is the management and orchestration function responsibility
+ required: true
+ floating_ip_activated:
+ type: boolean
+ description: Specifies if the floating IP scheme is activated on the Connection Point or not
+ required: true
+ ip_address_type:
+ type: string
+ description: Defines address type. The address type should be aligned with the address type supported by the layer_protocols properties of the parent VnfExtCp
+ required: false
+ constraints:
+ - valid_values: [ ipv4, ipv6 ]
+ number_of_ip_address:
+ type: integer
+ description: Minimum number of IP addresses to be assigned
+ required: false
+ constraints:
+ - greater_than: 0
+
+ tosca.datatypes.nfv.AddressData:
+ derived_from: tosca.datatypes.Root
+ description: Describes information about the addressing scheme and parameters applicable to a CP
+ properties:
+ address_type:
+ type: string
+ description: Describes the type of the address to be assigned to a connection point. The content type shall be aligned with the address type supported by the layerProtocol property of the connection point
+ required: true
+ constraints:
+ - valid_values: [ mac_address, ip_address ]
+ l2_address_data:
+ type: tosca.datatypes.nfv.L2AddressData
+ description: Provides the information on the MAC addresses to be assigned to a connection point.
+ required: false
+ l3_address_data:
+ type: tosca.datatypes.nfv.L3AddressData
+ description: Provides the information on the IP addresses to be assigned to a connection point
+ required: false
+
+ tosca.datatypes.nfv.ConnectivityType:
+ derived_from: tosca.datatypes.Root
+ description: describes additional connectivity information of a virtualLink
+ properties:
+ layer_protocols:
+ type: list
+ description: Identifies the protocol a virtualLink gives access to (ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire).The top layer protocol of the virtualLink protocol stack shall always be provided. The lower layer protocols may be included when there are specific requirements on these layers.
+ required: true
+ entry_schema:
+ type: string
+ constraints:
+ - valid_values: [ ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire ]
+ flow_pattern:
+ type: string
+ description: Identifies the flow pattern of the connectivity
+ required: false
+ constraints:
+ - valid_values: [ line, tree, mesh ]
+
+ tosca.datatypes.nfv.LinkBitrateRequirements:
+ derived_from: tosca.datatypes.Root
+ description: describes the requirements in terms of bitrate for a virtual link
+ properties:
+ root:
+ type: integer # in bits per second
+ description: Specifies the throughput requirement in bits per second of the link (e.g. bitrate of E-Line, root bitrate of E-Tree, aggregate capacity of E-LAN).
+ required: true
+ constraints:
+ - greater_or_equal: 0
+ leaf:
+ type: integer # in bits per second
+ description: Specifies the throughput requirement in bits per second of leaf connections to the link when applicable to the connectivity type (e.g. for E-Tree and E LAN branches).
+ required: false
+ constraints:
+ - greater_or_equal: 0
+
+ tosca.datatypes.nfv.CpProtocolData:
+ derived_from: tosca.datatypes.Root
+ description: Describes and associates the protocol layer that a CP uses together with other protocol and connection point information
+ properties:
+ associated_layer_protocol:
+ type: string
+ required: true
+ description: One of the values of the property layer_protocols of the CP
+ constraints:
+ - valid_values: [ ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire ]
+ address_data:
+ type: list
+ description: Provides information on the addresses to be assigned to the CP
+ entry_schema:
+ type: tosca.datatypes.nfv.AddressData
+ required: false
+
+ tosca.datatypes.nfv.VnfProfile:
+ derived_from: tosca.datatypes.Root
+ description: describes a profile for instantiating VNFs of a particular NS DF according to a specific VNFD and VNF DF.
+ properties:
+ instantiation_level:
+ type: string
+ description: Identifier of the instantiation level of the VNF DF to be used for instantiation. If not present, the default instantiation level as declared in the VNFD shall be used.
+ required: false
+ min_number_of_instances:
+ type: integer
+ description: Minimum number of instances of the VNF based on this VNFD that is permitted to exist for this VnfProfile.
+ required: true
+ constraints:
+ - greater_or_equal: 0
+ max_number_of_instances:
+ type: integer
+ description: Maximum number of instances of the VNF based on this VNFD that is permitted to exist for this VnfProfile.
+ required: true
+ constraints:
+ - greater_or_equal: 0
+
+ tosca.datatypes.nfv.Qos:
+ derived_from: tosca.datatypes.Root
+ description: describes QoS data for a given VL used in a VNF deployment flavour
+ properties:
+ latency:
+ type: scalar-unit.time #Number
+ description: Specifies the maximum latency
+ required: true
+ constraints:
+ - greater_than: 0 s
+ packet_delay_variation:
+ type: scalar-unit.time #Number
+ description: Specifies the maximum jitter
+ required: true
+ constraints:
+ - greater_or_equal: 0 s
+ packet_loss_ratio:
+ type: float
+ description: Specifies the maximum packet loss ratio
+ required: false
+ constraints:
+ - in_range: [ 0.0, 1.0 ]
+
+capability_types:
+ tosca.capabilities.nfv.VirtualLinkable:
+ derived_from: tosca.capabilities.Node
+ description: A node type that includes the VirtualLinkable capability indicates that it can be pointed by tosca.relationships.nfv.VirtualLinksTo relationship type
+
+relationship_types:
+ tosca.relationships.nfv.VirtualLinksTo:
+ derived_from: tosca.relationships.DependsOn
+ description: Represents an association relationship between the VduCp and VnfVirtualLink node types
+ valid_target_types: [ tosca.capabilities.nfv.VirtualLinkable ]
+
+node_types:
+ tosca.nodes.nfv.Cp:
+ derived_from: tosca.nodes.Root
+ description: Provides information regarding the purpose of the connection point
+ properties:
+ layer_protocols:
+ type: list
+ description: Identifies which protocol the connection point uses for connectivity purposes
+ required: true
+ entry_schema:
+ type: string
+ constraints:
+ - valid_values: [ ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire ]
+ role: #Name in ETSI NFV IFA011 v0.7.3: cpRole
+ type: string
+ description: Identifies the role of the port in the context of the traffic flow patterns in the VNF or parent NS
+ required: false
+ constraints:
+ - valid_values: [ root, leaf ]
+ description:
+ type: string
+ description: Provides human-readable information on the purpose of the connection point
+ required: false
+ protocol:
+ type: list
+ description: Provides information on the addresses to be assigned to the connection point(s) instantiated from this Connection Point Descriptor
+ required: false
+ entry_schema:
+ type: tosca.datatypes.nfv.CpProtocolData
+ trunk_mode:
+ type: boolean
+ description: Provides information about whether the CP instantiated from this Cp is in Trunk mode (802.1Q or other), When operating in "trunk mode", the Cp is capable of carrying traffic for several VLANs. Absence of this property implies that trunkMode is not configured for the Cp i.e. It is equivalent to boolean value "false".
+ required: false
diff --git a/tacker/samples/packages/vnf/Definitions/etsi_nfv_sol001_vnfd_types.yaml b/tacker/samples/packages/vnf/Definitions/etsi_nfv_sol001_vnfd_types.yaml
new file mode 100644
index 0000000..73b51da
--- /dev/null
+++ b/tacker/samples/packages/vnf/Definitions/etsi_nfv_sol001_vnfd_types.yaml
@@ -0,0 +1,1465 @@
+tosca_definitions_version: tosca_simple_yaml_1_2
+description: ETSI NFV SOL 001 vnfd types definitions version 2.6.1
+metadata:
+ template_name: etsi_nfv_sol001_vnfd_types
+ template_author: ETSI_NFV
+ template_version: 2.6.1
+
+imports:
+ - etsi_nfv_sol001_common_types.yaml
+
+data_types:
+ tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements:
+ derived_from: tosca.datatypes.Root
+ description: Describes requirements on a virtual network interface
+ properties:
+ name:
+ type: string
+ description: Provides a human readable name for the requirement.
+ required: false
+ description:
+ type: string
+ description: Provides a human readable description of the requirement.
+ required: false
+ support_mandatory:
+ type: boolean
+ description: Indicates whether fulfilling the constraint is mandatory (TRUE) for successful operation or desirable (FALSE).
+ required: true
+ network_interface_requirements:
+ type: map
+ description: The network interface requirements. A map of strings that contain a set of key-value pairs that describes the hardware platform specific network interface deployment requirements.
+ required: true
+ entry_schema:
+ type: string
+ nic_io_requirements:
+ type: tosca.datatypes.nfv.LogicalNodeData
+ description: references (couples) the CP with any logical node I/O requirements (for network devices) that may have been created. Linking these attributes is necessary so that so that I/O requirements that need to be articulated at the logical node level can be associated with the network interface requirements associated with the CP.
+ required: false
+
+ tosca.datatypes.nfv.RequestedAdditionalCapability:
+ derived_from: tosca.datatypes.Root
+ description: describes requested additional capability for a particular VDU
+ properties:
+ requested_additional_capability_name:
+ type: string
+ description: Identifies a requested additional capability for the VDU.
+ required: true
+ support_mandatory:
+ type: boolean
+ description: Indicates whether the requested additional capability is mandatory for successful operation.
+ required: true
+ min_requested_additional_capability_version:
+ type: string
+ description: Identifies the minimum version of the requested additional capability.
+ required: false
+ preferred_requested_additional_capability_version:
+ type: string
+ description: Identifies the preferred version of the requested additional capability.
+ required: false
+ target_performance_parameters:
+ type: map
+ description: Identifies specific attributes, dependent on the requested additional capability type.
+ required: true
+ entry_schema:
+ type: string
+
+ tosca.datatypes.nfv.VirtualMemory:
+ derived_from: tosca.datatypes.Root
+ description: supports the specification of requirements related to virtual memory of a virtual compute resource
+ properties:
+ virtual_mem_size:
+ type: scalar-unit.size
+ description: Amount of virtual memory.
+ required: true
+ virtual_mem_oversubscription_policy:
+ type: string
+ description: The memory core oversubscription policy in terms of virtual memory to physical memory on the platform.
+ required: false
+ vdu_mem_requirements:
+ type: map
+ description: The hardware platform specific VDU memory requirements. A map of strings that contains a set of key-value pairs that describes hardware platform specific VDU memory requirements.
+ required: false
+ entry_schema:
+ type: string
+ numa_enabled:
+ type: boolean
+ description: It specifies the memory allocation to be cognisant of the relevant process/core allocation.
+ required: false
+ default: false
+
+ tosca.datatypes.nfv.VirtualCpu:
+ derived_from: tosca.datatypes.Root
+ description: Supports the specification of requirements related to virtual CPU(s) of a virtual compute resource
+ properties:
+ cpu_architecture:
+ type: string
+ description: CPU architecture type. Examples are x86, ARM
+ required: false
+ num_virtual_cpu:
+ type: integer
+ description: Number of virtual CPUs
+ required: true
+ constraints:
+ - greater_than: 0
+ virtual_cpu_clock:
+ type: scalar-unit.frequency
+ description: Minimum virtual CPU clock rate
+ required: false
+ virtual_cpu_oversubscription_policy:
+ type: string
+ description: CPU core oversubscription policy e.g. the relation of virtual CPU cores to physical CPU cores/threads.
+ required: false
+ vdu_cpu_requirements:
+ type: map
+ description: The hardware platform specific VDU CPU requirements. A map of strings that contains a set of key-value pairs describing VDU CPU specific hardware platform requirements.
+ required: false
+ entry_schema:
+ type: string
+ virtual_cpu_pinning:
+ type: tosca.datatypes.nfv.VirtualCpuPinning
+ description: The virtual CPU pinning configuration for the virtualised compute resource.
+ required: false
+
+ tosca.datatypes.nfv.VirtualCpuPinning:
+ derived_from: tosca.datatypes.Root
+ description: Supports the specification of requirements related to the virtual CPU pinning configuration of a virtual compute resource
+ properties:
+ virtual_cpu_pinning_policy:
+ type: string
+ description: 'Indicates the policy for CPU pinning. The policy can take values of "static" or "dynamic". In case of "dynamic" the allocation of virtual CPU cores to logical CPU cores is decided by the VIM. (e.g.: SMT (Simultaneous Multi-Threading) requirements). In case of "static" the allocation is requested to be according to the virtual_cpu_pinning_rule.'
+ required: false
+ constraints:
+ - valid_values: [ static, dynamic ]
+ virtual_cpu_pinning_rule:
+ type: list
+ description: Provides the list of rules for allocating virtual CPU cores to logical CPU cores/threads
+ required: false
+ entry_schema:
+ type: string
+
+ tosca.datatypes.nfv.VnfcConfigurableProperties:
+ derived_from: tosca.datatypes.Root
+ description: Defines the configurable properties of a VNFC
+ # properties:
+ # additional_vnfc_configurable_properties:
+ # type: tosca.datatypes.nfv.VnfcAdditionalConfigurableProperties
+ # description: Describes additional configuration for VNFC that
+ # can be modified using the ModifyVnfInfo operation
+ # required: false
+ # derived types are expected to introduce
+ # additional_vnfc_configurable_properties with its type derived from
+ # tosca.datatypes.nfv.VnfcAdditionalConfigurableProperties
+
+ tosca.datatypes.nfv.VnfcAdditionalConfigurableProperties:
+ derived_from: tosca.datatypes.Root
+ description: VnfcAdditionalConfigurableProperties type is an empty base type for deriving data types for describing additional configurable properties for a given VNFC.
+
+ tosca.datatypes.nfv.VduProfile:
+ derived_from: tosca.datatypes.Root
+ description: describes additional instantiation data for a given Vdu.Compute used in a specific deployment flavour.
+ properties:
+ min_number_of_instances:
+ type: integer
+ description: Minimum number of instances of the VNFC based on this Vdu.Compute that is permitted to exist for a particular VNF deployment flavour.
+ required: true
+ constraints:
+ - greater_or_equal: 0
+ max_number_of_instances:
+ type: integer
+ description: Maximum number of instances of the VNFC based on this Vdu.Compute that is permitted to exist for a particular VNF deployment flavour.
+ required: true
+ constraints:
+ - greater_or_equal: 0
+
+ tosca.datatypes.nfv.VlProfile:
+ derived_from: tosca.datatypes.Root
+ description: Describes additional instantiation data for a given VL used in a specific VNF deployment flavour.
+ properties:
+ max_bitrate_requirements:
+ type: tosca.datatypes.nfv.LinkBitrateRequirements
+ description: Specifies the maximum bitrate requirements for a VL instantiated according to this profile.
+ required: true
+ min_bitrate_requirements:
+ type: tosca.datatypes.nfv.LinkBitrateRequirements
+ description: Specifies the minimum bitrate requirements for a VL instantiated according to this profile.
+ required: true
+ qos:
+ type: tosca.datatypes.nfv.Qos
+ description: Specifies the QoS requirements of a VL instantiated according to this profile.
+ required: false
+ virtual_link_protocol_data:
+ type: list
+ description: Specifies the protocol data for a virtual link.
+ required: false
+ entry_schema:
+ type: tosca.datatypes.nfv.VirtualLinkProtocolData
+
+ tosca.datatypes.nfv.VirtualLinkProtocolData:
+ derived_from: tosca.datatypes.Root
+ description: describes one protocol layer and associated protocol data for a given virtual link used in a specific VNF deployment flavour
+ properties:
+ associated_layer_protocol:
+ type: string
+ description: Identifies one of the protocols a virtualLink gives access to (ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire) as specified by the connectivity_type property.
+ required: true
+ constraints:
+ - valid_values: [ ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire ]
+ l2_protocol_data:
+ type: tosca.datatypes.nfv.L2ProtocolData
+ description: Specifies the L2 protocol data for a virtual link. Shall be present when the associatedLayerProtocol attribute indicates a L2 protocol and shall be absent otherwise.
+ required: false
+ l3_protocol_data:
+ type: tosca.datatypes.nfv.L3ProtocolData
+ description: Specifies the L3 protocol data for this virtual link. Shall be present when the associatedLayerProtocol attribute indicates a L3 protocol and shall be absent otherwise.
+ required: false
+
+ tosca.datatypes.nfv.L2ProtocolData:
+ derived_from: tosca.datatypes.Root
+ description: describes L2 protocol data for a given virtual link used in a specific VNF deployment flavour.
+ properties:
+ name:
+ type: string
+ description: Identifies the network name associated with this L2 protocol.
+ required: false
+ network_type:
+ type: string
+ description: Specifies the network type for this L2 protocol.The value may be overridden at run-time.
+ required: false
+ constraints:
+ - valid_values: [ flat, vlan, vxlan, gre ]
+ vlan_transparent:
+ type: boolean
+ description: Specifies whether to support VLAN transparency for this L2 protocol or not.
+ required: false
+ default: false
+ mtu:
+ type: integer
+ description: Specifies the maximum transmission unit (MTU) value for this L2 protocol.
+ required: false
+ constraints:
+ - greater_than: 0
+
+ tosca.datatypes.nfv.L3ProtocolData:
+ derived_from: tosca.datatypes.Root
+ description: describes L3 protocol data for a given virtual link used in a specific VNF deployment flavour.
+ properties:
+ name:
+ type: string
+ description: Identifies the network name associated with this L3 protocol.
+ required: false
+ ip_version:
+ type: string
+ description: Specifies IP version of this L3 protocol.The value of the ip_version property shall be consistent with the value of the layer_protocol in the connectivity_type property of the virtual link node.
+ required: true
+ constraints:
+ - valid_values: [ ipv4, ipv6 ]
+ cidr:
+ type: string
+ description: Specifies the CIDR (Classless Inter-Domain Routing) of this L3 protocol. The value may be overridden at run-time.
+ required: true
+ ip_allocation_pools:
+ type: list
+ description: Specifies the allocation pools with start and end IP addresses for this L3 protocol. The value may be overridden at run-time.
+ required: false
+ entry_schema:
+ type: tosca.datatypes.nfv.IpAllocationPool
+ gateway_ip:
+ type: string
+ description: Specifies the gateway IP address for this L3 protocol. The value may be overridden at run-time.
+ required: false
+ dhcp_enabled:
+ type: boolean
+ description: Indicates whether DHCP (Dynamic Host Configuration Protocol) is enabled or disabled for this L3 protocol. The value may be overridden at run-time.
+ required: false
+ ipv6_address_mode:
+ type: string
+ description: Specifies IPv6 address mode. May be present when the value of the ipVersion attribute is "ipv6" and shall be absent otherwise. The value may be overridden at run-time.
+ required: false
+ constraints:
+ - valid_values: [ slaac, dhcpv6-stateful, dhcpv6-stateless ]
+
+ tosca.datatypes.nfv.IpAllocationPool:
+ derived_from: tosca.datatypes.Root
+ description: Specifies a range of IP addresses
+ properties:
+ start_ip_address:
+ type: string
+ description: The IP address to be used as the first one in a pool of addresses derived from the cidr block full IP range
+ required: true
+ end_ip_address:
+ type: string
+ description: The IP address to be used as the last one in a pool of addresses derived from the cidr block full IP range
+ required: true
+
+ tosca.datatypes.nfv.InstantiationLevel:
+ derived_from: tosca.datatypes.Root
+ description: Describes the scale level for each aspect that corresponds to a given level of resources to be instantiated within a deployment flavour in term of the number VNFC instances
+ properties:
+ description:
+ type: string
+ description: Human readable description of the level
+ required: true
+ scale_info:
+ type: map # key: aspectId
+ description: Represents for each aspect the scale level that corresponds to this instantiation level. scale_info shall be present if the VNF supports scaling.
+ required: false
+ entry_schema:
+ type: tosca.datatypes.nfv.ScaleInfo
+
+ tosca.datatypes.nfv.VduLevel:
+ derived_from: tosca.datatypes.Root
+ description: Indicates for a given Vdu.Compute in a given level the number of instances to deploy
+ properties:
+ number_of_instances:
+ type: integer
+ description: Number of instances of VNFC based on this VDU to deploy for this level.
+ required: true
+ constraints:
+ - greater_or_equal: 0
+
+ tosca.datatypes.nfv.VnfLcmOperationsConfiguration:
+ derived_from: tosca.datatypes.Root
+ description: Represents information to configure lifecycle management operations
+ properties:
+ instantiate:
+ type: tosca.datatypes.nfv.VnfInstantiateOperationConfiguration
+ description: Configuration parameters for the InstantiateVnf operation
+ required: false
+ scale:
+ type: tosca.datatypes.nfv.VnfScaleOperationConfiguration
+ description: Configuration parameters for the ScaleVnf operation
+ required: false
+ scale_to_level:
+ type: tosca.datatypes.nfv.VnfScaleToLevelOperationConfiguration
+ description: Configuration parameters for the ScaleVnfToLevel operation
+ required: false
+ change_flavour:
+ type: tosca.datatypes.nfv.VnfChangeFlavourOperationConfiguration
+ description: Configuration parameters for the changeVnfFlavourOpConfig operation
+ required: false
+ heal:
+ type: tosca.datatypes.nfv.VnfHealOperationConfiguration
+ description: Configuration parameters for the HealVnf operation
+ required: false
+ terminate:
+ type: tosca.datatypes.nfv.VnfTerminateOperationConfiguration
+ description: Configuration parameters for the TerminateVnf operation
+ required: false
+ operate:
+ type: tosca.datatypes.nfv.VnfOperateOperationConfiguration
+ description: Configuration parameters for the OperateVnf operation
+ required: false
+ change_ext_connectivity:
+ type: tosca.datatypes.nfv.VnfChangeExtConnectivityOperationConfiguration
+ description: Configuration parameters for the changeExtVnfConnectivityOpConfig operation
+ required: false
+
+ tosca.datatypes.nfv.VnfInstantiateOperationConfiguration:
+ derived_from: tosca.datatypes.Root
+ description: represents information that affect the invocation of the InstantiateVnf operation.
+
+ tosca.datatypes.nfv.VnfScaleOperationConfiguration:
+ derived_from: tosca.datatypes.Root
+ description: Represents information that affect the invocation of the ScaleVnf operation
+ properties:
+ scaling_by_more_than_one_step_supported:
+ type: boolean
+ description: Signals whether passing a value larger than one in the numScalingSteps parameter of the ScaleVnf operation is supported by this VNF.
+ required: false
+ default: false
+
+ tosca.datatypes.nfv.VnfScaleToLevelOperationConfiguration:
+ derived_from: tosca.datatypes.Root
+ description: represents information that affect the invocation of the ScaleVnfToLevel operation
+ properties:
+ arbitrary_target_levels_supported:
+ type: boolean
+ description: Signals whether scaling according to the parameter "scaleInfo" is supported by this VNF
+ required: true
+
+ tosca.datatypes.nfv.VnfHealOperationConfiguration:
+ derived_from: tosca.datatypes.Root
+ description: represents information that affect the invocation of the HealVnf operation
+ properties:
+ causes:
+ type: list
+ description: Supported "cause" parameter values
+ required: false
+ entry_schema:
+ type: string
+
+ tosca.datatypes.nfv.VnfTerminateOperationConfiguration:
+ derived_from: tosca.datatypes.Root
+ description: represents information that affect the invocation of the TerminateVnf
+ properties:
+ min_graceful_termination_timeout:
+ type: scalar-unit.time
+ description: Minimum timeout value for graceful termination of a VNF instance
+ required: true
+ max_recommended_graceful_termination_timeout:
+ type: scalar-unit.time
+ description: Maximum recommended timeout value that can be needed to gracefully terminate a VNF instance of a particular type under certain conditions, such as maximum load condition. This is provided by VNF provider as information for the operator facilitating the selection of optimal timeout value. This value is not used as constraint
+ required: false
+
+ tosca.datatypes.nfv.VnfOperateOperationConfiguration:
+ derived_from: tosca.datatypes.Root
+ description: represents information that affect the invocation of the OperateVnf operation
+ properties:
+ min_graceful_stop_timeout:
+ type: scalar-unit.time
+ description: Minimum timeout value for graceful stop of a VNF instance
+ required: true
+ max_recommended_graceful_stop_timeout:
+ type: scalar-unit.time
+ description: Maximum recommended timeout value that can be needed to gracefully stop a VNF instance of a particular type under certain conditions, such as maximum load condition. This is provided by VNF provider as information for the operator facilitating the selection of optimal timeout value. This value is not used as constraint
+ required: false
+
+ tosca.datatypes.nfv.ScaleInfo:
+ derived_from: tosca.datatypes.Root
+ description: Indicates for a given scaleAspect the corresponding scaleLevel
+ properties:
+ scale_level:
+ type: integer
+ description: The scale level for a particular aspect
+ required: true
+ constraints:
+ - greater_or_equal: 0
+
+ tosca.datatypes.nfv.ScalingAspect:
+ derived_from: tosca.datatypes.Root
+ properties:
+ name:
+ type: string
+ required: true
+ description:
+ type: string
+ required: true
+ max_scale_level:
+ type: integer # positiveInteger
+ required: true
+ constraints:
+ - greater_or_equal: 0
+ step_deltas:
+ type: list
+ required: false
+ entry_schema:
+ type: string # Identifier
+
+ tosca.datatypes.nfv.VnfConfigurableProperties:
+ derived_from: tosca.datatypes.Root
+ description: indicates configuration properties for a given VNF (e.g. related to auto scaling and auto healing).
+ properties:
+ is_autoscale_enabled:
+ type: boolean
+ description: It permits to enable (TRUE)/disable (FALSE) the auto-scaling functionality. If the properties is not present for configuring, then VNF property is not supported
+ required: false
+ is_autoheal_enabled:
+ type: boolean
+ description: It permits to enable (TRUE)/disable (FALSE) the auto-healing functionality. If the properties is not present for configuring, then VNF property is not supported
+ required: false
+ # additional_configurable_properties:
+ # description: It provides VNF specific configurable properties that
+ # can be modified using the ModifyVnfInfo operation
+ # required: false
+ # type: tosca.datatypes.nfv.VnfAdditionalConfigurableProperties
+ # derived types are expected to introduce
+ # additional_configurable_properties with its type derived from
+ # tosca.datatypes.nfv.VnfAdditionalConfigurableProperties
+
+ tosca.datatypes.nfv.VnfAdditionalConfigurableProperties:
+ derived_from: tosca.datatypes.Root
+ description: is an empty base type for deriving data types for describing additional configurable properties for a given VNF
+
+ tosca.datatypes.nfv.VnfInfoModifiableAttributes:
+ derived_from: tosca.datatypes.Root
+ description: Describes VNF-specific extension and metadata for a given VNF
+ #properties:
+ #extensions:
+ #type: tosca.datatypes.nfv.VnfInfoModifiableAttributesExtensions
+ #description: "Extension" properties of VnfInfo that are writeable
+ #required: false
+ # derived types are expected to introduce
+ # extensions with its type derived from
+ # tosca.datatypes.nfv.VnfInfoModifiableAttributesExtensions
+ #metadata:
+ #type: tosca.datatypes.nfv.VnfInfoModifiableAttributesMetadata
+ #description: "Metadata" properties of VnfInfo that are writeable
+ #required: false
+ # derived types are expected to introduce
+ # metadata with its type derived from
+ # tosca.datatypes.nfv.VnfInfoModifiableAttributesMetadata
+
+ tosca.datatypes.nfv.VnfInfoModifiableAttributesExtensions:
+ derived_from: tosca.datatypes.Root
+ description: is an empty base type for deriving data types for describing VNF-specific extension
+
+ tosca.datatypes.nfv.VnfInfoModifiableAttributesMetadata:
+ derived_from: tosca.datatypes.Root
+ description: is an empty base type for deriving data types for describing VNF-specific metadata
+
+ tosca.datatypes.nfv.LogicalNodeData:
+ derived_from: tosca.datatypes.Root
+ description: Describes compute, memory and I/O requirements associated with a particular VDU.
+ properties:
+ logical_node_requirements:
+ type: map
+ description: The logical node-level compute, memory and I/O requirements. A map of strings that contains a set of key-value pairs that describes hardware platform specific deployment requirements, including the number of CPU cores on this logical node, a memory configuration specific to a logical node or a requirement related to the association of an I/O device with the logical node.
+ required: false
+ entry_schema:
+ type: string
+
+ tosca.datatypes.nfv.SwImageData:
+ derived_from: tosca.datatypes.Root
+ description: describes information related to a software image artifact
+ properties: # in SOL001 v0.8.0: "properties or metadata:"
+ name:
+ type: string
+ description: Name of this software image
+ required: true
+ version:
+ type: string
+ description: Version of this software image
+ required: true
+ checksum:
+ type: tosca.datatypes.nfv.ChecksumData
+ description: Checksum of the software image file
+ required: true
+ container_format:
+ type: string
+ description: The container format describes the container file format in which software image is provided
+ required: true
+ constraints:
+ - valid_values: [ aki, ami, ari, bare, docker, ova, ovf ]
+ disk_format:
+ type: string
+ description: The disk format of a software image is the format of the underlying disk image
+ required: true
+ constraints:
+ - valid_values: [ aki, ami, ari, iso, qcow2, raw, vdi, vhd, vhdx, vmdk ]
+ min_disk:
+ type: scalar-unit.size # Number
+ description: The minimal disk size requirement for this software image
+ required: true
+ constraints:
+ - greater_or_equal: 0 B
+ min_ram:
+ type: scalar-unit.size # Number
+ description: The minimal RAM requirement for this software image
+ required: false
+ constraints:
+ - greater_or_equal: 0 B
+ size:
+ type: scalar-unit.size # Number
+ description: The size of this software image
+ required: true
+ operating_system:
+ type: string
+ description: Identifies the operating system used in the software image
+ required: false
+ supported_virtualisation_environments:
+ type: list
+ description: Identifies the virtualisation environments (e.g. hypervisor) compatible with this software image
+ required: false
+ entry_schema:
+ type: string
+
+ tosca.datatypes.nfv.VirtualBlockStorageData:
+ derived_from: tosca.datatypes.Root
+ description: VirtualBlockStorageData describes block storage requirements associated with compute resources in a particular VDU, either as a local disk or as virtual attached storage
+ properties:
+ size_of_storage:
+ type: scalar-unit.size
+ description: Size of virtualised storage resource
+ required: true
+ constraints:
+ - greater_or_equal: 0 B
+ vdu_storage_requirements:
+ type: map
+ description: The hardware platform specific storage requirements. A map of strings that contains a set of key-value pairs that represents the hardware platform specific storage deployment requirements.
+ required: false
+ entry_schema:
+ type: string
+ rdma_enabled:
+ type: boolean
+ description: Indicates if the storage support RDMA
+ required: false
+ default: false
+
+ tosca.datatypes.nfv.VirtualObjectStorageData:
+ derived_from: tosca.datatypes.Root
+ description: VirtualObjectStorageData describes object storage requirements associated with compute resources in a particular VDU
+ properties:
+ max_size_of_storage:
+ type: scalar-unit.size
+ description: Maximum size of virtualized storage resource
+ required: false
+ constraints:
+ - greater_or_equal: 0 B
+
+ tosca.datatypes.nfv.VirtualFileStorageData:
+ derived_from: tosca.datatypes.Root
+ description: VirtualFileStorageData describes file storage requirements associated with compute resources in a particular VDU
+ properties:
+ size_of_storage:
+ type: scalar-unit.size
+ description: Size of virtualized storage resource
+ required: true
+ constraints:
+ - greater_or_equal: 0 B
+ file_system_protocol:
+ type: string
+ description: The shared file system protocol (e.g. NFS, CIFS)
+ required: true
+
+ tosca.datatypes.nfv.VirtualLinkBitrateLevel:
+ derived_from: tosca.datatypes.Root
+ description: Describes bitrate requirements applicable to the virtual link instantiated from a particicular VnfVirtualLink
+ properties:
+ bitrate_requirements:
+ type: tosca.datatypes.nfv.LinkBitrateRequirements
+ description: Virtual link bitrate requirements for an instantiation level or bitrate delta for a scaling step
+ required: true
+
+ tosca.datatypes.nfv.VnfOperationAdditionalParameters:
+ derived_from: tosca.datatypes.Root
+ description: Is an empty base type for deriving data type for describing VNF-specific parameters to be passed when invoking lifecycle management operations
+ #properties:
+
+ tosca.datatypes.nfv.VnfChangeFlavourOperationConfiguration:
+ derived_from: tosca.datatypes.Root
+ description: represents information that affect the invocation of the ChangeVnfFlavour operation
+ #properties:
+
+ tosca.datatypes.nfv.VnfChangeExtConnectivityOperationConfiguration:
+ derived_from: tosca.datatypes.Root
+ description: represents information that affect the invocation of the ChangeExtVnfConnectivity operation
+ #properties:
+
+ tosca.datatypes.nfv.VnfMonitoringParameter:
+ derived_from: tosca.datatypes.Root
+ description: Represents information on virtualised resource related performance metrics applicable to the VNF.
+ properties:
+ name:
+ type: string
+ description: Human readable name of the monitoring parameter
+ required: true
+ performance_metric:
+ type: string
+ description: Identifies the performance metric, according to ETSI GS NFV-IFA 027.
+ required: true
+ constraints:
+ - valid_values: [ v_cpu_usage_mean_vnf, v_cpu_usage_peak_vnf, v_memory_usage_mean_vnf, v_memory_usage_peak_vnf, v_disk_usage_mean_vnf, v_disk_usage_peak_vnf, byte_incoming_vnf_ext_cp, byte_outgoing_vnf_ext_cp,
+packet_incoming_vnf_ext_cp, packet_outgoing_vnf_ext_cp ]
+ collection_period:
+ type: scalar-unit.time
+ description: Describes the periodicity at which to collect the performance information.
+ required: false
+ constraints:
+ - greater_than: 0 s
+
+ tosca.datatypes.nfv.VnfcMonitoringParameter:
+ derived_from: tosca.datatypes.Root
+ description: Represents information on virtualised resource related performance metrics applicable to the VNF.
+ properties:
+ name:
+ type: string
+ description: Human readable name of the monitoring parameter
+ required: true
+ performance_metric:
+ type: string
+ description: Identifies the performance metric, according to ETSI GS NFV-IFA 027.
+ required: true
+ constraints:
+ - valid_values: [ v_cpu_usage_mean_vnf, v_cpu_usage_peak_vnf, v_memory_usage_mean_vnf, v_memory_usage_peak_vnf, v_disk_usage_mean_vnf, v_disk_usage_peak_vnf, byte_incoming_vnf_int_cp, byte_outgoing_vnf_int_cp, packet_incoming_vnf_int_cp, packet_outgoing_vnf_int_cp ]
+ collection_period:
+ type: scalar-unit.time
+ description: Describes the periodicity at which to collect the performance information.
+ required: false
+ constraints:
+ - greater_than: 0 s
+
+ tosca.datatypes.nfv.VirtualLinkMonitoringParameter:
+ derived_from: tosca.datatypes.Root
+ description: Represents information on virtualised resource related performance metrics applicable to the VNF.
+ properties:
+ name:
+ type: string
+ description: Human readable name of the monitoring parameter
+ required: true
+ performance_metric:
+ type: string
+ description: Identifies a performance metric derived from those defined in ETSI GS NFV-IFA 027.The packetOutgoingVirtualLink and packetIncomingVirtualLink metrics shall be obtained by aggregation the PacketOutgoing and PacketIncoming measurements defined in clause 7.1 of GS NFV-IFA 027 of all virtual link ports attached to the virtual link to which the metrics apply.
+ required: true
+ constraints:
+ - valid_values: [ packet_outgoing_virtual_link, packet_incoming_virtual_link ]
+ collection_period:
+ type: scalar-unit.time
+ description: Describes the periodicity at which to collect the performance information.
+ required: false
+ constraints:
+ - greater_than: 0 s
+
+ tosca.datatypes.nfv.InterfaceDetails:
+ derived_from: tosca.datatypes.Root
+ description: information used to access an interface exposed by a VNF
+ properties:
+ uri_components:
+ type: tosca.datatypes.nfv.UriComponents
+ description: Provides components to build a Uniform Ressource Identifier (URI) where to access the interface end point.
+ required: false
+ interface_specific_data:
+ type: map
+ description: Provides additional details that are specific to the type of interface considered.
+ required: false
+ entry_schema:
+ type: string
+
+ tosca.datatypes.nfv.UriComponents:
+ derived_from: tosca.datatypes.Root
+ description: information used to build a URI that complies with IETF RFC 3986 [8].
+ properties:
+ scheme:
+ type: string # shall comply with IETF RFC3986
+ description: scheme component of a URI.
+ required: true
+ authority:
+ type: tosca.datatypes.nfv.UriAuthority
+ description: Authority component of a URI
+ required: false
+ path:
+ type: string # shall comply with IETF RFC 3986
+ description: path component of a URI.
+ required: false
+ query:
+ type: string # shall comply with IETF RFC 3986
+ description: query component of a URI.
+ required: false
+ fragment:
+ type: string # shall comply with IETF RFC 3986
+ description: fragment component of a URI.
+ required: false
+
+ tosca.datatypes.nfv.UriAuthority:
+ derived_from: tosca.datatypes.Root
+ description: information that corresponds to the authority component of a URI as specified in IETF RFC 3986 [8]
+ properties:
+ user_info:
+ type: string # shall comply with IETF RFC 3986
+ description: user_info field of the authority component of a URI
+ required: false
+ host:
+ type: string # shall comply with IETF RFC 3986
+ description: host field of the authority component of a URI
+ required: false
+ port:
+ type: string # shall comply with IETF RFC 3986
+ description: port field of the authority component of a URI
+ required: false
+
+ tosca.datatypes.nfv.ChecksumData:
+ derived_from: tosca.datatypes.Root
+ description: Describes information about the result of performing a checksum operation over some arbitrary data
+ properties:
+ algorithm:
+ type: string
+ description: Describes the algorithm used to obtain the checksum value
+ required: true
+ constraints:
+ - valid_values: [sha-224, sha-256, sha-384, sha-512 ]
+ hash:
+ type: string
+ description: Contains the result of applying the algorithm indicated by the algorithm property to the data to which this ChecksumData refers
+ required: true
+
+artifact_types:
+ tosca.artifacts.nfv.SwImage:
+ derived_from: tosca.artifacts.Deployment.Image
+ description: describes the software image which is directly loaded on the virtualisation container realizing of the VDU or is to be loaded on a virtual storage resource.
+
+ tosca.artifacts.Implementation.nfv.Mistral:
+ derived_from: tosca.artifacts.Implementation
+ description: artifacts for Mistral workflows
+ mime_type: application/x-yaml
+ file_ext: [ yaml ]
+
+capability_types:
+ tosca.capabilities.nfv.VirtualBindable:
+ derived_from: tosca.capabilities.Node
+ description: Indicates that the node that includes it can be pointed by a tosca.relationships.nfv.VirtualBindsTo relationship type which is used to model the VduHasCpd association
+
+ tosca.capabilities.nfv.VirtualCompute:
+ derived_from: tosca.capabilities.Node
+ description: Describes the capabilities related to virtual compute resources
+ properties:
+ logical_node:
+ type: map
+ description: Describes the Logical Node requirements
+ required: false
+ entry_schema:
+ type: tosca.datatypes.nfv.LogicalNodeData
+ requested_additional_capabilities:
+ type: map
+ description: Describes additional capability for a particular VDU
+ required: false
+ entry_schema:
+ type: tosca.datatypes.nfv.RequestedAdditionalCapability
+ compute_requirements:
+ type: map
+ required: false
+ entry_schema:
+ type: string
+ virtual_memory:
+ type: tosca.datatypes.nfv.VirtualMemory
+ description: Describes virtual memory of the virtualized compute
+ required: true
+ virtual_cpu:
+ type: tosca.datatypes.nfv.VirtualCpu
+ description: Describes virtual CPU(s) of the virtualized compute
+ required: true
+ virtual_local_storage:
+ type: list
+ description: A list of virtual system disks created and destroyed as part of the VM lifecycle
+ required: false
+ entry_schema:
+ type: tosca.datatypes.nfv.VirtualBlockStorageData
+ description: virtual system disk definition
+
+ tosca.capabilities.nfv.VirtualStorage:
+ derived_from: tosca.capabilities.Root
+ description: Describes the attachment capabilities related to Vdu.Storage
+
+relationship_types:
+ tosca.relationships.nfv.VirtualBindsTo:
+ derived_from: tosca.relationships.DependsOn
+ description: Represents an association relationship between Vdu.Compute and VduCp node types
+ valid_target_types: [ tosca.capabilities.nfv.VirtualBindable ]
+
+ tosca.relationships.nfv.AttachesTo:
+ derived_from: tosca.relationships.Root
+ description: Represents an association relationship between the Vdu.Compute and one of the node types, Vdu.VirtualBlockStorage, Vdu.VirtualObjectStorage or Vdu.VirtualFileStorage
+ valid_target_types: [ tosca.capabilities.nfv.VirtualStorage ]
+
+interface_types:
+ tosca.interfaces.nfv.Vnflcm:
+ derived_from: tosca.interfaces.Root
+ description: This interface encompasses a set of TOSCA operations corresponding to the VNF LCM operations defined in ETSI GS NFV-IFA 007 as well as to preamble and postamble procedures to the execution of the VNF LCM operations.
+ instantiate:
+ description: Invoked upon receipt of an Instantiate VNF request
+ # inputs:
+ # additional_parameters:
+ # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ # required: false
+ # derived types are expected to introduce additional_parameters with
+ # its type derived from
+ # tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ instantiate_start:
+ description: Invoked before instantiate
+ instantiate_end:
+ description: Invoked after instantiate
+ terminate:
+ description: Invoked upon receipt Terminate VNF request
+ # inputs:
+ # additional_parameters:
+ # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ # required: false
+ # derived types are expected to introduce additional_parameters with
+ # its type derived from
+ # tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ terminate_start:
+ description: Invoked before terminate
+ terminate_end:
+ description: Invoked after terminate
+ modify_information:
+ description: Invoked upon receipt of a Modify VNF Information request
+ modify_information_start:
+ description: Invoked before modify_information
+ modify_information_end:
+ description: Invoked after modify_information
+ change_flavour:
+ description: Invoked upon receipt of a Change VNF Flavour request
+ # inputs:
+ # additional_parameters:
+ # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ # required: false
+ # derived types are expected to introduce additional_parameters with
+ # its type derived from
+ # tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ change_flavour_start:
+ description: Invoked before change_flavour
+ change_flavour_end:
+ description: Invoked after change_flavour
+ change_external_connectivity:
+ description: Invoked upon receipt of a Change External VNF Connectivity request
+ # inputs:
+ # additional_parameters:
+ # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ # required: false
+ # derived types are expected to introduce additional_parameters with
+ # its type derived from
+ # tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ change_external_connectivity_start:
+ description: Invoked before change_external_connectivity
+ change_external_connectivity_end:
+ description: Invoked after change_external_connectivity
+ operate:
+ description: Invoked upon receipt of an Operate VNF request
+ # inputs:
+ # additional_parameters:
+ # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ # required: false
+ # derived types are expected to introduce additional_parameters with
+ # its type derived from
+ # tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ operate_start:
+ description: Invoked before operate
+ operate_end:
+ description: Invoked after operate
+ heal:
+ description: Invoked upon receipt of a Heal VNF request
+ # inputs:
+ # additional_parameters:
+ # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ # required: false
+ # derived types are expected to introduce additional_parameters with
+ # its type derived from
+ # tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ heal_start:
+ description: Invoked before heal
+ heal_end:
+ description: Invoked after heal
+ scale:
+ description: Invoked upon receipt of a Scale VNF request
+ # inputs:
+ # additional_parameters:
+ # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ # required: false
+ # derived types are expected to introduce additional_parameters with
+ # its type derived from
+ # tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ scale_start:
+ description: Invoked before scale
+ scale_end:
+ description: Invoked after scale
+ scale_to_level:
+ description: Invoked upon receipt of a Scale VNF to Level request
+ # inputs:
+ # additional_parameters:
+ # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ # required: false
+ # derived types are expected to introduce additional_parameters with
+ # its type derived from
+ # tosca.datatypes.nfv.VnfOperationAdditionalParameters
+ scale_to_level_start:
+ description: Invoked before scale_to_level
+ scale_to_level_end:
+ description: Invoked after scale_to_level
+
+node_types:
+ tosca.nodes.nfv.VNF:
+ derived_from: tosca.nodes.Root
+ description: The generic abstract type from which all VNF specific abstract node types shall be derived to form, together with other node types, the TOSCA service template(s) representing the VNFD
+ properties:
+ descriptor_id: # instead of vnfd_id
+ type: string # GUID
+ description: Globally unique identifier of the VNFD
+ required: true
+ descriptor_version: # instead of vnfd_version
+ type: string
+ description: Identifies the version of the VNFD
+ required: true
+ provider: # instead of vnf_provider
+ type: string
+ description: Provider of the VNF and of the VNFD
+ required: true
+ product_name: # instead of vnf_product_name
+ type: string
+ description: Human readable name for the VNF Product
+ required: true
+ software_version: # instead of vnf_software_version
+ type: string
+ description: Software version of the VNF
+ required: true
+ product_info_name: # instead of vnf_product_info_name
+ type: string
+ description: Human readable name for the VNF Product
+ required: false
+ product_info_description: # instead of vnf_product_info_description
+ type: string
+ description: Human readable description of the VNF Product
+ required: false
+ vnfm_info:
+ type: list
+ required: true
+ description: Identifies VNFM(s) compatible with the VNF
+ entry_schema:
+ type: string
+ constraints:
+ - pattern: (^etsivnfm:v[0-9]?[0-9]\.[0-9]?[0-9]\.[0-9]?[0-9]$)|(^[0-9]+:[a-zA-Z0-9.-]+$)
+ localization_languages:
+ type: list
+ description: Information about localization languages of the VNF
+ required: false
+ entry_schema:
+ type: string #IETF RFC 5646 string
+ default_localization_language:
+ type: string #IETF RFC 5646 string
+ description: Default localization language that is instantiated if no information about selected localization language is available
+ required: false
+ #configurable_properties:
+ #type: tosca.datatypes.nfv.VnfConfigurableProperties
+ #description: Describes the configurable properties of the VNF
+ #required: false
+ # derived types are expected to introduce configurable_properties
+ # with its type derived from
+ # tosca.datatypes.nfv.VnfConfigurableProperties
+ #modifiable_attributes:
+ #type: tosca.datatypes.nfv.VnfInfoModifiableAttributes
+ #description: Describes the modifiable attributes of the VNF
+ #required: false
+ # derived types are expected to introduce modifiable_attributes
+ # with its type derived from
+ # tosca.datatypes.nfv.VnfInfoModifiableAttributes
+ lcm_operations_configuration:
+ type: tosca.datatypes.nfv.VnfLcmOperationsConfiguration
+ description: Describes the configuration parameters for the VNF LCM operations
+ required: false
+ monitoring_parameters:
+ type: list
+ entry_schema:
+ type: tosca.datatypes.nfv.VnfMonitoringParameter
+ description: Describes monitoring parameters applicable to the VNF.
+ required: false
+ flavour_id:
+ type: string
+ description: Identifier of the Deployment Flavour within the VNFD
+ required: true
+ flavour_description:
+ type: string
+ description: Human readable description of the DF
+ required: true
+ vnf_profile:
+ type: tosca.datatypes.nfv.VnfProfile
+ description: Describes a profile for instantiating VNFs of a particular NS DF according to a specific VNFD and VNF DF
+ required: false
+ requirements:
+ - virtual_link:
+ capability: tosca.capabilities.nfv.VirtualLinkable
+ relationship: tosca.relationships.nfv.VirtualLinksTo
+ occurrences: [ 0, 1 ]
+ # Additional requirements shall be defined in the VNF specific node type (deriving from tosca.nodes.nfv.VNF) corresponding to NS virtual links that need to connect to VnfExtCps
+ interfaces:
+ Vnflcm:
+ type: tosca.interfaces.nfv.Vnflcm
+
+ tosca.nodes.nfv.VnfExtCp:
+ derived_from: tosca.nodes.nfv.Cp
+ description: Describes a logical external connection point, exposed by the VNF enabling connection with an external Virtual Link
+ properties:
+ virtual_network_interface_requirements:
+ type: list
+ description: The actual virtual NIC requirements that is been assigned when instantiating the connection point
+ required: false
+ entry_schema:
+ type: tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements
+ requirements:
+ - external_virtual_link:
+ capability: tosca.capabilities.nfv.VirtualLinkable
+ relationship: tosca.relationships.nfv.VirtualLinksTo
+ - internal_virtual_link: #name in ETSI NFV IFA011 v0.7.3: intVirtualLinkDesc
+ capability: tosca.capabilities.nfv.VirtualLinkable
+ relationship: tosca.relationships.nfv.VirtualLinksTo
+
+ tosca.nodes.nfv.Vdu.Compute:
+ derived_from: tosca.nodes.Root
+ description: Describes the virtual compute part of a VDU which is a construct supporting the description of the deployment and operational behavior of a VNFC
+ properties:
+ name:
+ type: string
+ description: Human readable name of the VDU
+ required: true
+ description:
+ type: string
+ description: Human readable description of the VDU
+ required: true
+ boot_order:
+ type: list # explicit index (boot index) not necessary, contrary to IFA011
+ description: References a node template name from which a valid boot device is created
+ required: false
+ entry_schema:
+ type: string
+ nfvi_constraints:
+ type: list
+ description: Describes constraints on the NFVI for the VNFC instance(s) created from this VDU
+ required: false
+ entry_schema:
+ type: string
+ monitoring_parameters:
+ type: list
+ description: Describes monitoring parameters applicable to a VNFC instantiated from this VDU
+ required: false
+ entry_schema:
+ type: tosca.datatypes.nfv.VnfcMonitoringParameter
+ #configurable_properties:
+ #type: tosca.datatypes.nfv.VnfcConfigurableProperties
+ #required: false
+ # derived types are expected to introduce
+ # configurable_properties with its type derived from
+ # tosca.datatypes.nfv.VnfcConfigurableProperties
+ vdu_profile:
+ type: tosca.datatypes.nfv.VduProfile
+ description: Defines additional instantiation data for the VDU.Compute node
+ required: true
+ sw_image_data:
+ type: tosca.datatypes.nfv.SwImageData
+ description: Defines information related to a SwImage artifact used by this Vdu.Compute node
+ required: false # property is required when the node template has an associated artifact of type tosca.artifacts.nfv.SwImage and not required otherwise
+ boot_data:
+ type: string
+ description: Contains a string or a URL to a file contained in the VNF package used to customize a virtualised compute resource at boot time. The bootData may contain variable parts that are replaced by deployment specific values before being sent to the VIM.
+ required: false
+ capabilities:
+ virtual_compute:
+ type: tosca.capabilities.nfv.VirtualCompute
+ occurrences: [ 1, 1 ]
+ virtual_binding:
+ type: tosca.capabilities.nfv.VirtualBindable
+ occurrences: [ 1, UNBOUNDED ]
+ requirements:
+ - virtual_storage:
+ capability: tosca.capabilities.nfv.VirtualStorage
+ relationship: tosca.relationships.nfv.AttachesTo
+ occurrences: [ 0, UNBOUNDED ]
+
+ tosca.nodes.nfv.Vdu.VirtualBlockStorage:
+ derived_from: tosca.nodes.Root
+ description: This node type describes the specifications of requirements related to virtual block storage resources
+ properties:
+ virtual_block_storage_data:
+ type: tosca.datatypes.nfv.VirtualBlockStorageData
+ description: Describes the block storage characteristics.
+ required: true
+ sw_image_data:
+ type: tosca.datatypes.nfv.SwImageData
+ description: Defines information related to a SwImage artifact used by this Vdu.Compute node.
+ required: false # property is required when the node template has an associated artifact of type tosca.artifacts.nfv.SwImage and not required otherwise
+ capabilities:
+ virtual_storage:
+ type: tosca.capabilities.nfv.VirtualStorage
+ description: Defines the capabilities of virtual_storage.
+
+ tosca.nodes.nfv.Vdu.VirtualObjectStorage:
+ derived_from: tosca.nodes.Root
+ description: This node type describes the specifications of requirements related to virtual object storage resources
+ properties:
+ virtual_object_storage_data:
+ type: tosca.datatypes.nfv.VirtualObjectStorageData
+ description: Describes the object storage characteristics.
+ required: true
+ capabilities:
+ virtual_storage:
+ type: tosca.capabilities.nfv.VirtualStorage
+ description: Defines the capabilities of virtual_storage.
+
+ tosca.nodes.nfv.Vdu.VirtualFileStorage:
+ derived_from: tosca.nodes.Root
+ description: This node type describes the specifications of requirements related to virtual file storage resources
+ properties:
+ virtual_file_storage_data:
+ type: tosca.datatypes.nfv.VirtualFileStorageData
+ description: Describes the file storage characteristics.
+ required: true
+ capabilities:
+ virtual_storage:
+ type: tosca.capabilities.nfv.VirtualStorage
+ description: Defines the capabilities of virtual_storage.
+ requirements:
+ - virtual_link:
+ capability: tosca.capabilities.nfv.VirtualLinkable
+ relationship: tosca.relationships.nfv.VirtualLinksTo
+ #description: Describes the requirements for linking to virtual link
+
+ tosca.nodes.nfv.VduCp:
+ derived_from: tosca.nodes.nfv.Cp
+ description: describes network connectivity between a VNFC instance based on this VDU and an internal VL
+ properties:
+ bitrate_requirement:
+ type: integer # in bits per second
+ description: Bitrate requirement in bit per second on this connection point
+ required: false
+ constraints:
+ - greater_or_equal: 0
+ virtual_network_interface_requirements:
+ type: list
+ description: Specifies requirements on a virtual network interface realising the CPs instantiated from this CPD
+ required: false
+ entry_schema:
+ type: tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements
+ order:
+ type: integer
+ description: The order of the NIC on the compute instance (e.g.eth2)
+ required: false
+ constraints:
+ - greater_or_equal: 0
+ vnic_type:
+ type: string
+ description: Describes the type of the virtual network interface realizing the CPs instantiated from this CPD
+ required: false
+ constraints:
+ - valid_values: [ normal, virtio, direct-physical ]
+ requirements:
+ - virtual_link:
+ capability: tosca.capabilities.nfv.VirtualLinkable
+ relationship: tosca.relationships.nfv.VirtualLinksTo
+ - virtual_binding:
+ capability: tosca.capabilities.nfv.VirtualBindable
+ relationship: tosca.relationships.nfv.VirtualBindsTo
+ node: tosca.nodes.nfv.Vdu.Compute
+
+ tosca.nodes.nfv.VnfVirtualLink:
+ derived_from: tosca.nodes.Root
+ description: Describes the information about an internal VNF VL
+ properties:
+ connectivity_type:
+ type: tosca.datatypes.nfv.ConnectivityType
+ description: Specifies the protocol exposed by the VL and the flow pattern supported by the VL
+ required: true
+ description:
+ type: string
+ description: Provides human-readable information on the purpose of the VL
+ required: false
+ test_access:
+ type: list
+ description: Test access facilities available on the VL
+ required: false
+ entry_schema:
+ type: string
+ constraints:
+ - valid_values: [ passive_monitoring, active_loopback ]
+ vl_profile:
+ type: tosca.datatypes.nfv.VlProfile
+ description: Defines additional data for the VL
+ required: true
+ monitoring_parameters:
+ type: list
+ description: Describes monitoring parameters applicable to the VL
+ required: false
+ entry_schema:
+ type: tosca.datatypes.nfv.VirtualLinkMonitoringParameter
+ capabilities:
+ virtual_linkable:
+ type: tosca.capabilities.nfv.VirtualLinkable
+
+group_types:
+ tosca.groups.nfv.PlacementGroup:
+ derived_from: tosca.groups.Root
+ description: PlacementGroup is used for describing the affinity or anti-affinity relationship applicable between the virtualization containers to be created based on different VDUs, or between internal VLs to be created based on different VnfVirtualLinkDesc(s)
+ properties:
+ description:
+ type: string
+ description: Human readable description of the group
+ required: true
+ members: [ tosca.nodes.nfv.Vdu.Compute, tosca.nodes.nfv.VnfVirtualLink ]
+
+policy_types:
+ tosca.policies.nfv.InstantiationLevels:
+ derived_from: tosca.policies.Root
+ description: The InstantiationLevels type is a policy type representing all the instantiation levels of resources to be instantiated within a deployment flavour and including default instantiation level in term of the number of VNFC instances to be created as defined in ETSI GS NFV-IFA 011 [1].
+ properties:
+ levels:
+ type: map # key: levelId
+ description: Describes the various levels of resources that can be used to instantiate the VNF using this flavour.
+ required: true
+ entry_schema:
+ type: tosca.datatypes.nfv.InstantiationLevel
+ constraints:
+ - min_length: 1
+ default_level:
+ type: string # levelId
+ description: The default instantiation level for this flavour.
+ required: false # required if multiple entries in levels
+
+ tosca.policies.nfv.VduInstantiationLevels:
+ derived_from: tosca.policies.Root
+ description: The VduInstantiationLevels type is a policy type representing all the instantiation levels of resources to be instantiated within a deployment flavour in term of the number of VNFC instances to be created from each vdu.Compute. as defined in ETSI GS NFV-IFA 011 [1]
+ properties:
+ levels:
+ type: map # key: levelId
+ description: Describes the Vdu.Compute levels of resources that can be used to instantiate the VNF using this flavour
+ required: true
+ entry_schema:
+ type: tosca.datatypes.nfv.VduLevel
+ constraints:
+ - min_length: 1
+ targets: [ tosca.nodes.nfv.Vdu.Compute ]
+
+ tosca.policies.nfv.VirtualLinkInstantiationLevels:
+ derived_from: tosca.policies.Root
+ description: The VirtualLinkInstantiationLevels type is a policy type representing all the instantiation levels of virtual link resources to be instantiated within a deployment flavour as defined in ETSI GS NFV-IFA 011 [1].
+ properties:
+ levels:
+ type: map # key: levelId
+ description: Describes the virtual link levels of resources that can be used to instantiate the VNF using this flavour.
+ required: true
+ entry_schema:
+ type: tosca.datatypes.nfv.VirtualLinkBitrateLevel
+ constraints:
+ - min_length: 1
+ targets: [ tosca.nodes.nfv.VnfVirtualLink ]
+
+ tosca.policies.nfv.ScalingAspects:
+ derived_from: tosca.policies.Root
+ description: The ScalingAspects type is a policy type representing the scaling aspects used for horizontal scaling as defined in ETSI GS NFV-IFA 011 [1].
+ properties:
+ aspects:
+ type: map # key: aspectId
+ description: Describe maximum scale level for total number of scaling steps that can be applied to a particular aspect
+ required: true
+ entry_schema:
+ type: tosca.datatypes.nfv.ScalingAspect
+ constraints:
+ - min_length: 1
+
+ tosca.policies.nfv.VduScalingAspectDeltas:
+ derived_from: tosca.policies.Root
+ description: The VduScalingAspectDeltas type is a policy type representing the Vdu.Compute detail of an aspect deltas used for horizontal scaling, as defined in ETSI GS NFV-IFA 011 [1].
+ properties:
+ aspect:
+ type: string
+ description: Represents the scaling aspect to which this policy applies
+ required: true
+ deltas:
+ type: map # key: scalingDeltaId
+ description: Describes the Vdu.Compute scaling deltas to be applied for every scaling steps of a particular aspect.
+ required: true
+ entry_schema:
+ type: tosca.datatypes.nfv.VduLevel
+ constraints:
+ - min_length: 1
+ targets: [ tosca.nodes.nfv.Vdu.Compute ]
+
+ tosca.policies.nfv.VirtualLinkBitrateScalingAspectDeltas:
+ derived_from: tosca.policies.Root
+ description: The VirtualLinkBitrateScalingAspectDeltas type is a policy type representing the VnfVirtualLink detail of an aspect deltas used for horizontal scaling, as defined in ETSI GS NFV-IFA 011 [1].
+ properties:
+ aspect:
+ type: string
+ description: Represents the scaling aspect to which this policy applies.
+ required: true
+ deltas:
+ type: map # key: scalingDeltaId
+ description: Describes the VnfVirtualLink scaling deltas to be applied for every scaling steps of a particular aspect.
+ required: true
+ entry_schema:
+ type: tosca.datatypes.nfv.VirtualLinkBitrateLevel
+ constraints:
+ - min_length: 1
+ targets: [ tosca.nodes.nfv.VnfVirtualLink ]
+
+ tosca.policies.nfv.VduInitialDelta:
+ derived_from: tosca.policies.Root
+ description: The VduInitialDelta type is a policy type representing the Vdu.Compute detail of an initial delta used for horizontal scaling, as defined in ETSI GS NFV-IFA 011 [1].
+ properties:
+ initial_delta:
+ type: tosca.datatypes.nfv.VduLevel
+ description: Represents the initial minimum size of the VNF.
+ required: true
+ targets: [ tosca.nodes.nfv.Vdu.Compute ]
+
+ tosca.policies.nfv.VirtualLinkBitrateInitialDelta:
+ derived_from: tosca.policies.Root
+ description: The VirtualLinkBitrateInitialDelta type is a policy type representing the VnfVirtualLink detail of an initial deltas used for horizontal scaling, as defined in ETSI GS NFV-IFA 011 [1].
+ properties:
+ initial_delta:
+ type: tosca.datatypes.nfv.VirtualLinkBitrateLevel
+ description: Represents the initial minimum size of the VNF.
+ required: true
+ targets: [ tosca.nodes.nfv.VnfVirtualLink ]
+
+ tosca.policies.nfv.AffinityRule:
+ derived_from: tosca.policies.Placement
+ description: The AffinityRule describes the affinity rules applicable for the defined targets
+ properties:
+ scope:
+ type: string
+ description: scope of the rule is an NFVI_node, an NFVI_PoP, etc.
+ required: true
+ constraints:
+ - valid_values: [ nfvi_node, zone, zone_group, nfvi_pop ]
+ targets: [ tosca.nodes.nfv.Vdu.Compute, tosca.nodes.nfv.VnfVirtualLink, tosca.groups.nfv.PlacementGroup ]
+
+ tosca.policies.nfv.AntiAffinityRule:
+ derived_from: tosca.policies.Placement
+ description: The AntiAffinityRule describes the anti-affinity rules applicable for the defined targets
+ properties:
+ scope:
+ type: string
+ description: scope of the rule is an NFVI_node, an NFVI_PoP, etc.
+ required: true
+ constraints:
+ - valid_values: [ nfvi_node, zone, zone_group, nfvi_pop ]
+ targets: [ tosca.nodes.nfv.Vdu.Compute, tosca.nodes.nfv.VnfVirtualLink, tosca.groups.nfv.PlacementGroup ]
+
+ tosca.policies.nfv.SecurityGroupRule:
+ derived_from: tosca.policies.Root
+ description: The SecurityGroupRule type is a policy type specified the matching criteria for the ingress and/or egress traffic to/from visited connection points as defined in ETSI GS NFV-IFA 011 [1].
+ properties:
+ description:
+ type: string
+ description: Human readable description of the security group rule.
+ required: false
+ direction:
+ type: string
+ description: The direction in which the security group rule is applied. The direction of 'ingress' or 'egress' is specified against the associated CP. I.e., 'ingress' means the packets entering a CP, while 'egress' means the packets sent out of a CP.
+ required: false
+ constraints:
+ - valid_values: [ ingress, egress ]
+ default: ingress
+ ether_type:
+ type: string
+ description: Indicates the protocol carried over the Ethernet layer.
+ required: false
+ constraints:
+ - valid_values: [ ipv4, ipv6 ]
+ default: ipv4
+ protocol:
+ type: string
+ description: Indicates the protocol carried over the IP layer. Permitted values include any protocol defined in the IANA protocol registry, e.g. TCP, UDP, ICMP, etc.
+ required: false
+ constraints:
+ - valid_values: [ hopopt, icmp, igmp, ggp, ipv4, st, tcp, cbt, egp, igp, bbn_rcc_mon, nvp_ii, pup, argus, emcon, xnet, chaos, udp, mux, dcn_meas, hmp, prm, xns_idp, trunk_1, trunk_2, leaf_1, leaf_2, rdp, irtp, iso_tp4, netblt, mfe_nsp, merit_inp, dccp, 3pc, idpr, xtp, ddp, idpr_cmtp, tp++, il, ipv6, sdrp, ipv6_route, ipv6_frag, idrp, rsvp, gre, dsr, bna, esp, ah, i_nlsp, swipe, narp, mobile, tlsp, skip, ipv6_icmp, ipv6_no_nxt, ipv6_opts, cftp, sat_expak, kryptolan, rvd, ippc, sat_mon, visa, ipcv, cpnx, cphb, wsn, pvp, br_sat_mon, sun_nd, wb_mon, wb_expak, iso_ip, vmtp, secure_vmtp, vines, ttp, iptm, nsfnet_igp, dgp, tcf, eigrp, ospfigp, sprite_rpc, larp, mtp, ax.25, ipip, micp, scc_sp, etherip, encap, gmtp, ifmp, pnni, pim, aris, scps, qnx, a/n, ip_comp, snp, compaq_peer, ipx_in_ip, vrrp, pgm, l2tp, ddx, iatp, stp, srp, uti, smp, sm, ptp, isis, fire, crtp, crudp, sscopmce, iplt, sps, pipe, sctp, fc, rsvp_e2e_ignore, mobility, udp_lite, mpls_in_ip, manet, hip, shim6, wesp, rohc ]
+ default: tcp
+ port_range_min:
+ type: integer
+ description: Indicates minimum port number in the range that is matched by the security group rule. If a value is provided at design-time, this value may be overridden at run-time based on other deployment requirements or constraints.
+ required: false
+ constraints:
+ - greater_or_equal: 0
+ - less_or_equal: 65535
+ default: 0
+ port_range_max:
+ type: integer
+ description: Indicates maximum port number in the range that is matched by the security group rule. If a value is provided at design-time, this value may be overridden at run-time based on other deployment requirements or constraints.
+ required: false
+ constraints:
+ - greater_or_equal: 0
+ - less_or_equal: 65535
+ default: 65535
+ targets: [ tosca.nodes.nfv.VduCp, tosca.nodes.nfv.VnfExtCp ]
+
+ tosca.policies.nfv.SupportedVnfInterface:
+ derived_from: tosca.policies.Root
+ description: this policy type represents interfaces produced by a VNF, the details to access them and the applicable connection points to use to access these interfaces
+ properties:
+ interface_name:
+ type: string
+ description: Identifies an interface produced by the VNF.
+ required: true
+ constraints:
+ - valid_values: [ vnf_indicator, vnf_configuration ]
+ details:
+ type: tosca.datatypes.nfv.InterfaceDetails
+ description: Provide additional data to access the interface endpoint
+ required: false
+ targets: [ tosca.nodes.nfv.VnfExtCp, tosca.nodes.nfv.VduCp ]
+
+
diff --git a/tacker/samples/packages/vnf/Definitions/sample_vnfd_df_simple.yaml b/tacker/samples/packages/vnf/Definitions/sample_vnfd_df_simple.yaml
new file mode 100644
index 0000000..c90b358
--- /dev/null
+++ b/tacker/samples/packages/vnf/Definitions/sample_vnfd_df_simple.yaml
@@ -0,0 +1,141 @@
+tosca_definitions_version: tosca_simple_yaml_1_2
+
+description: Simple deployment flavour for Sample VNF
+
+imports:
+ - etsi_nfv_sol001_common_types.yaml
+ - etsi_nfv_sol001_vnfd_types.yaml
+ - sample_vnfd_types.yaml
+
+topology_template:
+ inputs:
+ id:
+ type: string
+ vendor:
+ type: string
+ version:
+ type: version
+ descriptor_id:
+ type: string
+ descriptor_version:
+ type: string
+ provider:
+ type: string
+ product_name:
+ type: string
+ software_version:
+ type: string
+ vnfm_info:
+ type: list
+ entry_schema:
+ type: string
+ flavour_id:
+ type: string
+ flavour_description:
+ type: string
+
+ substitution_mappings:
+ node_type: company.provider.VNF
+ properties:
+ flavour_id: simple
+ requirements:
+ virtual_link_external: []
+
+ node_templates:
+ VNF:
+ type: company.provider.VNF
+ properties:
+ flavour_description: A simple flavour
+ interfaces:
+ Vnflcm:
+ # supporting only 'instantiate', 'terminate', 'modify',
+ # and 'heal'
+ # not supporting LCM script, supporting only default LCM
+ instantiate: []
+ # instantiate_start: []
+ # instantiate_end: []
+ terminate: []
+ # terminate_start: []
+ # terminate_end: []
+ modify_information: []
+ # modify_information_start: []
+ # modify_information_end: []
+ # change_flavour: []
+ # change_flavour_start: []
+ # change_flavour_end: []
+ # change_external_connectivity: []
+ # change_external_connectivity_start: []
+ # change_external_connectivity_end: []
+ # operate: []
+ # operate_start: []
+ # operate_end: []
+ heal: []
+ # heal_start: []
+ # heal_end: []
+ # scale: []
+ # scale_start: []
+ # scale_end: []
+ # scale_to_level: []
+ # scale_to_level_start: []
+ # scale_to_level_end: []
+
+ VDU1:
+ type: tosca.nodes.nfv.Vdu.Compute
+ properties:
+ name: VDU1
+ description: VDU1 compute node
+ vdu_profile:
+ min_number_of_instances: 1
+ max_number_of_instances: 1
+ sw_image_data:
+ name: cirros-0.5.2-x86_64-disk
+ version: '0.5.2'
+ checksum:
+ algorithm: sha-512
+ hash: 6b813aa46bb90b4da216a4d19376593fa3f4fc7e617f03a92b7fe11e9a3981cbe8f0959dbebe36225e5f53dc4492341a4863cac4ed1ee0909f3fc78ef9c3e869
+ container_format: bare
+ disk_format: qcow2
+ min_disk: 1 GB
+ size: 1 GB
+
+ artifacts:
+ sw_image:
+ type: tosca.artifacts.nfv.SwImage
+ file: ../Files/images/cirros-0.5.2-x86_64-disk.img
+
+ capabilities:
+ virtual_compute:
+ properties:
+ virtual_memory:
+ virtual_mem_size: 512 MB
+ virtual_cpu:
+ num_virtual_cpu: 1
+ virtual_local_storage:
+ - size_of_storage: 1 GB
+
+ CP1:
+ type: tosca.nodes.nfv.VduCp
+ properties:
+ layer_protocols: [ ipv4 ]
+ requirements:
+ - virtual_binding: VDU1
+ - virtual_link: internalVL1
+
+ internalVL1:
+ type: tosca.nodes.nfv.VnfVirtualLink
+ properties:
+ connectivity_type:
+ layer_protocols: [ ipv4 ]
+ description: Internal Virtual link in the VNF
+ vl_profile:
+ max_bitrate_requirements:
+ root: 1048576
+ leaf: 1048576
+ min_bitrate_requirements:
+ root: 1048576
+ leaf: 1048576
+ virtual_link_protocol_data:
+ - associated_layer_protocol: ipv4
+ l3_protocol_data:
+ ip_version: ipv4
+ cidr: 10.0.0.0/24
diff --git a/tacker/samples/packages/vnf/Definitions/sample_vnfd_top.yaml b/tacker/samples/packages/vnf/Definitions/sample_vnfd_top.yaml
new file mode 100644
index 0000000..9212992
--- /dev/null
+++ b/tacker/samples/packages/vnf/Definitions/sample_vnfd_top.yaml
@@ -0,0 +1,31 @@
+tosca_definitions_version: tosca_simple_yaml_1_2
+
+description: Sample VNF
+
+imports:
+ - etsi_nfv_sol001_common_types.yaml
+ - etsi_nfv_sol001_vnfd_types.yaml
+ - sample_vnfd_types.yaml
+ - sample_vnfd_df_simple.yaml
+
+topology_template:
+ inputs:
+ selected_flavour:
+ type: string
+ description: VNF deployment flavour selected by the consumer. It is provided in the API
+
+ node_templates:
+ VNF:
+ type: company.provider.VNF
+ properties:
+ flavour_id: { get_input: selected_flavour }
+ descriptor_id: b1bb0ce7-ebca-4fa7-95ed-4840d70a1177
+ provider: Company
+ product_name: Sample VNF
+ software_version: '1.0'
+ descriptor_version: '1.0'
+ vnfm_info:
+ - Tacker
+ requirements:
+ #- virtual_link_external # mapped in lower-level templates
+ #- virtual_link_internal # mapped in lower-level templates
diff --git a/tacker/samples/packages/vnf/Definitions/sample_vnfd_types.yaml b/tacker/samples/packages/vnf/Definitions/sample_vnfd_types.yaml
new file mode 100644
index 0000000..957cb56
--- /dev/null
+++ b/tacker/samples/packages/vnf/Definitions/sample_vnfd_types.yaml
@@ -0,0 +1,63 @@
+tosca_definitions_version: tosca_simple_yaml_1_2
+
+description: VNF type definition
+
+imports:
+ - etsi_nfv_sol001_common_types.yaml
+ - etsi_nfv_sol001_vnfd_types.yaml
+
+node_types:
+ company.provider.VNF:
+ derived_from: tosca.nodes.nfv.VNF
+ properties:
+ id:
+ type: string
+ description: ID of this VNF
+ default: vnf_id
+ vendor:
+ type: string
+ description: name of the vendor who generate this VNF
+ default: vendor
+ version:
+ type: version
+ description: version of the software for this VNF
+ default: 1.0
+ descriptor_id:
+ type: string
+ constraints: [ valid_values: [ b1bb0ce7-ebca-4fa7-95ed-4840d70a1177 ] ]
+ default: b1bb0ce7-ebca-4fa7-95ed-4840d70a1177
+ descriptor_version:
+ type: string
+ constraints: [ valid_values: [ '1.0' ] ]
+ default: '1.0'
+ provider:
+ type: string
+ constraints: [ valid_values: [ 'Company' ] ]
+ default: 'Company'
+ product_name:
+ type: string
+ constraints: [ valid_values: [ 'Sample VNF' ] ]
+ default: 'Sample VNF'
+ software_version:
+ type: string
+ constraints: [ valid_values: [ '1.0' ] ]
+ default: '1.0'
+ vnfm_info:
+ type: list
+ entry_schema:
+ type: string
+ constraints: [ valid_values: [ Tacker ] ]
+ default: [ Tacker ]
+ flavour_id:
+ type: string
+ constraints: [ valid_values: [ simple ] ]
+ default: simple
+ flavour_description:
+ type: string
+ default: This is the default flavour description
+ requirements:
+ - virtual_link_internal:
+ capability: tosca.capabilities.nfv.VirtualLinkable
+ interfaces:
+ Vnflcm:
+ type: tosca.interfaces.nfv.Vnflcm
diff --git a/tacker/samples/packages/vnf/Files/images/.gitkeep b/tacker/samples/packages/vnf/Files/images/.gitkeep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/tacker/samples/packages/vnf/Files/images/.gitkeep
diff --git a/tacker/samples/packages/vnf/TOSCA-Metadata/TOSCA.meta b/tacker/samples/packages/vnf/TOSCA-Metadata/TOSCA.meta
new file mode 100644
index 0000000..4c10d98
--- /dev/null
+++ b/tacker/samples/packages/vnf/TOSCA-Metadata/TOSCA.meta
@@ -0,0 +1,4 @@
+TOSCA-Meta-File-Version: 1.0
+Created-by: Dummy User
+CSAR-Version: 1.1
+Entry-Definitions: Definitions/sample_vnfd_top.yaml
diff --git a/tacker/samples/packages/vnf/UserData/__init__.py b/tacker/samples/packages/vnf/UserData/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/tacker/samples/packages/vnf/UserData/__init__.py
diff --git a/tacker/samples/packages/vnf/UserData/lcm_user_data.py b/tacker/samples/packages/vnf/UserData/lcm_user_data.py
new file mode 100644
index 0000000..3602309
--- /dev/null
+++ b/tacker/samples/packages/vnf/UserData/lcm_user_data.py
@@ -0,0 +1,39 @@
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+import tacker.vnfm.lcm_user_data.utils as UserDataUtil
+
+from tacker.vnfm.lcm_user_data.abstract_user_data import AbstractUserData
+
+
+class SampleUserData(AbstractUserData):
+
+ @staticmethod
+ def instantiate(base_hot_dict=None,
+ vnfd_dict=None,
+ inst_req_info=None,
+ grant_info=None):
+
+ # Create HOT input parameter using util functions.
+ initial_param_dict = UserDataUtil.create_initial_param_dict(
+ base_hot_dict)
+
+ vdu_flavor_dict = UserDataUtil.create_vdu_flavor_dict(vnfd_dict)
+ vdu_image_dict = UserDataUtil.create_sw_image_dict(vnfd_dict)
+ cpd_vl_dict = UserDataUtil.create_network_dict(
+ inst_req_info, initial_param_dict)
+
+ final_param_dict = UserDataUtil.create_final_param_dict(
+ initial_param_dict, vdu_flavor_dict, vdu_image_dict, cpd_vl_dict)
+
+ return final_param_dict
diff --git a/tacker/samples/packages/vnf/input_param.json b/tacker/samples/packages/vnf/input_param.json
new file mode 100644
index 0000000..a40826d
--- /dev/null
+++ b/tacker/samples/packages/vnf/input_param.json
@@ -0,0 +1,43 @@
+{
+ "flavourId": "simple",
+ "extVirtualLinks": [
+ {
+ "id": "test1",
+ "resourceId": "0e1cc46a-6808-4738-8b84-9e99a775c9eb",
+ "extCps": [
+ {
+ "cpdId": "CP1",
+ "cpConfig": [
+ {
+ "cpProtocolData": [
+ {
+ "layerProtocol": "IP_OVER_ETHERNET",
+ "ipOverEthernet": {
+ "ipAddresses": [
+ {
+ "type": "IPV4",
+ "numDynamicAddresses": 1,
+ "subnetId": "309614e6-4aab-4424-977f-fd9c8dfe493e"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ ],
+ "vimConnectionInfo": [
+ {
+ "id": "e24f9796-a8e9-4cb0-85ce-5920dcddafa1",
+ "vimId": "d8d886e4-fd98-4493-81e2-0e2b9991d629",
+ "vimType": "openstack"
+ }
+ ],
+ "additionalParams": {
+ "lcm-operation-user-data": "./UserData/lcm_user_data.py",
+ "lcm-operation-user-data-class": "SampleUserData"
+ }
+}