b003df8da86707b8cf163e237413ecd702e40696
2 # Copyright 2016 RIFT.IO Inc
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
24 import rift
.mano
.utils
.juju_api
as juju
25 from . import riftcm_config_plugin
28 def get_vnf_unique_name(nsr_name
, vnfr_name
, member_vnf_index
):
29 """Get the unique VNF name.
30 Charm names accepts only a to z and non-consecutive - characters."""
31 name
= "{}-{}-{}".format(nsr_name
, vnfr_name
, member_vnf_index
)
39 return re
.sub('\-+', '-', new_name
.lower())
42 class JujuConfigPlugin(riftcm_config_plugin
.RiftCMConfigPluginBase
):
44 Juju implementation of the riftcm_config_plugin.RiftCMConfigPluginBase
46 def __init__(self
, dts
, log
, loop
, project
, account
):
47 riftcm_config_plugin
.RiftCMConfigPluginBase
.__init
__(self
, dts
, log
, loop
,
49 self
._name
= account
.name
51 self
._ip
_address
= account
.juju
.ip_address
52 self
._port
= account
.juju
.port
53 self
._user
= account
.juju
.user
54 self
._secret
= account
.juju
.secret
55 self
._rift
_install
_dir
= os
.environ
['RIFT_INSTALL']
56 self
._rift
_var
_root
_dir
= os
.environ
['RIFT_VAR_ROOT']
58 ############################################################
59 # This is wrongfully overloaded with 'juju' private data. #
60 # Really need to separate agent_vnfr from juju vnfr data. #
61 # Currently, this holds agent_vnfr, which has actual vnfr, #
62 # then this juju overloads actual vnfr with its own #
63 # dictionary elemetns (WRONG!!!) #
65 ############################################################
68 self
._api
= juju
.JujuApi(log
, loop
,
69 self
._ip
_address
, self
._port
,
70 self
._user
, self
._secret
)
89 host
=self
._ip
_address
,
95 def vnfr(self
, vnfr_id
):
97 vnfr
= self
._juju
_vnfs
[vnfr_id
].vnfr
99 self
._log
.error("jujuCA: Did not find VNFR %s in juju plugin", vnfr_id
)
104 def get_service_name(self
, vnfr_id
):
105 vnfr
= self
.vnfr(vnfr_id
)
106 if vnfr
and 'vnf_juju_name' in vnfr
:
107 return vnfr
['vnf_juju_name']
110 def juju_log(self
, level
, name
, log_str
, *args
):
112 g_log_str
= 'jujuCA:({}) {}'.format(name
, log_str
)
114 g_log_str
= 'jujuCA: {}'.format(log_str
)
115 getattr(self
._log
, level
)(g_log_str
, *args
)
117 # TBD: Do a better, similar to config manager
118 def xlate(self
, tag
, tags
):
123 if re
.search('<.*>', tag
):
124 self
._log
.debug("jujuCA: Xlate value %s", tag
)
126 if tag
== '<rw_mgmt_ip>':
127 val
= tags
['rw_mgmt_ip']
128 except KeyError as e
:
129 self
._log
.info("jujuCA: Did not get a value for tag %s, e=%s",
134 def notify_create_vlr(self
, agent_nsr
, agent_vnfr
, vld
, vlr
):
136 Notification of create VL record
141 def notify_create_vnfr(self
, agent_nsr
, agent_vnfr
):
143 Notification of create Network VNF record
144 Returns True if configured using config_agent
146 # Deploy the charm if specified for the vnf
147 self
._log
.debug("jujuCA: create vnfr nsr=%s vnfr=%s",
148 agent_nsr
.name
, agent_vnfr
.name
)
149 self
._log
.debug("jujuCA: Config = %s",
150 agent_vnfr
.vnf_configuration
)
152 vnf_config
= agent_vnfr
.vnfr_msg
.vnf_configuration
153 self
._log
.debug("jujuCA: vnf_configuration = %s", vnf_config
)
154 if not vnf_config
.has_field('juju'):
156 charm
= vnf_config
.juju
.charm
157 self
._log
.debug("jujuCA: charm = %s", charm
)
158 except Exception as e
:
159 self
._log
.Error("jujuCA: vnf_configuration error for vnfr {}: {}".
160 format(agent_vnfr
.name
, e
))
163 # Prepare unique name for this VNF
164 vnf_unique_name
= get_vnf_unique_name(agent_nsr
.name
,
166 agent_vnfr
.member_vnf_index
)
167 if vnf_unique_name
in self
._tasks
:
168 self
._log
.warn("jujuCA: Service %s already deployed",
171 vnfr_dict
= agent_vnfr
.vnfr
172 vnfr_dict
.update({'vnf_juju_name': vnf_unique_name
,
174 'nsr_id': agent_nsr
.id,
175 'member_vnf_index': agent_vnfr
.member_vnf_index
,
178 'config': vnf_config
,
179 'vnfr_name': agent_vnfr
.name
})
180 self
._log
.debug("jujuCA: Charm %s for vnf %s to be deployed as %s",
181 charm
, agent_vnfr
.name
, vnf_unique_name
)
183 # Find the charm directory
185 path
= os
.path
.join(self
._rift
_var
_root
_dir
,
186 'launchpad/packages/vnfd',
188 agent_vnfr
.vnfr_msg
.vnfd
.id,
191 self
._log
.debug("jujuCA: Charm dir is {}".format(path
))
192 if not os
.path
.isdir(path
):
193 msg
= "jujuCA: Did not find the charm directory at {}".format(path
)
196 # Return from here instead of forwarding the config request to juju_api
198 except Exception as e
:
199 self
.log
.exception(e
)
202 if vnf_unique_name
not in self
._tasks
:
203 self
._tasks
[vnf_unique_name
] = {}
205 self
._log
.debug("jujuCA: Deploying service %s",
207 yield from self
.api
.deploy_application(
215 def notify_instantiate_vnfr(self
, agent_nsr
, agent_vnfr
):
217 Notification of Instantiate NSR with the passed nsr id
222 def notify_instantiate_vlr(self
, agent_nsr
, agent_vnfr
, vlr
):
224 Notification of Instantiate NSR with the passed nsr id
229 def notify_terminate_nsr(self
, agent_nsr
, agent_vnfr
):
231 Notification of Terminate the network service
236 def notify_terminate_vnfr(self
, agent_nsr
, agent_vnfr
):
238 Notification of Terminate the network service
240 self
._log
.debug("jujuCA: Terminate VNFr {}, current vnfrs={}".
241 format(agent_vnfr
.name
, self
._juju
_vnfs
))
243 vnfr
= agent_vnfr
.vnfr
244 service
= vnfr
['vnf_juju_name']
246 self
._log
.debug("jujuCA: Terminating VNFr {}, {}".format(
250 yield from self
.api
.remove_application(service
)
252 del self
._juju
_vnfs
[agent_vnfr
.id]
253 self
._log
.debug("jujuCA: current vnfrs={}".
254 format(self
._juju
_vnfs
))
255 if service
in self
._tasks
:
257 for action
in self
._tasks
[service
].keys():
260 except KeyError as e
:
261 self
._log
.debug ("jujuCA: Terminating charm service for VNFr {}, e={}".
262 format(agent_vnfr
.name
, e
))
263 except Exception as e
:
264 self
._log
.error("jujuCA: Exception terminating charm service for VNFR {}: {}".
265 format(agent_vnfr
.name
, e
))
270 def notify_terminate_vlr(self
, agent_nsr
, agent_vnfr
, vlr
):
272 Notification of Terminate the virtual link
277 def _vnf_config_primitive(self
, nsr_id
, vnfr_id
, primitive
,
278 vnf_config
=None, wait
=False):
279 self
._log
.debug("jujuCA: VNF config primitive {} for nsr {}, "
281 format(primitive
, nsr_id
, vnfr_id
))
283 if vnf_config
is None:
284 vnfr_msg
= yield from self
.get_vnfr(vnfr_id
)
286 msg
= "Unable to get VNFR {} through DTS".format(vnfr_id
)
290 vnf_config
= vnfr_msg
.vnf_configuration
291 self
._log
.debug("VNF config= %s", vnf_config
.as_dict())
294 service
= vnfr
['vnf_juju_name']
295 self
._log
.debug("VNF config %s", vnf_config
)
296 configs
= vnf_config
.config_primitive
297 for config
in configs
:
298 if config
.name
== primitive
.name
:
299 self
._log
.debug("jujuCA: Found the config primitive %s",
302 for parameter
in config
.parameter
:
304 for p
in primitive
.parameter
:
305 if p
.name
== parameter
.name
:
307 val
= self
.xlate(p
.value
, vnfr
['tags'])
311 val
= parameter
.default_value
314 # Check if mandatory parameter
315 if parameter
.mandatory
:
316 msg
= "VNFR {}: Primitive {} called " \
317 "without mandatory parameter {}". \
318 format(vnfr_msg
.name
, config
.name
,
321 return 'failed', '', msg
324 val
= self
.convert_value(val
, parameter
.data_type
)
325 params
.update({parameter
.name
: val
})
330 if config
.name
== 'config':
333 self
._log
.debug("jujuCA: applying config with "
334 "params {} for service {}".
335 format(params
, service
))
337 rc
= yield from self
.api
.apply_config(params
, application
=service
)
341 self
._log
.debug("jujuCA: applied config {} "
342 "on {}".format(params
, service
))
346 'Failed to apply config: {}'.format(params
)
347 self
._log
.error("jujuCA: Error applying "
348 "config {} on service {}".
349 format(params
, service
))
351 self
._log
.warn("jujuCA: Did not find valid "
352 "parameters for config : {}".
353 format(primitive
.parameter
))
356 self
._log
.debug("jujuCA: Execute action {} on "
357 "service {} with params {}".
358 format(config
.name
, service
, params
))
360 resp
= yield from self
.api
.execute_action(
368 details
= resp
['error']['message']
370 exec_id
= resp
['action']['tag']
373 details
= resp
['message']
375 self
._log
.debug("jujuCA: execute action {} on "
376 "service {} returned {}".
377 format(config
.name
, service
, rc
))
379 self
._log
.error("jujuCA: error executing action "
381 format(config
.name
, service
,
385 details
= "Failed to queue the action"
388 except KeyError as e
:
389 msg
= "VNF %s does not have config primitives, e=%s", \
391 self
._log
.exception(msg
)
392 raise ValueError(msg
)
394 while wait
and (rc
in ['pending', 'running']):
395 self
._log
.debug("JujuCA: action {}, rc {}".
397 yield from asyncio
.sleep(0.2, loop
=self
._loop
)
398 status
= yield from self
.api
.get_action_status(exec_id
)
399 rc
= status
['status']
401 return rc
, exec_id
, details
404 def vnf_config_primitive(self
, nsr_id
, vnfr_id
, primitive
, output
):
406 vnfr
= self
._juju
_vnfs
[vnfr_id
].vnfr
408 msg
= "Did not find VNFR {} in Juju plugin".format(vnfr_id
)
412 output
.execution_status
= "failed"
413 output
.execution_id
= ''
414 output
.execution_error_details
= ''
416 rc
, exec_id
, err
= yield from self
._vnf
_config
_primitive
(
421 self
._log
.debug("VNFR {} primitive {} exec status: {}".
422 format(vnfr
.name
, primitive
.name
, rc
))
423 output
.execution_status
= rc
424 output
.execution_id
= exec_id
425 output
.execution_error_details
= err
428 def apply_config(self
, agent_nsr
, agent_vnfr
, config
, rpc_ip
):
429 """ Notification on configuration of an NSR """
433 def apply_ns_config(self
, agent_nsr
, agent_vnfrs
, rpc_ip
):
436 ###### TBD - This really does not belong here. Looks more like NS level script ####
437 ###### apply_config should be called for a particular VNF only here ###############
439 Hook: Runs the user defined script. Feeds all the necessary data
440 for the script thro' yaml file.
443 rpc_ip (YangInput_Nsr_ExecNsConfigPrimitive): The input data.
444 nsr (NetworkServiceRecord): Description
445 vnfrs (dict): VNFR ID => VirtualNetworkFunctionRecord
448 def get_meta(agent_nsr
):
449 unit_names
, initial_params
, vnfr_index_map
= {}, {}, {}
451 for vnfr_id
in agent_nsr
.vnfr_ids
:
452 juju_vnf
= self
._juju
_vnfs
[vnfr_id
].vnfr
455 vnfr_index_map
[vnfr_id
] = juju_vnf
['member_vnf_index']
458 unit_names
[vnfr_id
] = juju_vnf
['vnf_juju_name']
460 # Flatten the data for simplicity
462 self
._log
.debug("Juju Config:%s", juju_vnf
['config'])
463 for primitive
in juju_vnf
['config'].initial_config_primitive
:
464 for parameter
in primitive
.parameter
:
465 value
= self
.xlate(parameter
.value
, juju_vnf
['tags'])
466 param_data
[parameter
.name
] = value
468 initial_params
[vnfr_id
] = param_data
471 return unit_names
, initial_params
, vnfr_index_map
473 unit_names
, init_data
, vnfr_index_map
= get_meta(agent_nsr
)
475 # The data consists of 4 sections
477 # 2. The input passed.
478 # 3. Juju unit names (keyed by vnfr ID).
479 # 4. Initial config data (keyed by vnfr ID).
481 data
['config_agent'] = dict(
483 host
=self
._ip
_address
,
488 data
["rpc_ip"] = rpc_ip
.as_dict()
489 data
["unit_names"] = unit_names
490 data
["init_config"] = init_data
491 data
["vnfr_index_map"] = vnfr_index_map
494 with tempfile
.NamedTemporaryFile(delete
=False) as tmp_file
:
495 tmp_file
.write(yaml
.dump(data
, default_flow_style
=True)
498 self
._log
.debug("jujuCA: Creating a temp file: {} with input data".format(
501 # Get the full path to the script
503 if rpc_ip
.user_defined_script
[0] == '/':
504 # The script has full path, use as is
505 script
= rpc_ip
.user_defined_script
507 script
= os
.path
.join(self
._rift
_var
_root
_dir
, 'launchpad/nsd',
509 agent_nsr
.id, 'scripts',
510 rpc_ip
.user_defined_script
)
511 self
.log
.debug("jujuCA: Checking for script in %s", script
)
512 if not os
.path
.exists(script
):
513 script
= os
.path
.join(self
._rift
_install
_dir
, 'usr/bin', rpc_ip
.user_defined_script
)
515 cmd
= "{} {}".format(rpc_ip
.user_defined_script
, tmp_file
.name
)
516 self
._log
.debug("jujuCA: Running the CMD: {}".format(cmd
))
518 coro
= asyncio
.create_subprocess_shell(cmd
, loop
=self
._loop
,
519 stderr
=asyncio
.subprocess
.PIPE
)
520 process
= yield from coro
521 err
= yield from process
.stderr
.read()
522 task
= self
._loop
.create_task(process
.wait())
527 def apply_initial_config(self
, agent_nsr
, agent_vnfr
):
529 Apply the initial configuration
530 Expect config directives mostly, not actions
531 Actions in initial config may not work based on charm design
535 vnfr
= self
._juju
_vnfs
[agent_vnfr
.id].vnfr
536 service
= vnfr
['vnf_juju_name']
538 self
._log
.debug("Did not find VNFR %s in Juju plugin",
542 vnfr_msg
= yield from self
.get_vnfr(agent_vnfr
.id)
544 msg
= "Unable to get VNFR {} ({}) through DTS". \
545 format(agent_vnfr
.id, agent_vnfr
.name
)
547 raise RuntimeError(msg
)
549 vnf_config
= vnfr_msg
.vnf_configuration
550 self
._log
.debug("VNFR %s config: %s", vnfr_msg
.name
,
551 vnf_config
.as_dict())
553 # Sort the primitive based on the sequence number
554 primitives
= sorted(vnf_config
.initial_config_primitive
,
557 self
._log
.debug("VNFR {}: No initial-config-primitive specified".
558 format(vnfr_msg
.name
))
561 rc
= yield from self
.api
.is_application_up(application
=service
)
566 if vnfr_msg
.mgmt_interface
.ip_address
:
567 vnfr
['tags'].update({'rw_mgmt_ip': vnfr_msg
.mgmt_interface
.ip_address
})
568 self
._log
.debug("jujuCA:(%s) tags: %s", vnfr
['vnf_juju_name'], vnfr
['tags'])
570 for primitive
in primitives
:
571 self
._log
.debug("(%s) Initial config primitive %s",
572 vnfr
['vnf_juju_name'], primitive
.as_dict())
573 if primitive
.config_primitive_ref
:
574 # Reference to a primitive in config primitive
576 def __init__(self
, name
):
581 prim
= Primitive(primitive
.config_primitive_ref
)
582 rc
, eid
, err
= yield from self
._vnf
_config
_primitive
(
590 msg
= "Error executing initial config primitive" \
591 " {} in VNFR {}: rc={}, stderr={}". \
592 format(prim
.name
, vnfr_msg
.name
, rc
, err
)
598 if primitive
.name
== 'config':
599 for param
in primitive
.parameter
:
601 val
= self
.xlate(param
.value
,
603 config
.update({param
.name
: val
})
606 self
.juju_log('info', vnfr
['vnf_juju_name'],
607 "Applying Initial config:%s",
610 rc
= yield from self
.api
.apply_config(
615 self
.log
.error("Service {} is in error state".format(service
))
618 # Apply any actions specified as part of initial config
619 for primitive
in vnfr
['config'].initial_config_primitive
:
620 if primitive
.name
!= 'config':
621 self
._log
.debug("jujuCA:(%s) Initial config action primitive %s",
622 vnfr
['vnf_juju_name'], primitive
)
623 action
= primitive
.name
625 for param
in primitive
.parameter
:
626 val
= self
.xlate(param
.value
, vnfr
['tags'])
627 params
.update({param
.name
: val
})
629 self
._log
.info("jujuCA:(%s) Action %s with params %s",
630 vnfr
['vnf_juju_name'], action
, params
)
631 self
._log
.debug("executing action")
632 resp
= yield from self
.api
.execute_action(
637 self
._log
.debug("executed action")
639 self
._log
.error("Applying initial config on {} failed for {} with {}: {}".
640 format(vnfr
['vnf_juju_name'], action
, params
, resp
))
642 except KeyError as e
:
643 self
._log
.info("Juju config agent(%s): VNFR %s not managed by Juju",
644 vnfr
['vnf_juju_name'], agent_vnfr
.id)
646 except Exception as e
:
647 self
._log
.exception("jujuCA:(%s) Exception juju "
648 "apply_initial_config for VNFR {}: {}".
649 format(vnfr
['vnf_juju_name'],
655 def add_vnfr_managed(self
, agent_vnfr
):
656 if agent_vnfr
.id not in self
._juju
_vnfs
.keys():
657 self
._log
.info("juju config agent: add vnfr={}/{}".
658 format(agent_vnfr
.name
, agent_vnfr
.id))
659 self
._juju
_vnfs
[agent_vnfr
.id] = agent_vnfr
661 def is_vnfr_managed(self
, vnfr_id
):
663 if vnfr_id
in self
._juju
_vnfs
:
665 except Exception as e
:
666 self
._log
.debug("jujuCA: Is VNFR {} managed: {}".
671 def is_configured(self
, vnfr_id
):
673 agent_vnfr
= self
._juju
_vnfs
[vnfr_id
]
674 vnfr
= agent_vnfr
.vnfr
678 vnfr
= self
._juju
_vnfs
[vnfr_id
].vnfr
679 service
= vnfr
['vnf_juju_name']
680 resp
= self
.api
.is_application_active(application
=service
)
681 self
._juju
_vnfs
[vnfr_id
]['active'] = resp
682 self
._log
.debug("jujuCA: Service state for {} is {}".
683 format(service
, resp
))
687 self
._log
.debug("jujuCA: VNFR id {} not found in config agent".
690 except Exception as e
:
691 self
._log
.error("jujuCA: VNFR id {} is_configured: {}".
696 def get_config_status(self
, agent_nsr
, agent_vnfr
):
697 """Get the configuration status for the VNF"""
701 vnfr
= agent_vnfr
.vnfr
702 service
= vnfr
['vnf_juju_name']
704 # This VNF is not managed by Juju
710 # Get the status of the application
711 resp
= yield from self
.api
.get_application_status(service
)
713 # No status means the application is still pending deployment
722 self
._log
.error("jujuCA: Check unknown service %s status", service
)
723 except Exception as e
:
724 self
._log
.error("jujuCA: Caught exception when checking for service is active: %s", e
)
725 self
._log
.exception(e
)
729 def get_action_status(self
, execution_id
):
730 ''' Get the action status for an execution ID
731 *** Make sure this is NOT a asyncio coroutine function ***
735 self
._log
.debug("jujuCA: Get action status for {}".format(execution_id
))
736 resp
= self
.api
._get
_action
_status
(execution_id
)
737 self
._log
.debug("jujuCA: Action status: {}".format(resp
))
739 except Exception as e
:
740 self
._log
.error("jujuCA: Error fetching execution status for %s",
742 self
._log
.exception(e
)
745 def get_service_status(self
, vnfr_id
):
746 '''Get the service status, used by job status handle
747 Make sure this is NOT a coroutine
749 service
= self
.get_service_name(vnfr_id
)
751 self
._log
.error("jujuCA: VNFR {} not managed by this Juju agent".
755 # Delay for 3 seconds before checking as config apply takes a
756 # few seconds to transfer to the service
758 return self
.api
._get
_service
_status
(service
=service
)