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.
20 from juju
.errors
import JujuAPIError
21 from juju
.model
import Model
22 from juju
.machine
import Machine
23 from juju
.application
import Application
24 from juju
.unit
import Unit
25 from juju
.client
._definitions
import (
27 QueryApplicationOffersResults
,
31 from juju
.controller
import Controller
32 from juju
.client
import client
35 from n2vc
.config
import ModelConfig
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
,
48 from n2vc
.utils
import DB_DATA
49 from osm_common
.dbbase
import DbException
50 from kubernetes
.client
.configuration
import Configuration
52 RBAC_LABEL_KEY_NAME
= "rbac-id"
63 loop
: asyncio
.AbstractEventLoop
= None,
64 log
: logging
.Logger
= None,
66 n2vc
: N2VCConnector
= None,
67 model_config
: ModelConfig
= {},
72 :param: endpoint: Endpoint of the juju controller (host:port)
73 :param: api_proxy: Endpoint of the juju controller - Reachable from the VNFs
74 :param: username: Juju username
75 :param: password: Juju password
76 :param: cacert: Juju CA Certificate
77 :param: loop: Asyncio loop
80 :param: n2vc: N2VC object
81 :param: apt_mirror: APT Mirror
82 :param: enable_os_upgrade: Enable OS Upgrade
85 self
.log
= log
or logging
.getLogger("Libjuju")
87 db_endpoints
= self
._get
_api
_endpoints
_db
()
89 if (db_endpoints
and endpoint
not in db_endpoints
) or not db_endpoints
:
90 self
.endpoints
= [endpoint
]
91 self
._update
_api
_endpoints
_db
(self
.endpoints
)
93 self
.endpoints
= db_endpoints
94 self
.api_proxy
= api_proxy
95 self
.username
= username
96 self
.password
= password
98 self
.loop
= loop
or asyncio
.get_event_loop()
101 # Generate config for models
102 self
.model_config
= model_config
104 self
.loop
.set_exception_handler(self
.handle_exception
)
105 self
.creating_model
= asyncio
.Lock(loop
=self
.loop
)
107 self
.log
.debug("Libjuju initialized!")
109 self
.health_check_task
= self
._create
_health
_check
_task
()
111 def _create_health_check_task(self
):
112 return self
.loop
.create_task(self
.health_check())
114 async def get_controller(self
, timeout
: float = 15.0) -> Controller
:
118 :param: timeout: Time in seconds to wait for controller to connect
122 controller
= Controller(loop
=self
.loop
)
123 await asyncio
.wait_for(
125 endpoint
=self
.endpoints
,
126 username
=self
.username
,
127 password
=self
.password
,
132 endpoints
= await controller
.api_endpoints
133 if self
.endpoints
!= endpoints
:
134 self
.endpoints
= endpoints
135 self
._update
_api
_endpoints
_db
(self
.endpoints
)
137 except asyncio
.CancelledError
as e
:
139 except Exception as e
:
141 "Failed connecting to controller: {}...".format(self
.endpoints
)
144 await self
.disconnect_controller(controller
)
145 raise JujuControllerFailedConnecting(e
)
147 async def disconnect(self
):
149 # Cancel health check task
150 self
.health_check_task
.cancel()
151 self
.log
.debug("Libjuju disconnected!")
153 async def disconnect_model(self
, model
: Model
):
157 :param: model: Model that will be disconnected
159 await model
.disconnect()
161 async def disconnect_controller(self
, controller
: Controller
):
163 Disconnect controller
165 :param: controller: Controller that will be disconnected
168 await controller
.disconnect()
170 async def add_model(self
, model_name
: str, cloud_name
: str, credential_name
=None):
174 :param: model_name: Model name
175 :param: cloud_name: Cloud name
176 :param: credential_name: Credential name to use for adding the model
177 If not specified, same name as the cloud will be used.
181 controller
= await self
.get_controller()
184 # Block until other workers have finished model creation
185 while self
.creating_model
.locked():
186 await asyncio
.sleep(0.1)
189 async with self
.creating_model
:
190 if await self
.model_exists(model_name
, controller
=controller
):
192 self
.log
.debug("Creating model {}".format(model_name
))
193 model
= await controller
.add_model(
195 config
=self
.model_config
,
196 cloud_name
=cloud_name
,
197 credential_name
=credential_name
or cloud_name
,
201 await self
.disconnect_model(model
)
202 await self
.disconnect_controller(controller
)
205 self
, controller
: Controller
, model_name
: str, id=None
208 Get model from controller
210 :param: controller: Controller
211 :param: model_name: Model name
213 :return: Model: The created Juju model object
215 return await controller
.get_model(model_name
)
217 async def model_exists(
218 self
, model_name
: str, controller
: Controller
= None
221 Check if model exists
223 :param: controller: Controller
224 :param: model_name: Model name
228 need_to_disconnect
= False
230 # Get controller if not passed
232 controller
= await self
.get_controller()
233 need_to_disconnect
= True
235 # Check if model exists
237 return model_name
in await controller
.list_models()
239 if need_to_disconnect
:
240 await self
.disconnect_controller(controller
)
242 async def models_exist(self
, model_names
: [str]) -> (bool, list):
244 Check if models exists
246 :param: model_names: List of strings with model names
248 :return (bool, list[str]): (True if all models exists, List of model names that don't exist)
252 "model_names must be a non-empty array. Given value: {}".format(
256 non_existing_models
= []
257 models
= await self
.list_models()
258 existing_models
= list(set(models
).intersection(model_names
))
259 non_existing_models
= list(set(model_names
) - set(existing_models
))
262 len(non_existing_models
) == 0,
266 async def get_model_status(self
, model_name
: str) -> FullStatus
:
270 :param: model_name: Model name
272 :return: Full status object
274 controller
= await self
.get_controller()
275 model
= await self
.get_model(controller
, model_name
)
277 return await model
.get_status()
279 await self
.disconnect_model(model
)
280 await self
.disconnect_controller(controller
)
282 async def create_machine(
285 machine_id
: str = None,
286 db_dict
: dict = None,
287 progress_timeout
: float = None,
288 total_timeout
: float = None,
289 series
: str = "xenial",
291 ) -> (Machine
, bool):
295 :param: model_name: Model name
296 :param: machine_id: Machine id
297 :param: db_dict: Dictionary with data of the DB to write the updates
298 :param: progress_timeout: Maximum time between two updates in the model
299 :param: total_timeout: Timeout for the entity to be active
300 :param: series: Series of the machine (xenial, bionic, focal, ...)
301 :param: wait: Wait until machine is ready
303 :return: (juju.machine.Machine, bool): Machine object and a boolean saying
304 if the machine is new or it already existed
310 "Creating machine (id={}) in model: {}".format(machine_id
, model_name
)
314 controller
= await self
.get_controller()
317 model
= await self
.get_model(controller
, model_name
)
319 if machine_id
is not None:
321 "Searching machine (id={}) in model {}".format(
322 machine_id
, model_name
326 # Get machines from model and get the machine with machine_id if exists
327 machines
= await model
.get_machines()
328 if machine_id
in machines
:
330 "Machine (id={}) found in model {}".format(
331 machine_id
, model_name
334 machine
= machines
[machine_id
]
336 raise JujuMachineNotFound("Machine {} not found".format(machine_id
))
339 self
.log
.debug("Creating a new machine in model {}".format(model_name
))
342 machine
= await model
.add_machine(
343 spec
=None, constraints
=None, disks
=None, series
=series
347 # Wait until the machine is ready
349 "Wait until machine {} is ready in model {}".format(
350 machine
.entity_id
, model_name
354 await JujuModelWatcher
.wait_for(
357 progress_timeout
=progress_timeout
,
358 total_timeout
=total_timeout
,
363 await self
.disconnect_model(model
)
364 await self
.disconnect_controller(controller
)
367 "Machine {} ready at {} in model {}".format(
368 machine
.entity_id
, machine
.dns_name
, model_name
373 async def provision_machine(
378 private_key_path
: str,
379 db_dict
: dict = None,
380 progress_timeout
: float = None,
381 total_timeout
: float = None,
384 Manually provisioning of a machine
386 :param: model_name: Model name
387 :param: hostname: IP to access the machine
388 :param: username: Username to login to the machine
389 :param: private_key_path: Local path for the private key
390 :param: db_dict: Dictionary with data of the DB to write the updates
391 :param: progress_timeout: Maximum time between two updates in the model
392 :param: total_timeout: Timeout for the entity to be active
394 :return: (Entity): Machine id
397 "Provisioning machine. model: {}, hostname: {}, username: {}".format(
398 model_name
, hostname
, username
403 controller
= await self
.get_controller()
406 model
= await self
.get_model(controller
, model_name
)
410 provisioner
= AsyncSSHProvisioner(
413 private_key_path
=private_key_path
,
418 params
= await provisioner
.provision_machine()
420 params
.jobs
= ["JobHostUnits"]
422 self
.log
.debug("Adding machine to model")
423 connection
= model
.connection()
424 client_facade
= client
.ClientFacade
.from_connection(connection
)
426 results
= await client_facade
.AddMachines(params
=[params
])
427 error
= results
.machines
[0].error
430 msg
= "Error adding machine: {}".format(error
.message
)
431 self
.log
.error(msg
=msg
)
432 raise ValueError(msg
)
434 machine_id
= results
.machines
[0].machine
436 self
.log
.debug("Installing Juju agent into machine {}".format(machine_id
))
437 asyncio
.ensure_future(
438 provisioner
.install_agent(
439 connection
=connection
,
441 machine_id
=machine_id
,
442 proxy
=self
.api_proxy
,
443 series
=params
.series
,
449 machine_list
= await model
.get_machines()
450 if machine_id
in machine_list
:
451 self
.log
.debug("Machine {} found in model!".format(machine_id
))
452 machine
= model
.machines
.get(machine_id
)
454 await asyncio
.sleep(2)
457 msg
= "Machine {} not found in model".format(machine_id
)
458 self
.log
.error(msg
=msg
)
459 raise JujuMachineNotFound(msg
)
462 "Wait until machine {} is ready in model {}".format(
463 machine
.entity_id
, model_name
466 await JujuModelWatcher
.wait_for(
469 progress_timeout
=progress_timeout
,
470 total_timeout
=total_timeout
,
474 except Exception as e
:
477 await self
.disconnect_model(model
)
478 await self
.disconnect_controller(controller
)
481 "Machine provisioned {} in model {}".format(machine_id
, model_name
)
487 self
, uri
: str, model_name
: str, wait
: bool = True, timeout
: float = 3600
490 Deploy bundle or charm: Similar to the juju CLI command `juju deploy`
492 :param: uri: Path or Charm Store uri in which the charm or bundle can be found
493 :param: model_name: Model name
494 :param: wait: Indicates whether to wait or not until all applications are active
495 :param: timeout: Time in seconds to wait until all applications are active
497 controller
= await self
.get_controller()
498 model
= await self
.get_model(controller
, model_name
)
500 await model
.deploy(uri
)
502 await JujuModelWatcher
.wait_for_model(model
, timeout
=timeout
)
503 self
.log
.debug("All units active in model {}".format(model_name
))
505 await self
.disconnect_model(model
)
506 await self
.disconnect_controller(controller
)
508 async def deploy_charm(
510 application_name
: str,
514 db_dict
: dict = None,
515 progress_timeout
: float = None,
516 total_timeout
: float = None,
523 :param: application_name: Application name
524 :param: path: Local path to the charm
525 :param: model_name: Model name
526 :param: machine_id ID of the machine
527 :param: db_dict: Dictionary with data of the DB to write the updates
528 :param: progress_timeout: Maximum time between two updates in the model
529 :param: total_timeout: Timeout for the entity to be active
530 :param: config: Config for the charm
531 :param: series: Series of the charm
532 :param: num_units: Number of units
534 :return: (juju.application.Application): Juju application
537 "Deploying charm {} to machine {} in model ~{}".format(
538 application_name
, machine_id
, model_name
541 self
.log
.debug("charm: {}".format(path
))
544 controller
= await self
.get_controller()
547 model
= await self
.get_model(controller
, model_name
)
551 if application_name
not in model
.applications
:
553 if machine_id
is not None:
554 if machine_id
not in model
.machines
:
555 msg
= "Machine {} not found in model".format(machine_id
)
556 self
.log
.error(msg
=msg
)
557 raise JujuMachineNotFound(msg
)
558 machine
= model
.machines
[machine_id
]
559 series
= machine
.series
561 application
= await model
.deploy(
563 application_name
=application_name
,
572 "Wait until application {} is ready in model {}".format(
573 application_name
, model_name
577 for _
in range(num_units
- 1):
578 m
, _
= await self
.create_machine(model_name
, wait
=False)
579 await application
.add_unit(to
=m
.entity_id
)
581 await JujuModelWatcher
.wait_for(
584 progress_timeout
=progress_timeout
,
585 total_timeout
=total_timeout
,
590 "Application {} is ready in model {}".format(
591 application_name
, model_name
595 raise JujuApplicationExists(
596 "Application {} exists".format(application_name
)
599 await self
.disconnect_model(model
)
600 await self
.disconnect_controller(controller
)
604 def _get_application(self
, model
: Model
, application_name
: str) -> Application
:
607 :param: model: Model object
608 :param: application_name: Application name
610 :return: juju.application.Application (or None if it doesn't exist)
612 if model
.applications
and application_name
in model
.applications
:
613 return model
.applications
[application_name
]
615 async def execute_action(
617 application_name
: str,
620 db_dict
: dict = None,
621 progress_timeout
: float = None,
622 total_timeout
: float = None,
627 :param: application_name: Application name
628 :param: model_name: Model name
629 :param: action_name: Name of the action
630 :param: db_dict: Dictionary with data of the DB to write the updates
631 :param: progress_timeout: Maximum time between two updates in the model
632 :param: total_timeout: Timeout for the entity to be active
634 :return: (str, str): (output and status)
637 "Executing action {} using params {}".format(action_name
, kwargs
)
640 controller
= await self
.get_controller()
643 model
= await self
.get_model(controller
, model_name
)
647 application
= self
._get
_application
(
649 application_name
=application_name
,
651 if application
is None:
652 raise JujuApplicationNotFound("Cannot execute action")
656 # Ocassionally, self._get_leader_unit() will return None
657 # because the leader elected hook has not been triggered yet.
658 # Therefore, we are doing some retries. If it happens again,
661 time_between_retries
= 10
663 for _
in range(attempts
):
664 unit
= await self
._get
_leader
_unit
(application
)
666 await asyncio
.sleep(time_between_retries
)
670 raise JujuLeaderUnitNotFound(
671 "Cannot execute action: leader unit not found"
674 actions
= await application
.get_actions()
676 if action_name
not in actions
:
677 raise JujuActionNotFound(
678 "Action {} not in available actions".format(action_name
)
681 action
= await unit
.run_action(action_name
, **kwargs
)
684 "Wait until action {} is completed in application {} (model={})".format(
685 action_name
, application_name
, model_name
688 await JujuModelWatcher
.wait_for(
691 progress_timeout
=progress_timeout
,
692 total_timeout
=total_timeout
,
697 output
= await model
.get_action_output(action_uuid
=action
.entity_id
)
698 status
= await model
.get_action_status(uuid_or_prefix
=action
.entity_id
)
700 status
[action
.entity_id
] if action
.entity_id
in status
else "failed"
704 "Action {} completed with status {} in application {} (model={})".format(
705 action_name
, action
.status
, application_name
, model_name
709 await self
.disconnect_model(model
)
710 await self
.disconnect_controller(controller
)
712 return output
, status
714 async def get_actions(self
, application_name
: str, model_name
: str) -> dict:
715 """Get list of actions
717 :param: application_name: Application name
718 :param: model_name: Model name
720 :return: Dict with this format
722 "action_name": "Description of the action",
727 "Getting list of actions for application {}".format(application_name
)
731 controller
= await self
.get_controller()
734 model
= await self
.get_model(controller
, model_name
)
738 application
= self
._get
_application
(
740 application_name
=application_name
,
743 # Return list of actions
744 return await application
.get_actions()
747 # Disconnect from model and controller
748 await self
.disconnect_model(model
)
749 await self
.disconnect_controller(controller
)
751 async def get_metrics(self
, model_name
: str, application_name
: str) -> dict:
752 """Get the metrics collected by the VCA.
754 :param model_name The name or unique id of the network service
755 :param application_name The name of the application
757 if not model_name
or not application_name
:
758 raise Exception("model_name and application_name must be non-empty strings")
760 controller
= await self
.get_controller()
761 model
= await self
.get_model(controller
, model_name
)
763 application
= self
._get
_application
(model
, application_name
)
764 if application
is not None:
765 metrics
= await application
.get_metrics()
767 self
.disconnect_model(model
)
768 self
.disconnect_controller(controller
)
771 async def add_relation(
779 :param: model_name: Model name
780 :param: endpoint_1 First endpoint name
781 ("app:endpoint" format or directly the saas name)
782 :param: endpoint_2: Second endpoint name (^ same format)
785 self
.log
.debug("Adding relation: {} -> {}".format(endpoint_1
, endpoint_2
))
788 controller
= await self
.get_controller()
791 model
= await self
.get_model(controller
, model_name
)
795 await model
.add_relation(endpoint_1
, endpoint_2
)
796 except JujuAPIError
as e
:
797 if "not found" in e
.message
:
798 self
.log
.warning("Relation not found: {}".format(e
.message
))
800 if "already exists" in e
.message
:
801 self
.log
.warning("Relation already exists: {}".format(e
.message
))
803 # another exception, raise it
806 await self
.disconnect_model(model
)
807 await self
.disconnect_controller(controller
)
815 Adds a remote offer to the model. Relations can be created later using "juju relate".
817 :param: offer_url: Offer Url
818 :param: model_name: Model name
820 :raises ParseError if there's a problem parsing the offer_url
821 :raises JujuError if remote offer includes and endpoint
822 :raises JujuAPIError if the operation is not successful
824 controller
= await self
.get_controller()
825 model
= await controller
.get_model(model_name
)
828 await model
.consume(offer_url
)
830 await self
.disconnect_model(model
)
831 await self
.disconnect_controller(controller
)
833 async def destroy_model(self
, model_name
: str, total_timeout
: float):
837 :param: model_name: Model name
838 :param: total_timeout: Timeout
841 controller
= await self
.get_controller()
844 if not await self
.model_exists(model_name
, controller
=controller
):
847 model
= await self
.get_model(controller
, model_name
)
848 self
.log
.debug("Destroying model {}".format(model_name
))
849 uuid
= model
.info
.uuid
851 # Destroy machines that are manually provisioned
852 # and still are in pending state
853 await self
._destroy
_pending
_machines
(model
, only_manual
=True)
856 await self
.disconnect_model(model
)
858 await controller
.destroy_model(uuid
, force
=True, max_wait
=0)
860 # Wait until model is destroyed
861 self
.log
.debug("Waiting for model {} to be destroyed...".format(model_name
))
863 if total_timeout
is None:
865 end
= time
.time() + total_timeout
866 while time
.time() < end
:
867 models
= await controller
.list_models()
868 if model_name
not in models
:
870 "The model {} ({}) was destroyed".format(model_name
, uuid
)
873 await asyncio
.sleep(5)
875 "Timeout waiting for model {} to be destroyed".format(model_name
)
877 except Exception as e
:
879 await self
.disconnect_model(model
)
882 await self
.disconnect_controller(controller
)
884 async def destroy_application(self
, model
: Model
, application_name
: str):
888 :param: model: Model object
889 :param: application_name: Application name
892 "Destroying application {} in model {}".format(
893 application_name
, model
.info
.name
896 application
= model
.applications
.get(application_name
)
898 await application
.destroy()
900 self
.log
.warning("Application not found: {}".format(application_name
))
902 async def _destroy_pending_machines(self
, model
: Model
, only_manual
: bool = False):
904 Destroy pending machines in a given model
906 :param: only_manual: Bool that indicates only manually provisioned
907 machines should be destroyed (if True), or that
908 all pending machines should be destroyed
910 status
= await model
.get_status()
911 for machine_id
in status
.machines
:
912 machine_status
= status
.machines
[machine_id
]
913 if machine_status
.agent_status
.status
== "pending":
914 if only_manual
and not machine_status
.instance_id
.startswith("manual:"):
916 machine
= model
.machines
[machine_id
]
917 await machine
.destroy(force
=True)
919 # async def destroy_machine(
920 # self, model: Model, machine_id: str, total_timeout: float = 3600
925 # :param: model: Model object
926 # :param: machine_id: Machine id
927 # :param: total_timeout: Timeout in seconds
929 # machines = await model.get_machines()
930 # if machine_id in machines:
931 # machine = machines[machine_id]
932 # await machine.destroy(force=True)
934 # end = time.time() + total_timeout
936 # # wait for machine removal
937 # machines = await model.get_machines()
938 # while machine_id in machines and time.time() < end:
939 # self.log.debug("Waiting for machine {} is destroyed".format(machine_id))
940 # await asyncio.sleep(0.5)
941 # machines = await model.get_machines()
942 # self.log.debug("Machine destroyed: {}".format(machine_id))
944 # self.log.debug("Machine not found: {}".format(machine_id))
946 async def configure_application(
947 self
, model_name
: str, application_name
: str, config
: dict = None
949 """Configure application
951 :param: model_name: Model name
952 :param: application_name: Application name
953 :param: config: Config to apply to the charm
955 self
.log
.debug("Configuring application {}".format(application_name
))
958 controller
= await self
.get_controller()
961 model
= await self
.get_model(controller
, model_name
)
962 application
= self
._get
_application
(
964 application_name
=application_name
,
966 await application
.set_config(config
)
969 await self
.disconnect_model(model
)
970 await self
.disconnect_controller(controller
)
972 def _get_api_endpoints_db(self
) -> [str]:
974 Get API Endpoints from DB
976 :return: List of API endpoints
978 self
.log
.debug("Getting endpoints from database")
980 juju_info
= self
.db
.get_one(
981 DB_DATA
.api_endpoints
.table
,
982 q_filter
=DB_DATA
.api_endpoints
.filter,
985 if juju_info
and DB_DATA
.api_endpoints
.key
in juju_info
:
986 return juju_info
[DB_DATA
.api_endpoints
.key
]
988 def _update_api_endpoints_db(self
, endpoints
: [str]):
990 Update API endpoints in Database
992 :param: List of endpoints
994 self
.log
.debug("Saving endpoints {} in database".format(endpoints
))
996 juju_info
= self
.db
.get_one(
997 DB_DATA
.api_endpoints
.table
,
998 q_filter
=DB_DATA
.api_endpoints
.filter,
1001 # If it doesn't, then create it
1005 DB_DATA
.api_endpoints
.table
,
1006 DB_DATA
.api_endpoints
.filter,
1008 except DbException
as e
:
1009 # Racing condition: check if another N2VC worker has created it
1010 juju_info
= self
.db
.get_one(
1011 DB_DATA
.api_endpoints
.table
,
1012 q_filter
=DB_DATA
.api_endpoints
.filter,
1013 fail_on_empty
=False,
1018 DB_DATA
.api_endpoints
.table
,
1019 DB_DATA
.api_endpoints
.filter,
1020 {DB_DATA
.api_endpoints
.key
: endpoints
},
1023 def handle_exception(self
, loop
, context
):
1024 # All unhandled exceptions by libjuju are handled here.
1027 async def health_check(self
, interval
: float = 300.0):
1029 Health check to make sure controller and controller_model connections are OK
1031 :param: interval: Time in seconds between checks
1036 controller
= await self
.get_controller()
1037 # self.log.debug("VCA is alive")
1038 except Exception as e
:
1039 self
.log
.error("Health check to VCA failed: {}".format(e
))
1041 await self
.disconnect_controller(controller
)
1042 await asyncio
.sleep(interval
)
1044 async def list_models(self
, contains
: str = None) -> [str]:
1045 """List models with certain names
1047 :param: contains: String that is contained in model name
1049 :retur: [models] Returns list of model names
1052 controller
= await self
.get_controller()
1054 models
= await controller
.list_models()
1056 models
= [model
for model
in models
if contains
in model
]
1059 await self
.disconnect_controller(controller
)
1061 async def list_offers(self
, model_name
: str) -> QueryApplicationOffersResults
:
1062 """List models with certain names
1064 :param: model_name: Model name
1066 :return: Returns list of offers
1069 controller
= await self
.get_controller()
1071 return await controller
.list_offers(model_name
)
1073 await self
.disconnect_controller(controller
)
1080 client_cert_data
: str,
1081 configuration
: Configuration
,
1083 credential_name
: str = None,
1086 Add a Kubernetes cloud to the controller
1088 Similar to the `juju add-k8s` command in the CLI
1090 :param: name: Name for the K8s cloud
1091 :param: configuration: Kubernetes configuration object
1092 :param: storage_class: Storage Class to use in the cloud
1093 :param: credential_name: Storage Class to use in the cloud
1096 if not storage_class
:
1097 raise Exception("storage_class must be a non-empty string")
1099 raise Exception("name must be a non-empty string")
1100 if not configuration
:
1101 raise Exception("configuration must be provided")
1103 endpoint
= configuration
.host
1104 credential
= self
.get_k8s_cloud_credential(
1109 credential
.attrs
[RBAC_LABEL_KEY_NAME
] = rbac_id
1110 cloud
= client
.Cloud(
1112 auth_types
=[credential
.auth_type
],
1114 ca_certificates
=[client_cert_data
],
1116 "operator-storage": storage_class
,
1117 "workload-storage": storage_class
,
1121 return await self
.add_cloud(
1122 name
, cloud
, credential
, credential_name
=credential_name
1125 def get_k8s_cloud_credential(
1127 configuration
: Configuration
,
1128 client_cert_data
: str,
1130 ) -> client
.CloudCredential
:
1132 # TODO: Test with AKS
1133 key
= None # open(configuration.key_file, "r").read()
1134 username
= configuration
.username
1135 password
= configuration
.password
1137 if client_cert_data
:
1138 attrs
["ClientCertificateData"] = client_cert_data
1140 attrs
["ClientKeyData"] = key
1142 if username
or password
:
1143 raise JujuInvalidK8sConfiguration("Cannot set both token and user/pass")
1144 attrs
["Token"] = token
1148 auth_type
= "oauth2"
1149 if client_cert_data
:
1150 auth_type
= "oauth2withcert"
1152 raise JujuInvalidK8sConfiguration(
1153 "missing token for auth type {}".format(auth_type
)
1158 "credential for user {} has empty password".format(username
)
1160 attrs
["username"] = username
1161 attrs
["password"] = password
1162 if client_cert_data
:
1163 auth_type
= "userpasswithcert"
1165 auth_type
= "userpass"
1166 elif client_cert_data
and token
:
1167 auth_type
= "certificate"
1169 raise JujuInvalidK8sConfiguration("authentication method not supported")
1170 return client
.CloudCredential(auth_type
=auth_type
, attrs
=attrs
)
1172 async def add_cloud(
1176 credential
: CloudCredential
= None,
1177 credential_name
: str = None,
1180 Add cloud to the controller
1182 :param: name: Name of the cloud to be added
1183 :param: cloud: Cloud object
1184 :param: credential: CloudCredentials object for the cloud
1185 :param: credential_name: Credential name.
1186 If not defined, cloud of the name will be used.
1188 controller
= await self
.get_controller()
1190 _
= await controller
.add_cloud(name
, cloud
)
1192 await controller
.add_credential(
1193 credential_name
or name
, credential
=credential
, cloud
=name
1195 # Need to return the object returned by the controller.add_cloud() function
1196 # I'm returning the original value now until this bug is fixed:
1197 # https://github.com/juju/python-libjuju/issues/443
1200 await self
.disconnect_controller(controller
)
1202 async def remove_cloud(self
, name
: str):
1206 :param: name: Name of the cloud to be removed
1208 controller
= await self
.get_controller()
1210 await controller
.remove_cloud(name
)
1212 await self
.disconnect_controller(controller
)
1214 async def _get_leader_unit(self
, application
: Application
) -> Unit
:
1216 for u
in application
.units
:
1217 if await u
.is_leader_from_status():
1222 async def get_cloud_credentials(self
, cloud_name
: str, credential_name
: str):
1223 controller
= await self
.get_controller()
1225 facade
= client
.CloudFacade
.from_connection(controller
.connection())
1226 cloud_cred_tag
= tag
.credential(cloud_name
, self
.username
, credential_name
)
1227 params
= [client
.Entity(cloud_cred_tag
)]
1228 return (await facade
.Credential(params
)).results
1230 await self
.disconnect_controller(controller
)