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>
355 if kdu_model
.startswith("cs:"):
357 elif kdu_model
.startswith("http"):
363 # if kdu_model.endswith(".tar.gz") or kdu_model.endswith(".tgz")
364 # Uncompress temporarily
365 # bundle = <uncompressed file>
369 # Raise named exception that the bundle could not be found
372 self
.log
.debug("[install] deploying {}".format(bundle
))
373 await model
.deploy(bundle
)
375 # Get the application
377 # applications = model.applications
378 self
.log
.debug("[install] Applications: {}".format(model
.applications
))
379 for name
in model
.applications
:
380 self
.log
.debug("[install] Waiting for {} to settle".format(name
))
381 application
= model
.applications
[name
]
383 # It's not enough to wait for all units to be active;
384 # the application status needs to be active as well.
385 self
.log
.debug("Waiting for all units to be active...")
386 await model
.block_until(
388 unit
.agent_status
== 'idle'
389 and application
.status
in ['active', 'unknown']
390 and unit
.workload_status
in [
392 ] for unit
in application
.units
396 self
.log
.debug("All units active.")
398 except concurrent
.futures
._base
.TimeoutError
:
399 self
.log
.debug("[install] Timeout exceeded; resetting cluster")
400 await self
.reset(cluster_uuid
)
403 # Wait for the application to be active
404 if model
.is_connected():
405 self
.log
.debug("[install] Disconnecting model")
406 await model
.disconnect()
409 raise Exception("Unable to install")
411 async def instances_list(
416 returns a list of deployed releases in a cluster
418 :param cluster_uuid: the cluster
427 kdu_model
: str = None,
432 :param cluster_uuid str: The UUID of the cluster to upgrade
433 :param kdu_instance str: The unique name of the KDU instance
434 :param kdu_model str: The name or path of the bundle to upgrade to
435 :param params dict: Key-value pairs of instantiation parameters
437 :return: If successful, reference to the new revision number of the
441 # TODO: Loop through the bundle and upgrade each charm individually
444 The API doesn't have a concept of bundle upgrades, because there are
445 many possible changes: charm revision, disk, number of units, etc.
447 As such, we are only supporting a limited subset of upgrades. We'll
448 upgrade the charm revision but leave storage and scale untouched.
450 Scale changes should happen through OSM constructs, and changes to
451 storage would require a redeployment of the service, at least in this
454 namespace
= self
.get_namespace(cluster_uuid
)
455 model
= await self
.get_model(namespace
, cluster_uuid
=cluster_uuid
)
457 with
open(kdu_model
, 'r') as f
:
458 bundle
= yaml
.safe_load(f
)
462 'description': 'Test bundle',
463 'bundle': 'kubernetes',
466 'charm': 'cs:~charmed-osm/mariadb-k8s-20',
469 'password': 'manopw',
470 'root_password': 'osm4u',
473 'series': 'kubernetes'
478 # TODO: This should be returned in an agreed-upon format
479 for name
in bundle
['applications']:
480 self
.log
.debug(model
.applications
)
481 application
= model
.applications
[name
]
482 self
.log
.debug(application
)
484 path
= bundle
['applications'][name
]['charm']
487 await application
.upgrade_charm(switch
=path
)
488 except juju
.errors
.JujuError
as ex
:
489 if 'already running charm' in str(ex
):
490 # We're already running this version
493 await model
.disconnect()
496 raise NotImplemented()
507 :param cluster_uuid str: The UUID of the cluster to rollback
508 :param kdu_instance str: The unique name of the KDU instance
509 :param revision int: The revision to revert to. If omitted, rolls back
510 the previous upgrade.
512 :return: If successful, returns the revision of active KDU instance,
513 or raises an exception
515 raise NotImplemented()
523 """Uninstall a KDU instance
525 :param cluster_uuid str: The UUID of the cluster
526 :param kdu_instance str: The unique name of the KDU instance
528 :return: Returns True if successful, or raises an exception
530 if not self
.authenticated
:
531 self
.log
.debug("[uninstall] Connecting to controller")
532 await self
.login(cluster_uuid
)
534 self
.log
.debug("[uninstall] Destroying model")
536 await self
.controller
.destroy_models(kdu_instance
)
538 self
.log
.debug("[uninstall] Model destroyed and disconnecting")
544 async def inspect_kdu(
550 Inspects a bundle and returns a dictionary of config parameters and
551 their default values.
553 :param kdu_model str: The name or path of the bundle to inspect.
555 :return: If successful, returns a dictionary of available parameters
556 and their default values.
560 with
open(kdu_model
, 'r') as f
:
561 bundle
= yaml
.safe_load(f
)
565 'description': 'Test bundle',
566 'bundle': 'kubernetes',
569 'charm': 'cs:~charmed-osm/mariadb-k8s-20',
572 'password': 'manopw',
573 'root_password': 'osm4u',
576 'series': 'kubernetes'
581 # TODO: This should be returned in an agreed-upon format
582 kdu
= bundle
['applications']
592 If available, returns the README of the bundle.
594 :param kdu_model str: The name or path of a bundle
596 :return: If found, returns the contents of the README.
600 files
= ['README', 'README.txt', 'README.md']
601 path
= os
.path
.dirname(kdu_model
)
602 for file in os
.listdir(path
):
604 with
open(file, 'r') as f
:
610 async def status_kdu(
615 """Get the status of the KDU
617 Get the current status of the KDU instance.
619 :param cluster_uuid str: The UUID of the cluster
620 :param kdu_instance str: The unique id of the KDU instance
622 :return: Returns a dictionary containing namespace, state, resources,
627 model
= await self
.get_model(self
.get_namespace(cluster_uuid
), cluster_uuid
=cluster_uuid
)
629 # model = await self.get_model_by_uuid(cluster_uuid)
631 model_status
= await model
.get_status()
632 status
= model_status
.applications
634 for name
in model_status
.applications
:
635 application
= model_status
.applications
[name
]
637 'status': application
['status']['status']
640 if model
.is_connected():
641 await model
.disconnect()
651 """Add a k8s cloud to Juju
653 Adds a Kubernetes cloud to Juju, so it can be bootstrapped with a
656 :param cloud_name str: The name of the cloud to add.
657 :param credentials dict: A dictionary representing the output of
658 `kubectl config view --raw`.
660 :returns: True if successful, otherwise raises an exception.
663 cmd
= [self
.juju_command
, "add-k8s", "--local", cloud_name
]
666 process
= await asyncio
.create_subprocess_exec(
668 stdout
=asyncio
.subprocess
.PIPE
,
669 stderr
=asyncio
.subprocess
.PIPE
,
670 stdin
=asyncio
.subprocess
.PIPE
,
673 # Feed the process the credentials
674 process
.stdin
.write(credentials
.encode("utf-8"))
675 await process
.stdin
.drain()
676 process
.stdin
.close()
678 stdout
, stderr
= await process
.communicate()
680 return_code
= process
.returncode
682 self
.log
.debug("add-k8s return code: {}".format(return_code
))
685 raise Exception(stderr
)
693 ) -> juju
.model
.Model
:
694 """Adds a model to the controller
696 Adds a new model to the Juju controller
698 :param model_name str: The name of the model to add.
699 :returns: The juju.model.Model object of the new model upon success or
702 if not self
.authenticated
:
703 await self
.login(cluster_uuid
)
705 self
.log
.debug("Adding model '{}' to cluster_uuid '{}'".format(model_name
, cluster_uuid
))
707 model
= await self
.controller
.add_model(
709 config
={'authorized-keys': self
.juju_public_key
}
711 except Exception as ex
:
713 self
.log
.debug("Caught exception: {}".format(ex
))
724 """Bootstrap a Kubernetes controller
726 Bootstrap a Juju controller inside the Kubernetes cluster
728 :param cloud_name str: The name of the cloud.
729 :param cluster_uuid str: The UUID of the cluster to bootstrap.
730 :param loadbalancer bool: If the controller should use loadbalancer or not.
731 :returns: True upon success or raises an exception.
735 cmd
= [self
.juju_command
, "bootstrap", cloud_name
, cluster_uuid
]
738 For public clusters, specify that the controller service is using a LoadBalancer.
740 cmd
= [self
.juju_command
, "bootstrap", cloud_name
, cluster_uuid
, "--config", "controller-service-type=loadbalancer"]
742 self
.log
.debug("Bootstrapping controller {} in cloud {}".format(
743 cluster_uuid
, cloud_name
746 process
= await asyncio
.create_subprocess_exec(
748 stdout
=asyncio
.subprocess
.PIPE
,
749 stderr
=asyncio
.subprocess
.PIPE
,
752 stdout
, stderr
= await process
.communicate()
754 return_code
= process
.returncode
758 if b
'already exists' not in stderr
:
759 raise Exception(stderr
)
763 async def destroy_controller(
767 """Destroy a Kubernetes controller
769 Destroy an existing Kubernetes controller.
771 :param cluster_uuid str: The UUID of the cluster to bootstrap.
772 :returns: True upon success or raises an exception.
776 "destroy-controller",
777 "--destroy-all-models",
783 process
= await asyncio
.create_subprocess_exec(
785 stdout
=asyncio
.subprocess
.PIPE
,
786 stderr
=asyncio
.subprocess
.PIPE
,
789 stdout
, stderr
= await process
.communicate()
791 return_code
= process
.returncode
795 if 'already exists' not in stderr
:
796 raise Exception(stderr
)
802 """Get the cluster configuration
804 Gets the configuration of the cluster
806 :param cluster_uuid str: The UUID of the cluster.
807 :return: A dict upon success, or raises an exception.
809 cluster_config
= "{}/{}.yaml".format(self
.fs
.path
, cluster_uuid
)
810 if os
.path
.exists(cluster_config
):
811 with
open(cluster_config
, 'r') as f
:
812 config
= yaml
.safe_load(f
.read())
816 "Unable to locate configuration for cluster {}".format(
825 ) -> juju
.model
.Model
:
826 """Get a model from the Juju Controller.
828 Note: Model objects returned must call disconnected() before it goes
831 :param model_name str: The name of the model to get
832 :return The juju.model.Model object if found, or None.
834 if not self
.authenticated
:
835 await self
.login(cluster_uuid
)
838 models
= await self
.controller
.list_models()
839 self
.log
.debug(models
)
840 if model_name
in models
:
841 self
.log
.debug("Found model: {}".format(model_name
))
842 model
= await self
.controller
.get_model(
851 """Get the namespace UUID
852 Gets the namespace's unique name
854 :param cluster_uuid str: The UUID of the cluster
855 :returns: The namespace UUID, or raises an exception
857 config
= self
.get_config(cluster_uuid
)
859 # Make sure the name is in the config
860 if 'namespace' not in config
:
861 raise Exception("Namespace not found.")
863 # TODO: We want to make sure this is unique to the cluster, in case
864 # the cluster is being reused.
865 # Consider pre/appending the cluster id to the namespace string
866 return config
['namespace']
872 """Check if a model exists in the controller
874 Checks to see if a model exists in the connected Juju controller.
876 :param model_name str: The name of the model
877 :return: A boolean indicating if the model exists
879 models
= await self
.controller
.list_models()
881 if model_name
in models
:
889 """Check if a cluster is local
891 Checks if a cluster is running in the local host
893 :param credentials dict: A dictionary containing the k8s credentials
894 :returns: A boolean if the cluster is running locally
896 creds
= yaml
.safe_load(credentials
)
897 if os
.getenv("OSMLCM_VCA_APIPROXY"):
898 host_ip
= os
.getenv("OSMLCM_VCA_APIPROXY")
900 if creds
and host_ip
:
901 for cluster
in creds
['clusters']:
902 if 'server' in cluster
['cluster']:
903 if host_ip
in cluster
['cluster']['server']:
908 async def login(self
, cluster_uuid
):
909 """Login to the Juju controller."""
911 if self
.authenticated
:
914 self
.connecting
= True
916 # Test: Make sure we have the credentials loaded
917 config
= self
.get_config(cluster_uuid
)
919 self
.juju_endpoint
= config
['endpoint']
920 self
.juju_user
= config
['username']
921 self
.juju_secret
= config
['secret']
922 self
.juju_ca_cert
= config
['cacert']
923 self
.juju_public_key
= None
925 self
.controller
= Controller()
929 "Connecting to controller... ws://{} as {}/{}".format(
936 await self
.controller
.connect(
937 endpoint
=self
.juju_endpoint
,
938 username
=self
.juju_user
,
939 password
=self
.juju_secret
,
940 cacert
=self
.juju_ca_cert
,
942 self
.authenticated
= True
943 self
.log
.debug("JujuApi: Logged into controller")
944 except Exception as ex
:
946 self
.log
.debug("Caught exception: {}".format(ex
))
949 self
.log
.fatal("VCA credentials not configured.")
950 self
.authenticated
= False
952 async def logout(self
):
953 """Logout of the Juju controller."""
954 self
.log
.debug("[logout]")
955 if not self
.authenticated
:
958 for model
in self
.models
:
959 self
.log
.debug("Logging out of model {}".format(model
))
960 await self
.models
[model
].disconnect()
963 self
.log
.debug("Disconnecting controller {}".format(
966 await self
.controller
.disconnect()
967 self
.controller
= None
969 self
.authenticated
= False
971 async def remove_cloud(
975 """Remove a k8s cloud from Juju
977 Removes a Kubernetes cloud from Juju.
979 :param cloud_name str: The name of the cloud to add.
981 :returns: True if successful, otherwise raises an exception.
984 # Remove the bootstrapped controller
985 cmd
= [self
.juju_command
, "remove-k8s", "--client", cloud_name
]
986 process
= await asyncio
.create_subprocess_exec(
988 stdout
=asyncio
.subprocess
.PIPE
,
989 stderr
=asyncio
.subprocess
.PIPE
,
992 stdout
, stderr
= await process
.communicate()
994 return_code
= process
.returncode
997 raise Exception(stderr
)
999 # Remove the cloud from the local config
1000 cmd
= [self
.juju_command
, "remove-cloud", "--client", cloud_name
]
1001 process
= await asyncio
.create_subprocess_exec(
1003 stdout
=asyncio
.subprocess
.PIPE
,
1004 stderr
=asyncio
.subprocess
.PIPE
,
1007 stdout
, stderr
= await process
.communicate()
1009 return_code
= process
.returncode
1012 raise Exception(stderr
)
1016 async def set_config(
1021 """Save the cluster configuration
1023 Saves the cluster information to the file store
1025 :param cluster_uuid str: The UUID of the cluster
1026 :param config dict: A dictionary containing the cluster configuration
1027 :returns: Boolean upon success or raises an exception.
1030 cluster_config
= "{}/{}.yaml".format(self
.fs
.path
, cluster_uuid
)
1031 if not os
.path
.exists(cluster_config
):
1032 self
.log
.debug("Writing config to {}".format(cluster_config
))
1033 with
open(cluster_config
, 'w') as f
:
1034 f
.write(yaml
.dump(config
, Dumper
=yaml
.Dumper
))