10 # FIXME: this should load the juju inside or modules without having to
11 # explicitly install it. Check why it's not working.
12 # Load our subtree of the juju library
13 path
= os
.path
.abspath(os
.path
.join(os
.path
.dirname(__file__
), '..'))
14 path
= os
.path
.join(path
, "modules/libjuju/")
15 if path
not in sys
.path
:
16 sys
.path
.insert(1, path
)
18 from juju
.controller
import Controller
19 from juju
.model
import Model
, ModelObserver
22 # We might need this to connect to the websocket securely, but test and verify.
24 ssl
._create
_default
_https
_context
= ssl
._create
_unverified
_context
25 except AttributeError:
26 # Legacy Python doesn't verify by default (see pep-0476)
27 # https://www.python.org/dev/peps/pep-0476/
32 class JujuCharmNotFound(Exception):
33 """The Charm can't be found or is not readable."""
36 class JujuApplicationExists(Exception):
37 """The Application already exists."""
40 class N2VCPrimitiveExecutionFailed(Exception):
41 """Something failed while attempting to execute a primitive."""
44 # Quiet the debug logging
45 logging
.getLogger('websockets.protocol').setLevel(logging
.INFO
)
46 logging
.getLogger('juju.client.connection').setLevel(logging
.WARN
)
47 logging
.getLogger('juju.model').setLevel(logging
.WARN
)
48 logging
.getLogger('juju.machine').setLevel(logging
.WARN
)
51 class VCAMonitor(ModelObserver
):
52 """Monitor state changes within the Juju Model."""
57 def __init__(self
, ns_name
):
58 self
.log
= logging
.getLogger(__name__
)
60 self
.ns_name
= ns_name
62 def AddApplication(self
, application_name
, callback
, *callback_args
):
63 if application_name
not in self
.applications
:
64 self
.applications
[application_name
] = {
66 'callback_args': callback_args
69 def RemoveApplication(self
, application_name
):
70 if application_name
in self
.applications
:
71 del self
.applications
[application_name
]
73 async def on_change(self
, delta
, old
, new
, model
):
74 """React to changes in the Juju model."""
76 if delta
.entity
== "unit":
77 # Ignore change events from other applications
78 if delta
.data
['application'] not in self
.applications
.keys():
83 application_name
= delta
.data
['application']
85 callback
= self
.applications
[application_name
]['callback']
86 callback_args
= self
.applications
[application_name
]['callback_args']
89 old_status
= old
.workload_status
90 new_status
= new
.workload_status
92 if old_status
== new_status
:
93 """The workload status may fluctuate around certain events,
94 so wait until the status has stabilized before triggering
99 delta
.data
['application'],
101 new
.workload_status_message
,
105 # This is a charm being removed
109 delta
.data
['application'],
113 except Exception as e
:
114 self
.log
.debug("[1] notify_callback exception {}".format(e
))
115 elif delta
.entity
== "action":
116 # TODO: Decide how we want to notify the user of actions
118 # uuid = delta.data['id'] # The Action's unique id
119 # msg = delta.data['message'] # The output of the action
121 # if delta.data['status'] == "pending":
122 # # The action is queued
124 # elif delta.data['status'] == "completed""
125 # # The action was successful
127 # elif delta.data['status'] == "failed":
128 # # The action failed.
136 # Create unique models per network service
137 # Document all public functions
147 authenticated
= False
171 :param vcaconfig dict A dictionary containing the VCA configuration
173 :param artifacts str The directory where charms required by a vnfd are
177 n2vc = N2VC(vcaconfig={
178 'secret': 'MzI3MDJhOTYxYmM0YzRjNTJiYmY1Yzdm',
180 'ip-address': '10.44.127.137',
182 'artifacts': '/path/to/charms'
190 self
.log
= logging
.getLogger(__name__
)
192 # Quiet websocket traffic
193 logging
.getLogger('websockets.protocol').setLevel(logging
.INFO
)
194 logging
.getLogger('juju.client.connection').setLevel(logging
.WARN
)
195 logging
.getLogger('model').setLevel(logging
.WARN
)
196 # logging.getLogger('websockets.protocol').setLevel(logging.DEBUG)
198 self
.log
.debug('JujuApi: instantiated')
204 if user
.startswith('user-'):
207 self
.user
= 'user-{}'.format(user
)
209 self
.endpoint
= '%s:%d' % (server
, int(port
))
211 self
.artifacts
= artifacts
214 """Close any open connections."""
217 def notify_callback(self
, model_name
, application_name
, status
, message
, callback
=None, *callback_args
):
220 callback(model_name
, application_name
, status
, message
, *callback_args
)
221 except Exception as e
:
222 self
.log
.error("[0] notify_callback exception {}".format(e
))
227 async def CreateNetworkService(self
, nsd
):
228 """Create a new model to encapsulate this network service.
230 Create a new model in the Juju controller to encapsulate the
231 charms associated with a network service.
233 You can pass either the nsd record or the id of the network
234 service, but this method will fail without one of them.
236 if not self
.authenticated
:
239 # Ideally, we will create a unique model per network service.
240 # This change will require all components, i.e., LCM and SO, to use
241 # N2VC for 100% compatibility. If we adopt unique models for the LCM,
242 # services deployed via LCM would't be manageable via SO and vice versa
244 return self
.default_model
246 async def DeployCharms(self
, model_name
, application_name
, vnfd
, charm_path
, params
={}, machine_spec
={}, callback
=None, *callback_args
):
247 """Deploy one or more charms associated with a VNF.
249 Deploy the charm(s) referenced in a VNF Descriptor.
251 :param str model_name: The name of the network service.
252 :param str application_name: The name of the application
253 :param dict vnfd: The name of the application
254 :param str charm_path: The path to the Juju charm
255 :param dict params: A dictionary of runtime parameters
258 'rw_mgmt_ip': '1.2.3.4',
259 # Pass the initial-config-primitives section of the vnf or vdu
260 'initial-config-primitives': {...}
262 :param dict machine_spec: A dictionary describing the machine to install to
265 'hostname': '1.2.3.4',
266 'username': 'ubuntu',
268 :param obj callback: A callback function to receive status changes.
269 :param tuple callback_args: A list of arguments to be passed to the callback
272 ########################################################
273 # Verify the path to the charm exists and is readable. #
274 ########################################################
275 if not os
.path
.exists(charm_path
):
276 self
.log
.debug("Charm path doesn't exist: {}".format(charm_path
))
277 self
.notify_callback(model_name
, application_name
, "failed", callback
, *callback_args
)
278 raise JujuCharmNotFound("No artifacts configured.")
280 ################################
281 # Login to the Juju controller #
282 ################################
283 if not self
.authenticated
:
284 self
.log
.debug("Authenticating with Juju")
287 ##########################################
288 # Get the model for this network service #
289 ##########################################
290 # TODO: In a point release, we will use a model per deployed network
291 # service. In the meantime, we will always use the 'default' model.
292 model_name
= 'default'
293 model
= await self
.get_model(model_name
)
295 ########################################
296 # Verify the application doesn't exist #
297 ########################################
298 app
= await self
.get_application(model
, application_name
)
300 raise JujuApplicationExists("Can't deploy application \"{}\" to model \"{}\" because it already exists.".format(application_name
, model_name
))
302 ################################################################
303 # Register this application with the model-level event monitor #
304 ################################################################
306 self
.monitors
[model_name
].AddApplication(
312 ########################################################
313 # Check for specific machine placement (native charms) #
314 ########################################################
316 if machine_spec
.keys():
317 # TODO: This needs to be tested.
318 # if all(k in machine_spec for k in ['hostname', 'username']):
319 # # Enlist the existing machine in Juju
320 # machine = await self.model.add_machine(spec='ssh:%@%'.format(
327 #######################################
328 # Get the initial charm configuration #
329 #######################################
332 if 'rw_mgmt_ip' in params
:
333 rw_mgmt_ip
= params
['rw_mgmt_ip']
335 initial_config
= self
._get
_config
_from
_dict
(
336 params
['initial-config-primitive'],
337 {'<rw_mgmt_ip>': rw_mgmt_ip
}
340 self
.log
.debug("JujuApi: Deploying charm ({}) from {}".format(
346 ########################################################
347 # Deploy the charm and apply the initial configuration #
348 ########################################################
349 app
= await model
.deploy(
350 # We expect charm_path to be either the path to the charm on disk
351 # or in the format of cs:series/name
353 # This is the formatted, unique name for this charm
354 application_name
=application_name
,
355 # Proxy charms should use the current LTS. This will need to be
356 # changed for native charms.
358 # Apply the initial 'config' primitive during deployment
359 config
=initial_config
,
360 # TBD: Where to deploy the charm to.
364 # #######################################
365 # # Execute initial config primitive(s) #
366 # #######################################
369 # Build a sequential list of the primitives to execute
370 for primitive
in params
['initial-config-primitive']:
372 if primitive
['name'] == 'config':
373 # This is applied when the Application is deployed
376 seq
= primitive
['seq']
379 if 'parameter' in primitive
:
380 params
= primitive
['parameter']
383 'name': primitive
['name'],
384 'parameters': self
._map
_primitive
_parameters
(
386 {'<rw_mgmt_ip>': rw_mgmt_ip
}
390 for primitive
in sorted(primitives
):
391 await self
.ExecutePrimitive(
394 primitives
[primitive
]['name'],
397 **primitives
[primitive
]['parameters'],
399 except N2VCPrimitiveExecutionFailed
as e
:
401 "[N2VC] Exception executing primitive: {}".format(e
)
405 async def ExecutePrimitive(self
, model_name
, application_name
, primitive
, callback
, *callback_args
, **params
):
406 """Execute a primitive of a charm for Day 1 or Day 2 configuration.
408 Execute a primitive defined in the VNF descriptor.
410 :param str model_name: The name of the network service.
411 :param str application_name: The name of the application
412 :param str primitive: The name of the primitive to execute.
413 :param obj callback: A callback function to receive status changes.
414 :param tuple callback_args: A list of arguments to be passed to the callback function.
415 :param dict params: A dictionary of key=value pairs representing the primitive's parameters
418 'rw_mgmt_ip': '1.2.3.4',
419 # Pass the initial-config-primitives section of the vnf or vdu
420 'initial-config-primitives': {...}
425 if not self
.authenticated
:
428 # FIXME: This is hard-coded until model-per-ns is added
429 model_name
= 'default'
431 model
= await self
.controller
.get_model(model_name
)
433 if primitive
== 'config':
434 # config is special, and expecting params to be a dictionary
435 self
.log
.debug("Setting charm configuration for {}".format(application_name
))
436 self
.log
.debug(params
['params'])
437 await self
.set_config(model
, application_name
, params
['params'])
439 app
= await self
.get_application(model
, application_name
)
441 # Run against the first (and probably only) unit in the app
444 self
.log
.debug("Executing primitive {}".format(primitive
))
445 action
= await unit
.run_action(primitive
, **params
)
447 await model
.disconnect()
448 except Exception as e
:
449 self
.log
.debug("Caught exception while executing primitive: {}".format(e
))
453 async def RemoveCharms(self
, model_name
, application_name
, callback
=None, *callback_args
):
454 """Remove a charm from the VCA.
456 Remove a charm referenced in a VNF Descriptor.
458 :param str model_name: The name of the network service.
459 :param str application_name: The name of the application
460 :param obj callback: A callback function to receive status changes.
461 :param tuple callback_args: A list of arguments to be passed to the callback function.
464 if not self
.authenticated
:
467 model
= await self
.get_model(model_name
)
468 app
= await self
.get_application(model
, application_name
)
470 # Remove this application from event monitoring
471 self
.monitors
[model_name
].RemoveApplication(application_name
)
473 # self.notify_callback(model_name, application_name, "removing", callback, *callback_args)
474 self
.log
.debug("Removing the application {}".format(application_name
))
477 # Notify the callback that this charm has been removed.
478 self
.notify_callback(model_name
, application_name
, "removed", callback
, *callback_args
)
480 except Exception as e
:
481 print("Caught exception: {}".format(e
))
485 async def DestroyNetworkService(self
, nsd
):
486 raise NotImplementedError()
488 async def GetMetrics(self
, model_name
, application_name
):
489 """Get the metrics collected by the VCA.
491 :param model_name The name of the model
492 :param application_name The name of the application
495 model
= await self
.get_model(model_name
)
496 app
= await self
.get_application(model
, application_name
)
498 metrics
= await app
.get_metrics()
503 async def add_relation(self
, a
, b
, via
=None):
505 Add a relation between two application endpoints.
507 :param a An application endpoint
508 :param b An application endpoint
509 :param via The egress subnet(s) for outbound traffic, e.g.,
510 (192.168.0.0/16,10.0.0.0/8)
512 if not self
.authenticated
:
515 m
= await self
.get_model()
517 m
.add_relation(a
, b
, via
)
521 # async def apply_config(self, config, application):
522 # """Apply a configuration to the application."""
523 # print("JujuApi: Applying configuration to {}.".format(
526 # return await self.set_config(application=application, config=config)
528 def _get_config_from_dict(self
, config_primitive
, values
):
529 """Transform the yang config primitive to dict.
538 for primitive
in config_primitive
:
539 if primitive
['name'] == 'config':
540 # config = self._map_primitive_parameters()
541 for parameter
in primitive
['parameter']:
542 param
= str(parameter
['name'])
543 if parameter
['value'] == "<rw_mgmt_ip>":
544 config
[param
] = str(values
[parameter
['value']])
546 config
[param
] = str(parameter
['value'])
550 def _map_primitive_parameters(self
, parameters
, values
):
552 for parameter
in parameters
:
553 param
= str(parameter
['name'])
554 if parameter
['value'] == "<rw_mgmt_ip>":
555 params
[param
] = str(values
[parameter
['value']])
557 params
[param
] = str(parameter
['value'])
560 def _get_config_from_yang(self
, config_primitive
, values
):
561 """Transform the yang config primitive to dict."""
563 for primitive
in config_primitive
.values():
564 if primitive
['name'] == 'config':
565 for parameter
in primitive
['parameter'].values():
566 param
= str(parameter
['name'])
567 if parameter
['value'] == "<rw_mgmt_ip>":
568 config
[param
] = str(values
[parameter
['value']])
570 config
[param
] = str(parameter
['value'])
574 def FormatApplicationName(self
, *args
):
576 Generate a Juju-compatible Application name
578 :param args tuple: Positional arguments to be used to construct the
582 - Only accepts characters a-z and non-consequitive dashes (-)
583 - Application name should not exceed 50 characters
587 FormatApplicationName("ping_pong_ns", "ping_vnf", "a")
591 for c
in "-".join(list(args
)):
594 elif not c
.isalpha():
597 return re
.sub('\-+', '-', appname
.lower())
600 # def format_application_name(self, nsd_name, vnfr_name, member_vnf_index=0):
601 # """Format the name of the application
604 # - Only accepts characters a-z and non-consequitive dashes (-)
605 # - Application name should not exceed 50 characters
607 # name = "{}-{}-{}".format(nsd_name, vnfr_name, member_vnf_index)
611 # c = chr(97 + int(c))
612 # elif not c.isalpha():
615 # return re.sub('\-+', '-', new_name.lower())
617 def format_model_name(self
, name
):
618 """Format the name of model.
620 Model names may only contain lowercase letters, digits and hyphens
623 return name
.replace('_', '-').lower()
625 async def get_application(self
, model
, application
):
626 """Get the deployed application."""
627 if not self
.authenticated
:
631 if application
and model
:
632 if model
.applications
:
633 if application
in model
.applications
:
634 app
= model
.applications
[application
]
638 async def get_model(self
, model_name
='default'):
639 """Get a model from the Juju Controller.
641 Note: Model objects returned must call disconnected() before it goes
643 if not self
.authenticated
:
646 if model_name
not in self
.models
:
647 print("connecting to model {}".format(model_name
))
648 self
.models
[model_name
] = await self
.controller
.get_model(model_name
)
650 # Create an observer for this model
651 self
.monitors
[model_name
] = VCAMonitor(model_name
)
652 self
.models
[model_name
].add_observer(self
.monitors
[model_name
])
654 return self
.models
[model_name
]
656 async def login(self
):
657 """Login to the Juju controller."""
659 if self
.authenticated
:
662 self
.connecting
= True
664 self
.log
.debug("JujuApi: Logging into controller")
667 self
.controller
= Controller()
670 self
.log
.debug("Connecting to controller... ws://{}:{} as {}/{}".format(self
.endpoint
, self
.port
, self
.user
, self
.secret
))
671 await self
.controller
.connect(
672 endpoint
=self
.endpoint
,
674 password
=self
.secret
,
678 # current_controller no longer exists
679 # self.log.debug("Connecting to current controller...")
680 # await self.controller.connect_current()
681 # await self.controller.connect(
682 # endpoint=self.endpoint,
683 # username=self.user,
686 self
.log
.fatal("VCA credentials not configured.")
688 self
.authenticated
= True
689 self
.log
.debug("JujuApi: Logged into controller")
691 # self.default_model = await self.controller.get_model("default")
693 async def logout(self
):
694 """Logout of the Juju controller."""
695 if not self
.authenticated
:
699 if self
.default_model
:
700 self
.log
.debug("Disconnecting model {}".format(self
.default_model
))
701 await self
.default_model
.disconnect()
702 self
.default_model
= None
704 for model
in self
.models
:
705 await self
.models
[model
].disconnect()
708 self
.log
.debug("Disconnecting controller {}".format(self
.controller
))
709 await self
.controller
.disconnect()
710 # self.controller = None
712 self
.authenticated
= False
713 except Exception as e
:
714 self
.log
.fail("Fatal error logging out of Juju Controller: {}".format(e
))
718 # async def remove_application(self, name):
719 # """Remove the application."""
720 # if not self.authenticated:
723 # app = await self.get_application(name)
725 # self.log.debug("JujuApi: Destroying application {}".format(
729 # await app.destroy()
731 async def remove_relation(self
, a
, b
):
733 Remove a relation between two application endpoints
735 :param a An application endpoint
736 :param b An application endpoint
738 if not self
.authenticated
:
741 m
= await self
.get_model()
743 m
.remove_relation(a
, b
)
747 async def resolve_error(self
, application
=None):
748 """Resolve units in error state."""
749 if not self
.authenticated
:
752 app
= await self
.get_application(self
.default_model
, application
)
754 self
.log
.debug("JujuApi: Resolving errors for application {}".format(
758 for unit
in app
.units
:
759 app
.resolved(retry
=True)
761 async def run_action(self
, application
, action_name
, **params
):
762 """Execute an action and return an Action object."""
763 if not self
.authenticated
:
772 app
= await self
.get_application(self
.default_model
, application
)
774 # We currently only have one unit per application
775 # so use the first unit available.
778 self
.log
.debug("JujuApi: Running Action {} against Application {}".format(
783 action
= await unit
.run_action(action_name
, **params
)
785 # Wait for the action to complete
788 result
['status'] = action
.status
789 result
['action']['tag'] = action
.data
['id']
790 result
['action']['results'] = action
.results
794 async def set_config(self
, model_name
, application
, config
):
795 """Apply a configuration to the application."""
796 if not self
.authenticated
:
799 app
= await self
.get_application(model_name
, application
)
801 self
.log
.debug("JujuApi: Setting config for Application {}".format(
804 await app
.set_config(config
)
806 # Verify the config is set
807 newconf
= await app
.get_config()
809 if config
[key
] != newconf
[key
]['value']:
810 self
.log
.debug("JujuApi: Config not set! Key {} Value {} doesn't match {}".format(key
, config
[key
], newconf
[key
]))
812 # async def set_parameter(self, parameter, value, application=None):
813 # """Set a config parameter for a service."""
814 # if not self.authenticated:
817 # self.log.debug("JujuApi: Setting {}={} for Application {}".format(
822 # return await self.apply_config(
823 # {parameter: value},
824 # application=application,
827 async def wait_for_application(self
, name
, timeout
=300):
828 """Wait for an application to become active."""
829 if not self
.authenticated
:
832 app
= await self
.get_application(self
.default_model
, name
)
835 "JujuApi: Waiting {} seconds for Application {}".format(
841 await self
.default_model
.block_until(
843 unit
.agent_status
== 'idle'
844 and unit
.workload_status
845 in ['active', 'unknown'] for unit
in app
.units