1 # Copyright 2020 Canonical Ltd.
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
22 from juju
.model
import Model
23 from juju
.machine
import Machine
24 from juju
.application
import Application
25 from juju
.unit
import Unit
26 from juju
.client
._definitions
import (
28 QueryApplicationOffersResults
,
32 from juju
.controller
import Controller
33 from juju
.client
import client
36 from n2vc
.juju_watcher
import JujuModelWatcher
37 from n2vc
.provisioner
import AsyncSSHProvisioner
38 from n2vc
.n2vc_conn
import N2VCConnector
39 from n2vc
.exceptions
import (
41 JujuApplicationNotFound
,
42 JujuLeaderUnitNotFound
,
44 JujuControllerFailedConnecting
,
45 JujuApplicationExists
,
46 JujuInvalidK8sConfiguration
,
49 from n2vc
.vca
.cloud
import Cloud
as VcaCloud
50 from n2vc
.vca
.connection
import Connection
51 from kubernetes
.client
.configuration
import Configuration
52 from retrying_async
import retry
55 RBAC_LABEL_KEY_NAME
= "rbac-id"
61 vca_connection
: Connection
,
62 loop
: asyncio
.AbstractEventLoop
= None,
63 log
: logging
.Logger
= None,
64 n2vc
: N2VCConnector
= None,
69 :param: vca_connection: n2vc.vca.connection object
70 :param: loop: Asyncio loop
72 :param: n2vc: N2VC object
75 self
.log
= log
or logging
.getLogger("Libjuju")
77 self
.vca_connection
= vca_connection
79 self
.loop
= loop
or asyncio
.get_event_loop()
80 self
.loop
.set_exception_handler(self
.handle_exception
)
81 self
.creating_model
= asyncio
.Lock(loop
=self
.loop
)
83 if self
.vca_connection
.is_default
:
84 self
.health_check_task
= self
._create
_health
_check
_task
()
86 def _create_health_check_task(self
):
87 return self
.loop
.create_task(self
.health_check())
89 async def get_controller(self
, timeout
: float = 60.0) -> Controller
:
93 :param: timeout: Time in seconds to wait for controller to connect
97 controller
= Controller(loop
=self
.loop
)
98 await asyncio
.wait_for(
100 endpoint
=self
.vca_connection
.data
.endpoints
,
101 username
=self
.vca_connection
.data
.user
,
102 password
=self
.vca_connection
.data
.secret
,
103 cacert
=self
.vca_connection
.data
.cacert
,
107 if self
.vca_connection
.is_default
:
108 endpoints
= await controller
.api_endpoints
110 endpoint
in self
.vca_connection
.endpoints
for endpoint
in endpoints
112 await self
.vca_connection
.update_endpoints(endpoints
)
114 except asyncio
.CancelledError
as e
:
116 except Exception as e
:
118 "Failed connecting to controller: {}... {}".format(
119 self
.vca_connection
.data
.endpoints
, e
123 await self
.disconnect_controller(controller
)
124 raise JujuControllerFailedConnecting(e
)
126 async def disconnect(self
):
128 # Cancel health check task
129 self
.health_check_task
.cancel()
130 self
.log
.debug("Libjuju disconnected!")
132 async def disconnect_model(self
, model
: Model
):
136 :param: model: Model that will be disconnected
138 await model
.disconnect()
140 async def disconnect_controller(self
, controller
: Controller
):
142 Disconnect controller
144 :param: controller: Controller that will be disconnected
147 await controller
.disconnect()
149 @retry(attempts
=3, delay
=5, timeout
=None)
150 async def add_model(self
, model_name
: str, cloud
: VcaCloud
):
154 :param: model_name: Model name
155 :param: cloud: Cloud object
159 controller
= await self
.get_controller()
162 # Block until other workers have finished model creation
163 while self
.creating_model
.locked():
164 await asyncio
.sleep(0.1)
167 async with self
.creating_model
:
168 if await self
.model_exists(model_name
, controller
=controller
):
170 self
.log
.debug("Creating model {}".format(model_name
))
171 model
= await controller
.add_model(
173 config
=self
.vca_connection
.data
.model_config
,
174 cloud_name
=cloud
.name
,
175 credential_name
=cloud
.credential_name
,
177 except juju
.errors
.JujuAPIError
as e
:
178 if "already exists" in e
.message
:
184 await self
.disconnect_model(model
)
185 await self
.disconnect_controller(controller
)
187 async def get_executed_actions(self
, model_name
: str) -> list:
189 Get executed/history of actions for a model.
191 :param: model_name: Model name, str.
192 :return: List of executed actions for a model.
195 executed_actions
= []
196 controller
= await self
.get_controller()
198 model
= await self
.get_model(controller
, model_name
)
199 # Get all unique action names
201 for application
in model
.applications
:
202 application_actions
= await self
.get_actions(application
, model_name
)
203 actions
.update(application_actions
)
204 # Get status of all actions
205 for application_action
in actions
:
206 app_action_status_list
= await model
.get_action_status(
207 name
=application_action
209 for action_id
, action_status
in app_action_status_list
.items():
212 "action": application_action
,
213 "status": action_status
,
215 # Get action output by id
216 action_status
= await model
.get_action_output(executed_action
["id"])
217 for k
, v
in action_status
.items():
218 executed_action
[k
] = v
219 executed_actions
.append(executed_action
)
220 except Exception as e
:
222 "Error in getting executed actions for model: {}. Error: {}".format(
228 await self
.disconnect_model(model
)
229 await self
.disconnect_controller(controller
)
230 return executed_actions
232 async def get_application_configs(
233 self
, model_name
: str, application_name
: str
236 Get available configs for an application.
238 :param: model_name: Model name, str.
239 :param: application_name: Application name, str.
241 :return: A dict which has key - action name, value - action description
244 application_configs
= {}
245 controller
= await self
.get_controller()
247 model
= await self
.get_model(controller
, model_name
)
248 application
= self
._get
_application
(
249 model
, application_name
=application_name
251 application_configs
= await application
.get_config()
252 except Exception as e
:
254 "Error in getting configs for application: {} in model: {}. Error: {}".format(
255 application_name
, model_name
, str(e
)
260 await self
.disconnect_model(model
)
261 await self
.disconnect_controller(controller
)
262 return application_configs
264 @retry(attempts
=3, delay
=5)
265 async def get_model(self
, controller
: Controller
, model_name
: str) -> Model
:
267 Get model from controller
269 :param: controller: Controller
270 :param: model_name: Model name
272 :return: Model: The created Juju model object
274 return await controller
.get_model(model_name
)
276 async def model_exists(
277 self
, model_name
: str, controller
: Controller
= None
280 Check if model exists
282 :param: controller: Controller
283 :param: model_name: Model name
287 need_to_disconnect
= False
289 # Get controller if not passed
291 controller
= await self
.get_controller()
292 need_to_disconnect
= True
294 # Check if model exists
296 return model_name
in await controller
.list_models()
298 if need_to_disconnect
:
299 await self
.disconnect_controller(controller
)
301 async def models_exist(self
, model_names
: [str]) -> (bool, list):
303 Check if models exists
305 :param: model_names: List of strings with model names
307 :return (bool, list[str]): (True if all models exists, List of model names that don't exist)
311 "model_names must be a non-empty array. Given value: {}".format(
315 non_existing_models
= []
316 models
= await self
.list_models()
317 existing_models
= list(set(models
).intersection(model_names
))
318 non_existing_models
= list(set(model_names
) - set(existing_models
))
321 len(non_existing_models
) == 0,
325 async def get_model_status(self
, model_name
: str) -> FullStatus
:
329 :param: model_name: Model name
331 :return: Full status object
333 controller
= await self
.get_controller()
334 model
= await self
.get_model(controller
, model_name
)
336 return await model
.get_status()
338 await self
.disconnect_model(model
)
339 await self
.disconnect_controller(controller
)
341 async def create_machine(
344 machine_id
: str = None,
345 db_dict
: dict = None,
346 progress_timeout
: float = None,
347 total_timeout
: float = None,
348 series
: str = "bionic",
350 ) -> (Machine
, bool):
354 :param: model_name: Model name
355 :param: machine_id: Machine id
356 :param: db_dict: Dictionary with data of the DB to write the updates
357 :param: progress_timeout: Maximum time between two updates in the model
358 :param: total_timeout: Timeout for the entity to be active
359 :param: series: Series of the machine (xenial, bionic, focal, ...)
360 :param: wait: Wait until machine is ready
362 :return: (juju.machine.Machine, bool): Machine object and a boolean saying
363 if the machine is new or it already existed
369 "Creating machine (id={}) in model: {}".format(machine_id
, model_name
)
373 controller
= await self
.get_controller()
376 model
= await self
.get_model(controller
, model_name
)
378 if machine_id
is not None:
380 "Searching machine (id={}) in model {}".format(
381 machine_id
, model_name
385 # Get machines from model and get the machine with machine_id if exists
386 machines
= await model
.get_machines()
387 if machine_id
in machines
:
389 "Machine (id={}) found in model {}".format(
390 machine_id
, model_name
393 machine
= machines
[machine_id
]
395 raise JujuMachineNotFound("Machine {} not found".format(machine_id
))
398 self
.log
.debug("Creating a new machine in model {}".format(model_name
))
401 machine
= await model
.add_machine(
402 spec
=None, constraints
=None, disks
=None, series
=series
406 # Wait until the machine is ready
408 "Wait until machine {} is ready in model {}".format(
409 machine
.entity_id
, model_name
413 await JujuModelWatcher
.wait_for(
416 progress_timeout
=progress_timeout
,
417 total_timeout
=total_timeout
,
420 vca_id
=self
.vca_connection
._vca
_id
,
423 await self
.disconnect_model(model
)
424 await self
.disconnect_controller(controller
)
427 "Machine {} ready at {} in model {}".format(
428 machine
.entity_id
, machine
.dns_name
, model_name
433 async def provision_machine(
438 private_key_path
: str,
439 db_dict
: dict = None,
440 progress_timeout
: float = None,
441 total_timeout
: float = None,
444 Manually provisioning of a machine
446 :param: model_name: Model name
447 :param: hostname: IP to access the machine
448 :param: username: Username to login to the machine
449 :param: private_key_path: Local path for the private key
450 :param: db_dict: Dictionary with data of the DB to write the updates
451 :param: progress_timeout: Maximum time between two updates in the model
452 :param: total_timeout: Timeout for the entity to be active
454 :return: (Entity): Machine id
457 "Provisioning machine. model: {}, hostname: {}, username: {}".format(
458 model_name
, hostname
, username
463 controller
= await self
.get_controller()
466 model
= await self
.get_model(controller
, model_name
)
470 provisioner
= AsyncSSHProvisioner(
473 private_key_path
=private_key_path
,
478 params
= await provisioner
.provision_machine()
480 params
.jobs
= ["JobHostUnits"]
482 self
.log
.debug("Adding machine to model")
483 connection
= model
.connection()
484 client_facade
= client
.ClientFacade
.from_connection(connection
)
486 results
= await client_facade
.AddMachines(params
=[params
])
487 error
= results
.machines
[0].error
490 msg
= "Error adding machine: {}".format(error
.message
)
491 self
.log
.error(msg
=msg
)
492 raise ValueError(msg
)
494 machine_id
= results
.machines
[0].machine
496 self
.log
.debug("Installing Juju agent into machine {}".format(machine_id
))
497 asyncio
.ensure_future(
498 provisioner
.install_agent(
499 connection
=connection
,
501 machine_id
=machine_id
,
502 proxy
=self
.vca_connection
.data
.api_proxy
,
503 series
=params
.series
,
509 machine_list
= await model
.get_machines()
510 if machine_id
in machine_list
:
511 self
.log
.debug("Machine {} found in model!".format(machine_id
))
512 machine
= model
.machines
.get(machine_id
)
514 await asyncio
.sleep(2)
517 msg
= "Machine {} not found in model".format(machine_id
)
518 self
.log
.error(msg
=msg
)
519 raise JujuMachineNotFound(msg
)
522 "Wait until machine {} is ready in model {}".format(
523 machine
.entity_id
, model_name
526 await JujuModelWatcher
.wait_for(
529 progress_timeout
=progress_timeout
,
530 total_timeout
=total_timeout
,
533 vca_id
=self
.vca_connection
._vca
_id
,
535 except Exception as e
:
538 await self
.disconnect_model(model
)
539 await self
.disconnect_controller(controller
)
542 "Machine provisioned {} in model {}".format(machine_id
, model_name
)
548 self
, uri
: str, model_name
: str, wait
: bool = True, timeout
: float = 3600
551 Deploy bundle or charm: Similar to the juju CLI command `juju deploy`
553 :param: uri: Path or Charm Store uri in which the charm or bundle can be found
554 :param: model_name: Model name
555 :param: wait: Indicates whether to wait or not until all applications are active
556 :param: timeout: Time in seconds to wait until all applications are active
558 controller
= await self
.get_controller()
559 model
= await self
.get_model(controller
, model_name
)
561 await model
.deploy(uri
)
563 await JujuModelWatcher
.wait_for_model(model
, timeout
=timeout
)
564 self
.log
.debug("All units active in model {}".format(model_name
))
566 await self
.disconnect_model(model
)
567 await self
.disconnect_controller(controller
)
571 application_name
: str,
574 db_dict
: dict = None,
575 progress_timeout
: float = None,
576 total_timeout
: float = None,
580 :param: application_name: Application name
581 :param: model_name: Model name
582 :param: machine_id Machine id
583 :param: db_dict: Dictionary with data of the DB to write the updates
584 :param: progress_timeout: Maximum time between two updates in the model
585 :param: total_timeout: Timeout for the entity to be active
591 controller
= await self
.get_controller()
593 model
= await self
.get_model(controller
, model_name
)
594 application
= self
._get
_application
(model
, application_name
)
596 if application
is not None:
598 # Checks if the given machine id in the model,
599 # otherwise function raises an error
600 _machine
, _series
= self
._get
_machine
_info
(model
, machine_id
)
603 "Adding unit (machine {}) to application {} in model ~{}".format(
604 machine_id
, application_name
, model_name
608 await application
.add_unit(to
=machine_id
)
610 await JujuModelWatcher
.wait_for(
613 progress_timeout
=progress_timeout
,
614 total_timeout
=total_timeout
,
617 vca_id
=self
.vca_connection
._vca
_id
,
620 "Unit is added to application {} in model {}".format(
621 application_name
, model_name
625 raise JujuApplicationNotFound(
626 "Application {} not exists".format(application_name
)
630 await self
.disconnect_model(model
)
631 await self
.disconnect_controller(controller
)
633 async def destroy_unit(
635 application_name
: str,
638 total_timeout
: float = None,
642 :param: application_name: Application name
643 :param: model_name: Model name
644 :param: machine_id Machine id
645 :param: db_dict: Dictionary with data of the DB to write the updates
646 :param: total_timeout: Timeout for the entity to be active
652 controller
= await self
.get_controller()
654 model
= await self
.get_model(controller
, model_name
)
655 application
= self
._get
_application
(model
, application_name
)
657 if application
is None:
658 raise JujuApplicationNotFound(
659 "Application not found: {} (model={})".format(
660 application_name
, model_name
664 unit
= self
._get
_unit
(application
, machine_id
)
667 "A unit with machine id {} not in available units".format(
672 unit_name
= unit
.name
675 "Destroying unit {} from application {} in model {}".format(
676 unit_name
, application_name
, model_name
679 await application
.destroy_unit(unit_name
)
682 "Waiting for unit {} to be destroyed in application {} (model={})...".format(
683 unit_name
, application_name
, model_name
687 # TODO: Add functionality in the Juju watcher to replace this kind of blocks
688 if total_timeout
is None:
690 end
= time
.time() + total_timeout
691 while time
.time() < end
:
692 if not self
._get
_unit
(application
, machine_id
):
694 "The unit {} was destroyed in application {} (model={}) ".format(
695 unit_name
, application_name
, model_name
699 await asyncio
.sleep(5)
701 "Unit {} is destroyed from application {} in model {}".format(
702 unit_name
, application_name
, model_name
707 await self
.disconnect_model(model
)
708 await self
.disconnect_controller(controller
)
710 async def deploy_charm(
712 application_name
: str,
716 db_dict
: dict = None,
717 progress_timeout
: float = None,
718 total_timeout
: float = None,
725 :param: application_name: Application name
726 :param: path: Local path to the charm
727 :param: model_name: Model name
728 :param: machine_id ID of the machine
729 :param: db_dict: Dictionary with data of the DB to write the updates
730 :param: progress_timeout: Maximum time between two updates in the model
731 :param: total_timeout: Timeout for the entity to be active
732 :param: config: Config for the charm
733 :param: series: Series of the charm
734 :param: num_units: Number of units
736 :return: (juju.application.Application): Juju application
739 "Deploying charm {} to machine {} in model ~{}".format(
740 application_name
, machine_id
, model_name
743 self
.log
.debug("charm: {}".format(path
))
746 controller
= await self
.get_controller()
749 model
= await self
.get_model(controller
, model_name
)
752 if application_name
not in model
.applications
:
754 if machine_id
is not None:
755 machine
, series
= self
._get
_machine
_info
(model
, machine_id
)
757 application
= await model
.deploy(
759 application_name
=application_name
,
768 "Wait until application {} is ready in model {}".format(
769 application_name
, model_name
773 for _
in range(num_units
- 1):
774 m
, _
= await self
.create_machine(model_name
, wait
=False)
775 await application
.add_unit(to
=m
.entity_id
)
777 await JujuModelWatcher
.wait_for(
780 progress_timeout
=progress_timeout
,
781 total_timeout
=total_timeout
,
784 vca_id
=self
.vca_connection
._vca
_id
,
787 "Application {} is ready in model {}".format(
788 application_name
, model_name
792 raise JujuApplicationExists(
793 "Application {} exists".format(application_name
)
796 await self
.disconnect_model(model
)
797 await self
.disconnect_controller(controller
)
801 async def scale_application(
804 application_name
: str,
806 total_timeout
: float = None,
809 Scale application (K8s)
811 :param: model_name: Model name
812 :param: application_name: Application name
813 :param: scale: Scale to which to set this application
814 :param: total_timeout: Timeout for the entity to be active
818 controller
= await self
.get_controller()
820 model
= await self
.get_model(controller
, model_name
)
823 "Scaling application {} in model {}".format(
824 application_name
, model_name
827 application
= self
._get
_application
(model
, application_name
)
828 if application
is None:
829 raise JujuApplicationNotFound("Cannot scale application")
830 await application
.scale(scale
=scale
)
831 # Wait until application is scaled in model
833 "Waiting for application {} to be scaled in model {}...".format(
834 application_name
, model_name
837 if total_timeout
is None:
839 end
= time
.time() + total_timeout
840 while time
.time() < end
:
841 application_scale
= self
._get
_application
_count
(model
, application_name
)
842 # Before calling wait_for_model function,
843 # wait until application unit count and scale count are equal.
844 # Because there is a delay before scaling triggers in Juju model.
845 if application_scale
== scale
:
846 await JujuModelWatcher
.wait_for_model(
847 model
=model
, timeout
=total_timeout
850 "Application {} is scaled in model {}".format(
851 application_name
, model_name
855 await asyncio
.sleep(5)
857 "Timeout waiting for application {} in model {} to be scaled".format(
858 application_name
, model_name
863 await self
.disconnect_model(model
)
864 await self
.disconnect_controller(controller
)
866 def _get_application_count(self
, model
: Model
, application_name
: str) -> int:
867 """Get number of units of the application
869 :param: model: Model object
870 :param: application_name: Application name
872 :return: int (or None if application doesn't exist)
874 application
= self
._get
_application
(model
, application_name
)
875 if application
is not None:
876 return len(application
.units
)
878 def _get_application(self
, model
: Model
, application_name
: str) -> Application
:
881 :param: model: Model object
882 :param: application_name: Application name
884 :return: juju.application.Application (or None if it doesn't exist)
886 if model
.applications
and application_name
in model
.applications
:
887 return model
.applications
[application_name
]
889 def _get_unit(self
, application
: Application
, machine_id
: str) -> Unit
:
892 :param: application: Application object
893 :param: machine_id: Machine id
898 for u
in application
.units
:
899 if u
.machine_id
== machine_id
:
904 def _get_machine_info(
911 :param: model: Model object
912 :param: machine_id: Machine id
914 :return: (str, str): (machine, series)
916 if machine_id
not in model
.machines
:
917 msg
= "Machine {} not found in model".format(machine_id
)
918 self
.log
.error(msg
=msg
)
919 raise JujuMachineNotFound(msg
)
920 machine
= model
.machines
[machine_id
]
921 return machine
, machine
.series
923 async def execute_action(
925 application_name
: str,
928 db_dict
: dict = None,
929 machine_id
: str = None,
930 progress_timeout
: float = None,
931 total_timeout
: float = None,
936 :param: application_name: Application name
937 :param: model_name: Model name
938 :param: action_name: Name of the action
939 :param: db_dict: Dictionary with data of the DB to write the updates
940 :param: machine_id Machine id
941 :param: progress_timeout: Maximum time between two updates in the model
942 :param: total_timeout: Timeout for the entity to be active
944 :return: (str, str): (output and status)
947 "Executing action {} using params {}".format(action_name
, kwargs
)
950 controller
= await self
.get_controller()
953 model
= await self
.get_model(controller
, model_name
)
957 application
= self
._get
_application
(
959 application_name
=application_name
,
961 if application
is None:
962 raise JujuApplicationNotFound("Cannot execute action")
964 # Ocassionally, self._get_leader_unit() will return None
965 # because the leader elected hook has not been triggered yet.
966 # Therefore, we are doing some retries. If it happens again,
968 if machine_id
is None:
969 unit
= await self
._get
_leader
_unit
(application
)
971 "Action {} is being executed on the leader unit {}".format(
972 action_name
, unit
.name
976 unit
= self
._get
_unit
(application
, machine_id
)
979 "A unit with machine id {} not in available units".format(
984 "Action {} is being executed on {} unit".format(
985 action_name
, unit
.name
989 actions
= await application
.get_actions()
991 if action_name
not in actions
:
992 raise JujuActionNotFound(
993 "Action {} not in available actions".format(action_name
)
996 action
= await unit
.run_action(action_name
, **kwargs
)
999 "Wait until action {} is completed in application {} (model={})".format(
1000 action_name
, application_name
, model_name
1003 await JujuModelWatcher
.wait_for(
1006 progress_timeout
=progress_timeout
,
1007 total_timeout
=total_timeout
,
1010 vca_id
=self
.vca_connection
._vca
_id
,
1013 output
= await model
.get_action_output(action_uuid
=action
.entity_id
)
1014 status
= await model
.get_action_status(uuid_or_prefix
=action
.entity_id
)
1016 status
[action
.entity_id
] if action
.entity_id
in status
else "failed"
1020 "Action {} completed with status {} in application {} (model={})".format(
1021 action_name
, action
.status
, application_name
, model_name
1025 await self
.disconnect_model(model
)
1026 await self
.disconnect_controller(controller
)
1028 return output
, status
1030 async def get_actions(self
, application_name
: str, model_name
: str) -> dict:
1031 """Get list of actions
1033 :param: application_name: Application name
1034 :param: model_name: Model name
1036 :return: Dict with this format
1038 "action_name": "Description of the action",
1043 "Getting list of actions for application {}".format(application_name
)
1047 controller
= await self
.get_controller()
1050 model
= await self
.get_model(controller
, model_name
)
1054 application
= self
._get
_application
(
1056 application_name
=application_name
,
1059 # Return list of actions
1060 return await application
.get_actions()
1063 # Disconnect from model and controller
1064 await self
.disconnect_model(model
)
1065 await self
.disconnect_controller(controller
)
1067 async def get_metrics(self
, model_name
: str, application_name
: str) -> dict:
1068 """Get the metrics collected by the VCA.
1070 :param model_name The name or unique id of the network service
1071 :param application_name The name of the application
1073 if not model_name
or not application_name
:
1074 raise Exception("model_name and application_name must be non-empty strings")
1076 controller
= await self
.get_controller()
1077 model
= await self
.get_model(controller
, model_name
)
1079 application
= self
._get
_application
(model
, application_name
)
1080 if application
is not None:
1081 metrics
= await application
.get_metrics()
1083 self
.disconnect_model(model
)
1084 self
.disconnect_controller(controller
)
1087 async def add_relation(
1095 :param: model_name: Model name
1096 :param: endpoint_1 First endpoint name
1097 ("app:endpoint" format or directly the saas name)
1098 :param: endpoint_2: Second endpoint name (^ same format)
1101 self
.log
.debug("Adding relation: {} -> {}".format(endpoint_1
, endpoint_2
))
1104 controller
= await self
.get_controller()
1107 model
= await self
.get_model(controller
, model_name
)
1111 await model
.add_relation(endpoint_1
, endpoint_2
)
1112 except juju
.errors
.JujuAPIError
as e
:
1113 if "not found" in e
.message
:
1114 self
.log
.warning("Relation not found: {}".format(e
.message
))
1116 if "already exists" in e
.message
:
1117 self
.log
.warning("Relation already exists: {}".format(e
.message
))
1119 # another exception, raise it
1122 await self
.disconnect_model(model
)
1123 await self
.disconnect_controller(controller
)
1131 Adds a remote offer to the model. Relations can be created later using "juju relate".
1133 :param: offer_url: Offer Url
1134 :param: model_name: Model name
1136 :raises ParseError if there's a problem parsing the offer_url
1137 :raises JujuError if remote offer includes and endpoint
1138 :raises JujuAPIError if the operation is not successful
1140 controller
= await self
.get_controller()
1141 model
= await controller
.get_model(model_name
)
1144 await model
.consume(offer_url
)
1146 await self
.disconnect_model(model
)
1147 await self
.disconnect_controller(controller
)
1149 async def destroy_model(self
, model_name
: str, total_timeout
: float = 1800):
1153 :param: model_name: Model name
1154 :param: total_timeout: Timeout
1157 controller
= await self
.get_controller()
1160 if not await self
.model_exists(model_name
, controller
=controller
):
1163 self
.log
.debug("Destroying model {}".format(model_name
))
1165 model
= await self
.get_model(controller
, model_name
)
1166 # Destroy machines that are manually provisioned
1167 # and still are in pending state
1168 await self
._destroy
_pending
_machines
(model
, only_manual
=True)
1169 await self
.disconnect_model(model
)
1171 await self
._destroy
_model
(
1174 timeout
=total_timeout
,
1178 await self
.disconnect_model(model
)
1179 await self
.disconnect_controller(controller
)
1181 async def _destroy_model(
1182 self
, model_name
: str, controller
: Controller
, timeout
: float = 1800
1185 Destroy model from controller
1187 :param: model: Model name to be removed
1188 :param: controller: Controller object
1189 :param: timeout: Timeout in seconds
1192 async def _destroy_model_loop(model_name
: str, controller
: Controller
):
1193 while await self
.model_exists(model_name
, controller
=controller
):
1194 await controller
.destroy_model(
1195 model_name
, destroy_storage
=True, force
=True, max_wait
=0
1197 await asyncio
.sleep(5)
1200 await asyncio
.wait_for(
1201 _destroy_model_loop(model_name
, controller
), timeout
=timeout
1203 except asyncio
.TimeoutError
:
1205 "Timeout waiting for model {} to be destroyed".format(model_name
)
1208 async def destroy_application(
1209 self
, model_name
: str, application_name
: str, total_timeout
: float
1214 :param: model_name: Model name
1215 :param: application_name: Application name
1216 :param: total_timeout: Timeout
1219 controller
= await self
.get_controller()
1223 model
= await self
.get_model(controller
, model_name
)
1225 "Destroying application {} in model {}".format(
1226 application_name
, model_name
1229 application
= self
._get
_application
(model
, application_name
)
1231 await application
.destroy()
1233 self
.log
.warning("Application not found: {}".format(application_name
))
1236 "Waiting for application {} to be destroyed in model {}...".format(
1237 application_name
, model_name
1240 if total_timeout
is None:
1241 total_timeout
= 3600
1242 end
= time
.time() + total_timeout
1243 while time
.time() < end
:
1244 if not self
._get
_application
(model
, application_name
):
1246 "The application {} was destroyed in model {} ".format(
1247 application_name
, model_name
1251 await asyncio
.sleep(5)
1253 "Timeout waiting for application {} to be destroyed in model {}".format(
1254 application_name
, model_name
1258 if model
is not None:
1259 await self
.disconnect_model(model
)
1260 await self
.disconnect_controller(controller
)
1262 async def _destroy_pending_machines(self
, model
: Model
, only_manual
: bool = False):
1264 Destroy pending machines in a given model
1266 :param: only_manual: Bool that indicates only manually provisioned
1267 machines should be destroyed (if True), or that
1268 all pending machines should be destroyed
1270 status
= await model
.get_status()
1271 for machine_id
in status
.machines
:
1272 machine_status
= status
.machines
[machine_id
]
1273 if machine_status
.agent_status
.status
== "pending":
1274 if only_manual
and not machine_status
.instance_id
.startswith("manual:"):
1276 machine
= model
.machines
[machine_id
]
1277 await machine
.destroy(force
=True)
1279 async def configure_application(
1280 self
, model_name
: str, application_name
: str, config
: dict = None
1282 """Configure application
1284 :param: model_name: Model name
1285 :param: application_name: Application name
1286 :param: config: Config to apply to the charm
1288 self
.log
.debug("Configuring application {}".format(application_name
))
1291 controller
= await self
.get_controller()
1294 model
= await self
.get_model(controller
, model_name
)
1295 application
= self
._get
_application
(
1297 application_name
=application_name
,
1299 await application
.set_config(config
)
1302 await self
.disconnect_model(model
)
1303 await self
.disconnect_controller(controller
)
1305 def handle_exception(self
, loop
, context
):
1306 # All unhandled exceptions by libjuju are handled here.
1309 async def health_check(self
, interval
: float = 300.0):
1311 Health check to make sure controller and controller_model connections are OK
1313 :param: interval: Time in seconds between checks
1318 controller
= await self
.get_controller()
1319 # self.log.debug("VCA is alive")
1320 except Exception as e
:
1321 self
.log
.error("Health check to VCA failed: {}".format(e
))
1323 await self
.disconnect_controller(controller
)
1324 await asyncio
.sleep(interval
)
1326 async def list_models(self
, contains
: str = None) -> [str]:
1327 """List models with certain names
1329 :param: contains: String that is contained in model name
1331 :retur: [models] Returns list of model names
1334 controller
= await self
.get_controller()
1336 models
= await controller
.list_models()
1338 models
= [model
for model
in models
if contains
in model
]
1341 await self
.disconnect_controller(controller
)
1343 async def list_offers(self
, model_name
: str) -> QueryApplicationOffersResults
:
1344 """List models with certain names
1346 :param: model_name: Model name
1348 :return: Returns list of offers
1351 controller
= await self
.get_controller()
1353 return await controller
.list_offers(model_name
)
1355 await self
.disconnect_controller(controller
)
1362 client_cert_data
: str,
1363 configuration
: Configuration
,
1365 credential_name
: str = None,
1368 Add a Kubernetes cloud to the controller
1370 Similar to the `juju add-k8s` command in the CLI
1372 :param: name: Name for the K8s cloud
1373 :param: configuration: Kubernetes configuration object
1374 :param: storage_class: Storage Class to use in the cloud
1375 :param: credential_name: Storage Class to use in the cloud
1378 if not storage_class
:
1379 raise Exception("storage_class must be a non-empty string")
1381 raise Exception("name must be a non-empty string")
1382 if not configuration
:
1383 raise Exception("configuration must be provided")
1385 endpoint
= configuration
.host
1386 credential
= self
.get_k8s_cloud_credential(
1391 credential
.attrs
[RBAC_LABEL_KEY_NAME
] = rbac_id
1392 cloud
= client
.Cloud(
1394 auth_types
=[credential
.auth_type
],
1396 ca_certificates
=[client_cert_data
],
1398 "operator-storage": storage_class
,
1399 "workload-storage": storage_class
,
1403 return await self
.add_cloud(
1404 name
, cloud
, credential
, credential_name
=credential_name
1407 def get_k8s_cloud_credential(
1409 configuration
: Configuration
,
1410 client_cert_data
: str,
1412 ) -> client
.CloudCredential
:
1414 # TODO: Test with AKS
1415 key
= None # open(configuration.key_file, "r").read()
1416 username
= configuration
.username
1417 password
= configuration
.password
1419 if client_cert_data
:
1420 attrs
["ClientCertificateData"] = client_cert_data
1422 attrs
["ClientKeyData"] = key
1424 if username
or password
:
1425 raise JujuInvalidK8sConfiguration("Cannot set both token and user/pass")
1426 attrs
["Token"] = token
1430 auth_type
= "oauth2"
1431 if client_cert_data
:
1432 auth_type
= "oauth2withcert"
1434 raise JujuInvalidK8sConfiguration(
1435 "missing token for auth type {}".format(auth_type
)
1440 "credential for user {} has empty password".format(username
)
1442 attrs
["username"] = username
1443 attrs
["password"] = password
1444 if client_cert_data
:
1445 auth_type
= "userpasswithcert"
1447 auth_type
= "userpass"
1448 elif client_cert_data
and token
:
1449 auth_type
= "certificate"
1451 raise JujuInvalidK8sConfiguration("authentication method not supported")
1452 return client
.CloudCredential(auth_type
=auth_type
, attrs
=attrs
)
1454 async def add_cloud(
1458 credential
: CloudCredential
= None,
1459 credential_name
: str = None,
1462 Add cloud to the controller
1464 :param: name: Name of the cloud to be added
1465 :param: cloud: Cloud object
1466 :param: credential: CloudCredentials object for the cloud
1467 :param: credential_name: Credential name.
1468 If not defined, cloud of the name will be used.
1470 controller
= await self
.get_controller()
1472 _
= await controller
.add_cloud(name
, cloud
)
1474 await controller
.add_credential(
1475 credential_name
or name
, credential
=credential
, cloud
=name
1477 # Need to return the object returned by the controller.add_cloud() function
1478 # I'm returning the original value now until this bug is fixed:
1479 # https://github.com/juju/python-libjuju/issues/443
1482 await self
.disconnect_controller(controller
)
1484 async def remove_cloud(self
, name
: str):
1488 :param: name: Name of the cloud to be removed
1490 controller
= await self
.get_controller()
1492 await controller
.remove_cloud(name
)
1493 except juju
.errors
.JujuError
as e
:
1494 if len(e
.errors
) == 1 and f
'cloud "{name}" not found' == e
.errors
[0]:
1495 self
.log
.warning(f
"Cloud {name} not found, so it could not be deleted.")
1499 await self
.disconnect_controller(controller
)
1501 @retry(attempts
=20, delay
=5, fallback
=JujuLeaderUnitNotFound())
1502 async def _get_leader_unit(self
, application
: Application
) -> Unit
:
1504 for u
in application
.units
:
1505 if await u
.is_leader_from_status():
1512 async def get_cloud_credentials(self
, cloud
: Cloud
) -> typing
.List
:
1514 Get cloud credentials
1516 :param: cloud: Cloud object. The returned credentials will be from this cloud.
1518 :return: List of credentials object associated to the specified cloud
1521 controller
= await self
.get_controller()
1523 facade
= client
.CloudFacade
.from_connection(controller
.connection())
1524 cloud_cred_tag
= tag
.credential(
1525 cloud
.name
, self
.vca_connection
.data
.user
, cloud
.credential_name
1527 params
= [client
.Entity(cloud_cred_tag
)]
1528 return (await facade
.Credential(params
)).results
1530 await self
.disconnect_controller(controller
)
1532 async def check_application_exists(self
, model_name
, application_name
) -> bool:
1533 """Check application exists
1535 :param: model_name: Model Name
1536 :param: application_name: Application Name
1542 controller
= await self
.get_controller()
1544 model
= await self
.get_model(controller
, model_name
)
1546 "Checking if application {} exists in model {}".format(
1547 application_name
, model_name
1550 return self
._get
_application
(model
, application_name
) is not None
1553 await self
.disconnect_model(model
)
1554 await self
.disconnect_controller(controller
)