1 # Copyright 2019 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.
17 from .exceptions
import NotImplemented
21 # from juju.bundle import BundleHandler
22 from juju
.controller
import Controller
23 from juju
.model
import Model
24 from juju
.errors
import JujuAPIError
, JujuError
26 from n2vc
.k8s_conn
import K8sConnector
31 # from .vnf import N2VC
37 class K8sJujuConnector(K8sConnector
):
43 kubectl_command
: str = '/usr/bin/kubectl',
44 juju_command
: str = '/usr/bin/juju',
50 :param kubectl_command: path to kubectl executable
51 :param helm_command: path to helm executable
52 :param fs: file system for kubernetes and helm configuration
57 K8sConnector
.__init
__(
61 on_update_db
=on_update_db
,
65 self
.log
.debug('Initializing K8S Juju connector')
67 self
.authenticated
= False
70 self
.juju_command
= juju_command
73 self
.log
.debug('K8S Juju connector initialized')
79 namespace
: str = 'kube-system',
80 reuse_cluster_uuid
: str = None,
83 It prepares a given K8s cluster environment to run Juju bundles.
85 :param k8s_creds: credentials to access a given K8s cluster, i.e. a valid '.kube/config'
86 :param namespace: optional namespace to be used for juju. By default, 'kube-system' will be used
87 :param reuse_cluster_uuid: existing cluster uuid for reuse
88 :return: uuid of the K8s cluster and True if connector has installed some software in the cluster
89 (on error, an exception will be raised)
94 Bootstrapping cannot be done, by design, through the API. We need to
101 1. Has the environment already been bootstrapped?
102 - Check the database to see if we have a record for this env
104 2. If this is a new env, create it
105 - Add the k8s cloud to Juju
107 - Record it in the database
109 3. Connect to the Juju controller for this cloud
112 # cluster_uuid = reuse_cluster_uuid
113 # if not cluster_uuid:
114 # cluster_uuid = str(uuid4())
116 ##################################################
117 # TODO: Pull info from db based on the namespace #
118 ##################################################
120 ###################################################
121 # TODO: Make it idempotent, calling add-k8s and #
122 # bootstrap whenever reuse_cluster_uuid is passed #
124 # `init_env` is called to initialize the K8s #
125 # cluster for juju. If this initialization fails, #
126 # it can be called again by LCM with the param #
127 # reuse_cluster_uuid, e.g. to try to fix it. #
128 ###################################################
130 if not reuse_cluster_uuid
:
131 # This is a new cluster, so bootstrap it
133 cluster_uuid
= str(uuid
.uuid4())
135 # Is a local k8s cluster?
136 localk8s
= self
.is_local_k8s(k8s_creds
)
138 # If the k8s is external, the juju controller needs a loadbalancer
139 loadbalancer
= False if localk8s
else True
141 # Name the new k8s cloud
142 k8s_cloud
= "k8s-{}".format(cluster_uuid
)
144 self
.log
.debug("Adding k8s cloud {}".format(k8s_cloud
))
145 await self
.add_k8s(k8s_cloud
, k8s_creds
)
147 # Bootstrap Juju controller
148 self
.log
.debug("Bootstrapping...")
149 await self
.bootstrap(k8s_cloud
, cluster_uuid
, loadbalancer
)
150 self
.log
.debug("Bootstrap done.")
152 # Get the controller information
154 # Parse ~/.local/share/juju/controllers.yaml
155 # controllers.testing.api-endpoints|ca-cert|uuid
156 self
.log
.debug("Getting controller endpoints")
157 with
open(os
.path
.expanduser(
158 "~/.local/share/juju/controllers.yaml"
160 controllers
= yaml
.load(f
, Loader
=yaml
.Loader
)
161 controller
= controllers
['controllers'][cluster_uuid
]
162 endpoints
= controller
['api-endpoints']
163 self
.juju_endpoint
= endpoints
[0]
164 self
.juju_ca_cert
= controller
['ca-cert']
166 # Parse ~/.local/share/juju/accounts
167 # controllers.testing.user|password
168 self
.log
.debug("Getting accounts")
169 with
open(os
.path
.expanduser(
170 "~/.local/share/juju/accounts.yaml"
172 controllers
= yaml
.load(f
, Loader
=yaml
.Loader
)
173 controller
= controllers
['controllers'][cluster_uuid
]
175 self
.juju_user
= controller
['user']
176 self
.juju_secret
= controller
['password']
178 # raise Exception("EOL")
180 self
.juju_public_key
= None
183 'endpoint': self
.juju_endpoint
,
184 'username': self
.juju_user
,
185 'secret': self
.juju_secret
,
186 'cacert': self
.juju_ca_cert
,
187 'namespace': namespace
,
188 'loadbalancer': loadbalancer
,
191 # Store the cluster configuration so it
192 # can be used for subsequent calls
193 self
.log
.debug("Setting config")
194 await self
.set_config(cluster_uuid
, config
)
197 # This is an existing cluster, so get its config
198 cluster_uuid
= reuse_cluster_uuid
200 config
= self
.get_config(cluster_uuid
)
202 self
.juju_endpoint
= config
['endpoint']
203 self
.juju_user
= config
['username']
204 self
.juju_secret
= config
['secret']
205 self
.juju_ca_cert
= config
['cacert']
206 self
.juju_public_key
= None
208 # Login to the k8s cluster
209 if not self
.authenticated
:
210 await self
.login(cluster_uuid
)
212 # We're creating a new cluster
213 #print("Getting model {}".format(self.get_namespace(cluster_uuid), cluster_uuid=cluster_uuid))
214 #model = await self.get_model(
215 # self.get_namespace(cluster_uuid),
216 # cluster_uuid=cluster_uuid
219 ## Disconnect from the model
220 #if model and model.is_connected():
221 # await model.disconnect()
223 return cluster_uuid
, True
225 """Repo Management"""
232 raise NotImplemented()
234 async def repo_list(self
):
235 raise NotImplemented()
237 async def repo_remove(
241 raise NotImplemented()
243 async def synchronize_repos(
249 Returns None as currently add_repo is not implemented
258 uninstall_sw
: bool = False
262 Resets the Kubernetes cluster by removing the model that represents it.
264 :param cluster_uuid str: The UUID of the cluster to reset
265 :return: Returns True if successful or raises an exception.
269 if not self
.authenticated
:
270 await self
.login(cluster_uuid
)
272 if self
.controller
.is_connected():
274 namespace
= self
.get_namespace(cluster_uuid
)
275 if await self
.has_model(namespace
):
276 self
.log
.debug("[reset] Destroying model")
277 await self
.controller
.destroy_model(
282 # Disconnect from the controller
283 self
.log
.debug("[reset] Disconnecting controller")
286 # Destroy the controller (via CLI)
287 self
.log
.debug("[reset] Destroying controller")
288 await self
.destroy_controller(cluster_uuid
)
290 self
.log
.debug("[reset] Removing k8s cloud")
291 k8s_cloud
= "k8s-{}".format(cluster_uuid
)
292 await self
.remove_cloud(k8s_cloud
)
294 except Exception as ex
:
295 self
.log
.debug("Caught exception during reset: {}".format(ex
))
306 timeout
: float = 300,
308 db_dict
: dict = None,
313 :param cluster_uuid str: The UUID of the cluster to install to
314 :param kdu_model str: The name or path of a bundle to install
315 :param atomic bool: If set, waits until the model is active and resets
316 the cluster on failure.
317 :param timeout int: The time, in seconds, to wait for the install
319 :param params dict: Key-value pairs of instantiation parameters
320 :param kdu_name: Name of the KDU instance to be installed
322 :return: If successful, returns ?
325 if not self
.authenticated
:
326 self
.log
.debug("[install] Logging in to the controller")
327 await self
.login(cluster_uuid
)
330 # Get or create the model, based on the NS
333 kdu_instance
= "{}-{}".format(kdu_name
, db_dict
["filter"]["_id"])
335 kdu_instance
= db_dict
["filter"]["_id"]
337 self
.log
.debug("Checking for model named {}".format(kdu_instance
))
339 # Create the new model
340 self
.log
.debug("Adding model: {}".format(kdu_instance
))
341 model
= await self
.add_model(kdu_instance
, cluster_uuid
=cluster_uuid
)
344 # TODO: Instantiation parameters
347 "Juju bundle that models the KDU, in any of the following ways:
348 - <juju-repo>/<juju-bundle>
349 - <juju-bundle folder under k8s_models folder in the package>
350 - <juju-bundle tgz file (w/ or w/o extension) under k8s_models folder in the package>
351 - <URL_where_to_fetch_juju_bundle>
354 previous_workdir
= os
.getcwd()
357 if kdu_model
.startswith("cs:"):
359 elif kdu_model
.startswith("http"):
363 new_workdir
= kdu_model
.strip(kdu_model
.split("/")[-1])
365 os
.chdir(new_workdir
)
367 bundle
= "local:{}".format(kdu_model
)
370 # Raise named exception that the bundle could not be found
373 self
.log
.debug("[install] deploying {}".format(bundle
))
374 await model
.deploy(bundle
)
376 # Get the application
378 # applications = model.applications
379 self
.log
.debug("[install] Applications: {}".format(model
.applications
))
380 for name
in model
.applications
:
381 self
.log
.debug("[install] Waiting for {} to settle".format(name
))
382 application
= model
.applications
[name
]
384 # It's not enough to wait for all units to be active;
385 # the application status needs to be active as well.
386 self
.log
.debug("Waiting for all units to be active...")
387 await model
.block_until(
389 unit
.agent_status
== 'idle'
390 and application
.status
in ['active', 'unknown']
391 and unit
.workload_status
in [
393 ] for unit
in application
.units
397 self
.log
.debug("All units active.")
399 except concurrent
.futures
._base
.TimeoutError
:
400 os
.chdir(previous_workdir
)
401 self
.log
.debug("[install] Timeout exceeded; resetting cluster")
402 await self
.reset(cluster_uuid
)
405 # Wait for the application to be active
406 if model
.is_connected():
407 self
.log
.debug("[install] Disconnecting model")
408 await model
.disconnect()
410 os
.chdir(previous_workdir
)
413 raise Exception("Unable to install")
415 async def instances_list(
420 returns a list of deployed releases in a cluster
422 :param cluster_uuid: the cluster
431 kdu_model
: str = None,
436 :param cluster_uuid str: The UUID of the cluster to upgrade
437 :param kdu_instance str: The unique name of the KDU instance
438 :param kdu_model str: The name or path of the bundle to upgrade to
439 :param params dict: Key-value pairs of instantiation parameters
441 :return: If successful, reference to the new revision number of the
445 # TODO: Loop through the bundle and upgrade each charm individually
448 The API doesn't have a concept of bundle upgrades, because there are
449 many possible changes: charm revision, disk, number of units, etc.
451 As such, we are only supporting a limited subset of upgrades. We'll
452 upgrade the charm revision but leave storage and scale untouched.
454 Scale changes should happen through OSM constructs, and changes to
455 storage would require a redeployment of the service, at least in this
458 namespace
= self
.get_namespace(cluster_uuid
)
459 model
= await self
.get_model(namespace
, cluster_uuid
=cluster_uuid
)
461 with
open(kdu_model
, 'r') as f
:
462 bundle
= yaml
.safe_load(f
)
466 'description': 'Test bundle',
467 'bundle': 'kubernetes',
470 'charm': 'cs:~charmed-osm/mariadb-k8s-20',
473 'password': 'manopw',
474 'root_password': 'osm4u',
477 'series': 'kubernetes'
482 # TODO: This should be returned in an agreed-upon format
483 for name
in bundle
['applications']:
484 self
.log
.debug(model
.applications
)
485 application
= model
.applications
[name
]
486 self
.log
.debug(application
)
488 path
= bundle
['applications'][name
]['charm']
491 await application
.upgrade_charm(switch
=path
)
492 except juju
.errors
.JujuError
as ex
:
493 if 'already running charm' in str(ex
):
494 # We're already running this version
497 await model
.disconnect()
500 raise NotImplemented()
511 :param cluster_uuid str: The UUID of the cluster to rollback
512 :param kdu_instance str: The unique name of the KDU instance
513 :param revision int: The revision to revert to. If omitted, rolls back
514 the previous upgrade.
516 :return: If successful, returns the revision of active KDU instance,
517 or raises an exception
519 raise NotImplemented()
527 """Uninstall a KDU instance
529 :param cluster_uuid str: The UUID of the cluster
530 :param kdu_instance str: The unique name of the KDU instance
532 :return: Returns True if successful, or raises an exception
534 if not self
.authenticated
:
535 self
.log
.debug("[uninstall] Connecting to controller")
536 await self
.login(cluster_uuid
)
538 self
.log
.debug("[uninstall] Destroying model")
540 await self
.controller
.destroy_models(kdu_instance
)
542 self
.log
.debug("[uninstall] Model destroyed and disconnecting")
548 async def inspect_kdu(
554 Inspects a bundle and returns a dictionary of config parameters and
555 their default values.
557 :param kdu_model str: The name or path of the bundle to inspect.
559 :return: If successful, returns a dictionary of available parameters
560 and their default values.
564 with
open(kdu_model
, 'r') as f
:
565 bundle
= yaml
.safe_load(f
)
569 'description': 'Test bundle',
570 'bundle': 'kubernetes',
573 'charm': 'cs:~charmed-osm/mariadb-k8s-20',
576 'password': 'manopw',
577 'root_password': 'osm4u',
580 'series': 'kubernetes'
585 # TODO: This should be returned in an agreed-upon format
586 kdu
= bundle
['applications']
596 If available, returns the README of the bundle.
598 :param kdu_model str: The name or path of a bundle
600 :return: If found, returns the contents of the README.
604 files
= ['README', 'README.txt', 'README.md']
605 path
= os
.path
.dirname(kdu_model
)
606 for file in os
.listdir(path
):
608 with
open(file, 'r') as f
:
614 async def status_kdu(
619 """Get the status of the KDU
621 Get the current status of the KDU instance.
623 :param cluster_uuid str: The UUID of the cluster
624 :param kdu_instance str: The unique id of the KDU instance
626 :return: Returns a dictionary containing namespace, state, resources,
631 model
= await self
.get_model(self
.get_namespace(cluster_uuid
), cluster_uuid
=cluster_uuid
)
633 # model = await self.get_model_by_uuid(cluster_uuid)
635 model_status
= await model
.get_status()
636 status
= model_status
.applications
638 for name
in model_status
.applications
:
639 application
= model_status
.applications
[name
]
641 'status': application
['status']['status']
644 if model
.is_connected():
645 await model
.disconnect()
655 """Add a k8s cloud to Juju
657 Adds a Kubernetes cloud to Juju, so it can be bootstrapped with a
660 :param cloud_name str: The name of the cloud to add.
661 :param credentials dict: A dictionary representing the output of
662 `kubectl config view --raw`.
664 :returns: True if successful, otherwise raises an exception.
667 cmd
= [self
.juju_command
, "add-k8s", "--local", cloud_name
]
670 process
= await asyncio
.create_subprocess_exec(
672 stdout
=asyncio
.subprocess
.PIPE
,
673 stderr
=asyncio
.subprocess
.PIPE
,
674 stdin
=asyncio
.subprocess
.PIPE
,
677 # Feed the process the credentials
678 process
.stdin
.write(credentials
.encode("utf-8"))
679 await process
.stdin
.drain()
680 process
.stdin
.close()
682 stdout
, stderr
= await process
.communicate()
684 return_code
= process
.returncode
686 self
.log
.debug("add-k8s return code: {}".format(return_code
))
689 raise Exception(stderr
)
697 ) -> juju
.model
.Model
:
698 """Adds a model to the controller
700 Adds a new model to the Juju controller
702 :param model_name str: The name of the model to add.
703 :returns: The juju.model.Model object of the new model upon success or
706 if not self
.authenticated
:
707 await self
.login(cluster_uuid
)
709 self
.log
.debug("Adding model '{}' to cluster_uuid '{}'".format(model_name
, cluster_uuid
))
711 model
= await self
.controller
.add_model(
713 config
={'authorized-keys': self
.juju_public_key
}
715 except Exception as ex
:
717 self
.log
.debug("Caught exception: {}".format(ex
))
728 """Bootstrap a Kubernetes controller
730 Bootstrap a Juju controller inside the Kubernetes cluster
732 :param cloud_name str: The name of the cloud.
733 :param cluster_uuid str: The UUID of the cluster to bootstrap.
734 :param loadbalancer bool: If the controller should use loadbalancer or not.
735 :returns: True upon success or raises an exception.
739 cmd
= [self
.juju_command
, "bootstrap", cloud_name
, cluster_uuid
]
742 For public clusters, specify that the controller service is using a LoadBalancer.
744 cmd
= [self
.juju_command
, "bootstrap", cloud_name
, cluster_uuid
, "--config", "controller-service-type=loadbalancer"]
746 self
.log
.debug("Bootstrapping controller {} in cloud {}".format(
747 cluster_uuid
, cloud_name
750 process
= await asyncio
.create_subprocess_exec(
752 stdout
=asyncio
.subprocess
.PIPE
,
753 stderr
=asyncio
.subprocess
.PIPE
,
756 stdout
, stderr
= await process
.communicate()
758 return_code
= process
.returncode
762 if b
'already exists' not in stderr
:
763 raise Exception(stderr
)
767 async def destroy_controller(
771 """Destroy a Kubernetes controller
773 Destroy an existing Kubernetes controller.
775 :param cluster_uuid str: The UUID of the cluster to bootstrap.
776 :returns: True upon success or raises an exception.
780 "destroy-controller",
781 "--destroy-all-models",
787 process
= await asyncio
.create_subprocess_exec(
789 stdout
=asyncio
.subprocess
.PIPE
,
790 stderr
=asyncio
.subprocess
.PIPE
,
793 stdout
, stderr
= await process
.communicate()
795 return_code
= process
.returncode
799 if 'already exists' not in stderr
:
800 raise Exception(stderr
)
806 """Get the cluster configuration
808 Gets the configuration of the cluster
810 :param cluster_uuid str: The UUID of the cluster.
811 :return: A dict upon success, or raises an exception.
813 cluster_config
= "{}/{}.yaml".format(self
.fs
.path
, cluster_uuid
)
814 if os
.path
.exists(cluster_config
):
815 with
open(cluster_config
, 'r') as f
:
816 config
= yaml
.safe_load(f
.read())
820 "Unable to locate configuration for cluster {}".format(
829 ) -> juju
.model
.Model
:
830 """Get a model from the Juju Controller.
832 Note: Model objects returned must call disconnected() before it goes
835 :param model_name str: The name of the model to get
836 :return The juju.model.Model object if found, or None.
838 if not self
.authenticated
:
839 await self
.login(cluster_uuid
)
842 models
= await self
.controller
.list_models()
843 self
.log
.debug(models
)
844 if model_name
in models
:
845 self
.log
.debug("Found model: {}".format(model_name
))
846 model
= await self
.controller
.get_model(
855 """Get the namespace UUID
856 Gets the namespace's unique name
858 :param cluster_uuid str: The UUID of the cluster
859 :returns: The namespace UUID, or raises an exception
861 config
= self
.get_config(cluster_uuid
)
863 # Make sure the name is in the config
864 if 'namespace' not in config
:
865 raise Exception("Namespace not found.")
867 # TODO: We want to make sure this is unique to the cluster, in case
868 # the cluster is being reused.
869 # Consider pre/appending the cluster id to the namespace string
870 return config
['namespace']
876 """Check if a model exists in the controller
878 Checks to see if a model exists in the connected Juju controller.
880 :param model_name str: The name of the model
881 :return: A boolean indicating if the model exists
883 models
= await self
.controller
.list_models()
885 if model_name
in models
:
893 """Check if a cluster is local
895 Checks if a cluster is running in the local host
897 :param credentials dict: A dictionary containing the k8s credentials
898 :returns: A boolean if the cluster is running locally
900 creds
= yaml
.safe_load(credentials
)
901 if os
.getenv("OSMLCM_VCA_APIPROXY"):
902 host_ip
= os
.getenv("OSMLCM_VCA_APIPROXY")
904 if creds
and host_ip
:
905 for cluster
in creds
['clusters']:
906 if 'server' in cluster
['cluster']:
907 if host_ip
in cluster
['cluster']['server']:
912 async def login(self
, cluster_uuid
):
913 """Login to the Juju controller."""
915 if self
.authenticated
:
918 self
.connecting
= True
920 # Test: Make sure we have the credentials loaded
921 config
= self
.get_config(cluster_uuid
)
923 self
.juju_endpoint
= config
['endpoint']
924 self
.juju_user
= config
['username']
925 self
.juju_secret
= config
['secret']
926 self
.juju_ca_cert
= config
['cacert']
927 self
.juju_public_key
= None
929 self
.controller
= Controller()
933 "Connecting to controller... ws://{} as {}/{}".format(
940 await self
.controller
.connect(
941 endpoint
=self
.juju_endpoint
,
942 username
=self
.juju_user
,
943 password
=self
.juju_secret
,
944 cacert
=self
.juju_ca_cert
,
946 self
.authenticated
= True
947 self
.log
.debug("JujuApi: Logged into controller")
948 except Exception as ex
:
950 self
.log
.debug("Caught exception: {}".format(ex
))
953 self
.log
.fatal("VCA credentials not configured.")
954 self
.authenticated
= False
956 async def logout(self
):
957 """Logout of the Juju controller."""
958 self
.log
.debug("[logout]")
959 if not self
.authenticated
:
962 for model
in self
.models
:
963 self
.log
.debug("Logging out of model {}".format(model
))
964 await self
.models
[model
].disconnect()
967 self
.log
.debug("Disconnecting controller {}".format(
970 await self
.controller
.disconnect()
971 self
.controller
= None
973 self
.authenticated
= False
975 async def remove_cloud(
979 """Remove a k8s cloud from Juju
981 Removes a Kubernetes cloud from Juju.
983 :param cloud_name str: The name of the cloud to add.
985 :returns: True if successful, otherwise raises an exception.
988 # Remove the bootstrapped controller
989 cmd
= [self
.juju_command
, "remove-k8s", "--client", cloud_name
]
990 process
= await asyncio
.create_subprocess_exec(
992 stdout
=asyncio
.subprocess
.PIPE
,
993 stderr
=asyncio
.subprocess
.PIPE
,
996 stdout
, stderr
= await process
.communicate()
998 return_code
= process
.returncode
1001 raise Exception(stderr
)
1003 # Remove the cloud from the local config
1004 cmd
= [self
.juju_command
, "remove-cloud", "--client", cloud_name
]
1005 process
= await asyncio
.create_subprocess_exec(
1007 stdout
=asyncio
.subprocess
.PIPE
,
1008 stderr
=asyncio
.subprocess
.PIPE
,
1011 stdout
, stderr
= await process
.communicate()
1013 return_code
= process
.returncode
1016 raise Exception(stderr
)
1020 async def set_config(
1025 """Save the cluster configuration
1027 Saves the cluster information to the file store
1029 :param cluster_uuid str: The UUID of the cluster
1030 :param config dict: A dictionary containing the cluster configuration
1031 :returns: Boolean upon success or raises an exception.
1034 cluster_config
= "{}/{}.yaml".format(self
.fs
.path
, cluster_uuid
)
1035 if not os
.path
.exists(cluster_config
):
1036 self
.log
.debug("Writing config to {}".format(cluster_config
))
1037 with
open(cluster_config
, 'w') as f
:
1038 f
.write(yaml
.dump(config
, Dumper
=yaml
.Dumper
))