diff --git a/.gitignore b/.gitignore index cc02691..2f3e4c8 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ .tox/ __pycache__/ *.pyc +*.egg-info +.coverage \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..eefc45f --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2023 Canonical + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/ops/charms/node_base.py b/ops/charms/node_base.py new file mode 100644 index 0000000..14bc081 --- /dev/null +++ b/ops/charms/node_base.py @@ -0,0 +1,153 @@ +"""Library shared between kubernetes control plane and kubernetes worker charms.""" + +import json +import logging +from subprocess import run +from os import PathLike +import time +from typing import Union, List, Mapping, Optional, Protocol, Tuple + +from ops import Model, Object, CharmMeta, StoredState + +log = logging.getLogger(__name__) + + +class Charm(Protocol): + def get_node_name(self) -> str: + ... + + def get_cloud_name(self) -> str: + ... + + model: Model + + meta: CharmMeta + + +class LabelMaker(Object): + """Use to apply labels to a kubernetes node.""" + + _stored = StoredState() + + class NodeLabelError(Exception): + """Raised when there's an error labeling a node.""" + + pass + + def __init__(self, charm: Charm, kubeconfig_path: Union[PathLike, str]): + super().__init__(parent=charm, key="NodeBase") + self.kubeconfig_path = kubeconfig_path + self.charm = charm + self._stored.set_default(current_labels=dict()) + + @staticmethod + def _retried_call( + cmd: List[str], retry_msg: str, timeout: int = 180 + ) -> Tuple[str, str]: + deadline = time.time() + timeout + while time.time() < deadline: + rc = run(cmd) + if rc.returncode == 0: + return rc.stdout, rc.stderr + log.info(retry_msg) + time.sleep(1) + else: + raise LabelMaker.NodeLabelError(retry_msg) + + def active_labels(self) -> Optional[Mapping[str, str]]: + """ + Returns all existing labels if the api server fetch from the node, + otherwise returns None indicating the node cannot be relabeled. + """ + cmd = "kubectl --kubeconfig={0} get node {1} -o=jsonpath='{.metadata.labels}" + cmd = cmd.format(self.kubeconfig_path, self.charm.get_node_name()) + retry_msg = "Failed to get labels. Will retry." + try: + label_json = LabelMaker._retried_call(cmd.split(), retry_msg) + except LabelMaker.NodeLabelError: + return None + try: + return json.loads(label_json) + except json.JSONDecodeError: + return None + + def set_label(self, label: str, value: str) -> None: + """ + Add a label to this node. + + @param str label: Label name to apply + @param str value: Value to associate with the label + @raises LabelMaker.NodeLabelError: if the label cannot be added + """ + cmd = "kubectl --kubeconfig={0} label node {1} {2}={3} --overwrite" + cmd = cmd.format(self.kubeconfig_path, self.charm.get_node_name(), label, value) + retry_msg = "Failed to apply label {0}={1}. Will retry.".format(label, value) + LabelMaker._retried_call(cmd.split(), retry_msg) + + def remove_label(self, label: str) -> None: + """ + Remove a label to this node. + + @param str label: Label name to remove + @raises LabelMaker.NodeLabelError: if the label cannot be removed + """ + cmd = "kubectl --kubeconfig={0} label node {1} {2}-" + cmd = cmd.format(self.kubeconfig_path, self.charm.get_node_name(), label) + retry_msg = "Failed to remove label {0}. Will retry.".format(label) + LabelMaker._retried_call(cmd.split(), retry_msg) + + def apply_node_labels(self) -> None: + """ + Parse the `labels` configuration option and apply the labels to the + node. + + @raises LabelMaker.NodeLabelError: if the label cannot be added or removed + """ + # Get the user's configured labels. + config = self.charm.model.config + user_labels = {} + for item in config.get("labels").split(" "): + try: + key, val = item.split("=") + except ValueError: + log.info(f"Skipping malformed option: {item}.") + else: + user_labels[key] = val + # Collect the current label state. + current_labels = self._stored.current_labels + + try: + # Remove any labels that the user has removed from the config. + for key in list(current_labels.keys()): + if key not in user_labels: + self.remove_label(key) + del self._stored.current_labels[key] + + # Add any new labels. + for key, val in user_labels.items(): + self.set_label(key, val) + self._stored.current_labels[key] = val + + # Set the juju-application and juju-charm labels. + self.set_label("juju-application", self.charm.model.app.name) + self.set_label("juju-charm", self.charm.meta.name) + + # Set the juju.io/cloud label. + juju_io_cloud_labels = [ + ("aws", "ec2"), + ("gcp", "gce"), + ("openstack", "openstack"), + ("vsphere", "vsphere"), + ("azure", "azure"), + ] + for endpoint, label in juju_io_cloud_labels: + if endpoint == self.charm.get_cloud_name(): + self.set_label("juju.io/cloud", label) + break + else: + # none of the endpoints matched, remove the label + self.remove_label("juju.io/cloud") + + except self.NodeLabelError as ex: + log.exception(str(ex)) + raise diff --git a/ops/pyproject.toml b/ops/pyproject.toml new file mode 100644 index 0000000..e00d606 --- /dev/null +++ b/ops/pyproject.toml @@ -0,0 +1,24 @@ +[build-system] +requires = ["setuptools>=61.0"] +build-backend = "setuptools.build_meta" + +[project] +name = "charm-lib-node-base" +version = "0.0.0" +authors = [ + {name="Adam Dyess", email="adam.dyess@canonical.com"}, +] +description = "Charm library for node-base" +readme = "README.md" +requires-python = ">=3.8" +dependencies = [ + "ops", +] +classifiers = [ + "License :: OSI Approved :: Apache Software License", + "Programming Language :: Python :: 3", +] + +[project.urls] +"Homepage" = "https://github.com/charmed-kubernetes/layer-kubernetes-node-base" +"Bug Tracker" = "https://github.com/charmed-kubernetes/layer-kubernetes-node-base/issues" \ No newline at end of file diff --git a/ops/tests/unit/test_ops.py b/ops/tests/unit/test_ops.py new file mode 100644 index 0000000..a8a8219 --- /dev/null +++ b/ops/tests/unit/test_ops.py @@ -0,0 +1,2 @@ +def test_pass(): + pass diff --git a/ops/tox.ini b/ops/tox.ini new file mode 100644 index 0000000..c0bc03a --- /dev/null +++ b/ops/tox.ini @@ -0,0 +1,22 @@ +[tox] +envlist = unit + +[vars] +tst_path = {toxinidir}/tests + +[testenv] +basepython = python3 +setenv = + PYTHONPATH = {toxinidir} + +[testenv:unit] +deps = + pytest-cov + pytest-html +commands = + pytest \ + -vv \ + --cov='{envsitepackagesdir}/charms/' \ + --cov-report=term-missing \ + --tb=native \ + {posargs:{[vars]tst_path}/unit} \ No newline at end of file diff --git a/tox.ini b/tox.ini index 7a29347..9a334de 100644 --- a/tox.ini +++ b/tox.ini @@ -9,6 +9,7 @@ skipsdist = True envlist = lint,unit [testenv] +allowlist_externals = tox setenv = PYTHONPATH={toxinidir}:{toxinidir}/lib PYTHONBREAKPOINT=ipdb.set_trace @@ -20,12 +21,24 @@ deps = pytest charms.unit_test ipdb -commands = pytest --tb native -s {posargs} {toxinidir}/tests/unit +commands = + pytest --tb native -s {posargs} {toxinidir}/tests/unit --ignore={toxinidir}/ops + tox -c {toxinidir}/ops/ -e unit + + +[testenv:format] +deps = + black + ruff +commands = + ruff --fix {toxinidir}/lib {toxinidir}/reactive {toxinidir}/ops {toxinidir}/tests + black {toxinidir}/lib {toxinidir}/reactive {toxinidir}/ops {toxinidir}/tests + [testenv:lint] deps = black - flake8 + ruff commands = - flake8 {toxinidir}/lib {toxinidir}/reactive {toxinidir}/tests - black --check {toxinidir}/lib {toxinidir}/reactive {toxinidir}/tests + ruff {toxinidir}/lib {toxinidir}/reactive {toxinidir}/ops {toxinidir}/tests + black --check {toxinidir}/lib {toxinidir}/reactive {toxinidir}/ops {toxinidir}/tests