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
.juju_watcher
import JujuModelWatcher
36 from n2vc
.provisioner
import AsyncSSHProvisioner
37 from n2vc
.n2vc_conn
import N2VCConnector
38 from n2vc
.exceptions
import (
40 JujuApplicationNotFound
,
41 JujuLeaderUnitNotFound
,
43 JujuControllerFailedConnecting
,
44 JujuApplicationExists
,
45 JujuInvalidK8sConfiguration
,
47 from n2vc
.utils
import DB_DATA
48 from osm_common
.dbbase
import DbException
49 from kubernetes
.client
.configuration
import Configuration
51 RBAC_LABEL_KEY_NAME
= "rbac-id"
62 loop
: asyncio
.AbstractEventLoop
= None,
63 log
: logging
.Logger
= None,
65 n2vc
: N2VCConnector
= None,
66 apt_mirror
: str = None,
67 enable_os_upgrade
: bool = True,
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
= {}
104 self
.model_config
["apt-mirror"] = apt_mirror
105 self
.model_config
["enable-os-refresh-update"] = enable_os_upgrade
106 self
.model_config
["enable-os-upgrade"] = enable_os_upgrade
108 self
.loop
.set_exception_handler(self
.handle_exception
)
109 self
.creating_model
= asyncio
.Lock(loop
=self
.loop
)
111 self
.log
.debug("Libjuju initialized!")
113 self
.health_check_task
= self
._create
_health
_check
_task
()
115 def _create_health_check_task(self
):
116 return self
.loop
.create_task(self
.health_check())
118 async def get_controller(self
, timeout
: float = 15.0) -> Controller
:
122 :param: timeout: Time in seconds to wait for controller to connect
126 controller
= Controller(loop
=self
.loop
)
127 await asyncio
.wait_for(
129 endpoint
=self
.endpoints
,
130 username
=self
.username
,
131 password
=self
.password
,
136 endpoints
= await controller
.api_endpoints
137 if self
.endpoints
!= endpoints
:
138 self
.endpoints
= endpoints
139 self
._update
_api
_endpoints
_db
(self
.endpoints
)
141 except asyncio
.CancelledError
as e
:
143 except Exception as e
:
145 "Failed connecting to controller: {}...".format(self
.endpoints
)
148 await self
.disconnect_controller(controller
)
149 raise JujuControllerFailedConnecting(e
)
151 async def disconnect(self
):
153 # Cancel health check task
154 self
.health_check_task
.cancel()
155 self
.log
.debug("Libjuju disconnected!")
157 async def disconnect_model(self
, model
: Model
):
161 :param: model: Model that will be disconnected
163 await model
.disconnect()
165 async def disconnect_controller(self
, controller
: Controller
):
167 Disconnect controller
169 :param: controller: Controller that will be disconnected
172 await controller
.disconnect()
174 async def add_model(self
, model_name
: str, cloud_name
: str, credential_name
=None):
178 :param: model_name: Model name
179 :param: cloud_name: Cloud name
180 :param: credential_name: Credential name to use for adding the model
181 If not specified, same name as the cloud will be used.
185 controller
= await self
.get_controller()
188 # Block until other workers have finished model creation
189 while self
.creating_model
.locked():
190 await asyncio
.sleep(0.1)
193 async with self
.creating_model
:
194 if await self
.model_exists(model_name
, controller
=controller
):
196 self
.log
.debug("Creating model {}".format(model_name
))
197 model
= await controller
.add_model(
199 config
=self
.model_config
,
200 cloud_name
=cloud_name
,
201 credential_name
=credential_name
or cloud_name
,
205 await self
.disconnect_model(model
)
206 await self
.disconnect_controller(controller
)
209 self
, controller
: Controller
, model_name
: str, id=None
212 Get model from controller
214 :param: controller: Controller
215 :param: model_name: Model name
217 :return: Model: The created Juju model object
219 return await controller
.get_model(model_name
)
221 async def model_exists(
222 self
, model_name
: str, controller
: Controller
= None
225 Check if model exists
227 :param: controller: Controller
228 :param: model_name: Model name
232 need_to_disconnect
= False
234 # Get controller if not passed
236 controller
= await self
.get_controller()
237 need_to_disconnect
= True
239 # Check if model exists
241 return model_name
in await controller
.list_models()
243 if need_to_disconnect
:
244 await self
.disconnect_controller(controller
)
246 async def models_exist(self
, model_names
: [str]) -> (bool, list):
248 Check if models exists
250 :param: model_names: List of strings with model names
252 :return (bool, list[str]): (True if all models exists, List of model names that don't exist)
256 "model_names must be a non-empty array. Given value: {}".format(
260 non_existing_models
= []
261 models
= await self
.list_models()
262 existing_models
= list(set(models
).intersection(model_names
))
263 non_existing_models
= list(set(model_names
) - set(existing_models
))
266 len(non_existing_models
) == 0,
270 async def get_model_status(self
, model_name
: str) -> FullStatus
:
274 :param: model_name: Model name
276 :return: Full status object
278 controller
= await self
.get_controller()
279 model
= await self
.get_model(controller
, model_name
)
281 return await model
.get_status()
283 await self
.disconnect_model(model
)
284 await self
.disconnect_controller(controller
)
286 async def create_machine(
289 machine_id
: str = None,
290 db_dict
: dict = None,
291 progress_timeout
: float = None,
292 total_timeout
: float = None,
293 series
: str = "xenial",
295 ) -> (Machine
, bool):
299 :param: model_name: Model name
300 :param: machine_id: Machine id
301 :param: db_dict: Dictionary with data of the DB to write the updates
302 :param: progress_timeout: Maximum time between two updates in the model
303 :param: total_timeout: Timeout for the entity to be active
304 :param: series: Series of the machine (xenial, bionic, focal, ...)
305 :param: wait: Wait until machine is ready
307 :return: (juju.machine.Machine, bool): Machine object and a boolean saying
308 if the machine is new or it already existed
314 "Creating machine (id={}) in model: {}".format(machine_id
, model_name
)
318 controller
= await self
.get_controller()
321 model
= await self
.get_model(controller
, model_name
)
323 if machine_id
is not None:
325 "Searching machine (id={}) in model {}".format(
326 machine_id
, model_name
330 # Get machines from model and get the machine with machine_id if exists
331 machines
= await model
.get_machines()
332 if machine_id
in machines
:
334 "Machine (id={}) found in model {}".format(
335 machine_id
, model_name
338 machine
= machines
[machine_id
]
340 raise JujuMachineNotFound("Machine {} not found".format(machine_id
))
343 self
.log
.debug("Creating a new machine in model {}".format(model_name
))
346 machine
= await model
.add_machine(
347 spec
=None, constraints
=None, disks
=None, series
=series
351 # Wait until the machine is ready
353 "Wait until machine {} is ready in model {}".format(
354 machine
.entity_id
, model_name
358 await JujuModelWatcher
.wait_for(
361 progress_timeout
=progress_timeout
,
362 total_timeout
=total_timeout
,
367 await self
.disconnect_model(model
)
368 await self
.disconnect_controller(controller
)
371 "Machine {} ready at {} in model {}".format(
372 machine
.entity_id
, machine
.dns_name
, model_name
377 async def provision_machine(
382 private_key_path
: str,
383 db_dict
: dict = None,
384 progress_timeout
: float = None,
385 total_timeout
: float = None,
388 Manually provisioning of a machine
390 :param: model_name: Model name
391 :param: hostname: IP to access the machine
392 :param: username: Username to login to the machine
393 :param: private_key_path: Local path for the private key
394 :param: db_dict: Dictionary with data of the DB to write the updates
395 :param: progress_timeout: Maximum time between two updates in the model
396 :param: total_timeout: Timeout for the entity to be active
398 :return: (Entity): Machine id
401 "Provisioning machine. model: {}, hostname: {}, username: {}".format(
402 model_name
, hostname
, username
407 controller
= await self
.get_controller()
410 model
= await self
.get_model(controller
, model_name
)
414 provisioner
= AsyncSSHProvisioner(
417 private_key_path
=private_key_path
,
422 params
= await provisioner
.provision_machine()
424 params
.jobs
= ["JobHostUnits"]
426 self
.log
.debug("Adding machine to model")
427 connection
= model
.connection()
428 client_facade
= client
.ClientFacade
.from_connection(connection
)
430 results
= await client_facade
.AddMachines(params
=[params
])
431 error
= results
.machines
[0].error
434 msg
= "Error adding machine: {}".format(error
.message
)
435 self
.log
.error(msg
=msg
)
436 raise ValueError(msg
)
438 machine_id
= results
.machines
[0].machine
440 self
.log
.debug("Installing Juju agent into machine {}".format(machine_id
))
441 asyncio
.ensure_future(
442 provisioner
.install_agent(
443 connection
=connection
,
445 machine_id
=machine_id
,
446 proxy
=self
.api_proxy
,
447 series
=params
.series
,
453 machine_list
= await model
.get_machines()
454 if machine_id
in machine_list
:
455 self
.log
.debug("Machine {} found in model!".format(machine_id
))
456 machine
= model
.machines
.get(machine_id
)
458 await asyncio
.sleep(2)
461 msg
= "Machine {} not found in model".format(machine_id
)
462 self
.log
.error(msg
=msg
)
463 raise JujuMachineNotFound(msg
)
466 "Wait until machine {} is ready in model {}".format(
467 machine
.entity_id
, model_name
470 await JujuModelWatcher
.wait_for(
473 progress_timeout
=progress_timeout
,
474 total_timeout
=total_timeout
,
478 except Exception as e
:
481 await self
.disconnect_model(model
)
482 await self
.disconnect_controller(controller
)
485 "Machine provisioned {} in model {}".format(machine_id
, model_name
)
491 self
, uri
: str, model_name
: str, wait
: bool = True, timeout
: float = 3600
494 Deploy bundle or charm: Similar to the juju CLI command `juju deploy`
496 :param: uri: Path or Charm Store uri in which the charm or bundle can be found
497 :param: model_name: Model name
498 :param: wait: Indicates whether to wait or not until all applications are active
499 :param: timeout: Time in seconds to wait until all applications are active
501 controller
= await self
.get_controller()
502 model
= await self
.get_model(controller
, model_name
)
504 await model
.deploy(uri
)
506 await JujuModelWatcher
.wait_for_model(model
, timeout
=timeout
)
507 self
.log
.debug("All units active in model {}".format(model_name
))
509 await self
.disconnect_model(model
)
510 await self
.disconnect_controller(controller
)
512 async def deploy_charm(
514 application_name
: str,
518 db_dict
: dict = None,
519 progress_timeout
: float = None,
520 total_timeout
: float = None,
527 :param: application_name: Application name
528 :param: path: Local path to the charm
529 :param: model_name: Model name
530 :param: machine_id ID of the machine
531 :param: db_dict: Dictionary with data of the DB to write the updates
532 :param: progress_timeout: Maximum time between two updates in the model
533 :param: total_timeout: Timeout for the entity to be active
534 :param: config: Config for the charm
535 :param: series: Series of the charm
536 :param: num_units: Number of units
538 :return: (juju.application.Application): Juju application
541 "Deploying charm {} to machine {} in model ~{}".format(
542 application_name
, machine_id
, model_name
545 self
.log
.debug("charm: {}".format(path
))
548 controller
= await self
.get_controller()
551 model
= await self
.get_model(controller
, model_name
)
555 if application_name
not in model
.applications
:
557 if machine_id
is not None:
558 if machine_id
not in model
.machines
:
559 msg
= "Machine {} not found in model".format(machine_id
)
560 self
.log
.error(msg
=msg
)
561 raise JujuMachineNotFound(msg
)
562 machine
= model
.machines
[machine_id
]
563 series
= machine
.series
565 application
= await model
.deploy(
567 application_name
=application_name
,
576 "Wait until application {} is ready in model {}".format(
577 application_name
, model_name
581 for _
in range(num_units
- 1):
582 m
, _
= await self
.create_machine(model_name
, wait
=False)
583 await application
.add_unit(to
=m
.entity_id
)
585 await JujuModelWatcher
.wait_for(
588 progress_timeout
=progress_timeout
,
589 total_timeout
=total_timeout
,
594 "Application {} is ready in model {}".format(
595 application_name
, model_name
599 raise JujuApplicationExists(
600 "Application {} exists".format(application_name
)
603 await self
.disconnect_model(model
)
604 await self
.disconnect_controller(controller
)
608 def _get_application(self
, model
: Model
, application_name
: str) -> Application
:
611 :param: model: Model object
612 :param: application_name: Application name
614 :return: juju.application.Application (or None if it doesn't exist)
616 if model
.applications
and application_name
in model
.applications
:
617 return model
.applications
[application_name
]
619 async def execute_action(
621 application_name
: str,
624 db_dict
: dict = None,
625 progress_timeout
: float = None,
626 total_timeout
: float = None,
631 :param: application_name: Application name
632 :param: model_name: Model name
633 :param: action_name: Name of the action
634 :param: db_dict: Dictionary with data of the DB to write the updates
635 :param: progress_timeout: Maximum time between two updates in the model
636 :param: total_timeout: Timeout for the entity to be active
638 :return: (str, str): (output and status)
641 "Executing action {} using params {}".format(action_name
, kwargs
)
644 controller
= await self
.get_controller()
647 model
= await self
.get_model(controller
, model_name
)
651 application
= self
._get
_application
(
653 application_name
=application_name
,
655 if application
is None:
656 raise JujuApplicationNotFound("Cannot execute action")
660 # Ocassionally, self._get_leader_unit() will return None
661 # because the leader elected hook has not been triggered yet.
662 # Therefore, we are doing some retries. If it happens again,
665 time_between_retries
= 10
667 for _
in range(attempts
):
668 unit
= await self
._get
_leader
_unit
(application
)
670 await asyncio
.sleep(time_between_retries
)
674 raise JujuLeaderUnitNotFound(
675 "Cannot execute action: leader unit not found"
678 actions
= await application
.get_actions()
680 if action_name
not in actions
:
681 raise JujuActionNotFound(
682 "Action {} not in available actions".format(action_name
)
685 action
= await unit
.run_action(action_name
, **kwargs
)
688 "Wait until action {} is completed in application {} (model={})".format(
689 action_name
, application_name
, model_name
692 await JujuModelWatcher
.wait_for(
695 progress_timeout
=progress_timeout
,
696 total_timeout
=total_timeout
,
701 output
= await model
.get_action_output(action_uuid
=action
.entity_id
)
702 status
= await model
.get_action_status(uuid_or_prefix
=action
.entity_id
)
704 status
[action
.entity_id
] if action
.entity_id
in status
else "failed"
708 "Action {} completed with status {} in application {} (model={})".format(
709 action_name
, action
.status
, application_name
, model_name
713 await self
.disconnect_model(model
)
714 await self
.disconnect_controller(controller
)
716 return output
, status
718 async def get_actions(self
, application_name
: str, model_name
: str) -> dict:
719 """Get list of actions
721 :param: application_name: Application name
722 :param: model_name: Model name
724 :return: Dict with this format
726 "action_name": "Description of the action",
731 "Getting list of actions for application {}".format(application_name
)
735 controller
= await self
.get_controller()
738 model
= await self
.get_model(controller
, model_name
)
742 application
= self
._get
_application
(
744 application_name
=application_name
,
747 # Return list of actions
748 return await application
.get_actions()
751 # Disconnect from model and controller
752 await self
.disconnect_model(model
)
753 await self
.disconnect_controller(controller
)
755 async def get_metrics(self
, model_name
: str, application_name
: str) -> dict:
756 """Get the metrics collected by the VCA.
758 :param model_name The name or unique id of the network service
759 :param application_name The name of the application
761 if not model_name
or not application_name
:
762 raise Exception("model_name and application_name must be non-empty strings")
764 controller
= await self
.get_controller()
765 model
= await self
.get_model(controller
, model_name
)
767 application
= self
._get
_application
(model
, application_name
)
768 if application
is not None:
769 metrics
= await application
.get_metrics()
771 self
.disconnect_model(model
)
772 self
.disconnect_controller(controller
)
775 async def add_relation(
783 :param: model_name: Model name
784 :param: endpoint_1 First endpoint name
785 ("app:endpoint" format or directly the saas name)
786 :param: endpoint_2: Second endpoint name (^ same format)
789 self
.log
.debug("Adding relation: {} -> {}".format(endpoint_1
, endpoint_2
))
792 controller
= await self
.get_controller()
795 model
= await self
.get_model(controller
, model_name
)
799 await model
.add_relation(endpoint_1
, endpoint_2
)
800 except JujuAPIError
as e
:
801 if "not found" in e
.message
:
802 self
.log
.warning("Relation not found: {}".format(e
.message
))
804 if "already exists" in e
.message
:
805 self
.log
.warning("Relation already exists: {}".format(e
.message
))
807 # another exception, raise it
810 await self
.disconnect_model(model
)
811 await self
.disconnect_controller(controller
)
819 Adds a remote offer to the model. Relations can be created later using "juju relate".
821 :param: offer_url: Offer Url
822 :param: model_name: Model name
824 :raises ParseError if there's a problem parsing the offer_url
825 :raises JujuError if remote offer includes and endpoint
826 :raises JujuAPIError if the operation is not successful
828 controller
= await self
.get_controller()
829 model
= await controller
.get_model(model_name
)
832 await model
.consume(offer_url
)
834 await self
.disconnect_model(model
)
835 await self
.disconnect_controller(controller
)
837 async def destroy_model(self
, model_name
: str, total_timeout
: float):
841 :param: model_name: Model name
842 :param: total_timeout: Timeout
845 controller
= await self
.get_controller()
848 if not await self
.model_exists(model_name
, controller
=controller
):
851 model
= await self
.get_model(controller
, model_name
)
852 self
.log
.debug("Destroying model {}".format(model_name
))
853 uuid
= model
.info
.uuid
855 # Destroy machines that are manually provisioned
856 # and still are in pending state
857 await self
._destroy
_pending
_machines
(model
, only_manual
=True)
860 await self
.disconnect_model(model
)
862 await controller
.destroy_model(uuid
, force
=True, max_wait
=0)
864 # Wait until model is destroyed
865 self
.log
.debug("Waiting for model {} to be destroyed...".format(model_name
))
867 if total_timeout
is None:
869 end
= time
.time() + total_timeout
870 while time
.time() < end
:
871 models
= await controller
.list_models()
872 if model_name
not in models
:
874 "The model {} ({}) was destroyed".format(model_name
, uuid
)
877 await asyncio
.sleep(5)
879 "Timeout waiting for model {} to be destroyed".format(model_name
)
881 except Exception as e
:
883 await self
.disconnect_model(model
)
886 await self
.disconnect_controller(controller
)
888 async def destroy_application(self
, model
: Model
, application_name
: str):
892 :param: model: Model object
893 :param: application_name: Application name
896 "Destroying application {} in model {}".format(
897 application_name
, model
.info
.name
900 application
= model
.applications
.get(application_name
)
902 await application
.destroy()
904 self
.log
.warning("Application not found: {}".format(application_name
))
906 async def _destroy_pending_machines(self
, model
: Model
, only_manual
: bool = False):
908 Destroy pending machines in a given model
910 :param: only_manual: Bool that indicates only manually provisioned
911 machines should be destroyed (if True), or that
912 all pending machines should be destroyed
914 status
= await model
.get_status()
915 for machine_id
in status
.machines
:
916 machine_status
= status
.machines
[machine_id
]
917 if machine_status
.agent_status
.status
== "pending":
918 if only_manual
and not machine_status
.instance_id
.startswith("manual:"):
920 machine
= model
.machines
[machine_id
]
921 await machine
.destroy(force
=True)
923 async def configure_application(
924 self
, model_name
: str, application_name
: str, config
: dict = None
926 """Configure application
928 :param: model_name: Model name
929 :param: application_name: Application name
930 :param: config: Config to apply to the charm
932 self
.log
.debug("Configuring application {}".format(application_name
))
935 controller
= await self
.get_controller()
938 model
= await self
.get_model(controller
, model_name
)
939 application
= self
._get
_application
(
941 application_name
=application_name
,
943 await application
.set_config(config
)
946 await self
.disconnect_model(model
)
947 await self
.disconnect_controller(controller
)
949 def _get_api_endpoints_db(self
) -> [str]:
951 Get API Endpoints from DB
953 :return: List of API endpoints
955 self
.log
.debug("Getting endpoints from database")
957 juju_info
= self
.db
.get_one(
958 DB_DATA
.api_endpoints
.table
,
959 q_filter
=DB_DATA
.api_endpoints
.filter,
962 if juju_info
and DB_DATA
.api_endpoints
.key
in juju_info
:
963 return juju_info
[DB_DATA
.api_endpoints
.key
]
965 def _update_api_endpoints_db(self
, endpoints
: [str]):
967 Update API endpoints in Database
969 :param: List of endpoints
971 self
.log
.debug("Saving endpoints {} in database".format(endpoints
))
973 juju_info
= self
.db
.get_one(
974 DB_DATA
.api_endpoints
.table
,
975 q_filter
=DB_DATA
.api_endpoints
.filter,
978 # If it doesn't, then create it
982 DB_DATA
.api_endpoints
.table
,
983 DB_DATA
.api_endpoints
.filter,
985 except DbException
as e
:
986 # Racing condition: check if another N2VC worker has created it
987 juju_info
= self
.db
.get_one(
988 DB_DATA
.api_endpoints
.table
,
989 q_filter
=DB_DATA
.api_endpoints
.filter,
995 DB_DATA
.api_endpoints
.table
,
996 DB_DATA
.api_endpoints
.filter,
997 {DB_DATA
.api_endpoints
.key
: endpoints
},
1000 def handle_exception(self
, loop
, context
):
1001 # All unhandled exceptions by libjuju are handled here.
1004 async def health_check(self
, interval
: float = 300.0):
1006 Health check to make sure controller and controller_model connections are OK
1008 :param: interval: Time in seconds between checks
1013 controller
= await self
.get_controller()
1014 # self.log.debug("VCA is alive")
1015 except Exception as e
:
1016 self
.log
.error("Health check to VCA failed: {}".format(e
))
1018 await self
.disconnect_controller(controller
)
1019 await asyncio
.sleep(interval
)
1021 async def list_models(self
, contains
: str = None) -> [str]:
1022 """List models with certain names
1024 :param: contains: String that is contained in model name
1026 :retur: [models] Returns list of model names
1029 controller
= await self
.get_controller()
1031 models
= await controller
.list_models()
1033 models
= [model
for model
in models
if contains
in model
]
1036 await self
.disconnect_controller(controller
)
1038 async def list_offers(self
, model_name
: str) -> QueryApplicationOffersResults
:
1039 """List models with certain names
1041 :param: model_name: Model name
1043 :return: Returns list of offers
1046 controller
= await self
.get_controller()
1048 return await controller
.list_offers(model_name
)
1050 await self
.disconnect_controller(controller
)
1057 client_cert_data
: str,
1058 configuration
: Configuration
,
1060 credential_name
: str = None,
1063 Add a Kubernetes cloud to the controller
1065 Similar to the `juju add-k8s` command in the CLI
1067 :param: name: Name for the K8s cloud
1068 :param: configuration: Kubernetes configuration object
1069 :param: storage_class: Storage Class to use in the cloud
1070 :param: credential_name: Storage Class to use in the cloud
1073 if not storage_class
:
1074 raise Exception("storage_class must be a non-empty string")
1076 raise Exception("name must be a non-empty string")
1077 if not configuration
:
1078 raise Exception("configuration must be provided")
1080 endpoint
= configuration
.host
1081 credential
= self
.get_k8s_cloud_credential(
1086 credential
.attrs
[RBAC_LABEL_KEY_NAME
] = rbac_id
1087 cloud
= client
.Cloud(
1089 auth_types
=[credential
.auth_type
],
1091 ca_certificates
=[client_cert_data
],
1093 "operator-storage": storage_class
,
1094 "workload-storage": storage_class
,
1098 return await self
.add_cloud(
1099 name
, cloud
, credential
, credential_name
=credential_name
1102 def get_k8s_cloud_credential(
1104 configuration
: Configuration
,
1105 client_cert_data
: str,
1107 ) -> client
.CloudCredential
:
1109 # TODO: Test with AKS
1110 key
= None # open(configuration.key_file, "r").read()
1111 username
= configuration
.username
1112 password
= configuration
.password
1114 if client_cert_data
:
1115 attrs
["ClientCertificateData"] = client_cert_data
1117 attrs
["ClientKeyData"] = key
1119 if username
or password
:
1120 raise JujuInvalidK8sConfiguration("Cannot set both token and user/pass")
1121 attrs
["Token"] = token
1125 auth_type
= "oauth2"
1126 if client_cert_data
:
1127 auth_type
= "oauth2withcert"
1129 raise JujuInvalidK8sConfiguration(
1130 "missing token for auth type {}".format(auth_type
)
1135 "credential for user {} has empty password".format(username
)
1137 attrs
["username"] = username
1138 attrs
["password"] = password
1139 if client_cert_data
:
1140 auth_type
= "userpasswithcert"
1142 auth_type
= "userpass"
1143 elif client_cert_data
and token
:
1144 auth_type
= "certificate"
1146 raise JujuInvalidK8sConfiguration("authentication method not supported")
1147 return client
.CloudCredential(auth_type
=auth_type
, attrs
=attrs
)
1149 async def add_cloud(
1153 credential
: CloudCredential
= None,
1154 credential_name
: str = None,
1157 Add cloud to the controller
1159 :param: name: Name of the cloud to be added
1160 :param: cloud: Cloud object
1161 :param: credential: CloudCredentials object for the cloud
1162 :param: credential_name: Credential name.
1163 If not defined, cloud of the name will be used.
1165 controller
= await self
.get_controller()
1167 _
= await controller
.add_cloud(name
, cloud
)
1169 await controller
.add_credential(
1170 credential_name
or name
, credential
=credential
, cloud
=name
1172 # Need to return the object returned by the controller.add_cloud() function
1173 # I'm returning the original value now until this bug is fixed:
1174 # https://github.com/juju/python-libjuju/issues/443
1177 await self
.disconnect_controller(controller
)
1179 async def remove_cloud(self
, name
: str):
1183 :param: name: Name of the cloud to be removed
1185 controller
= await self
.get_controller()
1187 await controller
.remove_cloud(name
)
1189 await self
.disconnect_controller(controller
)
1191 async def _get_leader_unit(self
, application
: Application
) -> Unit
:
1193 for u
in application
.units
:
1194 if await u
.is_leader_from_status():
1199 async def get_cloud_credentials(self
, cloud_name
: str, credential_name
: str):
1200 controller
= await self
.get_controller()
1202 facade
= client
.CloudFacade
.from_connection(controller
.connection())
1203 cloud_cred_tag
= tag
.credential(cloud_name
, self
.username
, credential_name
)
1204 params
= [client
.Entity(cloud_cred_tag
)]
1205 return (await facade
.Credential(params
)).results
1207 await self
.disconnect_controller(controller
)