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
))
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 'name': primitive
['name'],
380 'parameters': self
._map
_primitive
_parameters
(
381 primitive
['parameter'],
382 {'<rw_mgmt_ip>': rw_mgmt_ip
}
386 for primitive
in sorted(primitives
):
387 await self
.ExecutePrimitive(
390 primitives
[primitive
]['name'],
393 **primitives
[primitive
]['parameters'],
395 except N2VCPrimitiveExecutionFailed
as e
:
397 "[N2VC] Exception executing primitive: {}".format(e
)
401 async def ExecutePrimitive(self
, model_name
, application_name
, primitive
, callback
, *callback_args
, **params
):
402 """Execute a primitive of a charm for Day 1 or Day 2 configuration.
404 Execute a primitive defined in the VNF descriptor.
406 :param str model_name: The name of the network service.
407 :param str application_name: The name of the application
408 :param str primitive: The name of the primitive to execute.
409 :param obj callback: A callback function to receive status changes.
410 :param tuple callback_args: A list of arguments to be passed to the callback function.
411 :param dict params: A dictionary of key=value pairs representing the primitive's parameters
414 'rw_mgmt_ip': '1.2.3.4',
415 # Pass the initial-config-primitives section of the vnf or vdu
416 'initial-config-primitives': {...}
421 if not self
.authenticated
:
424 # FIXME: This is hard-coded until model-per-ns is added
425 model_name
= 'default'
427 model
= await self
.controller
.get_model(model_name
)
429 if primitive
== 'config':
430 # config is special, and expecting params to be a dictionary
431 self
.log
.debug("Setting charm configuration for {}".format(application_name
))
432 self
.log
.debug(params
['params'])
433 await self
.set_config(model
, application_name
, params
['params'])
435 app
= await self
.get_application(model
, application_name
)
437 # Run against the first (and probably only) unit in the app
440 self
.log
.debug("Executing primitive {}".format(primitive
))
441 action
= await unit
.run_action(primitive
, **params
)
443 await model
.disconnect()
444 except Exception as e
:
445 self
.log
.debug("Caught exception while executing primitive: {}".format(e
))
449 async def RemoveCharms(self
, model_name
, application_name
, callback
=None, *callback_args
):
450 """Remove a charm from the VCA.
452 Remove a charm referenced in a VNF Descriptor.
454 :param str model_name: The name of the network service.
455 :param str application_name: The name of the application
456 :param obj callback: A callback function to receive status changes.
457 :param tuple callback_args: A list of arguments to be passed to the callback function.
460 if not self
.authenticated
:
463 model
= await self
.get_model(model_name
)
464 app
= await self
.get_application(model
, application_name
)
466 # Remove this application from event monitoring
467 self
.monitors
[model_name
].RemoveApplication(application_name
)
469 # self.notify_callback(model_name, application_name, "removing", callback, *callback_args)
470 self
.log
.debug("Removing the application {}".format(application_name
))
473 # Notify the callback that this charm has been removed.
474 self
.notify_callback(model_name
, application_name
, "removed", callback
, *callback_args
)
476 except Exception as e
:
477 print("Caught exception: {}".format(e
))
481 async def DestroyNetworkService(self
, nsd
):
482 raise NotImplementedError()
484 async def GetMetrics(self
, model_name
, application_name
):
485 """Get the metrics collected by the VCA.
487 :param model_name The name of the model
488 :param application_name The name of the application
491 model
= await self
.get_model(model_name
)
492 app
= await self
.get_application(model
, application_name
)
494 metrics
= await app
.get_metrics()
499 async def add_relation(self
, a
, b
, via
=None):
501 Add a relation between two application endpoints.
503 :param a An application endpoint
504 :param b An application endpoint
505 :param via The egress subnet(s) for outbound traffic, e.g.,
506 (192.168.0.0/16,10.0.0.0/8)
508 if not self
.authenticated
:
511 m
= await self
.get_model()
513 m
.add_relation(a
, b
, via
)
517 # async def apply_config(self, config, application):
518 # """Apply a configuration to the application."""
519 # print("JujuApi: Applying configuration to {}.".format(
522 # return await self.set_config(application=application, config=config)
524 def _get_config_from_dict(self
, config_primitive
, values
):
525 """Transform the yang config primitive to dict.
534 for primitive
in config_primitive
:
535 if primitive
['name'] == 'config':
536 # config = self._map_primitive_parameters()
537 for parameter
in primitive
['parameter']:
538 param
= str(parameter
['name'])
539 if parameter
['value'] == "<rw_mgmt_ip>":
540 config
[param
] = str(values
[parameter
['value']])
542 config
[param
] = str(parameter
['value'])
546 def _map_primitive_parameters(self
, parameters
, values
):
548 for parameter
in parameters
:
549 param
= str(parameter
['name'])
550 if parameter
['value'] == "<rw_mgmt_ip>":
551 params
[param
] = str(values
[parameter
['value']])
553 params
[param
] = str(parameter
['value'])
556 def _get_config_from_yang(self
, config_primitive
, values
):
557 """Transform the yang config primitive to dict."""
559 for primitive
in config_primitive
.values():
560 if primitive
['name'] == 'config':
561 for parameter
in primitive
['parameter'].values():
562 param
= str(parameter
['name'])
563 if parameter
['value'] == "<rw_mgmt_ip>":
564 config
[param
] = str(values
[parameter
['value']])
566 config
[param
] = str(parameter
['value'])
570 def FormatApplicationName(self
, *args
):
572 Generate a Juju-compatible Application name
574 :param args tuple: Positional arguments to be used to construct the
578 - Only accepts characters a-z and non-consequitive dashes (-)
579 - Application name should not exceed 50 characters
583 FormatApplicationName("ping_pong_ns", "ping_vnf", "a")
587 for c
in "-".join(list(args
)):
590 elif not c
.isalpha():
593 return re
.sub('\-+', '-', appname
.lower())
596 # def format_application_name(self, nsd_name, vnfr_name, member_vnf_index=0):
597 # """Format the name of the application
600 # - Only accepts characters a-z and non-consequitive dashes (-)
601 # - Application name should not exceed 50 characters
603 # name = "{}-{}-{}".format(nsd_name, vnfr_name, member_vnf_index)
607 # c = chr(97 + int(c))
608 # elif not c.isalpha():
611 # return re.sub('\-+', '-', new_name.lower())
613 def format_model_name(self
, name
):
614 """Format the name of model.
616 Model names may only contain lowercase letters, digits and hyphens
619 return name
.replace('_', '-').lower()
621 async def get_application(self
, model
, application
):
622 """Get the deployed application."""
623 if not self
.authenticated
:
627 if application
and model
:
628 if model
.applications
:
629 if application
in model
.applications
:
630 app
= model
.applications
[application
]
634 async def get_model(self
, model_name
='default'):
635 """Get a model from the Juju Controller.
637 Note: Model objects returned must call disconnected() before it goes
639 if not self
.authenticated
:
642 if model_name
not in self
.models
:
643 print("connecting to model {}".format(model_name
))
644 self
.models
[model_name
] = await self
.controller
.get_model(model_name
)
646 # Create an observer for this model
647 self
.monitors
[model_name
] = VCAMonitor(model_name
)
648 self
.models
[model_name
].add_observer(self
.monitors
[model_name
])
650 return self
.models
[model_name
]
652 async def login(self
):
653 """Login to the Juju controller."""
655 if self
.authenticated
:
658 self
.connecting
= True
660 self
.log
.debug("JujuApi: Logging into controller")
663 self
.controller
= Controller()
666 self
.log
.debug("Connecting to controller... ws://{}:{} as {}/{}".format(self
.endpoint
, self
.port
, self
.user
, self
.secret
))
667 await self
.controller
.connect(
668 endpoint
=self
.endpoint
,
670 password
=self
.secret
,
674 # current_controller no longer exists
675 # self.log.debug("Connecting to current controller...")
676 # await self.controller.connect_current()
677 # await self.controller.connect(
678 # endpoint=self.endpoint,
679 # username=self.user,
682 self
.log
.fatal("VCA credentials not configured.")
684 self
.authenticated
= True
685 self
.log
.debug("JujuApi: Logged into controller")
687 # self.default_model = await self.controller.get_model("default")
689 async def logout(self
):
690 """Logout of the Juju controller."""
691 if not self
.authenticated
:
695 if self
.default_model
:
696 self
.log
.debug("Disconnecting model {}".format(self
.default_model
))
697 await self
.default_model
.disconnect()
698 self
.default_model
= None
700 for model
in self
.models
:
701 await self
.models
[model
].disconnect()
704 self
.log
.debug("Disconnecting controller {}".format(self
.controller
))
705 await self
.controller
.disconnect()
706 # self.controller = None
708 self
.authenticated
= False
709 except Exception as e
:
710 self
.log
.fail("Fatal error logging out of Juju Controller: {}".format(e
))
714 # async def remove_application(self, name):
715 # """Remove the application."""
716 # if not self.authenticated:
719 # app = await self.get_application(name)
721 # self.log.debug("JujuApi: Destroying application {}".format(
725 # await app.destroy()
727 async def remove_relation(self
, a
, b
):
729 Remove a relation between two application endpoints
731 :param a An application endpoint
732 :param b An application endpoint
734 if not self
.authenticated
:
737 m
= await self
.get_model()
739 m
.remove_relation(a
, b
)
743 async def resolve_error(self
, application
=None):
744 """Resolve units in error state."""
745 if not self
.authenticated
:
748 app
= await self
.get_application(self
.default_model
, application
)
750 self
.log
.debug("JujuApi: Resolving errors for application {}".format(
754 for unit
in app
.units
:
755 app
.resolved(retry
=True)
757 async def run_action(self
, application
, action_name
, **params
):
758 """Execute an action and return an Action object."""
759 if not self
.authenticated
:
768 app
= await self
.get_application(self
.default_model
, application
)
770 # We currently only have one unit per application
771 # so use the first unit available.
774 self
.log
.debug("JujuApi: Running Action {} against Application {}".format(
779 action
= await unit
.run_action(action_name
, **params
)
781 # Wait for the action to complete
784 result
['status'] = action
.status
785 result
['action']['tag'] = action
.data
['id']
786 result
['action']['results'] = action
.results
790 async def set_config(self
, model_name
, application
, config
):
791 """Apply a configuration to the application."""
792 if not self
.authenticated
:
795 app
= await self
.get_application(model_name
, application
)
797 self
.log
.debug("JujuApi: Setting config for Application {}".format(
800 await app
.set_config(config
)
802 # Verify the config is set
803 newconf
= await app
.get_config()
805 if config
[key
] != newconf
[key
]['value']:
806 self
.log
.debug("JujuApi: Config not set! Key {} Value {} doesn't match {}".format(key
, config
[key
], newconf
[key
]))
808 # async def set_parameter(self, parameter, value, application=None):
809 # """Set a config parameter for a service."""
810 # if not self.authenticated:
813 # self.log.debug("JujuApi: Setting {}={} for Application {}".format(
818 # return await self.apply_config(
819 # {parameter: value},
820 # application=application,
823 async def wait_for_application(self
, name
, timeout
=300):
824 """Wait for an application to become active."""
825 if not self
.authenticated
:
828 app
= await self
.get_application(self
.default_model
, name
)
831 "JujuApi: Waiting {} seconds for Application {}".format(
837 await self
.default_model
.block_until(
839 unit
.agent_status
== 'idle'
840 and unit
.workload_status
841 in ['active', 'unknown'] for unit
in app
.units