cgcsdk 1.0.15__tar.gz → 1.0.17__tar.gz

{cgcsdk-1.0.15/cgcsdk.egg-info → cgcsdk-1.0.17}/PKG-INFO

@@ -1,23 +1,20 @@
 Metadata-Version: 2.1
 Name: cgcsdk
-Version: 1.0.15
-Summary: Comtegra GPU Cloud REST API client
-Home-page: https://git.comtegra.pl/
+Version: 1.0.17
+Summary: CGC Core REST API client
+Home-page: https://cgc.comtegra.cloud/
 Author: Comtegra AI Team
 Author-email: ai@comtegra.pl
 License: BSD 2-clause
 Project-URL: Documentation, https://docs.cgc.comtegra.cloud/
-Project-URL: GitHub, https://git.comtegra.pl/
-Project-URL: Changelog, https://git.comtegra.pl/foobar/foobar/blob/master/CHANGELOG.md
-Keywords: cloud,sdk,orchestrator,kubernetes,jupyter-notebook
-Classifier: Development Status :: 1 - Planning
+Project-URL: GitHub, https://git.comtegra.pl/k8s/cgc-client-k8s-cloud
+Project-URL: Changelog, https://git.comtegra.pl/k8s/cgc-client-k8s-cloud/-/blob/main/cgc/CHANGELOG.md
+Keywords: cloud,sdk,orchestrator,kubernetes,jupyter-notebook,cgc-core
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Description-Content-Type: text/markdown

{cgcsdk-1.0.15 → cgcsdk-1.0.17}/cgc/.env

@@ -6,4 +6,4 @@ CONFIG_FILE_NAME = cfg.json
 TMP_DIR = .tmp
 RELEASE = 1
 MAJOR_VERSION = 0
-MINOR_VERSION = 15
+MINOR_VERSION = 17

{cgcsdk-1.0.15 → cgcsdk-1.0.17}/cgc/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Change Log
 
+## 1.0.17
+
+Release on Aug 19, 2024
+
+* `cgc port list` now shows which ports are ingress (`cgc resource ingress app_name`)
+* fix bug for the `cgc keys ssh create` command
+* `cgc context list` now shows which context is active
+* `cgc context list` now shows context server address
+
+## 1.0.16
+
+Release on Aug 02, 2024
+
+* dynamic storage classes for volumes
+* dynamic templates available for compute
+* dynamic templates available for databases
+* fixed bug: context switched to cfg.json after CGC update
+* updated command: `cgc status`, now it is fully dynamic
+* add flag `-y` to `cgc compute port` group commands
+* `active_deadline_seconds` to `cgc job create` command
+* `cgc db create` now have option `-d` available
+* updated displayed values with `cgc job list`
+* updated version control messages
+
 ## 1.0.15
 
 Release on June 27, 2024

{cgcsdk-1.0.15 → cgcsdk-1.0.17}/cgc/commands/auth/auth_responses.py

@@ -3,8 +3,13 @@ import os
 
 from cgc.commands.auth import auth_utils
 from cgc.commands.auth import auth_logic
-from cgc.utils.consts.env_consts import TMP_DIR, get_config_file_name
-from cgc.utils.config_utils import get_config_path, save_to_config
+from cgc.utils.consts.env_consts import TMP_DIR
+from cgc.utils.config_utils import (
+    get_config_path,
+    save_to_config,
+    get_config_file_name,
+    save_to_local_config_context,
+)
 from cgc.utils.message_utils import key_error_decorator_for_helpers
 
 
@@ -17,6 +22,7 @@ def auth_register_response(
     aes_key, password = auth_utils.get_aes_key_and_password(unzip_dir, priv_key_bytes)
 
     os.environ["CONFIG_FILE_NAME"] = config_filename
+    save_to_local_config_context(config_filename)
     save_to_config(
         user_id=user_id,
         password=password,
@@ -27,8 +33,8 @@ def auth_register_response(
     )
     auth_logic.auth_create_api_key_with_save()
     shutil.rmtree(TMP_DIR_PATH)
-    # config.json
-    if config_filename == "config.json":
+    # cfg.json
+    if config_filename == "cfg.json":
         return f"Register successful! You can now use the CLI. Saved data to:{os.path.join(get_config_path(),config_filename)}\n\
         Consider backup this file. It stores data accessible only to you with which you can access CGC platform."
     return f"New context created successfully! \nNew config file saved to: {os.path.join(get_config_path(),config_filename)}\n\

{cgcsdk-1.0.15 → cgcsdk-1.0.17}/cgc/commands/cgc_cmd.py

@@ -12,10 +12,11 @@ from cgc.utils.prepare_headers import get_api_url_and_prepare_headers
 from cgc.utils.response_utils import retrieve_and_validate_response_send_metric
 from cgc.telemetry.basic import telemetry_permission_set
 from cgc.commands.compute.compute_responses import compute_logs_response
+
 # from cgc.commands.auth.auth_cmd import auth_register
 from cgc.utils import set_environment_data, check_if_config_exist, list_all_config_files
 from cgc.commands.cgc_helpers import table_of_user_context_files
-from cgc.utils.config_utils import config_path
+from cgc.utils.config_utils import config_path, save_to_local_config_context
 from cgc.utils.consts.env_consts import ENV_FILE_PATH
 
 
@@ -100,6 +101,7 @@ def switch_context(number: int):
         #     config_filename=file_name,
         # )
     set_environment_data("CONFIG_FILE_NAME", file_name)
+    save_to_local_config_context(file_name)
     click.echo(f"Context file changed to: {file_name}")
 
 

cgcsdk-1.0.17/cgc/commands/cgc_cmd_responses.py

@@ -0,0 +1,109 @@
+from enum import Enum
+from typing import Union
+from tabulate import tabulate
+from cgc.utils.message_utils import key_error_decorator_for_helpers
+
+
+def _resource_match(resource: str) -> Union[str, None]:
+    if resource == "requests.cpu":
+        return "Total CPU"
+    elif resource == "requests.memory":
+        return "Total RAM"
+    elif resource == "requests.nvidia.com/gpu":
+        return "Total GPU"
+    elif resource.startswith("requests.comtegra.cloud/"):
+        gpu_type = resource.split("/")[-1]
+        return f"GPU {gpu_type.upper()}"
+    elif resource == "persistentvolumeclaims":
+        return "Volume Count"
+    elif resource == "requests.storage":
+        return "Total Storage"
+    elif resource.endswith(".storageclass.storage.k8s.io/requests.storage"):
+        storage_class = resource.split(".")[0]
+        return f"Storage ({storage_class})"
+    else:
+        return None
+
+
+class ResourceOrder(Enum):
+    CPU = 1
+    MEMORY = 2
+    GPU = 3
+    STORAGE = 4
+    VOLUME = 5
+    GPU_TYPE = 6
+    OTHER = 7
+
+
+def _resource_order(resource: str) -> ResourceOrder:
+    if resource == "requests.cpu":
+        return ResourceOrder.CPU
+    elif resource == "requests.memory":
+        return ResourceOrder.MEMORY
+    elif resource == "requests.nvidia.com/gpu":
+        return ResourceOrder.GPU
+    elif resource.startswith("requests.comtegra.cloud/"):
+        return ResourceOrder.GPU_TYPE
+    elif resource == "persistentvolumeclaims":
+        return ResourceOrder.VOLUME
+    elif resource == "requests.storage":
+        return ResourceOrder.STORAGE
+    elif resource.endswith(".storageclass.storage.k8s.io/requests.storage"):
+        return ResourceOrder.STORAGE
+    else:
+        return ResourceOrder.OTHER
+
+
+@key_error_decorator_for_helpers
+def cgc_status_response(data: dict):
+    """Generates and prints resource limits and available resources in a pretty format
+
+    :param data: data to extrct resources from
+    :type data: dict
+    :param metric_error: error metric for graphana
+    :type metric_error: str
+    """
+
+    resources_available: dict = data["details"]["available_resources"]
+    resources_limits: dict = data["details"]["limits_resources"]
+    list_headers = ["Resource", "Available", "Limit"]
+    resource_names = []
+
+    resources_available_list = []
+    resources_limits_list = []
+    resources_available = {
+        key: value
+        for key, value in sorted(
+            resources_available.items(),
+            key=lambda x: (_resource_order(x[0]).value, x[1]),
+        )
+    }
+    for resource, available in resources_available.items():
+        if resource not in resources_limits.keys():
+            continue
+        resource_parsed = _resource_match(resource)
+        if resource_parsed is None:
+            continue
+        resource_names.append(resource_parsed)
+        limit = resources_limits[resource]
+        if "storage" in resource or "memory" in resource:
+            available = f"{available} GB"
+            limit = f"{limit} GB"
+        else:
+            available = int(available)
+            limit = int(limit)
+        resources_available_list.append(available)
+        resources_limits_list.append(limit)
+
+    return tabulate(
+        list(zip(resource_names, resources_available_list, resources_limits_list)),
+        headers=list_headers,
+    )
+
+
+def cgc_logs_response(data: dict):
+    return "\n".join(
+        "==> %s/%s <==\n%s" % (pod, cont, log)
+        for pod, containers in data["details"]["logs"].items()
+        for cont, log in containers.items()
+    )

{cgcsdk-1.0.15 → cgcsdk-1.0.17}/cgc/commands/cgc_helpers.py

@@ -1,12 +1,18 @@
 from typing import List
 from cgc.utils import quick_sort
-from cgc.utils.config_utils import read_from_cfg
+from cgc.utils.config_utils import get_config_file_name, read_from_cfg
 from tabulate import tabulate
 
 
+def _is_main_context_file(file: str) -> bool:
+    if get_config_file_name() == file:
+        return True
+    return None
+
+
 def table_of_user_context_files(config_files: List[str]):
     # print tabulate of: [context NR | namespace | user_id]
-    headers = ["Context No.", "Namespace", "User ID"]
+    headers = ["Context No.", "Namespace", "User ID", "URL", "Is active"]
     contexts = []
     contexts_nrs = []
     for file in config_files:
@@ -16,13 +22,17 @@ def table_of_user_context_files(config_files: List[str]):
         )  # should never throw exception with good config_file list
         contexts_nrs.append(file_context[0])
         file_data = read_from_cfg(None, file)
-        values_to_read = ["namespace", "user_id"]
+        values_to_read = ["namespace", "user_id", "cgc_api_url"]
         for k in values_to_read:
             try:
                 value = file_data[k]
             except KeyError:
                 value = None
+                if k == "cgc_api_url":
+                    value = "https://cgc-api.comtegra.cloud:443"
             file_context.append(value)
+
+        file_context.append(_is_main_context_file(file))
         contexts.append(file_context)
 
     contexts_nrs_sorted = quick_sort(contexts_nrs)

cgcsdk-1.0.17/cgc/commands/cgc_models.py

@@ -0,0 +1,17 @@
+from abc import ABC, abstractmethod
+
+
+class CGCEntityList(ABC):
+    """Base class for other lists"""
+
+    @staticmethod
+    @abstractmethod
+    def load_data() -> list[str]:
+        pass
+
+    @classmethod
+    def get_list(cls) -> list[str]:
+        try:
+            return [el for el in cls.load_data()]
+        except TypeError:
+            return []

{cgcsdk-1.0.15 → cgcsdk-1.0.17}/cgc/commands/compute/compute_cmd.py

@@ -96,9 +96,21 @@ def compute_filebrowser_delete():
     default=True,
     help="If set, port will NOT be exposed to the internet. By default port is exposed to the internet.",
 )
-def compute_port_add(app_name: str, port_name: str, port: int, ingress: bool):
+@click.option(
+    "-y",
+    "--yes",
+    "yes",
+    is_flag=True,
+    type=click.BOOL,
+    required=False,
+    default=False,
+    help="If set, command will not ask for confirmation",
+)
+def compute_port_add(
+    app_name: str, port_name: str, port: int, ingress: bool, yes: bool
+):
     """Add a port to a running resource"""
-    while True:
+    while True and not yes:
         click.echo(
             'Adding a port to a running resource will expose it to the internet. If you want to add a port without exposing it to the internet, use the "--no-ingress" flag.'
         )
@@ -161,9 +173,21 @@ def compute_port_add(app_name: str, port_name: str, port: int, ingress: bool):
     default=True,
     help="If set, port will NOT be exposed to the internet. By default port is exposed to the internet.",
 )
-def compute_port_update(app_name: str, port_name: str, port: int, ingress: bool):
+@click.option(
+    "-y",
+    "--yes",
+    "yes",
+    is_flag=True,
+    type=click.BOOL,
+    required=False,
+    default=False,
+    help="If set, command will not ask for confirmation",
+)
+def compute_port_update(
+    app_name: str, port_name: str, port: int, ingress: bool, yes: bool
+):
     """Update a port in a running resource"""
-    while True:
+    while True and not yes:
         click.echo(
             'Updating a port in a running resource will expose it to the internet. If you want to update a port without exposing it to the internet, use the "--no-ingress" flag.'
         )
@@ -204,9 +228,19 @@ def compute_port_update(app_name: str, port_name: str, port: int, ingress: bool)
     required=True,
     help="Name of port",
 )
-def compute_port_delete(app_name: str, port_name: str):
+@click.option(
+    "-y",
+    "--yes",
+    "yes",
+    is_flag=True,
+    type=click.BOOL,
+    required=False,
+    default=False,
+    help="If set, command will not ask for confirmation",
+)
+def compute_port_delete(app_name: str, port_name: str, yes: bool):
     """Delete a port from a running resource"""
-    while True:
+    while True and not yes:
         click.echo(
             'Deleting a port from a running resource will expose it to the internet. If you want to delete a port without exposing it to the internet, use the "--no-ingress" flag.'
         )

cgcsdk-1.0.17/cgc/commands/compute/compute_models.py

@@ -0,0 +1,35 @@
+from enum import Enum
+
+from cgc.commands.cgc_models import CGCEntityList
+from cgc.utils.config_utils import read_from_local_cfg
+import cgc.utils.version_control as version_control
+
+
+class ComputesList(CGCEntityList):
+    """List of compute templates in cgc-server"""
+
+    @staticmethod
+    def load_data() -> list[str]:
+        try:
+            return read_from_local_cfg("compute_templates")
+        except FileNotFoundError:
+            version_control.get_server_version()  # possible loop on error
+            return ComputesList.load_data()
+
+
+class GPUsList(Enum):
+    """List of templates in cgc-server
+
+    :param Enum: name of template
+    :type Enum: str
+    """
+
+    V100 = "V100"
+    A100 = "A100"
+    A5000 = "A5000"
+    H100 = "H100"
+    P40 = "P40"
+    P100 = "P100"
+
+    def get_list() -> list[str]:
+        return [el.value for el in GPUsList]

{cgcsdk-1.0.15 → cgcsdk-1.0.17}/cgc/commands/compute/compute_responses.py

@@ -9,12 +9,16 @@ from cgc.utils.response_utils import (
     tabulate_a_response,
     fill_missing_values_in_a_response,
 )
-from cgc.utils.message_utils import prepare_warning_message
 
 
 @key_error_decorator_for_helpers
 def get_compute_port_list(data: dict) -> list:
-    return data["details"]["ports"]["ports"]
+    resource_ports_data = data["details"]["ports"]["ports"]
+    ingress_data = data["details"]["ingress"]
+    ingress_port_names = [port["port_name"] for port in ingress_data]
+    for port in resource_ports_data:
+        port["ingress"] = True if port["name"] in ingress_port_names else False
+    return resource_ports_data
 
 
 @key_error_decorator_for_helpers

{cgcsdk-1.0.15 → cgcsdk-1.0.17}/cgc/commands/db/db_cmd.py

@@ -46,11 +46,19 @@ def db_group():
     multiple=True,
     help="Volume name to be mounted with default mount path",
 )
+@click.option(
+    "-d",
+    "--resource-data",
+    "resource_data",
+    multiple=True,
+    help="List of optional arguments to be passed to the app, key=value format",
+)
 def db_create(
     entity: str,
     cpu: int,
     memory: int,
     volumes: list[str],
+    resource_data: list[str],
     name: str,
 ):
     """
@@ -81,6 +89,7 @@ def db_create(
         cpu=cpu,
         memory=memory,
         volumes=volumes,
+        resource_data=resource_data,
     )
     __res = call_api(
         request=EndpointTypes.post,

{cgcsdk-1.0.15 → cgcsdk-1.0.17}/cgc/commands/db/db_models.py

@@ -1,19 +1,21 @@
 from cgc.commands.cgc_models import CGCEntityList
 from cgc.commands.exceptions import DatabaseCreationException
+from cgc.utils.config_utils import read_from_local_cfg
+import cgc.utils.version_control as version_control
 
 
 class DatabasesList(CGCEntityList):
-    """List of templates in cgc-server
+    """List of database templates in cgc-server"""
 
-    :param Enum: name of template
-    :type Enum: str
-    """
-
-    POSTGRESQL = "postgresql"
-    WEAVIATE = "weaviate"
-    # MINIO = "minio"
-    MONGODB = "mongodb"
-    REDIS = "redis"
+    @staticmethod
+    def load_data() -> list[str]:
+        try:
+            list_of_templates = read_from_local_cfg("database_templates")
+        except FileNotFoundError:
+            version_control.get_server_version()  # possible loop on error
+            return DatabasesList.load_data()
+        list_of_templates.extend(["mongodb", "redis"])
+        return list_of_templates
 
     @staticmethod
     def verify(entity: str) -> str:

{cgcsdk-1.0.15 → cgcsdk-1.0.17}/cgc/commands/jobs/job_utils.py

@@ -28,6 +28,7 @@ def job_create_payload(
     startup_command: str = "",
     repository_secret: str = "",
     ttl_seconds_after_finished: Optional[int] = None,
+    active_deadline_seconds: Optional[int] = None,
 ):
     """
     Create payload for app creation.
@@ -38,6 +39,8 @@ def job_create_payload(
 
     if ttl_seconds_after_finished is not None:
         extra_payload["ttl_seconds_after_finished"] = ttl_seconds_after_finished
+    if active_deadline_seconds is not None:
+        extra_payload["active_deadline_seconds"] = active_deadline_seconds
 
     payload = {
         "resource_data": {
@@ -111,13 +114,17 @@ def get_job_list(job_list: list, job_pod_list: list):
 
     for i, job_data in enumerate(job_list):
         list_of_json_job_data[i]["name"] = job_data.get("name", "")
-        list_of_json_job_data[i]["ttl_seconds_after_finished"] = job_data.get(
+        list_of_json_job_data[i]["ttl"] = job_data.get(
             "ttl_seconds_after_finished", "N/A"
         )
+        list_of_json_job_data[i]["ads"] = job_data.get("active_deadline_seconds", "N/A")
     for job in list_of_json_job_data:
         for job_pod in job_pod_list:
-            if job_pod.get("labels", {}).get("app-name") == job.get("name"):
-                job["status"] = job_pod.get("status", "Pending")
+            job_pod_labels: dict = job_pod.get("labels", {})
+            if job_pod_labels.get("app-name", "") == job.get("name"):
+                job["status"] = job_pod["status"]
+                job["gpu-count"] = job_pod_labels.get("gpu-count", 0)
+                job["gpu-label"] = job_pod_labels.get("gpu-label", "N/A")
                 # job["status_reason"] = [
                 #     x.get("reason", "N/A") for x in job_pod.get("status_reasons", [])
                 # ]
@@ -159,12 +166,12 @@ def get_job_json_data(job_list: list):
 
             job_data = {
                 "name": job.get("labels", {}).get("app-name"),
-                "status": job.get("status", {}).get("phase", "Pending"),
+                "status": job.get("status", {}).get(
+                    "phase", "Unknown"
+                ),  # only happen when Pod "disappeared" from the k8s - BUG
                 "volumes_mounted": volumes_mounted,
                 "cpu": cpu,
                 "ram": ram,
-                "gpu-count": job.get("labels", {}).get("gpu-count", 0),
-                "gpu-label": job.get("labels", {}).get("gpu-label", "N/A"),
             }
             # getting rid of unwanted and used values
             if "pod-template-hash" in job["labels"].keys():

{cgcsdk-1.0.15 → cgcsdk-1.0.17}/cgc/commands/jobs/jobs_cmd.py

@@ -155,6 +155,13 @@ def job_list():
     default=None,
     help="Time to live in seconds after app is finished",
 )
+@click.option(
+    "--ads",
+    "active_deadline_seconds",
+    type=click.INT,
+    default=None,
+    help="Time to live in seconds after app is started",
+)
 def job_create(
     gpu: int,
     gpu_type: str,
@@ -170,6 +177,7 @@ def job_create(
     startup_command: str,
     repository_secret: str,
     ttl_seconds_after_finished: int,
+    active_deadline_seconds: int,
 ):
     """
     Create job in user namespace.
@@ -200,6 +208,8 @@ def job_create(
     :type repository_secret: str
     :param ttl_seconds_after_finished: time to live in seconds after app is finished
     :type ttl_seconds_after_finished: int
+    :param active_deadline_seconds: time to live in seconds after app is started
+    :type active_deadline_seconds: int
     """
     api_url, headers = get_api_url_and_prepare_headers()
     url = f"{api_url}/v1/api/job/create"
@@ -226,6 +236,7 @@ def job_create(
         startup_command=cleaned_data,
         repository_secret=repository_secret,
         ttl_seconds_after_finished=ttl_seconds_after_finished,
+        active_deadline_seconds=active_deadline_seconds,
     )
     __res = call_api(
         request=EndpointTypes.post,

cgcsdk-1.0.17/cgc/commands/user/keys_models.py

@@ -0,0 +1,31 @@
+from cgc.commands.cgc_models import CGCEntityList
+
+
+class SSHKeyTypes(CGCEntityList):
+    """List of supported SSH key types
+
+    :param Enum: name of SSH key type
+    :type Enum: str
+    """
+
+    RSA = "ssh-rsa"
+    DSS = "ssh-dss"
+    ECDSA_P256 = "ecdsa-sha2-nistp256"
+    ECDSA_P384 = "ecdsa-sha2-nistp384"
+    ECDSA_P521 = "ecdsa-sha2-nistp521"
+    ED25519 = "ssh-ed25519"
+
+    def load_data() -> list:
+        """Return list of supported SSH key types
+
+        :return: list of supported SSH key types
+        :rtype: list
+        """
+        return [
+            SSHKeyTypes.RSA,
+            SSHKeyTypes.DSS,
+            SSHKeyTypes.ECDSA_P256,
+            SSHKeyTypes.ECDSA_P384,
+            SSHKeyTypes.ECDSA_P521,
+            SSHKeyTypes.ED25519,
+        ]

{cgcsdk-1.0.15 → cgcsdk-1.0.17}/cgc/commands/volume/data_model.py

@@ -1,12 +1,11 @@
-def volume_create_payload_validator(name, access, size, disk_type):
+def volume_create_payload_validator(name, size, storage_class):
     """
     Create payload for volume creation.
     """
     payload = {
         "name": name,
-        "access_type": access,
+        "storage_class": storage_class,
         "size": size,
-        "disks_type": disk_type,
         "auto_mount": "false",
     }
     return payload