kalavai-client 0.5.0__py2.py3-none-any.whl

kalavai_client/utils.py

@@ -0,0 +1,456 @@
+import json, base64
+import os
+import requests
+from pathlib import Path
+from urllib.parse import urljoin
+import shutil
+import subprocess
+import re
+
+import importlib
+from jinja2 import Template
+
+from rich.table import Table
+import yaml
+import platform
+import psutil
+
+import GPUtil
+
+from kalavai_client.auth import KalavaiAuthClient
+
+
+GITHUB_ORG = "kalavai-net"
+GITHUB_REPO = "kalavai-client"
+GITHUB_TEMPLATE_PATH = "templates"
+USER_NODE_LABEL_KEY = "user_node_label"
+CLUSTER_IP_KEY = "cluster_ip"
+CLUSTER_TOKEN_KEY = "cluster_token"
+SERVER_IP_KEY = "server_ip"
+NODE_NAME_KEY = "node_name"
+PUBLIC_LOCATION_KEY = "public_location"
+CLUSTER_NAME_KEY = "cluster_name"
+AUTH_KEY = "watcher_admin_key"
+WRITE_AUTH_KEY = "watcher_write_key"
+ALLOW_UNREGISTERED_USER_KEY = "watcher_allow_unregistered_user"
+USER_API_KEY = "user_api_key"
+READONLY_AUTH_KEY = "watcher_readonly_key"
+WATCHER_SERVICE_KEY = "watcher_service"
+WATCHER_PORT_KEY = "watcher_port"
+ENDPOINT_PORTS_KEY = "endpoint_ports"
+TEMPLATE_ID_FIELD = "id_field"
+TEMPLATE_ID_KEY = "deployment_id"
+MANDATORY_TOKEN_FIELDS = [
+    CLUSTER_IP_KEY,
+    CLUSTER_TOKEN_KEY,
+    CLUSTER_NAME_KEY,
+    AUTH_KEY,
+    WATCHER_SERVICE_KEY,
+    PUBLIC_LOCATION_KEY
+]
+MANDATORY_POOLCONFIG_FIELDS = [
+    SERVER_IP_KEY,
+    AUTH_KEY,
+    WATCHER_SERVICE_KEY,
+    NODE_NAME_KEY,
+    CLUSTER_NAME_KEY,
+    PUBLIC_LOCATION_KEY
+]
+
+
+####### Methods to check OS compatibility ########
+def check_gpu_drivers():
+    value = run_cmd("command -v nvidia-smi")
+    if len(value.decode("utf-8")) == 0:
+        # no nvidia installed, no need to check nvidia any further
+        return False
+    else:
+        # check drivers are set correctly
+        try:
+            value = run_cmd("nvidia-smi")
+            return True
+        except:
+            raise ("Nvidia not configured properly. Please check your drivers are installed and configured")
+
+def is_storage_compatible():
+    """
+    Raw method to determine if running node is compatible with PVC (longhorn)
+
+    Exclude: WSL
+    """
+    try:
+        flagged = any([
+            "microsoft" in run_cmd("cat /proc/version").decode().lower()
+        ])
+        return not flagged
+    except:
+        return False
+################
+
+def is_watcher_alive(server_creds, user_cookie):
+    try:
+        request_to_server(
+            method="get",
+            endpoint="/v1/health",
+            data=None,
+            server_creds=server_creds,
+            user_cookie=user_cookie
+        )
+    except Exception as e:
+        print(str(e))
+        return False
+    return True
+
+
+
+def load_server_info(data_key, file):
+    try:
+        with open(file, "r") as f:
+            return json.load(f)[data_key]
+    except:
+        return None
+    
+def user_login(user_cookie, username=None, password=None):
+    auth = KalavaiAuthClient(
+        user_cookie_file=user_cookie
+    )
+    user = auth.load_user_session()
+    if user is None:
+        user = auth.login(username=username, password=password)
+    return user
+
+def user_logout(user_cookie):
+    auth = KalavaiAuthClient(
+        user_cookie_file=user_cookie
+    )
+    auth.logout()
+
+def load_user_session(user_cookie):
+    auth = KalavaiAuthClient(
+        user_cookie_file=user_cookie
+    )
+    if not auth.is_logged_in():
+        return None
+    return auth.load_user_session()
+
+def get_public_vpns(user_cookie):
+    auth = KalavaiAuthClient(
+        user_cookie_file=user_cookie
+    )
+    if not auth.is_logged_in():
+        raise ValueError("Cannot access vpns, user is not authenticated")
+    seeds = auth.call_function(
+        "get_public_vpns"
+    )
+    return seeds
+
+def get_public_seeds(user_only, user_cookie):
+    auth = KalavaiAuthClient(
+        user_cookie_file=user_cookie
+    )
+    if not auth.is_logged_in():
+        raise ValueError("Cannot access vpns, user is not authenticated")
+    user = auth.load_user_session() if user_only else None
+    seeds = auth.call_function(
+        "get_available_seeds",
+        user
+    )
+    return seeds
+
+def get_vpn_details(location, user_cookie):
+    auth = KalavaiAuthClient(
+        user_cookie_file=user_cookie
+    )
+    if not auth.is_logged_in():
+        raise ValueError("Cannot access vpns, user is not authenticated")
+    vpn = auth.call_function(
+        "get_vpn_details",
+        location
+    )
+    return vpn
+
+def register_cluster(name, token, description, user_cookie):
+    auth = KalavaiAuthClient(
+        user_cookie_file=user_cookie
+    )
+    if not auth.is_logged_in():
+        raise ValueError("Cannot register cluster, user is not authenticated")
+    user = auth.load_user_session()
+    seed = auth.call_function(
+        "register_seed",
+        name,
+        user,
+        description,
+        token
+    )
+    return seed
+
+def unregister_cluster(name, user_cookie):
+    auth = KalavaiAuthClient(
+        user_cookie_file=user_cookie
+    )
+    if not auth.is_logged_in():
+        raise ValueError("Cannot unregister cluster, user is not authenticated")
+    user = auth.load_user_session()
+    seed = auth.call_function(
+        "unregister_seed",
+        name,
+        user,
+    )
+    return seed
+
+def validate_join_public_seed(cluster_name, join_key, user_cookie):
+    auth = KalavaiAuthClient(
+        user_cookie_file=user_cookie
+    )
+    if not auth.is_logged_in():
+        raise ValueError("Cannot notify join cluster, user is not authenticated")
+    user = auth.load_user_session()
+    seed = auth.call_function(
+        "validate_join_public_seed",
+        cluster_name,
+        join_key,
+        user,
+    )
+    return seed
+
+def validate_poolconfig(poolconfig_file):
+    if not Path(poolconfig_file).is_file():
+        return False
+    with open(poolconfig_file, "r") as f:
+        data = json.load(f)
+    for field in MANDATORY_POOLCONFIG_FIELDS:
+        if field not in data:
+            return False
+    return True
+
+def run_cmd(command):
+    try:
+        return_value = subprocess.check_output(command, shell=True, executable="/bin/bash")
+        return return_value
+    except OSError as error:
+        return error # for exit code
+
+def join_vpn(location, user_cookie):
+    vpn = get_vpn_details(location=location, user_cookie=user_cookie)
+    token = vpn["key"]
+    if token is None:
+        raise ValueError(f"VPN location {location} not found or is private")
+    try:
+        data = decode_dict(token)
+        for field in ["server", "value"]:
+            assert field in data
+    except:
+        raise ValueError("Invalid net token")
+    run_cmd(f"sudo netclient join -t {token} >/dev/null 2>&1")
+    return vpn
+
+def leave_vpn():
+    try:
+        vpns = json.loads(run_cmd("sudo netclient list").decode())
+        left_vpns = [vpn['network'] for vpn in vpns]
+        for vpn in left_vpns:
+            run_cmd(f"sudo netclient leave {vpn}")
+        return left_vpns
+    except:
+        return None
+
+def request_to_server(
+        method,
+        endpoint,
+        data,
+        server_creds,
+        force_url=None,
+        force_key=None,
+        user_cookie=None
+):
+    if force_url is None:
+        service_url = load_server_info(data_key=WATCHER_SERVICE_KEY, file=server_creds)
+    else:
+        service_url = force_url
+    
+    if force_key is None:
+        auth_key = load_server_info(data_key=AUTH_KEY, file=server_creds)
+    else:
+        auth_key = force_key
+
+    headers = {
+        "X-API-KEY": auth_key
+    }
+
+    user = load_user_session(user_cookie=user_cookie)
+    headers["USER-KEY"] = load_server_info(data_key=USER_API_KEY, file=server_creds)
+    headers["USER"] = user["username"] if user is not None else None
+
+    response = requests.request(
+        method=method,
+        url=f"http://{service_url}{endpoint}",
+        json=data,
+        headers=headers
+    )
+    result = response.json()
+    return result
+
+
+def generate_table(columns, rows, end_sections=None):
+
+    table = Table(show_header=True, header_style="bold white")
+    [table.add_column(col, overflow="fold") for col in columns]
+    for idx, row in enumerate(rows):
+        table.add_row(*row, end_section=end_sections and idx in end_sections)
+
+    return table
+
+def store_server_info(server_ip, auth_key, watcher_service, file, node_name, cluster_name, readonly_auth_key=None, write_auth_key=None, public_location=None, user_api_key=None):
+    with open(file, "w") as f:
+        json.dump({
+            SERVER_IP_KEY: server_ip,
+            AUTH_KEY: auth_key,
+            READONLY_AUTH_KEY: readonly_auth_key,
+            WRITE_AUTH_KEY: write_auth_key,
+            WATCHER_SERVICE_KEY: watcher_service,
+            NODE_NAME_KEY: node_name,
+            CLUSTER_NAME_KEY: cluster_name,
+            PUBLIC_LOCATION_KEY: public_location,
+            USER_API_KEY: user_api_key
+        }, f)
+    return True
+
+def populate_template(template_str, values_dict):
+    return Template(template_str).render(values_dict)
+
+def escape_field(text):
+    return re.sub('[^0-9a-z]+', '-', text.lower())
+
+def load_template(template_path, values, default_values_path=None, force_defaults=False):
+
+    if not Path(template_path).exists():
+        raise FileNotFoundError(f"{template_path} does not exist")
+    with open(template_path, 'r') as f:
+        yaml_template = "".join(f.readlines())
+    
+    # substitute missing values with defaults
+    if default_values_path is not None:
+        with open(default_values_path, 'r') as f:
+            default_values = yaml.safe_load(f)
+        for default in default_values:
+            if default["name"] == TEMPLATE_ID_FIELD:
+                if default["default"] not in values:
+                    raise ValueError(f"Key value '{default['default']}' missing from values")
+                values[TEMPLATE_ID_KEY] = escape_field(values[default["default"]])
+                continue
+            if force_defaults or default["name"] not in values:
+                values[default['name']] = default['default']
+        
+    return populate_template(template_str=yaml_template, values_dict=values)
+
+
+def user_confirm(question: str, options: list, multiple: bool=False) -> int:
+    try:
+        print(question)
+        [print(f"{idx}) {option}") for idx, option in enumerate(options)]
+        reply = str(input())
+        if multiple:
+            if "," in reply:
+                selection = reply.split(",")
+                cast_selection = [int(s) for s in selection]
+                if all([s >= 0 and s < len(options) for s in cast_selection]):
+                    return cast_selection
+            else:
+                reply = int(reply)
+                if reply >= 0 and reply <= len(options):
+                    return [reply]
+        else:
+            reply = int(reply)
+            if reply >= 0 and reply <= len(options):
+                return reply
+
+    except:
+        return None
+    return None
+
+def generate_join_token(cluster_ip, cluster_token, cluster_name, auth_key, watcher_service, public_location):
+    data = {
+        CLUSTER_IP_KEY: cluster_ip,
+        CLUSTER_NAME_KEY: cluster_name,
+        CLUSTER_TOKEN_KEY: cluster_token,
+        AUTH_KEY: auth_key,
+        WATCHER_SERVICE_KEY: watcher_service,
+        PUBLIC_LOCATION_KEY: public_location
+    }
+    return encode_dict(data=data)
+
+def encode_dict(data: dict):
+    base64_str = base64.b64encode(json.dumps(data).encode())
+    return base64_str.decode()
+
+def decode_dict(str_data: str):
+    return json.loads(base64.b64decode(str_data.encode()))
+
+def get_gpus():
+    GPUs = GPUtil.getGPUs()
+    gpus = []
+    for gpu in GPUs:
+        name = "nvidia" if "nvidia" in gpu.name.lower() else None
+        if name is None:
+            continue
+        mem = int(gpu.memoryTotal / 1000) # in GBs
+        gpus.append(f"{name}-{mem}GB")
+    return ",".join(gpus)
+
+def system_uptick_request(username, node_name, backend_endpoint, backend_api_key, local_version=0):
+    gpus = get_gpus()
+    data = {
+        "username": username,
+        "system_info": {
+            "os": platform.system(),
+            "cpu_count": os.cpu_count(),
+            "cpu": platform.processor(),
+            "platform": platform.platform(),
+            "ram": round(psutil.virtual_memory().total / (1024.0 **3)),
+            "hostname": node_name,
+            "gpus": gpus
+        },
+        "version": local_version
+    }
+
+    response = requests.post(
+        url=urljoin(backend_endpoint, "/uptick"),
+        json=data,
+        headers={'X-API-KEY': backend_api_key}
+    )
+    response.raise_for_status()
+    return response.json()
+
+def resource_path(relative_path: str):
+    """ Get absolute path to resource """
+    try:
+        last_slash = relative_path.rfind("/") 
+        path = relative_path[:last_slash].replace("/", ".")
+        filename = relative_path[last_slash+1:]
+        resource = importlib.resources.path(path, filename)
+    except:
+        return None
+    return resource
+
+def user_path(relative_path, create_path=False):
+    """Transform a relative path into the user's cache folder path"""
+    base = os.path.expanduser("~")
+    kalavai_user_path = os.path.join(base, ".cache/kalavai")
+    full_path = os.path.join(kalavai_user_path, relative_path)
+    if create_path:
+        Path(full_path).mkdir(parents=True, exist_ok=True)
+    
+    return full_path
+
+def safe_remove(filepath, force=True):
+    if not os.path.exists(filepath):
+        return
+    try:
+        if os.path.isfile(filepath):
+            os.remove(filepath)
+        if os.path.isdir(filepath):
+            shutil.rmtree(filepath)
+    except:
+        if force:
+            run_cmd(f"sudo rm -rf {filepath}")

kalavai_client-0.5.0.dist-info/LICENSE

@@ -0,0 +1,201 @@
+                                 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 [yyyy] [name of copyright owner]
+
+   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.