1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
from typing import Iterable
from uuid import uuid4
from onapsdk.aai.business import Customer, ServiceInstance, ServiceSubscription
from onapsdk.configuration import settings
from onapsdk.exceptions import APIError, ResourceNotFound
from onapsdk.k8s import Definition
from onapsdk.so.instantiation import InstantiationParameter
from yaml import SafeLoader, load
import onaptests.utils.exceptions as onap_test_exceptions
from ..base import BaseStep
from .vnf_ala_carte import YamlTemplateVnfAlaCarteInstantiateStep
class K8SProfileStep(BaseStep):
"""CreateK8sProfileStep."""
def __init__(self):
"""Initialize step.
"""
super().__init__(cleanup=settings.CLEANUP_FLAG)
self._yaml_template: dict = None
self._service_instance_name: str = None
self._service_instance: ServiceInstance = None
self.add_step(YamlTemplateVnfAlaCarteInstantiateStep())
@property
def description(self) -> str:
"""Step description."""
return "Create K8S profile."
@property
def component(self) -> str:
"""Component name."""
return "K8S plugin"
@property
def yaml_template(self) -> dict:
"""Step YAML template.
Load from file if it's a root step, get from parent otherwise.
Returns:
dict: Step YAML template
"""
if self.is_root:
if not self._yaml_template:
with open(settings.SERVICE_YAML_TEMPLATE, "r", encoding="utf-8") as yaml_template:
self._yaml_template: dict = load(yaml_template, SafeLoader)
return self._yaml_template
return self.parent.yaml_template
@property
def service_name(self) -> str:
"""Service name.
Get from YAML template if it's a root step, get from parent otherwise.
Returns:
str: Service name
"""
if self.is_root:
return next(iter(self.yaml_template.keys()))
return self.parent.service_name
@property
def service_instance_name(self) -> str:
"""Service instance name.
Generate using `service_name` and `uuid4()` function if it's a root step,
get from parent otherwise.
Returns:
str: Service instance name
"""
if self.is_root:
if not self._service_instance_name:
self._service_instance_name: str = f"{self.service_name}-{str(uuid4())}"
return self._service_instance_name
return self.parent.service_instance_name
def get_vnf_parameters(self, vnf_name: str) -> Iterable[InstantiationParameter]:
"""Get VNF parameters from YAML template.
Args:
vnf_name (str): VNF name to get parameters for.
Yields:
Iterator[Iterable[InstantiationParameter]]: VNF parameter
"""
# workaround, as VNF name differs from model name (added " 0")
vnf_name = vnf_name.split()[0]
for vnf in self.yaml_template[self.service_name]["vnfs"]:
if vnf["vnf_name"] == vnf_name:
for vnf_parameter in vnf["vnf_parameters"]:
yield InstantiationParameter(
name=vnf_parameter["name"],
value=vnf_parameter["value"]
)
@BaseStep.store_state
def execute(self):
"""Creation of k8s profile for resource bundle definition
Use settings values:
- GLOBAL_CUSTOMER_ID
- K8S_PROFILE_K8S_VERSION
- K8S_PROFILE_ARTIFACT_PATH.
"""
self._logger.info("Create the k8s profile if it doesn't exist")
super().execute()
customer: Customer = Customer.get_by_global_customer_id(settings.GLOBAL_CUSTOMER_ID)
service_subscription: ServiceSubscription = \
customer.get_service_subscription_by_service_type(self.service_name)
self._service_instance: ServiceInstance = \
service_subscription.get_service_instance_by_name(self.service_instance_name)
for vnf_instance in self._service_instance.vnf_instances:
# possible to have several modules for 1 VNF
for vf_module in vnf_instance.vnf.vf_modules:
# Define profile (rb_profile) for resource bundle definition
# Retrieve resource bundle definition (rbdef) corresponding to vf module
rbdef_name = vf_module.model_invariant_uuid
rbdef_version = vf_module.model_customization_id
rbdef = Definition.get_definition_by_name_version(rbdef_name, rbdef_version)
# Get k8s profile name from yaml service template
vnf_parameters = self.get_vnf_parameters(vnf_instance.vnf.name)
k8s_profile_name = ""
k8s_profile_namespace = ""
for param in vnf_parameters:
if param.name == "k8s-rb-profile-name":
k8s_profile_name = param.value
if param.name == "k8s-rb-profile-namespace":
k8s_profile_namespace = param.value
if k8s_profile_name == "" or k8s_profile_namespace == "":
self._logger.error("Missing rb profile information")
raise onap_test_exceptions.ProfileInformationException
# Check profile for Definition
try:
rbdef.get_profile_by_name(k8s_profile_name)
except ResourceNotFound:
# Create profile for Definition
profile = rbdef.create_profile(k8s_profile_name,
k8s_profile_namespace,
settings.K8S_PROFILE_K8S_VERSION)
# Upload artifact for created profile
with open(settings.K8S_PROFILE_ARTIFACT_PATH, 'rb') as k8s_profile:
profile.upload_artifact(k8s_profile.read())
@BaseStep.store_state(cleanup=True)
def cleanup(self) -> None:
"""Cleanup K8S profiles.
"""
self._logger.info("Clean the k8s profile")
for vnf_instance in self._service_instance.vnf_instances:
# possible to have several modules for 1 VNF
for vf_module in vnf_instance.vnf.vf_modules:
# Retrieve resource bundle definition (rbdef) corresponding to vf module
rbdef_name = vf_module.model_invariant_uuid
rbdef_version = vf_module.model_customization_id
rbdef = Definition.get_definition_by_name_version(rbdef_name, rbdef_version)
# Get k8s profile name from yaml service template
vnf_parameters = self.get_vnf_parameters(vnf_instance.vnf.name)
k8s_profile_name = ""
for param in vnf_parameters:
if param.name == "k8s-rb-profile-name":
k8s_profile_name = param.value
if k8s_profile_name == "":
self._logger.error("K8s profile deletion failed, missing rb profile name")
raise onap_test_exceptions.ProfileInformationException
# Delete profile for Definition
try:
profile = rbdef.get_profile_by_name(k8s_profile_name)
profile.delete()
except APIError as exc:
self._logger.error("K8s profile deletion %s failed", k8s_profile_name)
raise onap_test_exceptions.ProfileCleanupException from exc
super().cleanup()
|
