diff --git a/.zuul.yaml b/.zuul.yaml index 34359c3ce..16c95cc97 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -749,6 +749,23 @@ vars: config_enhanced_policy: true +- job: + name: tacker-functional-devstack-multinode-sol-terraform-v2 + parent: tacker-functional-devstack-multinode-legacy + description: | + Multinodes job for SOL Terraform devstack-based functional tests + attempts: 1 + host-vars: + controller-tacker: + tox_envlist: dsvm-functional-sol-terraform-v2 + devstack_local_conf: + post-config: + $TACKER_CONF: + v2_vnfm: + tf_file_dir: /tmp/tacker/terraform + vars: + terraform_setup: true + - job: name: tacker-compliance-devstack-multinode-sol parent: tacker-functional-devstack-multinode-legacy @@ -791,3 +808,4 @@ - tacker-functional-devstack-enhanced-policy-sol - tacker-functional-devstack-enhanced-policy-sol-kubernetes - tacker-compliance-devstack-multinode-sol + - tacker-functional-devstack-multinode-sol-terraform-v2 diff --git a/playbooks/devstack/pre.yaml b/playbooks/devstack/pre.yaml index 003f68f51..fb696faf6 100644 --- a/playbooks/devstack/pre.yaml +++ b/playbooks/devstack/pre.yaml @@ -7,6 +7,8 @@ - setup-k8s-oidc - setup-default-vim - setup-helm + - role: setup-terraform + when: terraform_setup is defined and terraform_setup | bool - role: setup-fake-prometheus-server when: prometheus_setup is defined and prometheus_setup | bool - role: setup-multi-tenant-vim diff --git a/releasenotes/notes/bobcat-terraform-driver-08d528b8447ef3be.yaml b/releasenotes/notes/bobcat-terraform-driver-08d528b8447ef3be.yaml new file mode 100644 index 000000000..c6a9aecc1 --- /dev/null +++ b/releasenotes/notes/bobcat-terraform-driver-08d528b8447ef3be.yaml @@ -0,0 +1,6 @@ +--- +features: + - | + Support Terraform infra-driver. Using Terraform as a backend tool enables + Tacker to create virtual resources on several platforms that Terraform + has already supported, such as AWS. diff --git a/roles/setup-terraform/files/aws_config b/roles/setup-terraform/files/aws_config new file mode 100644 index 000000000..5bd0ce5dc --- /dev/null +++ b/roles/setup-terraform/files/aws_config @@ -0,0 +1,2 @@ +[profile localstack_profile] +region = us-east-1 diff --git a/roles/setup-terraform/files/aws_credentials b/roles/setup-terraform/files/aws_credentials new file mode 100644 index 000000000..9478cc6b1 --- /dev/null +++ b/roles/setup-terraform/files/aws_credentials @@ -0,0 +1,3 @@ +[localstack_profile] +aws_access_key_id = mock_access_key +aws_secret_access_key = mock_secret_key diff --git a/roles/setup-terraform/tasks/main.yaml b/roles/setup-terraform/tasks/main.yaml new file mode 100644 index 000000000..2a6beaafe --- /dev/null +++ b/roles/setup-terraform/tasks/main.yaml @@ -0,0 +1,61 @@ +- block: + - name: Install docker from ubuntu official repository + package: + name: docker.io + state: present + become: yes + + - name: Make the user belong to a Docker group + user: + name: stack + groups: docker + append: yes + become: yes + + - name: Get gpg key of hashicorp + get_url: + url: https://apt.releases.hashicorp.com/gpg + dest: /usr/share/keyrings/hashicorp-archive-keyring.asc + mode: 0644 + force: true + become: yes + + - name: Add hashicorp repository + apt_repository: + repo: deb [signed-by=/usr/share/keyrings/hashicorp-archive-keyring.asc] https://apt.releases.hashicorp.com {{ ansible_distribution_release }} main + filename: hashicorp + state: present + become: yes + + - name: Install terraform + apt: + name: terraform + state: present + update_cache: yes + become: yes + + - name: Install awscli, LocalStack CLI + pip: + name: + - awscli>=1.29.0 + - localstack>=2.0.0 + state: present + become: yes + become_user: stack + + - name: Check terraform version + shell: terraform --version + register: terraform_version + become: yes + become_user: stack + + - name: Start LocalStack + shell: localstack start -d + register: localstack_start + environment: + PATH: "{{ ansible_env.PATH }}:/opt/stack/.local/bin" + become: yes + become_user: stack + + when: + - inventory_hostname == 'controller-tacker' diff --git a/tacker/sol_refactored/common/config.py b/tacker/sol_refactored/common/config.py index f8e15664c..90c1719ae 100644 --- a/tacker/sol_refactored/common/config.py +++ b/tacker/sol_refactored/common/config.py @@ -130,7 +130,11 @@ VNFM_OPTS = [ cfg.StrOpt('heat_ca_cert_file', default='', help=_('Specifies the root CA certificate to use when the ' - 'heat_verify_cert option is True.')) + 'heat_verify_cert option is True.')), + cfg.StrOpt('tf_file_dir', + default='/var/lib/tacker/terraform/', + help=_('Temporary directory for Terraform infra-driver to ' + 'store terraform config files')) ] CONF.register_opts(VNFM_OPTS, 'v2_vnfm') diff --git a/tacker/sol_refactored/common/exceptions.py b/tacker/sol_refactored/common/exceptions.py index 5cc1acdac..95b8b7dd6 100644 --- a/tacker/sol_refactored/common/exceptions.py +++ b/tacker/sol_refactored/common/exceptions.py @@ -384,6 +384,11 @@ class HelmOperationFailed(SolHttpError422): # detail set in the code +class TerraformOperationFailed(SolHttpError422): + title = 'Terraform operation failed' + # detail set in the code + + class HelmParameterNotFound(SolHttpError400): message = _("Helm parameter for scale vdu %(vdu_name)s is not found.") diff --git a/tacker/sol_refactored/conductor/vnflcm_driver_v2.py b/tacker/sol_refactored/conductor/vnflcm_driver_v2.py index 1fc065874..a6c46ec01 100644 --- a/tacker/sol_refactored/conductor/vnflcm_driver_v2.py +++ b/tacker/sol_refactored/conductor/vnflcm_driver_v2.py @@ -28,6 +28,7 @@ from tacker.sol_refactored.common import vnf_instance_utils as inst_utils from tacker.sol_refactored.infra_drivers.kubernetes import helm from tacker.sol_refactored.infra_drivers.kubernetes import kubernetes from tacker.sol_refactored.infra_drivers.openstack import openstack +from tacker.sol_refactored.infra_drivers.terraform import terraform from tacker.sol_refactored.nfvo import nfvo_client from tacker.sol_refactored import objects from tacker.sol_refactored.objects.v2 import fields as v2fields @@ -428,6 +429,9 @@ class VnfLcmDriverV2(object): elif vim_info.vimType == 'ETSINFV.HELM.V_3': driver = helm.Helm() driver.instantiate(req, inst, grant_req, grant, vnfd) + elif vim_info.vimType == 'TERRAFORM.V1': + driver = terraform.Terraform() + driver.instantiate(req, inst, grant_req, grant, vnfd) else: # should not occur raise sol_ex.SolException(sol_detail='not support vim type') @@ -447,6 +451,9 @@ class VnfLcmDriverV2(object): elif vim_info.vimType == 'ETSINFV.HELM.V_3': driver = helm.Helm() driver.instantiate_rollback(req, inst, grant_req, grant, vnfd) + elif vim_info.vimType == 'TERRAFORM.V1': + driver = terraform.Terraform() + driver.instantiate_rollback(req, inst, grant_req, grant, vnfd) else: # should not occur raise sol_ex.SolException(sol_detail='not support vim type') @@ -592,6 +599,9 @@ class VnfLcmDriverV2(object): elif vim_info.vimType == 'ETSINFV.HELM.V_3': driver = helm.Helm() driver.terminate(req, inst, grant_req, grant, vnfd) + elif vim_info.vimType == 'TERRAFORM.V1': + driver = terraform.Terraform() + driver.terminate(req, inst, grant_req, grant, vnfd) else: # should not occur raise sol_ex.SolException(sol_detail='not support vim type') diff --git a/tacker/sol_refactored/infra_drivers/terraform/terraform.py b/tacker/sol_refactored/infra_drivers/terraform/terraform.py new file mode 100644 index 000000000..b4b557413 --- /dev/null +++ b/tacker/sol_refactored/infra_drivers/terraform/terraform.py @@ -0,0 +1,289 @@ +# Copyright (C) 2023 Nippon Telegraph and Telephone Corporation +# All Rights Reserved. +# +# 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. + +from oslo_log import log as logging + +from tacker.common import exceptions +from tacker.objects import vnf_package_vnfd +from tacker.sol_refactored.common import config +from tacker.sol_refactored.common import exceptions as sol_ex +from tacker.sol_refactored.common import vnf_instance_utils as inst_utils +from tacker.sol_refactored import objects + + +import json +import os +import shutil +import subprocess +import tacker.conf + +LOG = logging.getLogger(__name__) + +CONF = config.CONF + + +class Terraform(): + '''Implements Terraform in Tacker''' + + def __init__(self): + pass + + def instantiate(self, req, inst, grant_req, grant, vnfd): + '''Implements instantiate using Terraform commands''' + + vim_conn_info = inst_utils.select_vim_info(inst.vimConnectionInfo) + tf_dir_path = req.additionalParams.get('tf_dir_path') + tf_var_path = req.additionalParams.get('tf_var_path') + working_dir = self._get_tf_vnfpkg( + inst.id, grant_req.vnfdId, tf_dir_path) + + self._generate_provider_tf(vim_conn_info, working_dir) + self._instantiate(vim_conn_info, working_dir, tf_var_path) + self._make_instantiated_vnf_info(req, inst, grant_req, + grant, vnfd, working_dir, + tf_var_path) + + def _instantiate(self, vim_conn_info, working_dir, tf_var_path): + '''Executes terraform init, terraform plan, and terraform apply''' + + access_info = vim_conn_info.get('accessInfo', {}) + + try: + init_cmd = self._gen_tf_cmd("init") + self._exec_cmd(init_cmd, cwd=working_dir) + LOG.info("Terraform init completed successfully.") + + plan_cmd = self._gen_tf_cmd('plan', access_info, tf_var_path) + self._exec_cmd(plan_cmd, cwd=working_dir) + LOG.info("Terraform plan completed successfully.") + + apply_cmd = self._gen_tf_cmd('apply', access_info, tf_var_path) + self._exec_cmd(apply_cmd, cwd=working_dir) + LOG.info("Terraform apply completed successfully.") + + except subprocess.CalledProcessError as error: + raise sol_ex.TerraformOperationFailed(sol_detail=str(error)) + + def terminate(self, req, inst, grant_req, grant, vnfd): + '''Terminates the terraform resources managed by the current project''' + + vim_conn_info = inst_utils.select_vim_info(inst.vimConnectionInfo) + working_dir = f"{CONF.v2_vnfm.tf_file_dir}/{inst.id}" + tf_var_path = inst.instantiatedVnfInfo.metadata['tf_var_path'] + self._terminate(vim_conn_info, working_dir, tf_var_path) + + def _terminate(self, vim_conn_info, working_dir, tf_var_path): + '''Executes Terraform Destroy and removes the working_dir''' + + access_info = vim_conn_info.get('accessInfo', {}) + + try: + # Execute the terraform destroy command (auto-approve) + destroy_cmd = self._gen_tf_cmd('destroy', access_info, tf_var_path) + self._exec_cmd(destroy_cmd, cwd=working_dir) + LOG.info("Terraform destroy completed successfully.") + + except subprocess.CalledProcessError as error: + failed_process = error.cmd[0].capitalize() + LOG.error(f"Error running {failed_process}: {error}") + # raise error and leave working_dir for retry + raise sol_ex.TerraformOperationFailed(sol_detail=str(error)) + + try: + # Remove the working directory and its contents + shutil.rmtree(working_dir) + LOG.info(f"Working directory {working_dir} destroyed successfully") + except OSError as error: + LOG.error(f"Error destroying working directory: {error}") + raise + + def instantiate_rollback(self, req, inst, grant_req, grant, vnfd): + '''Calls terminate''' + self.terminate(req, inst, grant_req, grant, vnfd) + + def _make_instantiated_vnf_info(self, req, inst, grant_req, + grant, vnfd, working_dir, tf_var_path): + '''Updates Tacker with information on the VNF state''' + + # Define inst_vnf_info + flavour_id = req.flavourId + inst.instantiatedVnfInfo = objects.VnfInstanceV2_InstantiatedVnfInfo( + flavourId=flavour_id, + vnfState='STARTED', + metadata={ + 'tf_var_path': tf_var_path + } + ) + + # Specify the path to the terraform.tfstate file + tfstate_file = f"{working_dir}/terraform.tfstate" + + # Read the contents of the file + with open(tfstate_file, "r", encoding="utf-8") as file: + tfstate_data = json.load(file) + + vdu_nodes = vnfd.get_vdu_nodes(flavour_id) + vdu_ids = {value.get('properties').get('name'): key + for key, value in vdu_nodes.items()} + + # Extract the required fields from the tfstate data + resources = tfstate_data["resources"] + + # Define vnfcResourceInfo and vnfcInfo in a single iteration + vnfc_resource_info_list = [ + objects.VnfcResourceInfoV2( + id=resource['name'], + vduId=vdu_ids.get(resource['name']), + computeResource=objects.ResourceHandle( + resourceId=resource['name'], + vimLevelResourceType=resource['type'] + ), + metadata={} + ) + for resource in resources + if (resource["type"] == "aws_instance" and + vdu_ids.get(resource['name'])) + ] + + vnfc_info_list = [ + objects.VnfcInfoV2( + id=f"{vnfc_res_info.vduId}-{vnfc_res_info.id}", + vduId=vnfc_res_info.vduId, + vnfcResourceInfoId=vnfc_res_info.id, + vnfcState='STARTED' + ) + for vnfc_res_info in vnfc_resource_info_list + ] + + inst.instantiatedVnfInfo.vnfcResourceInfo = vnfc_resource_info_list + inst.instantiatedVnfInfo.vnfcInfo = vnfc_info_list + + def _get_tf_vnfpkg(self, vnf_instance_id, vnfd_id, tf_dir_path): + """Create a VNF package with given IDs + + A path of created package is returned, or failed if vnfd_id is invalid. + """ + + # Define variables + context = tacker.context.get_admin_context() + try: + pkg_vnfd = vnf_package_vnfd.VnfPackageVnfd().get_by_id( + context, vnfd_id) + except exceptions.VnfPackageVnfdNotFound as exc: + raise sol_ex.VnfdIdNotFound(vnfd_id=vnfd_id) from exc + csar_path = os.path.join(CONF.vnf_package.vnf_package_csar_path, + pkg_vnfd.package_uuid) + + # Assemble paths and copy recursively + vnf_package_path = f"{csar_path}/{tf_dir_path}" + new_tf_dir_path = f"{CONF.v2_vnfm.tf_file_dir}/{vnf_instance_id}" + os.makedirs(new_tf_dir_path, exist_ok=True) + # NOTE: the creation of the directory /var/lib/tacker/terraform + # should be completed during the installation of Tacker. + shutil.copytree(vnf_package_path, new_tf_dir_path, dirs_exist_ok=True) + + return new_tf_dir_path + + def _generate_provider_tf(self, vim_conn_info, main_tf_path): + '''Creates provider.tf beside main.tf''' + + # Read vimConnectionInfo for information + access_info = vim_conn_info.get('accessInfo', {}) + interface_info = vim_conn_info.get('interfaceInfo', {}) + provider_type = interface_info.get('providerType') + provider_version = interface_info.get('providerVersion') + + # Create provider.tf content using the above information + content = { + "variable": {}, + "terraform": { + "required_version": ">=0.13", + "required_providers": { + provider_type: { + "source": f"hashicorp/{provider_type}", + "version": f"~> {provider_version}" + } + } + }, + "provider": { + provider_type: {} + } + } + + # Add accessInfo keys as variables and provider arguments + for key, value in access_info.items(): + if key == "endpoints": + content["provider"][provider_type][key] = value + continue + content["variable"][key] = { + "type": "string" + } + content["provider"][provider_type][key] = f"${{var.{key}}}" + + # Save the provider.tf file + provider_tf_path = os.path.join(main_tf_path, 'provider.tf.json') + with open(provider_tf_path, 'w', encoding='utf-8') as f: + json.dump(content, f, indent=4) + + return provider_tf_path + + def _exec_cmd(self, cmd, cwd, + stdout=subprocess.PIPE, stderr=subprocess.PIPE, + check=True, text=True): + """A helper for subprocess.run() + + Exec a command through subprocess.run() with common options among + commands used in this package. All the args other than self and cmd + the same as for subprocess.run(). + """ + res = subprocess.run(cmd, cwd=cwd, stdout=stdout, stderr=stderr, + check=check, text=text) + if res.returncode != 0: + raise + return res + + def _gen_tf_cmd(self, subcmd, access_info=None, tf_var_path=None, + auto_approve=True): + """Return terraform command of given subcommand as a list + + The result is intended to be an arg of supprocess.run(). + """ + + # NOTE(yasufum): Only following subcommands are supported. + allowed_subcmds = ["init", "plan", "apply", "destroy"] + if subcmd not in allowed_subcmds: + return [] + + if subcmd == "init": + return ["terraform", "init"] + + def _gen_tf_cmd_args(access_info, tf_var_path): + args = [] + for key, value in access_info.items(): + if key == "endpoints": + continue + args.extend(['-var', f'{key}={value}']) + if tf_var_path: + args.extend(['-var-file', tf_var_path]) + return args + + # list of subcommands accept "-auto-approve" option. + accept_ap = ["apply", "destroy"] + if auto_approve is True and subcmd in accept_ap: + cmd = ["terraform", subcmd, "-auto-approve"] + else: + cmd = ["terraform", subcmd] + args = _gen_tf_cmd_args(access_info, tf_var_path) + return cmd + args diff --git a/tacker/tests/functional/sol_terraform_v2/__init__.py b/tacker/tests/functional/sol_terraform_v2/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/tacker/tests/functional/sol_terraform_v2/base_v2.py b/tacker/tests/functional/sol_terraform_v2/base_v2.py new file mode 100644 index 000000000..17b081242 --- /dev/null +++ b/tacker/tests/functional/sol_terraform_v2/base_v2.py @@ -0,0 +1,119 @@ +# Copyright (C) 2023 Nippon Telegraph and Telephone Corporation +# All Rights Reserved. +# +# 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 os +import shutil +import tempfile +import time + +from oslo_config import cfg +from oslo_utils import uuidutils + +from tacker.sol_refactored.common import http_client +from tacker.sol_refactored import objects +from tacker.tests.functional import base_v2 +from tacker.tests.functional.common.fake_server import FakeServerManager +from tacker.tests.functional.sol_v2_common import utils +from tacker import version + +FAKE_SERVER_MANAGER = FakeServerManager() + +VNF_PACKAGE_UPLOAD_TIMEOUT = 300 + + +class BaseVnfLcmTerraformV2Test(base_v2.BaseTackerTestV2): + + @classmethod + def setUpClass(cls): + super(BaseVnfLcmTerraformV2Test, cls).setUpClass() + """Base test case class for SOL v2 terraform functional tests.""" + + cfg.CONF(args=['--config-file', '/etc/tacker/tacker.conf'], + project='tacker', + version='%%prog %s' % version.version_info.release_string()) + objects.register_all() + + vim_info = cls.get_vim_info() + auth = http_client.KeystonePasswordAuthHandle( + auth_url=vim_info.interfaceInfo['endpoint'], + username=vim_info.accessInfo['username'], + password=vim_info.accessInfo['password'], + project_name=vim_info.accessInfo['project'], + user_domain_name=vim_info.accessInfo['userDomain'], + project_domain_name=vim_info.accessInfo['projectDomain'] + ) + cls.tacker_client = http_client.HttpClient(auth) + + def assert_notification_get(self, callback_url): + notify_mock_responses = FAKE_SERVER_MANAGER.get_history( + callback_url) + FAKE_SERVER_MANAGER.clear_history( + callback_url) + self.assertEqual(1, len(notify_mock_responses)) + self.assertEqual(204, notify_mock_responses[0].status_code) + + def _check_notification(self, callback_url, notify_type): + notify_mock_responses = FAKE_SERVER_MANAGER.get_history( + callback_url) + FAKE_SERVER_MANAGER.clear_history( + callback_url) + self.assertEqual(1, len(notify_mock_responses)) + self.assertEqual(204, notify_mock_responses[0].status_code) + self.assertEqual(notify_type, notify_mock_responses[0].request_body[ + 'notificationType']) + + @classmethod + def create_vnf_package(cls, sample_path, user_data=None, image_path=None): + vnfd_id = uuidutils.generate_uuid() + tmp_dir = tempfile.mkdtemp() + + utils.make_zip(sample_path, tmp_dir, vnfd_id, image_path) + + zip_file_name = os.path.basename(os.path.abspath(sample_path)) + ".zip" + zip_file_path = os.path.join(tmp_dir, zip_file_name) + + path = "/vnfpkgm/v1/vnf_packages" + if user_data is not None: + req_body = {'userDefinedData': user_data} + else: + req_body = {} + resp, body = cls.tacker_client.do_request( + path, "POST", expected_status=[201], body=req_body) + + pkg_id = body['id'] + + with open(zip_file_path, 'rb') as fp: + path = f"/vnfpkgm/v1/vnf_packages/{pkg_id}/package_content" + resp, body = cls.tacker_client.do_request( + path, "PUT", body=fp, content_type='application/zip', + expected_status=[202]) + + # wait for onboard + timeout = VNF_PACKAGE_UPLOAD_TIMEOUT + start_time = int(time.time()) + path = f"/vnfpkgm/v1/vnf_packages/{pkg_id}" + while True: + resp, body = cls.tacker_client.do_request( + path, "GET", expected_status=[200]) + if body['onboardingState'] == "ONBOARDED": + break + + if (int(time.time()) - start_time) > timeout: + raise Exception("Failed to onboard vnf package") + + time.sleep(5) + + shutil.rmtree(tmp_dir) + + return pkg_id, vnfd_id diff --git a/tacker/tests/functional/sol_terraform_v2/paramgen.py b/tacker/tests/functional/sol_terraform_v2/paramgen.py new file mode 100644 index 000000000..a5bc02882 --- /dev/null +++ b/tacker/tests/functional/sol_terraform_v2/paramgen.py @@ -0,0 +1,79 @@ +# Copyright (C) 2023 Nippon Telegraph and Telephone Corporation +# All Rights Reserved. +# +# 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. + +from oslo_utils import uuidutils + + +def create_req_by_vnfd_id(vnfd_id): + return { + "vnfdId": vnfd_id, + "vnfInstanceName": "test_terraform_instantiate", + "vnfInstanceDescription": "test_terraform_instantiate", + "metadata": {"dummy-key": "dummy-val"} + } + + +def instantiate_req(): + # All attributes are set. + # NOTE: All of the following cardinality attributes are set. + # In addition, 0..N or 1..N attributes are set to 2 or more. + # - 0..1 (1) + # - 0..N (2 or more) + # - 1 + # - 1..N (2 or more) + auth_url = "http://localhost:4566" + + vim = { + "vimId": uuidutils.generate_uuid(), + "vimType": "TERRAFORM.V1", + "interfaceInfo": { + "providerType": "aws", + "providerVersion": "4.0" + }, + "accessInfo": { + "region": "ap-northeast-1", + "access_key": "mock_access_key", + "secret_key": "mock_secret_key", + "skip_credentials_validation": "true", + "skip_metadata_api_check": "true", + "skip_requesting_account_id": "true", + "endpoints": { + "ec2": auth_url + } + } + } + + return { + "flavourId": "simple", + "vimConnectionInfo": { + "vim1": vim + }, + "additionalParams": {"tf_dir_path": "Files/terraform"} + } + + +def terminate_req(): + # All attributes are set. + # NOTE: All of the following cardinality attributes are set. + # In addition, 0..N or 1..N attributes are set to 2 or more. + # - 0..1 (1) + # - 0..N (2 or more) + # - 1 + # - 1..N (2 or more) + return { + "terminationType": "GRACEFUL", + "gracefulTerminationTimeout": 5, + "additionalParams": {"dummy-key": "dummy-val"} + } diff --git a/tacker/tests/functional/sol_terraform_v2/samples/common/Definitions/etsi_nfv_sol001_common_types.yaml b/tacker/tests/functional/sol_terraform_v2/samples/common/Definitions/etsi_nfv_sol001_common_types.yaml new file mode 100644 index 000000000..20f8a99ce --- /dev/null +++ b/tacker/tests/functional/sol_terraform_v2/samples/common/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/tests/functional/sol_terraform_v2/samples/common/Definitions/etsi_nfv_sol001_vnfd_types.yaml b/tacker/tests/functional/sol_terraform_v2/samples/common/Definitions/etsi_nfv_sol001_vnfd_types.yaml new file mode 100644 index 000000000..0d51d36be --- /dev/null +++ b/tacker/tests/functional/sol_terraform_v2/samples/common/Definitions/etsi_nfv_sol001_vnfd_types.yaml @@ -0,0 +1,1463 @@ +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 particular 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 Resource 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/tests/functional/sol_terraform_v2/samples/test_terraform_basic/contents/Definitions/sample_tf_df_simple.yaml b/tacker/tests/functional/sol_terraform_v2/samples/test_terraform_basic/contents/Definitions/sample_tf_df_simple.yaml new file mode 100644 index 000000000..b269b697c --- /dev/null +++ b/tacker/tests/functional/sol_terraform_v2/samples/test_terraform_basic/contents/Definitions/sample_tf_df_simple.yaml @@ -0,0 +1,177 @@ +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_tf_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: simple + requirements: + virtual_link_external: [] + + node_templates: + VNF: + type: company.provider.VNF + properties: + flavour_description: A simple flavour + interfaces: + Vnflcm: + instantiate_start: + implementation: sample-script + instantiate_end: + implementation: sample-script + terminate_start: + implementation: sample-script + terminate_end: + implementation: sample-script + scale_start: + implementation: sample-script + scale_end: + implementation: sample-script + heal_start: + implementation: sample-script + heal_end: + implementation: sample-script + modify_information_start: + implementation: sample-script + modify_information_end: + implementation: sample-script + artifacts: + sample-script: + description: Sample script + type: tosca.artifacts.Implementation.Python + file: ../Scripts/sample_script.py + + 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: 3 + + VDU2: + type: tosca.nodes.nfv.Vdu.Compute + properties: + name: vdu2 + description: VDU2 compute node + 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 + vdu2_aspect: + name: vdu2_aspect + description: vdu2 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 ] + + - VDU2_initial_delta: + type: tosca.policies.nfv.VduInitialDelta + properties: + initial_delta: + number_of_instances: 1 + targets: [ VDU2 ] + + - VDU2_scaling_aspect_deltas: + type: tosca.policies.nfv.VduScalingAspectDeltas + properties: + aspect: vdu2_aspect + deltas: + delta_1: + number_of_instances: 1 + targets: [ VDU2 ] + + - instantiation_levels: + type: tosca.policies.nfv.InstantiationLevels + properties: + levels: + instantiation_level_1: + description: Smallest size + scale_info: + vdu1_aspect: + scale_level: 0 + vdu2_aspect: + scale_level: 0 + instantiation_level_2: + description: Largest size + scale_info: + vdu1_aspect: + scale_level: 2 + vdu2_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 ] + + - VDU2_instantiation_levels: + type: tosca.policies.nfv.VduInstantiationLevels + properties: + levels: + instantiation_level_1: + number_of_instances: 1 + instantiation_level_2: + number_of_instances: 3 + targets: [ VDU2 ] diff --git a/tacker/tests/functional/sol_terraform_v2/samples/test_terraform_basic/contents/Definitions/sample_tf_top.vnfd.yaml b/tacker/tests/functional/sol_terraform_v2/samples/test_terraform_basic/contents/Definitions/sample_tf_top.vnfd.yaml new file mode 100644 index 000000000..40bf30e0c --- /dev/null +++ b/tacker/tests/functional/sol_terraform_v2/samples/test_terraform_basic/contents/Definitions/sample_tf_top.vnfd.yaml @@ -0,0 +1,31 @@ +tosca_definitions_version: tosca_simple_yaml_1_2 + +description: Sample Terraform VNF + +imports: + - etsi_nfv_sol001_common_types.yaml + - etsi_nfv_sol001_vnfd_types.yaml + - sample_tf_types.yaml + - sample_tf_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-4840d7000000 + provider: Company + product_name: Sample Terraform 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/tests/functional/sol_terraform_v2/samples/test_terraform_basic/contents/Definitions/sample_tf_types.yaml b/tacker/tests/functional/sol_terraform_v2/samples/test_terraform_basic/contents/Definitions/sample_tf_types.yaml new file mode 100644 index 000000000..7b0cd97fc --- /dev/null +++ b/tacker/tests/functional/sol_terraform_v2/samples/test_terraform_basic/contents/Definitions/sample_tf_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: [ b1bb0ce7-ebca-4fa7-95ed-4840d7000000 ] ] + default: b1bb0ce7-ebca-4fa7-95ed-4840d7000000 + 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 Terraform VNF' ] ] + default: 'Sample Terraform 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,complex ] ] + default: simple + 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/tests/functional/sol_terraform_v2/samples/test_terraform_basic/contents/Files/terraform/main.tf b/tacker/tests/functional/sol_terraform_v2/samples/test_terraform_basic/contents/Files/terraform/main.tf new file mode 100644 index 000000000..e046b2dc5 --- /dev/null +++ b/tacker/tests/functional/sol_terraform_v2/samples/test_terraform_basic/contents/Files/terraform/main.tf @@ -0,0 +1,8 @@ +resource "aws_instance" "vdu1"{ + ami = "ami-785db401" + instance_type = "t2.micro" + + tags = { + Name = "hoge01" + } +} diff --git a/tacker/tests/functional/sol_terraform_v2/samples/test_terraform_basic/contents/Scripts/sample_script.py b/tacker/tests/functional/sol_terraform_v2/samples/test_terraform_basic/contents/Scripts/sample_script.py new file mode 100644 index 000000000..03c68716a --- /dev/null +++ b/tacker/tests/functional/sol_terraform_v2/samples/test_terraform_basic/contents/Scripts/sample_script.py @@ -0,0 +1,67 @@ +# Copyright (C) 2023 Nippon Telegraph and Telephone Corporation +# All Rights Reserved. +# +# 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 os +import pickle +import sys + + +class SampleScript(object): + + def __init__(self, req, inst, grant_req, grant, csar_dir): + self.req = req + self.inst = inst + self.grant_req = grant_req + self.grant = grant + self.csar_dir = csar_dir + + def instantiate_start(self): + pass + + def instantiate_end(self): + pass + + def terminate_start(self): + pass + + def terminate_end(self): + pass + + +def main(): + script_dict = pickle.load(sys.stdin.buffer) + + operation = script_dict['operation'] + req = script_dict['request'] + inst = script_dict['vnf_instance'] + grant_req = script_dict['grant_request'] + grant = script_dict['grant_response'] + csar_dir = script_dict['tmp_csar_dir'] + + script = SampleScript(req, inst, grant_req, grant, csar_dir) + try: + getattr(script, operation)() + except AttributeError: + raise Exception("{} is not included in the script.".format(operation)) + + +if __name__ == "__main__": + try: + main() + os._exit(0) + except Exception as ex: + sys.stderr.write(str(ex)) + sys.stderr.flush() + os._exit(1) diff --git a/tacker/tests/functional/sol_terraform_v2/samples/test_terraform_basic/contents/TOSCA-Metadata/TOSCA.meta b/tacker/tests/functional/sol_terraform_v2/samples/test_terraform_basic/contents/TOSCA-Metadata/TOSCA.meta new file mode 100644 index 000000000..0787473d2 --- /dev/null +++ b/tacker/tests/functional/sol_terraform_v2/samples/test_terraform_basic/contents/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_tf_top.vnfd.yaml + +Name: Files/terraform/main.tf +Content-Type: test-data +Algorithm: SHA-256 +Hash: 8b781c33326f6383316f24464371de38724898215bc04653e1985e3c9514c87d diff --git a/tacker/tests/functional/sol_terraform_v2/samples/test_terraform_basic/pkggen.py b/tacker/tests/functional/sol_terraform_v2/samples/test_terraform_basic/pkggen.py new file mode 100644 index 000000000..cca236de6 --- /dev/null +++ b/tacker/tests/functional/sol_terraform_v2/samples/test_terraform_basic/pkggen.py @@ -0,0 +1,48 @@ +# Copyright (C) 2023 Nippon Telegraph and Telephone Corporation +# All Rights Reserved. +# +# 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 json +import os +import shutil +import tempfile + +from oslo_utils import uuidutils + +from tacker.tests.functional.sol_terraform_v2 import paramgen as tf_paramgen +from tacker.tests.functional.sol_v2_common import utils + + +zip_file_name = os.path.basename(os.path.abspath(".")) + '.zip' +tmp_dir = tempfile.mkdtemp() +vnfd_id = uuidutils.generate_uuid() + +# tacker/tests/functional/sol_terraform_v2/samples/{package_name} +utils.make_zip(".", tmp_dir, vnfd_id) + +shutil.move(os.path.join(tmp_dir, zip_file_name), ".") +shutil.rmtree(tmp_dir) + +create_req = tf_paramgen.create_req_by_vnfd_id(vnfd_id) +instantiate_req = tf_paramgen.instantiate_req() +terminate_req = tf_paramgen.terminate_req() + +with open("create_req", "w", encoding='utf-8') as f: + f.write(json.dumps(create_req, indent=2)) + +with open("instantiate_req", "w", encoding='utf-8') as f: + f.write(json.dumps(instantiate_req, indent=2)) + +with open("terminate_req", "w", encoding='utf-8') as f: + f.write(json.dumps(terminate_req, indent=2)) diff --git a/tacker/tests/functional/sol_terraform_v2/test_terraform.py b/tacker/tests/functional/sol_terraform_v2/test_terraform.py new file mode 100644 index 000000000..a50894b5d --- /dev/null +++ b/tacker/tests/functional/sol_terraform_v2/test_terraform.py @@ -0,0 +1,153 @@ +# Copyright (C) 2023 Nippon Telegraph and Telephone Corporation +# All Rights Reserved. +# +# 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 os + +import tacker.conf + +from tacker.objects import fields +from tacker.tests.functional.sol_terraform_v2 import base_v2 +from tacker.tests.functional.sol_terraform_v2 import paramgen as tf_paramgen + +CONF = tacker.conf.CONF + + +class VnfLcmTerraformTest(base_v2.BaseVnfLcmTerraformV2Test): + + @classmethod + def setUpClass(cls): + super(VnfLcmTerraformTest, cls).setUpClass() + + cur_dir = os.path.dirname(__file__) + sample_pkg = "samples/test_terraform_basic" + pkg_dir_path = os.path.join(cur_dir, sample_pkg) + cls.basic_pkg, cls.basic_vnfd_id = cls.create_vnf_package(pkg_dir_path) + + @classmethod + def tearDownClass(cls): + super(VnfLcmTerraformTest, cls).tearDownClass() + + cls.delete_vnf_package(cls.basic_pkg) + + def setUp(self): + super(VnfLcmTerraformTest, self).setUp() + + def instantiate_vnf_instance(self, inst_id, req_body): + path = "/vnflcm/v2/vnf_instances/{}/instantiate".format(inst_id) + return self.tacker_client.do_request( + path, "POST", body=req_body, version="2.0.0") + + def terminate_vnf_instance(self, inst_id, req_body): + path = "/vnflcm/v2/vnf_instances/{}/terminate".format(inst_id) + return self.tacker_client.do_request( + path, "POST", body=req_body, version="2.0.0") + + def test_basic_lcms(self): + self._get_basic_lcms_procedure() + + def _get_basic_lcms_procedure(self, use_register_vim=False): + """Test basic LCM operations + + * About LCM operations: + This test includes the following operations. + - 1. Create VNF instance + - 2. Instantiate VNF + - 3. Show VNF instance + - 4. Terminate VNF + - 5. Delete a VNF instance + """ + + # 1. Create a new VNF instance resource + # NOTE: extensions and vnfConfigurableProperties are omitted + # because they are commented out in etsi_nfv_sol001. + expected_inst_attrs = [ + 'id', + 'vnfInstanceName', + 'vnfInstanceDescription', + 'vnfdId', + 'vnfProvider', + 'vnfProductName', + 'vnfSoftwareVersion', + 'vnfdVersion', + # 'vnfConfigurableProperties', # omitted + # 'vimConnectionInfo', # omitted + 'instantiationState', + # 'instantiatedVnfInfo', # omitted + 'metadata', + # 'extensions', # omitted + '_links' + ] + create_req = tf_paramgen.create_req_by_vnfd_id(self.basic_vnfd_id) + resp, body = self.create_vnf_instance(create_req) + self.assertEqual(201, resp.status_code) + self.check_resp_headers_in_create(resp) + self.check_resp_body(body, expected_inst_attrs) + inst_id = body['id'] + self.check_package_usage(self.basic_pkg, state='IN_USE') + + # 2. Instantiate VNF + instantiate_req = tf_paramgen.instantiate_req() + resp, body = self.instantiate_vnf_instance(inst_id, instantiate_req) + self.assertEqual(202, resp.status_code) + self.check_resp_headers_in_operation_task(resp) + + lcmocc_id = os.path.basename(resp.headers['Location']) + self.wait_lcmocc_complete(lcmocc_id) + + # 3. Show VNF instance + additional_inst_attrs = [ + 'vimConnectionInfo', + 'instantiatedVnfInfo' + ] + expected_inst_attrs.extend(additional_inst_attrs) + resp, body = self.show_vnf_instance(inst_id) + self.assertEqual(200, resp.status_code) + self.check_resp_headers_in_get(resp) + self.check_resp_body(body, expected_inst_attrs) + + # check instantiationState of VNF + self.assertEqual(fields.VnfInstanceState.INSTANTIATED, + body['instantiationState']) + + # check vnfState of VNF + self.assertEqual(fields.VnfOperationalStateType.STARTED, + body['instantiatedVnfInfo']['vnfState']) + + # 4. Terminate VNF instance + terminate_req = tf_paramgen.terminate_req() + resp, body = self.terminate_vnf_instance(inst_id, terminate_req) + self.assertEqual(202, resp.status_code) + self.check_resp_headers_in_operation_task(resp) + + lcmocc_id = os.path.basename(resp.headers['Location']) + self.wait_lcmocc_complete(lcmocc_id) + + # check instantiationState of VNF + resp, body = self.show_vnf_instance(inst_id) + self.assertEqual(200, resp.status_code) + self.assertEqual(fields.VnfInstanceState.NOT_INSTANTIATED, + body['instantiationState']) + + # 5. Delete a VNF instance + resp, body = self.delete_vnf_instance(inst_id) + self.assertEqual(204, resp.status_code) + self.check_resp_headers_in_delete(resp) + + # check deletion of VNF instance + resp, body = self.show_vnf_instance(inst_id) + self.assertEqual(404, resp.status_code) + self.check_package_usage(self.basic_pkg, state='NOT_IN_USE') + + # TODO(yasufum) consider to add a test for instantiate_rollback here. diff --git a/tacker/tests/unit/sol_refactored/infra_drivers/terraform/__init__.py b/tacker/tests/unit/sol_refactored/infra_drivers/terraform/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/tacker/tests/unit/sol_refactored/infra_drivers/terraform/test_terraform.py b/tacker/tests/unit/sol_refactored/infra_drivers/terraform/test_terraform.py new file mode 100644 index 000000000..035cd2328 --- /dev/null +++ b/tacker/tests/unit/sol_refactored/infra_drivers/terraform/test_terraform.py @@ -0,0 +1,236 @@ +# Copyright (C) 2023 Nippon Telegraph and Telephone Corporation +# All Rights Reserved. +# +# 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 json +import os +import tempfile + +from oslo_utils import uuidutils +from unittest import mock + +from tacker import context +from tacker.sol_refactored.common import vnfd_utils +from tacker.sol_refactored.infra_drivers.terraform import terraform +from tacker.sol_refactored import objects +from tacker.sol_refactored.objects.v2 import fields +from tacker.tests import base + +SAMPLE_VNFD_ID = "65b62a2a-c207-423f-9b01-f399c9ab5629" +SAMPLE_FLAVOUR_ID = "simple" + +_vim_connection_info_example = { + "vimId": "terraform_provider_aws_v4_tokyo", + "vimType": "ETSINFV.TERRAFORM.V_1", + "interfaceInfo": { + "providerType": "aws", + "providerVersion": "4.0" + }, + "accessInfo": { + "region": "ap-northeast-1", + "access_key": "example_access_key", + "secret_key": "example_secret_key" + } +} + +_instantiate_req_example = { + # instantiateVnfRequest example + "flavourId": SAMPLE_FLAVOUR_ID, + "vimConnectionInfo": { + "vim1": _vim_connection_info_example + }, + "additionalParams": { + "tf_dir_path": "Files/terraform", + "tf_var_path": "Files/terraform/variables.tf" + } +} + + +class TestTerraform(base.BaseTestCase): + def setUp(self): + super(TestTerraform, self).setUp() + objects.register_all() + self.driver = terraform.Terraform() + self.context = context.get_admin_context() + + cur_dir = os.path.dirname(__file__) + sample_dir = os.path.join(cur_dir, "../..", "samples") + + self.vnfd_2 = vnfd_utils.Vnfd(SAMPLE_VNFD_ID) + self.vnfd_2.init_from_csar_dir(os.path.join(sample_dir, "sample2")) + + @mock.patch.object(terraform.Terraform, '_get_tf_vnfpkg') + @mock.patch.object(terraform.Terraform, '_generate_provider_tf') + @mock.patch.object(terraform.Terraform, '_make_instantiated_vnf_info') + @mock.patch.object(terraform.Terraform, '_instantiate') + def test_instantiate(self, mock_instantiate, + mock_make_instantiated_vnf_info, + mock_generate_provider_tf, + mock_tf_files): + '''Verifies instantiate is called once''' + + req = objects.InstantiateVnfRequest.from_dict(_instantiate_req_example) + + inst = objects.VnfInstanceV2( + # Required fields + id=uuidutils.generate_uuid(), + vnfdId=SAMPLE_VNFD_ID, + vnfProvider='provider', + vnfProductName='product name', + vnfSoftwareVersion='software version', + vnfdVersion='vnfd version', + instantiationState='INSTANTIATED', + vimConnectionInfo=req['vimConnectionInfo'] + ) + + grant_req = objects.GrantRequestV1( + operation=fields.LcmOperationType.INSTANTIATE, + vnfdId=SAMPLE_VNFD_ID + ) + + grant = objects.GrantV1() + + # Set the desired return value for _get_tf_vnfpkg + mock_tf_files.return_value = f"/var/lib/tacker/terraform/{inst.id}" + + # Execute + self.driver.instantiate(req, inst, grant_req, grant, self.vnfd_2) + + # TODO(yasufum) Test _instantiate mock subprocess + # Verify _instantiate is called once + mock_instantiate.assert_called_once_with( + req.vimConnectionInfo['vim1'], + f"/var/lib/tacker/terraform/{inst.id}", + req.additionalParams.get('tf_var_path')) + + def test_make_instantiated_vnf_info(self): + '''Verifies instantiated vnf info is correct''' + + req = objects.InstantiateVnfRequest.from_dict(_instantiate_req_example) + + inst = objects.VnfInstanceV2( + # Required fields + id=uuidutils.generate_uuid(), + vnfdId=SAMPLE_VNFD_ID, + vnfProvider='provider', + vnfProductName='product name', + vnfSoftwareVersion='software version', + vnfdVersion='vnfd version', + instantiationState='INSTANTIATED', + vimConnectionInfo=req['vimConnectionInfo'] + ) + + grant_req = objects.GrantRequestV1( + operation='INSTANTIATE' + ) + + grant = objects.GrantV1() + + # Expected results + _expected_inst_info = { + "flavourId": "simple", + "vnfState": "STARTED", + "vnfcResourceInfo": [ + { + "id": "vdu1", + "vduId": "VDU1", + "computeResource": { + "resourceId": "vdu1", + "vimLevelResourceType": "aws_instance" + }, + "metadata": {} + }, + { + "id": "vdu2", + "vduId": "VDU2", + "computeResource": { + "resourceId": "vdu2", + "vimLevelResourceType": "aws_instance" + }, + "metadata": {} + } + ], + "vnfcInfo": [ + { + "id": "VDU1-vdu1", + "vduId": "VDU1", + "vnfcResourceInfoId": "vdu1", + "vnfcState": "STARTED" + }, + { + "id": "VDU2-vdu2", + "vduId": "VDU2", + "vnfcResourceInfoId": "vdu2", + "vnfcState": "STARTED" + } + ] + } + + # Create a temporary directory + with tempfile.TemporaryDirectory() as temp_dir: + # Create the tfstate content + provider = "provider[\"registry.terraform.io/hashicorp/aws\"]" + tfstate_content = { + "version": 4, + "terraform_version": "1.4.4", + "serial": 4, + "lineage": "5745b992-04a2-5811-2e02-19d64f6f4b44", + "outputs": {}, + "resources": [ + { + "mode": "managed", + "type": "aws_instance", + "name": "vdu1", + "provider": provider + }, + { + "mode": "managed", + "type": "aws_instance", + "name": "vdu2", + "provider": provider + }, + { + "mode": "managed", + "type": "aws_subnet", + "name": "hoge-subnet01", + "provider": provider + } + ] + } + + # Write the tfstate content to a temporary file + tfstate_file_path = f"{temp_dir}/terraform.tfstate" + with open(tfstate_file_path, "w") as tfstate_file: + json.dump(tfstate_content, tfstate_file) + + # Execute the test with the temporary tfstate_file + self.driver._make_instantiated_vnf_info(req, inst, + grant_req, grant, + self.vnfd_2, temp_dir, + req.additionalParams.get( + 'tf_var_path') + ) + + # check + result = inst.to_dict()["instantiatedVnfInfo"] + expected = _expected_inst_info + + # vnfcResourceInfo is sorted by creation_time (reverse) + self.assertIn("vnfcResourceInfo", result) + self.assertEqual(expected["vnfcResourceInfo"], + result["vnfcResourceInfo"]) + + # order of vnfcInfo is same as vnfcResourceInfo + self.assertIn("vnfcInfo", result) + self.assertEqual(expected["vnfcInfo"], result["vnfcInfo"]) diff --git a/tox.ini b/tox.ini index bdcc39dc5..c268709c4 100644 --- a/tox.ini +++ b/tox.ini @@ -145,6 +145,12 @@ commands_post = allowlist_externals = sudo +[testenv:dsvm-functional-sol-terraform-v2] +setenv = {[testenv]setenv} + +commands = + stestr --test-path=./tacker/tests/functional/sol_terraform_v2 run --slowest --concurrency 1 {posargs} + [testenv:dsvm-compliance-sol-api] passenv = {[testenv]passenv}