diff --git a/releasenotes/notes/support-cir-k8s-cluster-d2596de8fed78f6c.yaml b/releasenotes/notes/support-cir-k8s-cluster-d2596de8fed78f6c.yaml new file mode 100644 index 000000000..c48bccea8 --- /dev/null +++ b/releasenotes/notes/support-cir-k8s-cluster-d2596de8fed78f6c.yaml @@ -0,0 +1,27 @@ +--- +features: + - | + Functions to enable the use of Docker private registry images in a + Kubernetes Cluster environment. We provide the sample of MgmtDriver + which can deploy Docker private registry VNF for Kubernetes cluster + before deploying Kubernetes cluster VNF, and deploy Kubernetes cluster + VNF that can support both the Docker private registry created above + and any others created outside of Tacker. + + Instantiate operation for Kubernetes cluster with MgmtDriver: + MgmtDriver configures connections with Docker private registries on + newly created all Master/Worker VMs. + + Scale-out operation for Kubernetes cluster Worker-nodes with MgmtDriver: + MgmtDriver configures connections with Docker private registries on + newly created Worker VMs. + + Heal operation for the entire Kubernetes cluster with MgmtDriver: + MgmtDriver configures connections with Docker private registries on + the created all Master/Worker VMs. + + Heal operation for a single node in Kubernetes cluster with MgmtDriver: + MgmtDriver configures connections with Docker private registries on + the created Master/Worker VM. + + diff --git a/samples/mgmt_driver/install_k8s_cluster.sh b/samples/mgmt_driver/install_k8s_cluster.sh index 82c0e3ef1..49c8a605f 100644 --- a/samples/mgmt_driver/install_k8s_cluster.sh +++ b/samples/mgmt_driver/install_k8s_cluster.sh @@ -355,11 +355,20 @@ function set_docker_proxy { [Service] Environment="HTTP_PROXY=${http_proxy//%40/@}" "HTTPS_PROXY=${https_proxy//%40/@}" "NO_PROXY=$no_proxy" EOF - cat </dev/null + if [[ -z "$HTTP_PRIVATE_REGISTRIES" ]]; then + cat </dev/null { "exec-opts": ["native.cgroupdriver=systemd"] } EOF + else + cat </dev/null +{ + "exec-opts": ["native.cgroupdriver=systemd"], + "insecure-registries": [${HTTP_PRIVATE_REGISTRIES}] +} +EOF + fi sudo systemctl daemon-reload sudo systemctl restart docker sleep 3 @@ -779,4 +788,8 @@ else exit 255 fi fi + +sudo ln -s /root/.docker/config.json /var/lib/kubelet/config.json +sudo chmod 666 /var/lib/kubelet/config.json + exit 0 diff --git a/samples/mgmt_driver/kubernetes_mgmt.py b/samples/mgmt_driver/kubernetes_mgmt.py index df066ff41..f4012d47e 100644 --- a/samples/mgmt_driver/kubernetes_mgmt.py +++ b/samples/mgmt_driver/kubernetes_mgmt.py @@ -43,6 +43,10 @@ HELM_CHART_DIR = "/var/tacker/helm" HELM_CHART_CMP_PATH = "/tmp/tacker-helm.tgz" SERVER_WAIT_COMPLETE_TIME = 60 +# CLI timeout period when setting private registries connection +PR_CONNECT_TIMEOUT = 30 +PR_CMD_TIMEOUT = 300 + class KubernetesMgmtDriver(vnflcm_abstract_driver.VnflcmMgmtAbstractDriver): @@ -114,6 +118,10 @@ class KubernetesMgmtDriver(vnflcm_abstract_driver.VnflcmMgmtAbstractDriver): err = result.get_stderr() LOG.error(err) raise exceptions.MgmtDriverRemoteCommandError(err_info=err) + elif type == 'docker_login': + ret1 = result.get_stdout() + ret2 = result.get_stderr() + return ret1, ret2 elif type == 'helm_repo_list': if result.get_return_code() != 0: err = result.get_stderr()[0].replace('\n', '') @@ -458,7 +466,7 @@ class KubernetesMgmtDriver(vnflcm_abstract_driver.VnflcmMgmtAbstractDriver): def _install_worker_node(self, commander, proxy, ha_flag, nic_ip, cluster_ip, kubeadm_token, - ssl_ca_cert_hash): + ssl_ca_cert_hash, http_private_registries): if proxy.get('http_proxy') and proxy.get('https_proxy'): ssh_command = \ "export http_proxy={http_proxy};" \ @@ -485,6 +493,13 @@ class KubernetesMgmtDriver(vnflcm_abstract_driver.VnflcmMgmtAbstractDriver): worker_ip=nic_ip, cluster_ip=cluster_ip, kubeadm_token=kubeadm_token, ssl_ca_cert_hash=ssl_ca_cert_hash) + + # if connecting to the private registries over HTTP, + # add "export HTTP_PRIVATE_REGISTRIES" command + if http_private_registries: + ssh_command = "export HTTP_PRIVATE_REGISTRIES=\"{}\";{}".format( + http_private_registries, ssh_command) + self._execute_command( commander, ssh_command, K8S_INSTALL_TIMEOUT, 'install', 0) @@ -537,10 +552,132 @@ class KubernetesMgmtDriver(vnflcm_abstract_driver.VnflcmMgmtAbstractDriver): commander, ssh_command, K8S_CMD_TIMEOUT, 'common', 0) commander.close_session() + def _get_http_private_registries(self, pr_connection_info): + http_private_registries = "" + if pr_connection_info: + http_pr_list = [] + for pr_info in pr_connection_info: + pr_connection_type = str(pr_info.get('connection_type')) + pr_server = pr_info.get('server') + # NOTE: "connection_type" values are "0" for HTTP and + # "1" for HTTPS. + if pr_connection_type == "0": + http_pr_list.append("\\\"" + pr_server + "\\\"") + if http_pr_list: + http_private_registries = ",".join(http_pr_list) + return http_private_registries + + def _connect_to_private_registries(self, vnf_package_path, + pr_connection_info, node_username, + node_password, node_ip): + LOG.debug("Start the _connect_to_private_registries function. " + "node ip: {}, pr connection info: {}".format( + node_ip, pr_connection_info)) + + commander = cmd_executer.RemoteCommandExecutor( + user=node_username, password=node_password, + host=node_ip, timeout=PR_CONNECT_TIMEOUT) + + # create a cert file list for file transfer + cert_file_list = [] + for pr_info in pr_connection_info: + pr_certificate_path = pr_info.get('certificate_path') + if pr_certificate_path: + local_file_path = os.path.join( + vnf_package_path, pr_certificate_path) + # check existence of cert file + if not os.path.exists(local_file_path): + err_param = "certificate_path(path:{})".format( + pr_certificate_path) + LOG.error("The {} in the additionalParams is invalid. " + "File does not exist.".format(err_param)) + commander.close_session() + raise exceptions.MgmtDriverParamInvalid(param=err_param) + cert_file_name = os.path.basename(pr_certificate_path) + remote_tmp_path = os.path.join("/tmp", cert_file_name) + remote_dir_path = os.path.join( + "/etc/docker/certs.d", pr_info.get('server')) + remote_file_path = os.path.join( + remote_dir_path, cert_file_name) + cert_file_list.append((local_file_path, remote_tmp_path, + remote_dir_path, remote_file_path)) + + # send cert files to node + if cert_file_list: + retry = 4 + while retry > 0: + try: + transport = paramiko.Transport(node_ip, 22) + transport.connect( + username=node_username, password=node_password) + sftp_client = paramiko.SFTPClient.from_transport( + transport) + for cert_item in cert_file_list: + local_file_path = cert_item[0] + remote_tmp_path = cert_item[1] + remote_dir_path = cert_item[2] + remote_file_path = cert_item[3] + # send cert file to tmp directory + sftp_client.put(local_file_path, remote_tmp_path) + # copy under /etc/docker/certs.d/ + ssh_command = ("sudo mkdir -p {} && " + "sudo cp {} {} && sudo rm -f {}".format( + remote_dir_path, remote_tmp_path, + remote_file_path, remote_tmp_path)) + self._execute_command( + commander, ssh_command, + PR_CMD_TIMEOUT, 'common', 0) + transport.close() + except paramiko.SSHException as e: + LOG.debug(e) + retry -= 1 + if retry == 0: + LOG.error(e) + commander.close_session() + raise paramiko.SSHException() + time.sleep(SERVER_WAIT_COMPLETE_TIME) + + # connect to private registries + for pr_info in pr_connection_info: + # add host to /etc/hosts + pr_hosts_string = pr_info.get('hosts_string') + if pr_hosts_string: + ssh_command = ("echo '{}' | sudo tee -a /etc/hosts " + ">/dev/null".format(pr_hosts_string)) + self._execute_command( + commander, ssh_command, PR_CMD_TIMEOUT, 'common', 0) + + # connect to private registry (run docker login) + pr_server = pr_info.get('server') + login_username = pr_info.get('username', 'tacker') + login_password = pr_info.get('password', 'tacker') + ssh_command = ("sudo docker login {} " + "--username {} --password {}".format( + pr_server, login_username, login_password)) + result = self._execute_command( + commander, ssh_command, PR_CMD_TIMEOUT, 'docker_login', 0) + stdout = result[0] + login_successful = ( + [line for line in stdout if "Login Succeeded" in line]) + if not login_successful: + # Login Failed + stderr = result[1] + unnecessary_msg = "WARNING! Using --password via the CLI" + err_info = ( + [line for line in stderr if not(unnecessary_msg in line)]) + err_msg = ("Failed to login Docker private registry. " + "ErrInfo:{}".format(err_info)) + LOG.error(err_msg) + commander.close_session() + raise exceptions.MgmtDriverOtherError(error_message=err_msg) + + commander.close_session() + LOG.debug("_connect_to_private_registries function complete.") + def _install_k8s_cluster(self, context, vnf_instance, proxy, script_path, master_vm_dict_list, worker_vm_dict_list, - helm_inst_script_path): + helm_inst_script_path, pr_connection_info): # instantiate: pre /etc/hosts hosts_str = self._get_hosts( master_vm_dict_list, worker_vm_dict_list) @@ -586,6 +723,10 @@ class KubernetesMgmtDriver(vnflcm_abstract_driver.VnflcmMgmtAbstractDriver): "127.0.0.1", "localhost", master_cluster_ip] + vm_cidr_list))) + # get private registries of type HTTP + http_private_registries = self._get_http_private_registries( + pr_connection_info) + # install k8s active_username = "" active_password = "" @@ -698,6 +839,14 @@ class KubernetesMgmtDriver(vnflcm_abstract_driver.VnflcmMgmtAbstractDriver): kubeadm_token=kubeadm_token, ssl_ca_cert_hash=ssl_ca_cert_hash, certificate_key=certificate_key) + + # if connecting to the private registries over HTTP, + # add "export HTTP_PRIVATE_REGISTRIES" command + if http_private_registries: + ssh_command = \ + "export HTTP_PRIVATE_REGISTRIES=\"{}\";{}".format( + http_private_registries, ssh_command) + results = self._execute_command( commander, ssh_command, K8S_INSTALL_TIMEOUT, 'install', 0) @@ -738,6 +887,12 @@ class KubernetesMgmtDriver(vnflcm_abstract_driver.VnflcmMgmtAbstractDriver): masternode_ip_list.append(host) commander.close_session() + # connect to private registries + if pr_connection_info: + self._connect_to_private_registries( + vnf_package_path, pr_connection_info, + user, password, host) + # install worker node for vm_dict in worker_vm_dict_list: user = vm_dict.get('ssh', {}).get('username') @@ -768,9 +923,16 @@ class KubernetesMgmtDriver(vnflcm_abstract_driver.VnflcmMgmtAbstractDriver): # execute install k8s command on VM self._install_worker_node( commander, proxy, ha_flag, nic_ip, - cluster_ip, kubeadm_token, ssl_ca_cert_hash) + cluster_ip, kubeadm_token, ssl_ca_cert_hash, + http_private_registries) commander.close_session() + # connect to private registries + if pr_connection_info: + self._connect_to_private_registries( + vnf_package_path, pr_connection_info, + user, password, host) + # set pod_affinity commander = cmd_executer.RemoteCommandExecutor( user=active_username, password=active_password, @@ -865,6 +1027,36 @@ class KubernetesMgmtDriver(vnflcm_abstract_driver.VnflcmMgmtAbstractDriver): raise exceptions.MgmtDriverParamInvalid(param='cluster_cidr') else: additional_param['master_node']['cluster_cidr'] = '10.96.0.0/12' + + # get private_registry_connection_info param + pr_connection_info = additional_param.get( + 'private_registry_connection_info') + if pr_connection_info: + # check private_registry_connection_info param + for pr_info in pr_connection_info: + pr_connection_type = str(pr_info.get('connection_type', '')) + pr_server = pr_info.get('server') + # check connection_type param exists + if not pr_connection_type: + LOG.error("The connection_type " + "in the additionalParams does not exist.") + raise exceptions.MgmtDriverNotFound( + param="connection_type") + # check server param exists + if not pr_server: + LOG.error("The server " + "in the additionalParams does not exist.") + raise exceptions.MgmtDriverNotFound(param="server") + # check connection_type value + # NOTE: "connection_type" values are "0" for HTTP and + # "1" for HTTPS. + if not (pr_connection_type == "0" + or pr_connection_type == "1"): + LOG.error("The connection_type " + "in the additionalParams is invalid.") + raise exceptions.MgmtDriverParamInvalid( + param="connection_type") + # check grants exists if grant: self.SET_ZONE_ID_FLAG = True @@ -887,9 +1079,11 @@ class KubernetesMgmtDriver(vnflcm_abstract_driver.VnflcmMgmtAbstractDriver): access_info, vnf_instance, grant) server, bearer_token, ssl_ca_cert, project_name, masternode_ip_list = \ self._install_k8s_cluster(context, vnf_instance, - proxy, script_path, master_vm_dict_list, + proxy, script_path, + master_vm_dict_list, worker_vm_dict_list, - helm_inst_script_path) + helm_inst_script_path, + pr_connection_info) # register vim with kubernetes cluster info self._create_vim(context, vnf_instance, server, @@ -1294,6 +1488,13 @@ class KubernetesMgmtDriver(vnflcm_abstract_driver.VnflcmMgmtAbstractDriver): heatclient = hc.HeatClient(vim_connection_info.access_info) scale_out_id_list = kwargs.get('scale_out_id_list') + # get private_registry_connection_info param + pr_connection_info = k8s_cluster_installation_param.get( + 'private_registry_connection_info') + # get private registries of type HTTP + http_private_registries = self._get_http_private_registries( + pr_connection_info) + # get master_ip master_ssh_ip_list = [] master_nic_ip_list = [] @@ -1416,8 +1617,16 @@ class KubernetesMgmtDriver(vnflcm_abstract_driver.VnflcmMgmtAbstractDriver): add_worker_ssh_ip_list.index(worker_ip)] self._install_worker_node( commander, proxy, ha_flag, worker_nic_ip, - cluster_ip, kubeadm_token, ssl_ca_cert_hash) + cluster_ip, kubeadm_token, ssl_ca_cert_hash, + http_private_registries) commander.close_session() + + # connect to private registries + if pr_connection_info: + self._connect_to_private_registries( + vnf_package_path, pr_connection_info, + worker_username, worker_password, worker_ip) + if self.SET_NODE_LABEL_FLAG: commander, _ = self._connect_ssh_scale( master_ssh_ip_list, master_username, @@ -1925,7 +2134,8 @@ class KubernetesMgmtDriver(vnflcm_abstract_driver.VnflcmMgmtAbstractDriver): fixed_master_infos, proxy, master_username, master_password, vnf_package_path, script_path, cluster_ip, pod_cidr, cluster_cidr, - kubeadm_token, ssl_ca_cert_hash, ha_flag, helm_info): + kubeadm_token, ssl_ca_cert_hash, ha_flag, helm_info, + pr_connection_info, http_private_registries): not_fixed_master_nic_ips = [ master_ips.get('master_nic_ip') for master_ips in not_fixed_master_infos.values()] @@ -1994,6 +2204,14 @@ class KubernetesMgmtDriver(vnflcm_abstract_driver.VnflcmMgmtAbstractDriver): kubeadm_token=kubeadm_token, ssl_ca_cert_hash=ssl_ca_cert_hash, certificate_key=certificate_key) + + # if connecting to the private registries over HTTP, + # add "export HTTP_PRIVATE_REGISTRIES" command + if http_private_registries: + ssh_command = \ + "export HTTP_PRIVATE_REGISTRIES=\"{}\";{}".format( + http_private_registries, ssh_command) + self._execute_command( commander, ssh_command, K8S_INSTALL_TIMEOUT, 'install', 0) if helm_info: @@ -2018,11 +2236,19 @@ class KubernetesMgmtDriver(vnflcm_abstract_driver.VnflcmMgmtAbstractDriver): commander, ssh_command, K8S_CMD_TIMEOUT, 'common', 3) commander.close_session() + # connect to private registries + if pr_connection_info: + self._connect_to_private_registries( + vnf_package_path, pr_connection_info, + master_username, master_password, + fixed_master_info.get('master_ssh_ip')) + def _fix_worker_node( self, fixed_worker_infos, hosts_str, worker_username, worker_password, vnf_package_path, script_path, proxy, cluster_ip, - kubeadm_token, ssl_ca_cert_hash, ha_flag): + kubeadm_token, ssl_ca_cert_hash, ha_flag, + pr_connection_info, http_private_registries): for fixed_worker_name, fixed_worker in fixed_worker_infos.items(): commander = self._init_commander_and_send_install_scripts( worker_username, worker_password, @@ -2031,11 +2257,19 @@ class KubernetesMgmtDriver(vnflcm_abstract_driver.VnflcmMgmtAbstractDriver): self._install_worker_node( commander, proxy, ha_flag, fixed_worker.get('worker_nic_ip'), - cluster_ip, kubeadm_token, ssl_ca_cert_hash) + cluster_ip, kubeadm_token, ssl_ca_cert_hash, + http_private_registries) self._set_node_ip_in_hosts( commander, 'heal_end', hosts_str=hosts_str) commander.close_session() + # connect to private registries + if pr_connection_info: + self._connect_to_private_registries( + vnf_package_path, pr_connection_info, + worker_username, worker_password, + fixed_worker.get('worker_ssh_ip')) + def _heal_and_join_k8s_node( self, heatclient, stack_id, target_physical_resource_ids, vnf_additional_params, master_resource_name, master_username, @@ -2141,19 +2375,29 @@ class KubernetesMgmtDriver(vnflcm_abstract_driver.VnflcmMgmtAbstractDriver): hosts_str = self._get_all_hosts( not_fixed_master_infos, fixed_master_infos, not_fixed_worker_infos, fixed_worker_infos) + + # get private_registry_connection_info param + pr_connection_info = k8s_cluster_installation_param.get( + 'private_registry_connection_info') + # get private registries of type HTTP + http_private_registries = self._get_http_private_registries( + pr_connection_info) + if flag_master: self._fix_master_node( not_fixed_master_infos, hosts_str, fixed_master_infos, proxy, master_username, master_password, vnf_package_path, script_path, cluster_ip, pod_cidr, cluster_cidr, - kubeadm_token, ssl_ca_cert_hash, ha_flag, helm_info) + kubeadm_token, ssl_ca_cert_hash, ha_flag, helm_info, + pr_connection_info, http_private_registries) if flag_worker: self._fix_worker_node( fixed_worker_infos, hosts_str, worker_username, worker_password, vnf_package_path, script_path, proxy, cluster_ip, - kubeadm_token, ssl_ca_cert_hash, ha_flag) + kubeadm_token, ssl_ca_cert_hash, ha_flag, + pr_connection_info, http_private_registries) if self.SET_NODE_LABEL_FLAG: for fixed_worker_name, fixed_worker in fixed_worker_infos.items(): diff --git a/samples/mgmt_driver/private_registry_mgmt.py b/samples/mgmt_driver/private_registry_mgmt.py new file mode 100644 index 000000000..e23a997f2 --- /dev/null +++ b/samples/mgmt_driver/private_registry_mgmt.py @@ -0,0 +1,467 @@ +# Copyright (C) 2021 FUJITSU +# 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 time + +import eventlet +from oslo_log import log as logging +import paramiko + +from tacker.common import cmd_executer +from tacker.common import exceptions +from tacker import objects +from tacker.vnflcm import utils as vnflcm_utils +from tacker.vnfm.infra_drivers.openstack import heat_client as hc +from tacker.vnfm.mgmt_drivers import vnflcm_abstract_driver + +LOG = logging.getLogger(__name__) + +# CLI timeout period +PR_CONNECT_TIMEOUT = 30 +PR_CMD_TIMEOUT_DEFAULT = 600 +PR_CMD_TIMEOUT_INSTALL = 2700 + +# retry interval(sec) +PR_CMD_RETRY_INTERVAL = 30 + +# number of check command retries for wait for Docker running +PR_NUM_OF_RETRY_WAIT_DOCKER = 5 + +# number of check command retries for wait for Private registry running +PR_NUM_OF_RETRY_WAIT_PR = 5 + +# Command type +CMD_TYPE_COMMON = "common" + +# Default host port +DEFAULT_HOST_PORT = '5000' + + +class PrivateRegistryMgmtDriver( + vnflcm_abstract_driver.VnflcmMgmtAbstractDriver): + + def get_type(self): + return "mgmt-drivers-private-registry" + + def get_name(self): + return "mgmt-drivers-private-registry" + + def get_description(self): + return "Tacker Private registry VNF Mgmt Driver" + + def _get_cp_ip_address(self, vnf_instance, vim_connection_info, cp_name): + heatclient = hc.HeatClient(vim_connection_info.access_info) + stack_id = vnf_instance.instantiated_vnf_info.instance_id + + # get IP address from heat + resource_info = heatclient.resources.get( + stack_id=stack_id, resource_name=cp_name) + fixed_ips = resource_info.attributes.get("fixed_ips") + if fixed_ips: + cp_ip_address = fixed_ips[0].get("ip_address") + else: + cp_ip_address = "" + + # check result + if not cp_ip_address: + err_msg = "Failed to get IP address for Private registry VM" + LOG.error(err_msg) + raise exceptions.MgmtDriverOtherError(error_message=err_msg) + + LOG.debug("Getting IP address succeeded. " + "(CP name: {}, IP address: {})".format(cp_name, cp_ip_address)) + return cp_ip_address + + def _execute_command(self, commander, ssh_command, + timeout=PR_CMD_TIMEOUT_DEFAULT, + type=CMD_TYPE_COMMON, retry=0): + eventlet.monkey_patch() + while retry >= 0: + try: + with eventlet.Timeout(timeout, True): + LOG.debug("execute command: {}".format(ssh_command)) + result = commander.execute_command( + ssh_command, input_data=None) + break + except eventlet.timeout.Timeout: + err_msg = ("It is time out, When execute command: " + "{}.".format(ssh_command)) + retry -= 1 + if retry < 0: + LOG.error(err_msg) + commander.close_session() + raise exceptions.MgmtDriverOtherError( + error_message=err_msg) + err_msg += " Retry after {} seconds.".format( + PR_CMD_RETRY_INTERVAL) + LOG.debug(err_msg) + time.sleep(PR_CMD_RETRY_INTERVAL) + if type == CMD_TYPE_COMMON: + stderr = result.get_stderr() + if stderr: + err_msg = ("Failed to execute command: {}, " + "stderr: {}".format(ssh_command, stderr)) + LOG.error(err_msg) + commander.close_session() + raise exceptions.MgmtDriverOtherError(error_message=err_msg) + return result.get_stdout() + + def _wait_docker_running(self, commander, err_msg, + retry=PR_NUM_OF_RETRY_WAIT_DOCKER): + while retry >= 0: + ssh_command = ("sudo systemctl status docker " + "| grep Active | grep -c running") + result = self._execute_command(commander, ssh_command) + count_result = result[0].replace("\n", "") + if count_result == "0": + retry -= 1 + if retry < 0: + LOG.error(err_msg) + commander.close_session() + raise exceptions.MgmtDriverOtherError( + error_message=err_msg) + LOG.debug("Docker service is not running. " + "Check again after {} seconds.".format( + PR_CMD_RETRY_INTERVAL)) + time.sleep(PR_CMD_RETRY_INTERVAL) + else: + LOG.debug("Docker service is running.") + break + + def _wait_private_registry_running(self, commander, + retry=PR_NUM_OF_RETRY_WAIT_PR): + while retry >= 0: + ssh_command = ("sudo docker inspect " + "--format=\'{{.State.Status}}\' " + "private_registry") + result = self._execute_command(commander, ssh_command) + status = result[0].replace("\n", "") + if status == "running": + LOG.debug("Private registry container is running.") + break + retry -= 1 + if retry < 0: + err_msg = "Failed to run Private registry container" + LOG.error(err_msg) + commander.close_session() + raise exceptions.MgmtDriverOtherError( + error_message=err_msg) + LOG.debug("Private registry container is not running. " + "Check again after {} seconds.".format( + PR_CMD_RETRY_INTERVAL)) + time.sleep(PR_CMD_RETRY_INTERVAL) + + def _check_pr_installation_params(self, pr_installation_params): + if not pr_installation_params: + LOG.error("The private_registry_installation_param " + "in the additionalParams does not exist.") + raise exceptions.MgmtDriverNotFound( + param="private_registry_installation_param") + ssh_cp_name = pr_installation_params.get("ssh_cp_name") + ssh_username = pr_installation_params.get("ssh_username") + ssh_password = pr_installation_params.get("ssh_password") + if not ssh_cp_name: + LOG.error("The ssh_cp_name " + "in the additionalParams does not exist.") + raise exceptions.MgmtDriverNotFound(param="ssh_cp_name") + if not ssh_username: + LOG.error("The ssh_username " + "in the additionalParams does not exist.") + raise exceptions.MgmtDriverNotFound(param="ssh_username") + if not ssh_password: + LOG.error("The ssh_password " + "in the additionalParams does not exist.") + raise exceptions.MgmtDriverNotFound(param="ssh_password") + + def _install_private_registry(self, context, vnf_instance, + vim_connection_info, + pr_installation_params): + LOG.debug("Start private registry installation. " + "installation param: {}".format(pr_installation_params)) + + # check parameters + self._check_pr_installation_params(pr_installation_params) + + ssh_cp_name = pr_installation_params.get("ssh_cp_name") + ssh_username = pr_installation_params.get("ssh_username") + ssh_password = pr_installation_params.get("ssh_password") + image_path = pr_installation_params.get("image_path") + port_no = pr_installation_params.get("port_no") + proxy = pr_installation_params.get("proxy") + + # get IP address from cp name + ssh_ip_address = self._get_cp_ip_address( + vnf_instance, vim_connection_info, ssh_cp_name) + + # initialize RemoteCommandExecutor + retry = 4 + while retry > 0: + try: + commander = cmd_executer.RemoteCommandExecutor( + user=ssh_username, password=ssh_password, + host=ssh_ip_address, timeout=PR_CONNECT_TIMEOUT) + break + except (exceptions.NotAuthorized, paramiko.SSHException, + paramiko.ssh_exception.NoValidConnectionsError) as e: + LOG.debug(e) + retry -= 1 + if retry < 0: + err_msg = "Failed to use SSH to connect to the registry " \ + "server: {}".format(ssh_ip_address) + LOG.error(err_msg) + raise exceptions.MgmtDriverOtherError( + error_message=err_msg) + time.sleep(PR_CMD_RETRY_INTERVAL) + + # check OS and architecture + ssh_command = ("cat /etc/os-release " + "| grep \"PRETTY_NAME=\" " + "| grep -c \"Ubuntu 20.04\"; arch | grep -c x86_64") + result = self._execute_command(commander, ssh_command) + os_check_result = result[0].replace("\n", "") + arch_check_result = result[1].replace("\n", "") + if os_check_result == "0" or arch_check_result == "0": + err_msg = ("Failed to install. " + "Your OS does not support at present. " + "It only supports Ubuntu 20.04 (x86_64)") + LOG.error(err_msg) + commander.close_session() + raise exceptions.MgmtDriverOtherError(error_message=err_msg) + + # get proxy params + http_proxy = "" + https_proxy = "" + no_proxy = "" + if proxy: + http_proxy = proxy.get("http_proxy") + https_proxy = proxy.get("https_proxy") + no_proxy = proxy.get("no_proxy") + + # execute apt-get install command + ssh_command = "" + if http_proxy or https_proxy: + # set apt's proxy config + ssh_command = "echo -e \"" + if http_proxy: + ssh_command += ("Acquire::http::Proxy " + "\\\"{}\\\";\\n".format(http_proxy)) + if https_proxy: + ssh_command += ("Acquire::https::Proxy " + "\\\"{}\\\";\\n".format(https_proxy)) + ssh_command += ("\" | sudo tee /etc/apt/apt.conf.d/proxy.conf " + ">/dev/null && ") + ssh_command += ( + "sudo apt-get update && " + "export DEBIAN_FRONTEND=noninteractive;" + "sudo -E apt-get install -y apt-transport-https " + "ca-certificates curl gnupg-agent software-properties-common") + self._execute_command(commander, ssh_command, PR_CMD_TIMEOUT_INSTALL) + + # execute add-apt-repository command + ssh_command = "" + if http_proxy: + ssh_command += "export http_proxy=\"{}\";".format(http_proxy) + if https_proxy: + ssh_command += "export https_proxy=\"{}\";".format(https_proxy) + if no_proxy: + ssh_command += "export no_proxy=\"{}\";".format(no_proxy) + ssh_command += ( + "export APT_KEY_DONT_WARN_ON_DANGEROUS_USAGE=DontWarn;" + "curl -fsSL https://download.docker.com/linux/ubuntu/gpg " + "| sudo -E apt-key add - && " + "sudo add-apt-repository \"deb [arch=amd64] " + "https://download.docker.com/linux/ubuntu " + "$(lsb_release -cs) stable\"") + self._execute_command(commander, ssh_command, PR_CMD_TIMEOUT_INSTALL) + + # install docker + ssh_command = ( + "sudo apt-get update && " + "export DEBIAN_FRONTEND=noninteractive;" + "sudo -E apt-get install -y " + "docker-ce=5:19.03.11~3-0~ubuntu-focal " + "docker-ce-cli containerd.io") + self._execute_command(commander, ssh_command, PR_CMD_TIMEOUT_INSTALL) + + # wait for the Docker service running + err_msg = "Failed to install Docker(Docker service is not running)" + self._wait_docker_running(commander, err_msg) + + # set Docker's proxy config + if http_proxy or https_proxy or no_proxy: + proxy_env_list = [] + if http_proxy: + proxy_env = "\\\"HTTP_PROXY={}\\\"".format(http_proxy) + proxy_env_list.append(proxy_env) + if https_proxy: + proxy_env = "\\\"HTTPS_PROXY={}\\\"".format(https_proxy) + proxy_env_list.append(proxy_env) + if no_proxy: + proxy_env = "\\\"NO_PROXY={}\\\"".format(no_proxy) + proxy_env_list.append(proxy_env) + proxy_env = " ".join(proxy_env_list) + ssh_command = ( + "sudo mkdir -p /etc/systemd/system/docker.service.d && " + "echo -e \"[Service]\\nEnvironment={}\" | sudo tee " + "/etc/systemd/system/docker.service.d/https-proxy.conf " + ">/dev/null && " + "sudo systemctl daemon-reload && " + "sudo systemctl restart docker".format(proxy_env)) + self._execute_command(commander, ssh_command) + + # wait for the Docker service running + err_msg = ("Failed to restart Docker" + "(Docker service is not running)") + self._wait_docker_running(commander, err_msg) + + # pull or load the Docker image named "registry" + if not image_path: + # pull the Docker image + ssh_command = "sudo docker pull registry" + self._execute_command(commander, ssh_command) + else: + vnf_package_path = vnflcm_utils._get_vnf_package_path( + context, vnf_instance.vnfd_id) + local_image_path = os.path.join( + vnf_package_path, image_path) + + # check existence of local image file + if not os.path.exists(local_image_path): + LOG.error("The image_path in the additionalParams is invalid. " + "File does not exist.") + commander.close_session() + raise exceptions.MgmtDriverParamInvalid(param="image_path") + + # transfer the Docker image file to Private registry VM + image_file_name = os.path.basename(image_path) + remote_image_path = os.path.join("/tmp", image_file_name) + transport = paramiko.Transport(ssh_ip_address, 22) + transport.connect(username=ssh_username, password=ssh_password) + sftp_client = paramiko.SFTPClient.from_transport(transport) + sftp_client.put(local_image_path, remote_image_path) + transport.close() + + # load the Docker image + ssh_command = "sudo docker load -i {}".format(remote_image_path) + self._execute_command(commander, ssh_command) + + # check Docker images list + ssh_command = "sudo docker images | grep -c registry" + result = self._execute_command(commander, ssh_command) + count_result = result[0].replace("\n", "") + if count_result == "0": + err_msg = "Failed to pull or load the Docker image named registry" + LOG.error(err_msg) + commander.close_session() + raise exceptions.MgmtDriverOtherError(error_message=err_msg) + + # run the Private registry container + if port_no is None: + port = DEFAULT_HOST_PORT + else: + port = str(port_no) + ssh_command = ( + "sudo docker run -d -p {}:5000 " + "-v /private_registry:/var/lib/registry " + "--restart=always " + "--name private_registry " + "registry:latest".format(port)) + self._execute_command(commander, ssh_command) + + # wait for the Private registry container running + self._wait_private_registry_running(commander) + + commander.close_session() + LOG.debug("Private registry installation complete.") + + def instantiate_start(self, context, vnf_instance, + instantiate_vnf_request, grant, + grant_request, **kwargs): + pass + + def instantiate_end(self, context, vnf_instance, + instantiate_vnf_request, grant, + grant_request, **kwargs): + # get vim_connection_info + vim_info = vnflcm_utils._get_vim(context, + instantiate_vnf_request.vim_connection_info) + vim_connection_info = objects.VimConnectionInfo.obj_from_primitive( + vim_info, context) + + # get parameters for private registry installation + pr_installation_params = instantiate_vnf_request.additional_params.get( + "private_registry_installation_param") + + self._install_private_registry( + context, vnf_instance, vim_connection_info, pr_installation_params) + + def terminate_start(self, context, vnf_instance, + terminate_vnf_request, grant, + grant_request, **kwargs): + pass + + def terminate_end(self, context, vnf_instance, + terminate_vnf_request, grant, + grant_request, **kwargs): + pass + + def scale_start(self, context, vnf_instance, + scale_vnf_request, grant, + grant_request, **kwargs): + pass + + def scale_end(self, context, vnf_instance, + scale_vnf_request, grant, + grant_request, **kwargs): + pass + + def heal_start(self, context, vnf_instance, + heal_vnf_request, grant, + grant_request, **kwargs): + pass + + def heal_end(self, context, vnf_instance, + heal_vnf_request, grant, + grant_request, **kwargs): + # NOTE: Private registry VNF has only one VNFC. + # Therefore, VNFC that is repaired by entire Heal and + # VNFC that is repaired by specifying VNFC instance are the same VNFC. + + # get vim_connection_info + vim_info = vnflcm_utils._get_vim(context, + vnf_instance.vim_connection_info) + vim_connection_info = objects.VimConnectionInfo.obj_from_primitive( + vim_info, context) + + # get parameters for private registry installation + pr_installation_params = ( + vnf_instance.instantiated_vnf_info.additional_params.get( + "private_registry_installation_param")) + + self._install_private_registry( + context, vnf_instance, vim_connection_info, pr_installation_params) + + def change_external_connectivity_start( + self, context, vnf_instance, + change_ext_conn_request, grant, + grant_request, **kwargs): + pass + + def change_external_connectivity_end( + self, context, vnf_instance, + change_ext_conn_request, grant, + grant_request, **kwargs): + pass diff --git a/samples/mgmt_driver/private_registry_vnf_package/Definitions/etsi_nfv_sol001_common_types.yaml b/samples/mgmt_driver/private_registry_vnf_package/Definitions/etsi_nfv_sol001_common_types.yaml new file mode 100644 index 000000000..15ab39b13 --- /dev/null +++ b/samples/mgmt_driver/private_registry_vnf_package/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/samples/mgmt_driver/private_registry_vnf_package/Definitions/etsi_nfv_sol001_vnfd_types.yaml b/samples/mgmt_driver/private_registry_vnf_package/Definitions/etsi_nfv_sol001_vnfd_types.yaml new file mode 100644 index 000000000..73b51da2d --- /dev/null +++ b/samples/mgmt_driver/private_registry_vnf_package/Definitions/etsi_nfv_sol001_vnfd_types.yaml @@ -0,0 +1,1465 @@ +tosca_definitions_version: tosca_simple_yaml_1_2 +description: ETSI NFV SOL 001 vnfd types definitions version 2.6.1 +metadata: + template_name: etsi_nfv_sol001_vnfd_types + template_author: ETSI_NFV + template_version: 2.6.1 + +imports: + - etsi_nfv_sol001_common_types.yaml + +data_types: + tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements: + derived_from: tosca.datatypes.Root + description: Describes requirements on a virtual network interface + properties: + name: + type: string + description: Provides a human readable name for the requirement. + required: false + description: + type: string + description: Provides a human readable description of the requirement. + required: false + support_mandatory: + type: boolean + description: Indicates whether fulfilling the constraint is mandatory (TRUE) for successful operation or desirable (FALSE). + required: true + network_interface_requirements: + type: map + description: The network interface requirements. A map of strings that contain a set of key-value pairs that describes the hardware platform specific network interface deployment requirements. + required: true + entry_schema: + type: string + nic_io_requirements: + type: tosca.datatypes.nfv.LogicalNodeData + description: references (couples) the CP with any logical node I/O requirements (for network devices) that may have been created. Linking these attributes is necessary so that so that I/O requirements that need to be articulated at the logical node level can be associated with the network interface requirements associated with the CP. + required: false + + tosca.datatypes.nfv.RequestedAdditionalCapability: + derived_from: tosca.datatypes.Root + description: describes requested additional capability for a particular VDU + properties: + requested_additional_capability_name: + type: string + description: Identifies a requested additional capability for the VDU. + required: true + support_mandatory: + type: boolean + description: Indicates whether the requested additional capability is mandatory for successful operation. + required: true + min_requested_additional_capability_version: + type: string + description: Identifies the minimum version of the requested additional capability. + required: false + preferred_requested_additional_capability_version: + type: string + description: Identifies the preferred version of the requested additional capability. + required: false + target_performance_parameters: + type: map + description: Identifies specific attributes, dependent on the requested additional capability type. + required: true + entry_schema: + type: string + + tosca.datatypes.nfv.VirtualMemory: + derived_from: tosca.datatypes.Root + description: supports the specification of requirements related to virtual memory of a virtual compute resource + properties: + virtual_mem_size: + type: scalar-unit.size + description: Amount of virtual memory. + required: true + virtual_mem_oversubscription_policy: + type: string + description: The memory core oversubscription policy in terms of virtual memory to physical memory on the platform. + required: false + vdu_mem_requirements: + type: map + description: The hardware platform specific VDU memory requirements. A map of strings that contains a set of key-value pairs that describes hardware platform specific VDU memory requirements. + required: false + entry_schema: + type: string + numa_enabled: + type: boolean + description: It specifies the memory allocation to be cognisant of the relevant process/core allocation. + required: false + default: false + + tosca.datatypes.nfv.VirtualCpu: + derived_from: tosca.datatypes.Root + description: Supports the specification of requirements related to virtual CPU(s) of a virtual compute resource + properties: + cpu_architecture: + type: string + description: CPU architecture type. Examples are x86, ARM + required: false + num_virtual_cpu: + type: integer + description: Number of virtual CPUs + required: true + constraints: + - greater_than: 0 + virtual_cpu_clock: + type: scalar-unit.frequency + description: Minimum virtual CPU clock rate + required: false + virtual_cpu_oversubscription_policy: + type: string + description: CPU core oversubscription policy e.g. the relation of virtual CPU cores to physical CPU cores/threads. + required: false + vdu_cpu_requirements: + type: map + description: The hardware platform specific VDU CPU requirements. A map of strings that contains a set of key-value pairs describing VDU CPU specific hardware platform requirements. + required: false + entry_schema: + type: string + virtual_cpu_pinning: + type: tosca.datatypes.nfv.VirtualCpuPinning + description: The virtual CPU pinning configuration for the virtualised compute resource. + required: false + + tosca.datatypes.nfv.VirtualCpuPinning: + derived_from: tosca.datatypes.Root + description: Supports the specification of requirements related to the virtual CPU pinning configuration of a virtual compute resource + properties: + virtual_cpu_pinning_policy: + type: string + description: 'Indicates the policy for CPU pinning. The policy can take values of "static" or "dynamic". In case of "dynamic" the allocation of virtual CPU cores to logical CPU cores is decided by the VIM. (e.g.: SMT (Simultaneous Multi-Threading) requirements). In case of "static" the allocation is requested to be according to the virtual_cpu_pinning_rule.' + required: false + constraints: + - valid_values: [ static, dynamic ] + virtual_cpu_pinning_rule: + type: list + description: Provides the list of rules for allocating virtual CPU cores to logical CPU cores/threads + required: false + entry_schema: + type: string + + tosca.datatypes.nfv.VnfcConfigurableProperties: + derived_from: tosca.datatypes.Root + description: Defines the configurable properties of a VNFC + # properties: + # additional_vnfc_configurable_properties: + # type: tosca.datatypes.nfv.VnfcAdditionalConfigurableProperties + # description: Describes additional configuration for VNFC that + # can be modified using the ModifyVnfInfo operation + # required: false + # derived types are expected to introduce + # additional_vnfc_configurable_properties with its type derived from + # tosca.datatypes.nfv.VnfcAdditionalConfigurableProperties + + tosca.datatypes.nfv.VnfcAdditionalConfigurableProperties: + derived_from: tosca.datatypes.Root + description: VnfcAdditionalConfigurableProperties type is an empty base type for deriving data types for describing additional configurable properties for a given VNFC. + + tosca.datatypes.nfv.VduProfile: + derived_from: tosca.datatypes.Root + description: describes additional instantiation data for a given Vdu.Compute used in a specific deployment flavour. + properties: + min_number_of_instances: + type: integer + description: Minimum number of instances of the VNFC based on this Vdu.Compute that is permitted to exist for a particular VNF deployment flavour. + required: true + constraints: + - greater_or_equal: 0 + max_number_of_instances: + type: integer + description: Maximum number of instances of the VNFC based on this Vdu.Compute that is permitted to exist for a particular VNF deployment flavour. + required: true + constraints: + - greater_or_equal: 0 + + tosca.datatypes.nfv.VlProfile: + derived_from: tosca.datatypes.Root + description: Describes additional instantiation data for a given VL used in a specific VNF deployment flavour. + properties: + max_bitrate_requirements: + type: tosca.datatypes.nfv.LinkBitrateRequirements + description: Specifies the maximum bitrate requirements for a VL instantiated according to this profile. + required: true + min_bitrate_requirements: + type: tosca.datatypes.nfv.LinkBitrateRequirements + description: Specifies the minimum bitrate requirements for a VL instantiated according to this profile. + required: true + qos: + type: tosca.datatypes.nfv.Qos + description: Specifies the QoS requirements of a VL instantiated according to this profile. + required: false + virtual_link_protocol_data: + type: list + description: Specifies the protocol data for a virtual link. + required: false + entry_schema: + type: tosca.datatypes.nfv.VirtualLinkProtocolData + + tosca.datatypes.nfv.VirtualLinkProtocolData: + derived_from: tosca.datatypes.Root + description: describes one protocol layer and associated protocol data for a given virtual link used in a specific VNF deployment flavour + properties: + associated_layer_protocol: + type: string + description: Identifies one of the protocols a virtualLink gives access to (ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire) as specified by the connectivity_type property. + required: true + constraints: + - valid_values: [ ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire ] + l2_protocol_data: + type: tosca.datatypes.nfv.L2ProtocolData + description: Specifies the L2 protocol data for a virtual link. Shall be present when the associatedLayerProtocol attribute indicates a L2 protocol and shall be absent otherwise. + required: false + l3_protocol_data: + type: tosca.datatypes.nfv.L3ProtocolData + description: Specifies the L3 protocol data for this virtual link. Shall be present when the associatedLayerProtocol attribute indicates a L3 protocol and shall be absent otherwise. + required: false + + tosca.datatypes.nfv.L2ProtocolData: + derived_from: tosca.datatypes.Root + description: describes L2 protocol data for a given virtual link used in a specific VNF deployment flavour. + properties: + name: + type: string + description: Identifies the network name associated with this L2 protocol. + required: false + network_type: + type: string + description: Specifies the network type for this L2 protocol.The value may be overridden at run-time. + required: false + constraints: + - valid_values: [ flat, vlan, vxlan, gre ] + vlan_transparent: + type: boolean + description: Specifies whether to support VLAN transparency for this L2 protocol or not. + required: false + default: false + mtu: + type: integer + description: Specifies the maximum transmission unit (MTU) value for this L2 protocol. + required: false + constraints: + - greater_than: 0 + + tosca.datatypes.nfv.L3ProtocolData: + derived_from: tosca.datatypes.Root + description: describes L3 protocol data for a given virtual link used in a specific VNF deployment flavour. + properties: + name: + type: string + description: Identifies the network name associated with this L3 protocol. + required: false + ip_version: + type: string + description: Specifies IP version of this L3 protocol.The value of the ip_version property shall be consistent with the value of the layer_protocol in the connectivity_type property of the virtual link node. + required: true + constraints: + - valid_values: [ ipv4, ipv6 ] + cidr: + type: string + description: Specifies the CIDR (Classless Inter-Domain Routing) of this L3 protocol. The value may be overridden at run-time. + required: true + ip_allocation_pools: + type: list + description: Specifies the allocation pools with start and end IP addresses for this L3 protocol. The value may be overridden at run-time. + required: false + entry_schema: + type: tosca.datatypes.nfv.IpAllocationPool + gateway_ip: + type: string + description: Specifies the gateway IP address for this L3 protocol. The value may be overridden at run-time. + required: false + dhcp_enabled: + type: boolean + description: Indicates whether DHCP (Dynamic Host Configuration Protocol) is enabled or disabled for this L3 protocol. The value may be overridden at run-time. + required: false + ipv6_address_mode: + type: string + description: Specifies IPv6 address mode. May be present when the value of the ipVersion attribute is "ipv6" and shall be absent otherwise. The value may be overridden at run-time. + required: false + constraints: + - valid_values: [ slaac, dhcpv6-stateful, dhcpv6-stateless ] + + tosca.datatypes.nfv.IpAllocationPool: + derived_from: tosca.datatypes.Root + description: Specifies a range of IP addresses + properties: + start_ip_address: + type: string + description: The IP address to be used as the first one in a pool of addresses derived from the cidr block full IP range + required: true + end_ip_address: + type: string + description: The IP address to be used as the last one in a pool of addresses derived from the cidr block full IP range + required: true + + tosca.datatypes.nfv.InstantiationLevel: + derived_from: tosca.datatypes.Root + description: Describes the scale level for each aspect that corresponds to a given level of resources to be instantiated within a deployment flavour in term of the number VNFC instances + properties: + description: + type: string + description: Human readable description of the level + required: true + scale_info: + type: map # key: aspectId + description: Represents for each aspect the scale level that corresponds to this instantiation level. scale_info shall be present if the VNF supports scaling. + required: false + entry_schema: + type: tosca.datatypes.nfv.ScaleInfo + + tosca.datatypes.nfv.VduLevel: + derived_from: tosca.datatypes.Root + description: Indicates for a given Vdu.Compute in a given level the number of instances to deploy + properties: + number_of_instances: + type: integer + description: Number of instances of VNFC based on this VDU to deploy for this level. + required: true + constraints: + - greater_or_equal: 0 + + tosca.datatypes.nfv.VnfLcmOperationsConfiguration: + derived_from: tosca.datatypes.Root + description: Represents information to configure lifecycle management operations + properties: + instantiate: + type: tosca.datatypes.nfv.VnfInstantiateOperationConfiguration + description: Configuration parameters for the InstantiateVnf operation + required: false + scale: + type: tosca.datatypes.nfv.VnfScaleOperationConfiguration + description: Configuration parameters for the ScaleVnf operation + required: false + scale_to_level: + type: tosca.datatypes.nfv.VnfScaleToLevelOperationConfiguration + description: Configuration parameters for the ScaleVnfToLevel operation + required: false + change_flavour: + type: tosca.datatypes.nfv.VnfChangeFlavourOperationConfiguration + description: Configuration parameters for the changeVnfFlavourOpConfig operation + required: false + heal: + type: tosca.datatypes.nfv.VnfHealOperationConfiguration + description: Configuration parameters for the HealVnf operation + required: false + terminate: + type: tosca.datatypes.nfv.VnfTerminateOperationConfiguration + description: Configuration parameters for the TerminateVnf operation + required: false + operate: + type: tosca.datatypes.nfv.VnfOperateOperationConfiguration + description: Configuration parameters for the OperateVnf operation + required: false + change_ext_connectivity: + type: tosca.datatypes.nfv.VnfChangeExtConnectivityOperationConfiguration + description: Configuration parameters for the changeExtVnfConnectivityOpConfig operation + required: false + + tosca.datatypes.nfv.VnfInstantiateOperationConfiguration: + derived_from: tosca.datatypes.Root + description: represents information that affect the invocation of the InstantiateVnf operation. + + tosca.datatypes.nfv.VnfScaleOperationConfiguration: + derived_from: tosca.datatypes.Root + description: Represents information that affect the invocation of the ScaleVnf operation + properties: + scaling_by_more_than_one_step_supported: + type: boolean + description: Signals whether passing a value larger than one in the numScalingSteps parameter of the ScaleVnf operation is supported by this VNF. + required: false + default: false + + tosca.datatypes.nfv.VnfScaleToLevelOperationConfiguration: + derived_from: tosca.datatypes.Root + description: represents information that affect the invocation of the ScaleVnfToLevel operation + properties: + arbitrary_target_levels_supported: + type: boolean + description: Signals whether scaling according to the parameter "scaleInfo" is supported by this VNF + required: true + + tosca.datatypes.nfv.VnfHealOperationConfiguration: + derived_from: tosca.datatypes.Root + description: represents information that affect the invocation of the HealVnf operation + properties: + causes: + type: list + description: Supported "cause" parameter values + required: false + entry_schema: + type: string + + tosca.datatypes.nfv.VnfTerminateOperationConfiguration: + derived_from: tosca.datatypes.Root + description: represents information that affect the invocation of the TerminateVnf + properties: + min_graceful_termination_timeout: + type: scalar-unit.time + description: Minimum timeout value for graceful termination of a VNF instance + required: true + max_recommended_graceful_termination_timeout: + type: scalar-unit.time + description: Maximum recommended timeout value that can be needed to gracefully terminate a VNF instance of a particular type under certain conditions, such as maximum load condition. This is provided by VNF provider as information for the operator facilitating the selection of optimal timeout value. This value is not used as constraint + required: false + + tosca.datatypes.nfv.VnfOperateOperationConfiguration: + derived_from: tosca.datatypes.Root + description: represents information that affect the invocation of the OperateVnf operation + properties: + min_graceful_stop_timeout: + type: scalar-unit.time + description: Minimum timeout value for graceful stop of a VNF instance + required: true + max_recommended_graceful_stop_timeout: + type: scalar-unit.time + description: Maximum recommended timeout value that can be needed to gracefully stop a VNF instance of a particular type under certain conditions, such as maximum load condition. This is provided by VNF provider as information for the operator facilitating the selection of optimal timeout value. This value is not used as constraint + required: false + + tosca.datatypes.nfv.ScaleInfo: + derived_from: tosca.datatypes.Root + description: Indicates for a given scaleAspect the corresponding scaleLevel + properties: + scale_level: + type: integer + description: The scale level for a particular aspect + required: true + constraints: + - greater_or_equal: 0 + + tosca.datatypes.nfv.ScalingAspect: + derived_from: tosca.datatypes.Root + properties: + name: + type: string + required: true + description: + type: string + required: true + max_scale_level: + type: integer # positiveInteger + required: true + constraints: + - greater_or_equal: 0 + step_deltas: + type: list + required: false + entry_schema: + type: string # Identifier + + tosca.datatypes.nfv.VnfConfigurableProperties: + derived_from: tosca.datatypes.Root + description: indicates configuration properties for a given VNF (e.g. related to auto scaling and auto healing). + properties: + is_autoscale_enabled: + type: boolean + description: It permits to enable (TRUE)/disable (FALSE) the auto-scaling functionality. If the properties is not present for configuring, then VNF property is not supported + required: false + is_autoheal_enabled: + type: boolean + description: It permits to enable (TRUE)/disable (FALSE) the auto-healing functionality. If the properties is not present for configuring, then VNF property is not supported + required: false + # additional_configurable_properties: + # description: It provides VNF specific configurable properties that + # can be modified using the ModifyVnfInfo operation + # required: false + # type: tosca.datatypes.nfv.VnfAdditionalConfigurableProperties + # derived types are expected to introduce + # additional_configurable_properties with its type derived from + # tosca.datatypes.nfv.VnfAdditionalConfigurableProperties + + tosca.datatypes.nfv.VnfAdditionalConfigurableProperties: + derived_from: tosca.datatypes.Root + description: is an empty base type for deriving data types for describing additional configurable properties for a given VNF + + tosca.datatypes.nfv.VnfInfoModifiableAttributes: + derived_from: tosca.datatypes.Root + description: Describes VNF-specific extension and metadata for a given VNF + #properties: + #extensions: + #type: tosca.datatypes.nfv.VnfInfoModifiableAttributesExtensions + #description: "Extension" properties of VnfInfo that are writeable + #required: false + # derived types are expected to introduce + # extensions with its type derived from + # tosca.datatypes.nfv.VnfInfoModifiableAttributesExtensions + #metadata: + #type: tosca.datatypes.nfv.VnfInfoModifiableAttributesMetadata + #description: "Metadata" properties of VnfInfo that are writeable + #required: false + # derived types are expected to introduce + # metadata with its type derived from + # tosca.datatypes.nfv.VnfInfoModifiableAttributesMetadata + + tosca.datatypes.nfv.VnfInfoModifiableAttributesExtensions: + derived_from: tosca.datatypes.Root + description: is an empty base type for deriving data types for describing VNF-specific extension + + tosca.datatypes.nfv.VnfInfoModifiableAttributesMetadata: + derived_from: tosca.datatypes.Root + description: is an empty base type for deriving data types for describing VNF-specific metadata + + tosca.datatypes.nfv.LogicalNodeData: + derived_from: tosca.datatypes.Root + description: Describes compute, memory and I/O requirements associated with a particular VDU. + properties: + logical_node_requirements: + type: map + description: The logical node-level compute, memory and I/O requirements. A map of strings that contains a set of key-value pairs that describes hardware platform specific deployment requirements, including the number of CPU cores on this logical node, a memory configuration specific to a logical node or a requirement related to the association of an I/O device with the logical node. + required: false + entry_schema: + type: string + + tosca.datatypes.nfv.SwImageData: + derived_from: tosca.datatypes.Root + description: describes information related to a software image artifact + properties: # in SOL001 v0.8.0: "properties or metadata:" + name: + type: string + description: Name of this software image + required: true + version: + type: string + description: Version of this software image + required: true + checksum: + type: tosca.datatypes.nfv.ChecksumData + description: Checksum of the software image file + required: true + container_format: + type: string + description: The container format describes the container file format in which software image is provided + required: true + constraints: + - valid_values: [ aki, ami, ari, bare, docker, ova, ovf ] + disk_format: + type: string + description: The disk format of a software image is the format of the underlying disk image + required: true + constraints: + - valid_values: [ aki, ami, ari, iso, qcow2, raw, vdi, vhd, vhdx, vmdk ] + min_disk: + type: scalar-unit.size # Number + description: The minimal disk size requirement for this software image + required: true + constraints: + - greater_or_equal: 0 B + min_ram: + type: scalar-unit.size # Number + description: The minimal RAM requirement for this software image + required: false + constraints: + - greater_or_equal: 0 B + size: + type: scalar-unit.size # Number + description: The size of this software image + required: true + operating_system: + type: string + description: Identifies the operating system used in the software image + required: false + supported_virtualisation_environments: + type: list + description: Identifies the virtualisation environments (e.g. hypervisor) compatible with this software image + required: false + entry_schema: + type: string + + tosca.datatypes.nfv.VirtualBlockStorageData: + derived_from: tosca.datatypes.Root + description: VirtualBlockStorageData describes block storage requirements associated with compute resources in a particular VDU, either as a local disk or as virtual attached storage + properties: + size_of_storage: + type: scalar-unit.size + description: Size of virtualised storage resource + required: true + constraints: + - greater_or_equal: 0 B + vdu_storage_requirements: + type: map + description: The hardware platform specific storage requirements. A map of strings that contains a set of key-value pairs that represents the hardware platform specific storage deployment requirements. + required: false + entry_schema: + type: string + rdma_enabled: + type: boolean + description: Indicates if the storage support RDMA + required: false + default: false + + tosca.datatypes.nfv.VirtualObjectStorageData: + derived_from: tosca.datatypes.Root + description: VirtualObjectStorageData describes object storage requirements associated with compute resources in a particular VDU + properties: + max_size_of_storage: + type: scalar-unit.size + description: Maximum size of virtualized storage resource + required: false + constraints: + - greater_or_equal: 0 B + + tosca.datatypes.nfv.VirtualFileStorageData: + derived_from: tosca.datatypes.Root + description: VirtualFileStorageData describes file storage requirements associated with compute resources in a particular VDU + properties: + size_of_storage: + type: scalar-unit.size + description: Size of virtualized storage resource + required: true + constraints: + - greater_or_equal: 0 B + file_system_protocol: + type: string + description: The shared file system protocol (e.g. NFS, CIFS) + required: true + + tosca.datatypes.nfv.VirtualLinkBitrateLevel: + derived_from: tosca.datatypes.Root + description: Describes bitrate requirements applicable to the virtual link instantiated from a particicular VnfVirtualLink + properties: + bitrate_requirements: + type: tosca.datatypes.nfv.LinkBitrateRequirements + description: Virtual link bitrate requirements for an instantiation level or bitrate delta for a scaling step + required: true + + tosca.datatypes.nfv.VnfOperationAdditionalParameters: + derived_from: tosca.datatypes.Root + description: Is an empty base type for deriving data type for describing VNF-specific parameters to be passed when invoking lifecycle management operations + #properties: + + tosca.datatypes.nfv.VnfChangeFlavourOperationConfiguration: + derived_from: tosca.datatypes.Root + description: represents information that affect the invocation of the ChangeVnfFlavour operation + #properties: + + tosca.datatypes.nfv.VnfChangeExtConnectivityOperationConfiguration: + derived_from: tosca.datatypes.Root + description: represents information that affect the invocation of the ChangeExtVnfConnectivity operation + #properties: + + tosca.datatypes.nfv.VnfMonitoringParameter: + derived_from: tosca.datatypes.Root + description: Represents information on virtualised resource related performance metrics applicable to the VNF. + properties: + name: + type: string + description: Human readable name of the monitoring parameter + required: true + performance_metric: + type: string + description: Identifies the performance metric, according to ETSI GS NFV-IFA 027. + required: true + constraints: + - valid_values: [ v_cpu_usage_mean_vnf, v_cpu_usage_peak_vnf, v_memory_usage_mean_vnf, v_memory_usage_peak_vnf, v_disk_usage_mean_vnf, v_disk_usage_peak_vnf, byte_incoming_vnf_ext_cp, byte_outgoing_vnf_ext_cp, +packet_incoming_vnf_ext_cp, packet_outgoing_vnf_ext_cp ] + collection_period: + type: scalar-unit.time + description: Describes the periodicity at which to collect the performance information. + required: false + constraints: + - greater_than: 0 s + + tosca.datatypes.nfv.VnfcMonitoringParameter: + derived_from: tosca.datatypes.Root + description: Represents information on virtualised resource related performance metrics applicable to the VNF. + properties: + name: + type: string + description: Human readable name of the monitoring parameter + required: true + performance_metric: + type: string + description: Identifies the performance metric, according to ETSI GS NFV-IFA 027. + required: true + constraints: + - valid_values: [ v_cpu_usage_mean_vnf, v_cpu_usage_peak_vnf, v_memory_usage_mean_vnf, v_memory_usage_peak_vnf, v_disk_usage_mean_vnf, v_disk_usage_peak_vnf, byte_incoming_vnf_int_cp, byte_outgoing_vnf_int_cp, packet_incoming_vnf_int_cp, packet_outgoing_vnf_int_cp ] + collection_period: + type: scalar-unit.time + description: Describes the periodicity at which to collect the performance information. + required: false + constraints: + - greater_than: 0 s + + tosca.datatypes.nfv.VirtualLinkMonitoringParameter: + derived_from: tosca.datatypes.Root + description: Represents information on virtualised resource related performance metrics applicable to the VNF. + properties: + name: + type: string + description: Human readable name of the monitoring parameter + required: true + performance_metric: + type: string + description: Identifies a performance metric derived from those defined in ETSI GS NFV-IFA 027.The packetOutgoingVirtualLink and packetIncomingVirtualLink metrics shall be obtained by aggregation the PacketOutgoing and PacketIncoming measurements defined in clause 7.1 of GS NFV-IFA 027 of all virtual link ports attached to the virtual link to which the metrics apply. + required: true + constraints: + - valid_values: [ packet_outgoing_virtual_link, packet_incoming_virtual_link ] + collection_period: + type: scalar-unit.time + description: Describes the periodicity at which to collect the performance information. + required: false + constraints: + - greater_than: 0 s + + tosca.datatypes.nfv.InterfaceDetails: + derived_from: tosca.datatypes.Root + description: information used to access an interface exposed by a VNF + properties: + uri_components: + type: tosca.datatypes.nfv.UriComponents + description: Provides components to build a Uniform Ressource Identifier (URI) where to access the interface end point. + required: false + interface_specific_data: + type: map + description: Provides additional details that are specific to the type of interface considered. + required: false + entry_schema: + type: string + + tosca.datatypes.nfv.UriComponents: + derived_from: tosca.datatypes.Root + description: information used to build a URI that complies with IETF RFC 3986 [8]. + properties: + scheme: + type: string # shall comply with IETF RFC3986 + description: scheme component of a URI. + required: true + authority: + type: tosca.datatypes.nfv.UriAuthority + description: Authority component of a URI + required: false + path: + type: string # shall comply with IETF RFC 3986 + description: path component of a URI. + required: false + query: + type: string # shall comply with IETF RFC 3986 + description: query component of a URI. + required: false + fragment: + type: string # shall comply with IETF RFC 3986 + description: fragment component of a URI. + required: false + + tosca.datatypes.nfv.UriAuthority: + derived_from: tosca.datatypes.Root + description: information that corresponds to the authority component of a URI as specified in IETF RFC 3986 [8] + properties: + user_info: + type: string # shall comply with IETF RFC 3986 + description: user_info field of the authority component of a URI + required: false + host: + type: string # shall comply with IETF RFC 3986 + description: host field of the authority component of a URI + required: false + port: + type: string # shall comply with IETF RFC 3986 + description: port field of the authority component of a URI + required: false + + tosca.datatypes.nfv.ChecksumData: + derived_from: tosca.datatypes.Root + description: Describes information about the result of performing a checksum operation over some arbitrary data + properties: + algorithm: + type: string + description: Describes the algorithm used to obtain the checksum value + required: true + constraints: + - valid_values: [sha-224, sha-256, sha-384, sha-512 ] + hash: + type: string + description: Contains the result of applying the algorithm indicated by the algorithm property to the data to which this ChecksumData refers + required: true + +artifact_types: + tosca.artifacts.nfv.SwImage: + derived_from: tosca.artifacts.Deployment.Image + description: describes the software image which is directly loaded on the virtualisation container realizing of the VDU or is to be loaded on a virtual storage resource. + + tosca.artifacts.Implementation.nfv.Mistral: + derived_from: tosca.artifacts.Implementation + description: artifacts for Mistral workflows + mime_type: application/x-yaml + file_ext: [ yaml ] + +capability_types: + tosca.capabilities.nfv.VirtualBindable: + derived_from: tosca.capabilities.Node + description: Indicates that the node that includes it can be pointed by a tosca.relationships.nfv.VirtualBindsTo relationship type which is used to model the VduHasCpd association + + tosca.capabilities.nfv.VirtualCompute: + derived_from: tosca.capabilities.Node + description: Describes the capabilities related to virtual compute resources + properties: + logical_node: + type: map + description: Describes the Logical Node requirements + required: false + entry_schema: + type: tosca.datatypes.nfv.LogicalNodeData + requested_additional_capabilities: + type: map + description: Describes additional capability for a particular VDU + required: false + entry_schema: + type: tosca.datatypes.nfv.RequestedAdditionalCapability + compute_requirements: + type: map + required: false + entry_schema: + type: string + virtual_memory: + type: tosca.datatypes.nfv.VirtualMemory + description: Describes virtual memory of the virtualized compute + required: true + virtual_cpu: + type: tosca.datatypes.nfv.VirtualCpu + description: Describes virtual CPU(s) of the virtualized compute + required: true + virtual_local_storage: + type: list + description: A list of virtual system disks created and destroyed as part of the VM lifecycle + required: false + entry_schema: + type: tosca.datatypes.nfv.VirtualBlockStorageData + description: virtual system disk definition + + tosca.capabilities.nfv.VirtualStorage: + derived_from: tosca.capabilities.Root + description: Describes the attachment capabilities related to Vdu.Storage + +relationship_types: + tosca.relationships.nfv.VirtualBindsTo: + derived_from: tosca.relationships.DependsOn + description: Represents an association relationship between Vdu.Compute and VduCp node types + valid_target_types: [ tosca.capabilities.nfv.VirtualBindable ] + + tosca.relationships.nfv.AttachesTo: + derived_from: tosca.relationships.Root + description: Represents an association relationship between the Vdu.Compute and one of the node types, Vdu.VirtualBlockStorage, Vdu.VirtualObjectStorage or Vdu.VirtualFileStorage + valid_target_types: [ tosca.capabilities.nfv.VirtualStorage ] + +interface_types: + tosca.interfaces.nfv.Vnflcm: + derived_from: tosca.interfaces.Root + description: This interface encompasses a set of TOSCA operations corresponding to the VNF LCM operations defined in ETSI GS NFV-IFA 007 as well as to preamble and postamble procedures to the execution of the VNF LCM operations. + instantiate: + description: Invoked upon receipt of an Instantiate VNF request + # inputs: + # additional_parameters: + # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters + # required: false + # derived types are expected to introduce additional_parameters with + # its type derived from + # tosca.datatypes.nfv.VnfOperationAdditionalParameters + instantiate_start: + description: Invoked before instantiate + instantiate_end: + description: Invoked after instantiate + terminate: + description: Invoked upon receipt Terminate VNF request + # inputs: + # additional_parameters: + # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters + # required: false + # derived types are expected to introduce additional_parameters with + # its type derived from + # tosca.datatypes.nfv.VnfOperationAdditionalParameters + terminate_start: + description: Invoked before terminate + terminate_end: + description: Invoked after terminate + modify_information: + description: Invoked upon receipt of a Modify VNF Information request + modify_information_start: + description: Invoked before modify_information + modify_information_end: + description: Invoked after modify_information + change_flavour: + description: Invoked upon receipt of a Change VNF Flavour request + # inputs: + # additional_parameters: + # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters + # required: false + # derived types are expected to introduce additional_parameters with + # its type derived from + # tosca.datatypes.nfv.VnfOperationAdditionalParameters + change_flavour_start: + description: Invoked before change_flavour + change_flavour_end: + description: Invoked after change_flavour + change_external_connectivity: + description: Invoked upon receipt of a Change External VNF Connectivity request + # inputs: + # additional_parameters: + # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters + # required: false + # derived types are expected to introduce additional_parameters with + # its type derived from + # tosca.datatypes.nfv.VnfOperationAdditionalParameters + change_external_connectivity_start: + description: Invoked before change_external_connectivity + change_external_connectivity_end: + description: Invoked after change_external_connectivity + operate: + description: Invoked upon receipt of an Operate VNF request + # inputs: + # additional_parameters: + # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters + # required: false + # derived types are expected to introduce additional_parameters with + # its type derived from + # tosca.datatypes.nfv.VnfOperationAdditionalParameters + operate_start: + description: Invoked before operate + operate_end: + description: Invoked after operate + heal: + description: Invoked upon receipt of a Heal VNF request + # inputs: + # additional_parameters: + # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters + # required: false + # derived types are expected to introduce additional_parameters with + # its type derived from + # tosca.datatypes.nfv.VnfOperationAdditionalParameters + heal_start: + description: Invoked before heal + heal_end: + description: Invoked after heal + scale: + description: Invoked upon receipt of a Scale VNF request + # inputs: + # additional_parameters: + # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters + # required: false + # derived types are expected to introduce additional_parameters with + # its type derived from + # tosca.datatypes.nfv.VnfOperationAdditionalParameters + scale_start: + description: Invoked before scale + scale_end: + description: Invoked after scale + scale_to_level: + description: Invoked upon receipt of a Scale VNF to Level request + # inputs: + # additional_parameters: + # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters + # required: false + # derived types are expected to introduce additional_parameters with + # its type derived from + # tosca.datatypes.nfv.VnfOperationAdditionalParameters + scale_to_level_start: + description: Invoked before scale_to_level + scale_to_level_end: + description: Invoked after scale_to_level + +node_types: + tosca.nodes.nfv.VNF: + derived_from: tosca.nodes.Root + description: The generic abstract type from which all VNF specific abstract node types shall be derived to form, together with other node types, the TOSCA service template(s) representing the VNFD + properties: + descriptor_id: # instead of vnfd_id + type: string # GUID + description: Globally unique identifier of the VNFD + required: true + descriptor_version: # instead of vnfd_version + type: string + description: Identifies the version of the VNFD + required: true + provider: # instead of vnf_provider + type: string + description: Provider of the VNF and of the VNFD + required: true + product_name: # instead of vnf_product_name + type: string + description: Human readable name for the VNF Product + required: true + software_version: # instead of vnf_software_version + type: string + description: Software version of the VNF + required: true + product_info_name: # instead of vnf_product_info_name + type: string + description: Human readable name for the VNF Product + required: false + product_info_description: # instead of vnf_product_info_description + type: string + description: Human readable description of the VNF Product + required: false + vnfm_info: + type: list + required: true + description: Identifies VNFM(s) compatible with the VNF + entry_schema: + type: string + constraints: + - pattern: (^etsivnfm:v[0-9]?[0-9]\.[0-9]?[0-9]\.[0-9]?[0-9]$)|(^[0-9]+:[a-zA-Z0-9.-]+$) + localization_languages: + type: list + description: Information about localization languages of the VNF + required: false + entry_schema: + type: string #IETF RFC 5646 string + default_localization_language: + type: string #IETF RFC 5646 string + description: Default localization language that is instantiated if no information about selected localization language is available + required: false + #configurable_properties: + #type: tosca.datatypes.nfv.VnfConfigurableProperties + #description: Describes the configurable properties of the VNF + #required: false + # derived types are expected to introduce configurable_properties + # with its type derived from + # tosca.datatypes.nfv.VnfConfigurableProperties + #modifiable_attributes: + #type: tosca.datatypes.nfv.VnfInfoModifiableAttributes + #description: Describes the modifiable attributes of the VNF + #required: false + # derived types are expected to introduce modifiable_attributes + # with its type derived from + # tosca.datatypes.nfv.VnfInfoModifiableAttributes + lcm_operations_configuration: + type: tosca.datatypes.nfv.VnfLcmOperationsConfiguration + description: Describes the configuration parameters for the VNF LCM operations + required: false + monitoring_parameters: + type: list + entry_schema: + type: tosca.datatypes.nfv.VnfMonitoringParameter + description: Describes monitoring parameters applicable to the VNF. + required: false + flavour_id: + type: string + description: Identifier of the Deployment Flavour within the VNFD + required: true + flavour_description: + type: string + description: Human readable description of the DF + required: true + vnf_profile: + type: tosca.datatypes.nfv.VnfProfile + description: Describes a profile for instantiating VNFs of a particular NS DF according to a specific VNFD and VNF DF + required: false + requirements: + - virtual_link: + capability: tosca.capabilities.nfv.VirtualLinkable + relationship: tosca.relationships.nfv.VirtualLinksTo + occurrences: [ 0, 1 ] + # Additional requirements shall be defined in the VNF specific node type (deriving from tosca.nodes.nfv.VNF) corresponding to NS virtual links that need to connect to VnfExtCps + interfaces: + Vnflcm: + type: tosca.interfaces.nfv.Vnflcm + + tosca.nodes.nfv.VnfExtCp: + derived_from: tosca.nodes.nfv.Cp + description: Describes a logical external connection point, exposed by the VNF enabling connection with an external Virtual Link + properties: + virtual_network_interface_requirements: + type: list + description: The actual virtual NIC requirements that is been assigned when instantiating the connection point + required: false + entry_schema: + type: tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements + requirements: + - external_virtual_link: + capability: tosca.capabilities.nfv.VirtualLinkable + relationship: tosca.relationships.nfv.VirtualLinksTo + - internal_virtual_link: #name in ETSI NFV IFA011 v0.7.3: intVirtualLinkDesc + capability: tosca.capabilities.nfv.VirtualLinkable + relationship: tosca.relationships.nfv.VirtualLinksTo + + tosca.nodes.nfv.Vdu.Compute: + derived_from: tosca.nodes.Root + description: Describes the virtual compute part of a VDU which is a construct supporting the description of the deployment and operational behavior of a VNFC + properties: + name: + type: string + description: Human readable name of the VDU + required: true + description: + type: string + description: Human readable description of the VDU + required: true + boot_order: + type: list # explicit index (boot index) not necessary, contrary to IFA011 + description: References a node template name from which a valid boot device is created + required: false + entry_schema: + type: string + nfvi_constraints: + type: list + description: Describes constraints on the NFVI for the VNFC instance(s) created from this VDU + required: false + entry_schema: + type: string + monitoring_parameters: + type: list + description: Describes monitoring parameters applicable to a VNFC instantiated from this VDU + required: false + entry_schema: + type: tosca.datatypes.nfv.VnfcMonitoringParameter + #configurable_properties: + #type: tosca.datatypes.nfv.VnfcConfigurableProperties + #required: false + # derived types are expected to introduce + # configurable_properties with its type derived from + # tosca.datatypes.nfv.VnfcConfigurableProperties + vdu_profile: + type: tosca.datatypes.nfv.VduProfile + description: Defines additional instantiation data for the VDU.Compute node + required: true + sw_image_data: + type: tosca.datatypes.nfv.SwImageData + description: Defines information related to a SwImage artifact used by this Vdu.Compute node + required: false # property is required when the node template has an associated artifact of type tosca.artifacts.nfv.SwImage and not required otherwise + boot_data: + type: string + description: Contains a string or a URL to a file contained in the VNF package used to customize a virtualised compute resource at boot time. The bootData may contain variable parts that are replaced by deployment specific values before being sent to the VIM. + required: false + capabilities: + virtual_compute: + type: tosca.capabilities.nfv.VirtualCompute + occurrences: [ 1, 1 ] + virtual_binding: + type: tosca.capabilities.nfv.VirtualBindable + occurrences: [ 1, UNBOUNDED ] + requirements: + - virtual_storage: + capability: tosca.capabilities.nfv.VirtualStorage + relationship: tosca.relationships.nfv.AttachesTo + occurrences: [ 0, UNBOUNDED ] + + tosca.nodes.nfv.Vdu.VirtualBlockStorage: + derived_from: tosca.nodes.Root + description: This node type describes the specifications of requirements related to virtual block storage resources + properties: + virtual_block_storage_data: + type: tosca.datatypes.nfv.VirtualBlockStorageData + description: Describes the block storage characteristics. + required: true + sw_image_data: + type: tosca.datatypes.nfv.SwImageData + description: Defines information related to a SwImage artifact used by this Vdu.Compute node. + required: false # property is required when the node template has an associated artifact of type tosca.artifacts.nfv.SwImage and not required otherwise + capabilities: + virtual_storage: + type: tosca.capabilities.nfv.VirtualStorage + description: Defines the capabilities of virtual_storage. + + tosca.nodes.nfv.Vdu.VirtualObjectStorage: + derived_from: tosca.nodes.Root + description: This node type describes the specifications of requirements related to virtual object storage resources + properties: + virtual_object_storage_data: + type: tosca.datatypes.nfv.VirtualObjectStorageData + description: Describes the object storage characteristics. + required: true + capabilities: + virtual_storage: + type: tosca.capabilities.nfv.VirtualStorage + description: Defines the capabilities of virtual_storage. + + tosca.nodes.nfv.Vdu.VirtualFileStorage: + derived_from: tosca.nodes.Root + description: This node type describes the specifications of requirements related to virtual file storage resources + properties: + virtual_file_storage_data: + type: tosca.datatypes.nfv.VirtualFileStorageData + description: Describes the file storage characteristics. + required: true + capabilities: + virtual_storage: + type: tosca.capabilities.nfv.VirtualStorage + description: Defines the capabilities of virtual_storage. + requirements: + - virtual_link: + capability: tosca.capabilities.nfv.VirtualLinkable + relationship: tosca.relationships.nfv.VirtualLinksTo + #description: Describes the requirements for linking to virtual link + + tosca.nodes.nfv.VduCp: + derived_from: tosca.nodes.nfv.Cp + description: describes network connectivity between a VNFC instance based on this VDU and an internal VL + properties: + bitrate_requirement: + type: integer # in bits per second + description: Bitrate requirement in bit per second on this connection point + required: false + constraints: + - greater_or_equal: 0 + virtual_network_interface_requirements: + type: list + description: Specifies requirements on a virtual network interface realising the CPs instantiated from this CPD + required: false + entry_schema: + type: tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements + order: + type: integer + description: The order of the NIC on the compute instance (e.g.eth2) + required: false + constraints: + - greater_or_equal: 0 + vnic_type: + type: string + description: Describes the type of the virtual network interface realizing the CPs instantiated from this CPD + required: false + constraints: + - valid_values: [ normal, virtio, direct-physical ] + requirements: + - virtual_link: + capability: tosca.capabilities.nfv.VirtualLinkable + relationship: tosca.relationships.nfv.VirtualLinksTo + - virtual_binding: + capability: tosca.capabilities.nfv.VirtualBindable + relationship: tosca.relationships.nfv.VirtualBindsTo + node: tosca.nodes.nfv.Vdu.Compute + + tosca.nodes.nfv.VnfVirtualLink: + derived_from: tosca.nodes.Root + description: Describes the information about an internal VNF VL + properties: + connectivity_type: + type: tosca.datatypes.nfv.ConnectivityType + description: Specifies the protocol exposed by the VL and the flow pattern supported by the VL + required: true + description: + type: string + description: Provides human-readable information on the purpose of the VL + required: false + test_access: + type: list + description: Test access facilities available on the VL + required: false + entry_schema: + type: string + constraints: + - valid_values: [ passive_monitoring, active_loopback ] + vl_profile: + type: tosca.datatypes.nfv.VlProfile + description: Defines additional data for the VL + required: true + monitoring_parameters: + type: list + description: Describes monitoring parameters applicable to the VL + required: false + entry_schema: + type: tosca.datatypes.nfv.VirtualLinkMonitoringParameter + capabilities: + virtual_linkable: + type: tosca.capabilities.nfv.VirtualLinkable + +group_types: + tosca.groups.nfv.PlacementGroup: + derived_from: tosca.groups.Root + description: PlacementGroup is used for describing the affinity or anti-affinity relationship applicable between the virtualization containers to be created based on different VDUs, or between internal VLs to be created based on different VnfVirtualLinkDesc(s) + properties: + description: + type: string + description: Human readable description of the group + required: true + members: [ tosca.nodes.nfv.Vdu.Compute, tosca.nodes.nfv.VnfVirtualLink ] + +policy_types: + tosca.policies.nfv.InstantiationLevels: + derived_from: tosca.policies.Root + description: The InstantiationLevels type is a policy type representing all the instantiation levels of resources to be instantiated within a deployment flavour and including default instantiation level in term of the number of VNFC instances to be created as defined in ETSI GS NFV-IFA 011 [1]. + properties: + levels: + type: map # key: levelId + description: Describes the various levels of resources that can be used to instantiate the VNF using this flavour. + required: true + entry_schema: + type: tosca.datatypes.nfv.InstantiationLevel + constraints: + - min_length: 1 + default_level: + type: string # levelId + description: The default instantiation level for this flavour. + required: false # required if multiple entries in levels + + tosca.policies.nfv.VduInstantiationLevels: + derived_from: tosca.policies.Root + description: The VduInstantiationLevels type is a policy type representing all the instantiation levels of resources to be instantiated within a deployment flavour in term of the number of VNFC instances to be created from each vdu.Compute. as defined in ETSI GS NFV-IFA 011 [1] + properties: + levels: + type: map # key: levelId + description: Describes the Vdu.Compute levels of resources that can be used to instantiate the VNF using this flavour + required: true + entry_schema: + type: tosca.datatypes.nfv.VduLevel + constraints: + - min_length: 1 + targets: [ tosca.nodes.nfv.Vdu.Compute ] + + tosca.policies.nfv.VirtualLinkInstantiationLevels: + derived_from: tosca.policies.Root + description: The VirtualLinkInstantiationLevels type is a policy type representing all the instantiation levels of virtual link resources to be instantiated within a deployment flavour as defined in ETSI GS NFV-IFA 011 [1]. + properties: + levels: + type: map # key: levelId + description: Describes the virtual link levels of resources that can be used to instantiate the VNF using this flavour. + required: true + entry_schema: + type: tosca.datatypes.nfv.VirtualLinkBitrateLevel + constraints: + - min_length: 1 + targets: [ tosca.nodes.nfv.VnfVirtualLink ] + + tosca.policies.nfv.ScalingAspects: + derived_from: tosca.policies.Root + description: The ScalingAspects type is a policy type representing the scaling aspects used for horizontal scaling as defined in ETSI GS NFV-IFA 011 [1]. + properties: + aspects: + type: map # key: aspectId + description: Describe maximum scale level for total number of scaling steps that can be applied to a particular aspect + required: true + entry_schema: + type: tosca.datatypes.nfv.ScalingAspect + constraints: + - min_length: 1 + + tosca.policies.nfv.VduScalingAspectDeltas: + derived_from: tosca.policies.Root + description: The VduScalingAspectDeltas type is a policy type representing the Vdu.Compute detail of an aspect deltas used for horizontal scaling, as defined in ETSI GS NFV-IFA 011 [1]. + properties: + aspect: + type: string + description: Represents the scaling aspect to which this policy applies + required: true + deltas: + type: map # key: scalingDeltaId + description: Describes the Vdu.Compute scaling deltas to be applied for every scaling steps of a particular aspect. + required: true + entry_schema: + type: tosca.datatypes.nfv.VduLevel + constraints: + - min_length: 1 + targets: [ tosca.nodes.nfv.Vdu.Compute ] + + tosca.policies.nfv.VirtualLinkBitrateScalingAspectDeltas: + derived_from: tosca.policies.Root + description: The VirtualLinkBitrateScalingAspectDeltas type is a policy type representing the VnfVirtualLink detail of an aspect deltas used for horizontal scaling, as defined in ETSI GS NFV-IFA 011 [1]. + properties: + aspect: + type: string + description: Represents the scaling aspect to which this policy applies. + required: true + deltas: + type: map # key: scalingDeltaId + description: Describes the VnfVirtualLink scaling deltas to be applied for every scaling steps of a particular aspect. + required: true + entry_schema: + type: tosca.datatypes.nfv.VirtualLinkBitrateLevel + constraints: + - min_length: 1 + targets: [ tosca.nodes.nfv.VnfVirtualLink ] + + tosca.policies.nfv.VduInitialDelta: + derived_from: tosca.policies.Root + description: The VduInitialDelta type is a policy type representing the Vdu.Compute detail of an initial delta used for horizontal scaling, as defined in ETSI GS NFV-IFA 011 [1]. + properties: + initial_delta: + type: tosca.datatypes.nfv.VduLevel + description: Represents the initial minimum size of the VNF. + required: true + targets: [ tosca.nodes.nfv.Vdu.Compute ] + + tosca.policies.nfv.VirtualLinkBitrateInitialDelta: + derived_from: tosca.policies.Root + description: The VirtualLinkBitrateInitialDelta type is a policy type representing the VnfVirtualLink detail of an initial deltas used for horizontal scaling, as defined in ETSI GS NFV-IFA 011 [1]. + properties: + initial_delta: + type: tosca.datatypes.nfv.VirtualLinkBitrateLevel + description: Represents the initial minimum size of the VNF. + required: true + targets: [ tosca.nodes.nfv.VnfVirtualLink ] + + tosca.policies.nfv.AffinityRule: + derived_from: tosca.policies.Placement + description: The AffinityRule describes the affinity rules applicable for the defined targets + properties: + scope: + type: string + description: scope of the rule is an NFVI_node, an NFVI_PoP, etc. + required: true + constraints: + - valid_values: [ nfvi_node, zone, zone_group, nfvi_pop ] + targets: [ tosca.nodes.nfv.Vdu.Compute, tosca.nodes.nfv.VnfVirtualLink, tosca.groups.nfv.PlacementGroup ] + + tosca.policies.nfv.AntiAffinityRule: + derived_from: tosca.policies.Placement + description: The AntiAffinityRule describes the anti-affinity rules applicable for the defined targets + properties: + scope: + type: string + description: scope of the rule is an NFVI_node, an NFVI_PoP, etc. + required: true + constraints: + - valid_values: [ nfvi_node, zone, zone_group, nfvi_pop ] + targets: [ tosca.nodes.nfv.Vdu.Compute, tosca.nodes.nfv.VnfVirtualLink, tosca.groups.nfv.PlacementGroup ] + + tosca.policies.nfv.SecurityGroupRule: + derived_from: tosca.policies.Root + description: The SecurityGroupRule type is a policy type specified the matching criteria for the ingress and/or egress traffic to/from visited connection points as defined in ETSI GS NFV-IFA 011 [1]. + properties: + description: + type: string + description: Human readable description of the security group rule. + required: false + direction: + type: string + description: The direction in which the security group rule is applied. The direction of 'ingress' or 'egress' is specified against the associated CP. I.e., 'ingress' means the packets entering a CP, while 'egress' means the packets sent out of a CP. + required: false + constraints: + - valid_values: [ ingress, egress ] + default: ingress + ether_type: + type: string + description: Indicates the protocol carried over the Ethernet layer. + required: false + constraints: + - valid_values: [ ipv4, ipv6 ] + default: ipv4 + protocol: + type: string + description: Indicates the protocol carried over the IP layer. Permitted values include any protocol defined in the IANA protocol registry, e.g. TCP, UDP, ICMP, etc. + required: false + constraints: + - valid_values: [ hopopt, icmp, igmp, ggp, ipv4, st, tcp, cbt, egp, igp, bbn_rcc_mon, nvp_ii, pup, argus, emcon, xnet, chaos, udp, mux, dcn_meas, hmp, prm, xns_idp, trunk_1, trunk_2, leaf_1, leaf_2, rdp, irtp, iso_tp4, netblt, mfe_nsp, merit_inp, dccp, 3pc, idpr, xtp, ddp, idpr_cmtp, tp++, il, ipv6, sdrp, ipv6_route, ipv6_frag, idrp, rsvp, gre, dsr, bna, esp, ah, i_nlsp, swipe, narp, mobile, tlsp, skip, ipv6_icmp, ipv6_no_nxt, ipv6_opts, cftp, sat_expak, kryptolan, rvd, ippc, sat_mon, visa, ipcv, cpnx, cphb, wsn, pvp, br_sat_mon, sun_nd, wb_mon, wb_expak, iso_ip, vmtp, secure_vmtp, vines, ttp, iptm, nsfnet_igp, dgp, tcf, eigrp, ospfigp, sprite_rpc, larp, mtp, ax.25, ipip, micp, scc_sp, etherip, encap, gmtp, ifmp, pnni, pim, aris, scps, qnx, a/n, ip_comp, snp, compaq_peer, ipx_in_ip, vrrp, pgm, l2tp, ddx, iatp, stp, srp, uti, smp, sm, ptp, isis, fire, crtp, crudp, sscopmce, iplt, sps, pipe, sctp, fc, rsvp_e2e_ignore, mobility, udp_lite, mpls_in_ip, manet, hip, shim6, wesp, rohc ] + default: tcp + port_range_min: + type: integer + description: Indicates minimum port number in the range that is matched by the security group rule. If a value is provided at design-time, this value may be overridden at run-time based on other deployment requirements or constraints. + required: false + constraints: + - greater_or_equal: 0 + - less_or_equal: 65535 + default: 0 + port_range_max: + type: integer + description: Indicates maximum port number in the range that is matched by the security group rule. If a value is provided at design-time, this value may be overridden at run-time based on other deployment requirements or constraints. + required: false + constraints: + - greater_or_equal: 0 + - less_or_equal: 65535 + default: 65535 + targets: [ tosca.nodes.nfv.VduCp, tosca.nodes.nfv.VnfExtCp ] + + tosca.policies.nfv.SupportedVnfInterface: + derived_from: tosca.policies.Root + description: this policy type represents interfaces produced by a VNF, the details to access them and the applicable connection points to use to access these interfaces + properties: + interface_name: + type: string + description: Identifies an interface produced by the VNF. + required: true + constraints: + - valid_values: [ vnf_indicator, vnf_configuration ] + details: + type: tosca.datatypes.nfv.InterfaceDetails + description: Provide additional data to access the interface endpoint + required: false + targets: [ tosca.nodes.nfv.VnfExtCp, tosca.nodes.nfv.VduCp ] + + diff --git a/samples/mgmt_driver/private_registry_vnf_package/Definitions/sample_vnfd_df_simple.yaml b/samples/mgmt_driver/private_registry_vnf_package/Definitions/sample_vnfd_df_simple.yaml new file mode 100644 index 000000000..cbb25c2db --- /dev/null +++ b/samples/mgmt_driver/private_registry_vnf_package/Definitions/sample_vnfd_df_simple.yaml @@ -0,0 +1,101 @@ +tosca_definitions_version: tosca_simple_yaml_1_2 + +description: Sample Private registry VNF + +imports: + - etsi_nfv_sol001_common_types.yaml + - etsi_nfv_sol001_vnfd_types.yaml + - sample_vnfd_types.yaml + +topology_template: + inputs: + id: + type: string + vendor: + type: string + version: + type: version + descriptor_id: + type: string + descriptor_version: + type: string + provider: + type: string + product_name: + type: string + software_version: + type: string + vnfm_info: + type: list + entry_schema: + type: string + flavour_id: + type: string + flavour_description: + type: string + + substitution_mappings: + node_type: company.provider.VNF + properties: + flavour_id: simple + requirements: + virtual_link_external: [ CP1, virtual_link ] + + node_templates: + VNF: + type: company.provider.VNF + properties: + flavour_description: A simple flavour + interfaces: + Vnflcm: + instantiate_end: + implementation: mgmt-drivers-private-registry + heal_end: + implementation: mgmt-drivers-private-registry + artifacts: + mgmt-drivers-private-registry: + description: Management driver for Docker private registry + type: tosca.artifacts.Implementation.Python + file: Scripts/private_registry_mgmt.py + + PrivateRegistryVDU: + type: tosca.nodes.nfv.Vdu.Compute + properties: + name: PrivateRegistryVDU + description: Private registry compute node + vdu_profile: + min_number_of_instances: 1 + max_number_of_instances: 1 + sw_image_data: + name: Image for Private registry + version: '20.04' + checksum: + algorithm: sha-512 + hash: fb1a1e50f9af2df6ab18a69b6bc5df07ebe8ef962b37e556ce95350ffc8f4a1118617d486e2018d1b3586aceaeda799e6cc073f330a7ad8f0ec0416cbd825452 + container_format: bare + disk_format: qcow2 + min_disk: 0 GB + size: 2 GB + + artifacts: + sw_image: + type: tosca.artifacts.nfv.SwImage + file: ../Files/images/ubuntu-20.04-server-cloudimg-amd64.img + + capabilities: + virtual_compute: + properties: + virtual_memory: + virtual_mem_size: 4 GB + virtual_cpu: + num_virtual_cpu: 2 + virtual_local_storage: + - size_of_storage: 45 GB + + CP1: + type: tosca.nodes.nfv.VduCp + properties: + layer_protocols: [ ipv4 ] + order: 0 + requirements: + - virtual_binding: PrivateRegistryVDU diff --git a/samples/mgmt_driver/private_registry_vnf_package/Definitions/sample_vnfd_top.yaml b/samples/mgmt_driver/private_registry_vnf_package/Definitions/sample_vnfd_top.yaml new file mode 100644 index 000000000..0e60eb2b5 --- /dev/null +++ b/samples/mgmt_driver/private_registry_vnf_package/Definitions/sample_vnfd_top.yaml @@ -0,0 +1,31 @@ +tosca_definitions_version: tosca_simple_yaml_1_2 + +description: Sample Private registry VNF + +imports: + - etsi_nfv_sol001_common_types.yaml + - etsi_nfv_sol001_vnfd_types.yaml + - sample_vnfd_types.yaml + - sample_vnfd_df_simple.yaml + +topology_template: + inputs: + selected_flavour: + type: string + description: VNF deployment flavour selected by the consumer. It is provided in the API + + node_templates: + VNF: + type: company.provider.VNF + properties: + flavour_id: { get_input: selected_flavour } + descriptor_id: b1bb0ce7-ebca-4fa7-95ed-4840d70a1189 + provider: Company + product_name: Sample Private registry 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/samples/mgmt_driver/private_registry_vnf_package/Definitions/sample_vnfd_types.yaml b/samples/mgmt_driver/private_registry_vnf_package/Definitions/sample_vnfd_types.yaml new file mode 100644 index 000000000..e1631146d --- /dev/null +++ b/samples/mgmt_driver/private_registry_vnf_package/Definitions/sample_vnfd_types.yaml @@ -0,0 +1,63 @@ +tosca_definitions_version: tosca_simple_yaml_1_2 + +description: VNF type definition + +imports: + - etsi_nfv_sol001_common_types.yaml + - etsi_nfv_sol001_vnfd_types.yaml + +node_types: + company.provider.VNF: + derived_from: tosca.nodes.nfv.VNF + properties: + id: + type: string + description: ID of this VNF + default: vnf_id + vendor: + type: string + description: name of the vendor who generate this VNF + default: vendor + version: + type: version + description: version of the software for this VNF + default: 1.0 + descriptor_id: + type: string + constraints: [ valid_values: [ b1bb0ce7-ebca-4fa7-95ed-4840d70a1189 ] ] + default: b1bb0ce7-ebca-4fa7-95ed-4840d70a1189 + 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 Private registry VNF' ] ] + default: 'Sample Private registry VNF' + software_version: + type: string + constraints: [ valid_values: [ '1.0' ] ] + default: '1.0' + vnfm_info: + type: list + entry_schema: + type: string + constraints: [ valid_values: [ Tacker ] ] + default: [ Tacker ] + flavour_id: + type: string + constraints: [ valid_values: [ simple ] ] + default: simple + flavour_description: + type: string + default: "This is the default flavour description" + requirements: + - virtual_link_external: + capability: tosca.capabilities.nfv.VirtualLinkable + interfaces: + Vnflcm: + type: tosca.interfaces.nfv.Vnflcm diff --git a/samples/mgmt_driver/private_registry_vnf_package/TOSCA-Metadata/TOSCA.meta b/samples/mgmt_driver/private_registry_vnf_package/TOSCA-Metadata/TOSCA.meta new file mode 100644 index 000000000..55fae6ff9 --- /dev/null +++ b/samples/mgmt_driver/private_registry_vnf_package/TOSCA-Metadata/TOSCA.meta @@ -0,0 +1,12 @@ +TOSCA-Meta-File-Version: 1.0 +Created-by: Dummy User +CSAR-Version: 1.1 +Entry-Definitions: Definitions/sample_vnfd_top.yaml + +Name: Files/images/ubuntu-20.04-server-cloudimg-amd64.img +Content-Type: application/x-iso9066-image + +Name: Scripts/private_registry_mgmt.py +Content-Type: text/x-python +Algorithm: SHA-256 +Hash: