cgcsdk 1.0.3__py3-none-any.whl → 1.0.5__py3-none-any.whl

cgc/.env

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

cgc/CHANGELOG.md

@@ -1,5 +1,42 @@
 # Change Log
 
+## 1.0.5
+
+Release on March 7, 2024
+
+* added new compute template: custom
+* custom template can be any docker image
+* custom template can use docker registry, that requires authentication
+* during compute create, new flag available: -fp, --full-path
+  * allows to mount volume with full path; works with one volume only
+* added support for adding for compute create config_map_data
+* added for compute create
+  * --startup-command flag to set startup command (overrides default command in Dockerfile)
+  * --repository-secret flag to set docker registry secret from namespace
+  * --image flag to set docker image for custom template
+* managing compute ports, require user confirmation
+* resource commands
+* add compute custom create and resource delete to cgc sdk
+* add compute port add, delete, update, list to cgc sdk
+* add compute and db **list** to cgc sdk
+* add resource ready command to cgc sdk
+* on-premises support for node_port_enabled
+* added new command: cgc context replace-env "path_to_env_file"
+* added new command: cgc context get-env "where_to_save_env_file"
+* added new command: cgc compute list-mounts
+
+## 1.0.4
+
+Release on December 12, 2023
+
+* fixed typos
+* command group "cgc compute port" updated logic
+* added "--shm size" option to "cgc compute create" command
+* add support for: weaviate (db, no gpu), t2v-transformers (compute, gpu enabled)
+* weaviate can work with t2v-transformers
+  * requires added -d flag: weaviate_enable_modules=text2vec-transformers
+  * requires added -d flag: weaviate_transformers_inference_api=<http://name-of-t2v-app:8080>
+
 ## 1.0.3
 
 Release on November 21, 2023

cgc/commands/cgc_cmd.py

@@ -13,6 +13,7 @@ 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.consts.env_consts import ENV_FILE_PATH
 
 
 @click.command("rm", cls=CustomCommand)
@@ -115,3 +116,9 @@ def folder_of_contexts():
     click.echo(
         "You can check location of that folder on different machine with the same command."
     )
+
+
+@context_group.command("get-env-path", cls=CustomCommand)
+def get_env_path():
+    """Displays current environment file path"""
+    click.echo(f"Current environment file path: {ENV_FILE_PATH}")

cgc/commands/cgc_helpers.py

@@ -1,33 +1,45 @@
-from typing import List
-from cgc.utils import quick_sort
-from cgc.utils.config_utils import read_from_cfg
-from tabulate import tabulate
-
-
-def table_of_user_context_files(config_files: List[str]):
-    # print tabulate of: [context NR | namespace | user_id]
-    headers = ["Context No.", "Namespace", "User ID"]
-    contexts = []
-    contexts_nrs = []
-    for file in config_files:
-        file_context = []
-        file_context.append(
-            int(file.split(".")[0]) if file != "cfg.json" else 1
-        )  # 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"]
-        for k in values_to_read:
-            try:
-                value = file_data[k]
-            except KeyError:
-                value = None
-            file_context.append(value)
-        contexts.append(file_context)
-
-    contexts_nrs_sorted = quick_sort(contexts_nrs)
-    contexts_sorted = []
-    for context in contexts_nrs_sorted:
-        contexts_sorted.append(contexts[contexts_nrs.index(context)])
-
-    return tabulate(contexts_sorted, headers=headers)
+from typing import List
+from cgc.utils import quick_sort
+from cgc.utils.config_utils import read_from_cfg
+from tabulate import tabulate
+
+
+def table_of_user_context_files(config_files: List[str]):
+    # print tabulate of: [context NR | namespace | user_id]
+    headers = ["Context No.", "Namespace", "User ID"]
+    contexts = []
+    contexts_nrs = []
+    for file in config_files:
+        file_context = []
+        file_context.append(
+            int(file.split(".")[0]) if file != "cfg.json" else 1
+        )  # 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"]
+        for k in values_to_read:
+            try:
+                value = file_data[k]
+            except KeyError:
+                value = None
+            file_context.append(value)
+        contexts.append(file_context)
+
+    contexts_nrs_sorted = quick_sort(contexts_nrs)
+    contexts_sorted = []
+    for context in contexts_nrs_sorted:
+        contexts_sorted.append(contexts[contexts_nrs.index(context)])
+
+    return tabulate(contexts_sorted, headers=headers)
+
+def process_stdin(input_file: str):
+    full_stdin = []
+    try:
+        for line in input_file:
+            line = line.strip()
+            if line and line != '|':
+                full_stdin.append(line.rstrip('\n'))  # Remove newline characters
+    except TypeError:
+        return None
+    return " ".join(full_stdin)
+            

cgc/commands/compute/compute_cmd.py

@@ -1,10 +1,13 @@
 import json
+import sys
 import click
+from cgc.commands.cgc_helpers import process_stdin
 
-from cgc.commands.compute.compute_models import EntityList, GPUsList
+from cgc.commands.compute.compute_models import ComputesList, GPUsList
 from cgc.commands.compute.compute_responses import (
     compute_create_filebrowser_response,
     compute_create_response,
+    compute_list_mounts_response,
     compute_list_response,
     get_compute_port_list,
 )
@@ -74,15 +77,15 @@ def compute_filebrowser_delete():
 
 
 @port_group.command("add", cls=CustomCommand)
-@click.argument("name", type=click.STRING)
+@click.argument("app_name", type=click.STRING)
 @click.option("-p", "--port", "port", type=click.INT, required=True, help="Port number")
 @click.option(
     "-n",
-    "--app-name",
-    "app_name",
+    "--name",
+    "port_name",
     type=click.STRING,
     required=True,
-    help="Name of application",
+    help="Name of port",
 )
 @click.option(
     "-ni",
@@ -94,13 +97,23 @@ 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(name: str, port: int, app_name: str, ingress: bool):
+def compute_port_add(app_name: str, port_name: str, port: int, ingress: bool):
     """Add a port to a running resource"""
+    while True:
+        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.'
+        )
+        click.echo("Resource will be restarted after port addition.")
+        answer = input("Do you want to continue? (Y/N): ").lower()
+        if answer in ("y", "yes"):
+            break
+        if answer in ("n", "no"):
+            sys.exit()
     api_url, headers = get_api_url_and_prepare_headers()
     url = f"{api_url}/v1/api/resource/ports?port_modification_mode=ADD"
     metric = "resource.ports.add"
     __payload = port_modification_payload(
-        port_name=name,
+        port_name=port_name,
         port_number=port,
         ingress=ingress,
         app_name=app_name,
@@ -113,12 +126,12 @@ def compute_port_add(name: str, port: int, app_name: str, ingress: bool):
         retrieve_and_validate_response_send_metric(__res, metric)
     )
     table = fill_missing_values_in_a_response(__res_list)
-    click.echo(f"Port {name} added successfully to {app_name}. Printing ports:")
+    click.echo(f"Port {port_name} added successfully to {app_name}. Printing ports:")
     click.echo(tabulate_a_response(table))
 
 
 @port_group.command("update", cls=CustomCommand)
-@click.argument("name", type=click.STRING)
+@click.argument("app_name", type=click.STRING)
 @click.option(
     "-p",
     "--port",
@@ -130,11 +143,11 @@ def compute_port_add(name: str, port: int, app_name: str, ingress: bool):
 )
 @click.option(
     "-n",
-    "--app-name",
-    "app_name",
+    "--name",
+    "port_name",
     type=click.STRING,
     required=True,
-    help="Name of application",
+    help="Name of port",
 )
 @click.option(
     "-ni",
@@ -146,13 +159,23 @@ def compute_port_add(name: str, port: int, app_name: str, 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(name: str, port: int, app_name: str, ingress: bool):
+def compute_port_update(app_name: str, port_name: str, port: int, ingress: bool):
     """Update a port in a running resource"""
+    while True:
+        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.'
+        )
+        click.echo("Resource will be restarted after port update.")
+        answer = input("Do you want to continue? (Y/N): ").lower()
+        if answer in ("y", "yes"):
+            break
+        if answer in ("n", "no"):
+            sys.exit()
     api_url, headers = get_api_url_and_prepare_headers()
     url = f"{api_url}/v1/api/resource/ports?port_modification_mode=UPDATE"
     metric = "resource.ports.update"
     __payload = port_modification_payload(
-        port_name=name,
+        port_name=port_name,
         port_number=port,
         ingress=ingress,
         app_name=app_name,
@@ -163,26 +186,36 @@ def compute_port_update(name: str, port: int, app_name: str, ingress: bool):
 
     retrieve_and_validate_response_send_metric(__res, metric)
 
-    click.echo(f"Port {name} updated successfully in {app_name}")
+    click.echo(f"Port {port_name} updated successfully in {app_name}")
 
 
 @port_group.command("delete", cls=CustomCommand)
-@click.argument("name", type=click.STRING)
+@click.argument("app_name", type=click.STRING)
 @click.option(
     "-n",
-    "--app-name",
-    "app_name",
+    "--name",
+    "port_name",
     type=click.STRING,
     required=True,
-    help="Name of application",
+    help="Name of port",
 )
-def compute_port_delete(name: str, app_name: str):
+def compute_port_delete(app_name: str, port_name: str):
     """Delete a port from a running resource"""
+    while True:
+        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.'
+        )
+        click.echo("Resource will be restarted after port delete.")
+        answer = input("Do you want to continue? (Y/N): ").lower()
+        if answer in ("y", "yes"):
+            break
+        if answer in ("n", "no"):
+            sys.exit()
     api_url, headers = get_api_url_and_prepare_headers()
     url = f"{api_url}/v1/api/resource/ports?port_modification_mode=DELETE"
     metric = "resource.ports.delete"
     __payload = port_delete_payload(
-        port_name=name,
+        port_name=port_name,
         app_name=app_name,
     )
     __res = call_api(
@@ -191,7 +224,7 @@ def compute_port_delete(name: str, app_name: str):
 
     retrieve_and_validate_response_send_metric(__res, metric)
 
-    click.echo(f"Port {name} deleted successfully from {app_name}")
+    click.echo(f"Port {port_name} deleted successfully from {app_name}")
 
 
 @port_group.command("list", cls=CustomCommand)
@@ -217,8 +250,11 @@ def compute_port_list(app_name: str):
 
 
 @compute_group.command("create", cls=CustomCommand)
-@click.argument("entity", type=click.Choice(EntityList.get_list()))
-@click.option("-n", "--name", "name", type=click.STRING, required=True)
+@click.argument("entity", type=click.Choice(ComputesList.get_list()))
+@click.argument("startup_command", type=click.File("r"), default="-", required=False)
+@click.option(
+    "-n", "--name", "name", type=click.STRING, required=True, help="Desired app name"
+)
 @click.option(
     "-g",
     "--gpu",
@@ -258,6 +294,13 @@ def compute_port_list(app_name: str):
     multiple=True,
     help="List of volume names to be mounted with default mount path",
 )
+@click.option(
+    "-fp",
+    "--full-path",
+    "volume_full_path",
+    type=click.STRING,
+    help="If set, full path will be used for volume mount. Valid for 1 volume.",
+)
 @click.option(
     "-d",
     "--resource-data",
@@ -265,6 +308,40 @@ def compute_port_list(app_name: str):
     multiple=True,
     help="List of optional arguments to be passed to the app, key=value format",
 )
+@click.option(
+    "--image",
+    "image_name",
+    type=click.STRING,
+    help="Image to be used by the app",
+)
+@click.option(
+    "--repository-secret",
+    "repository_secret",
+    type=click.STRING,
+    help="Use secret to pull image from private repository",
+)
+@click.option(
+    "-cm",
+    "--config-map",
+    "config_maps_data",
+    multiple=True,
+    help="List of optional arguments to be passed to the app, key=value format",
+)
+@click.option(
+    "--shm",
+    "shm_size",
+    type=click.IntRange(0, 1024, clamp=True),
+    default=0,
+    help="Size of shared memory in Gi",
+)
+@click.option(
+    "--node-port-enabled",
+    "node_port_enabled",
+    type=click.BOOL,
+    default=False,
+    is_flag=True,
+    help="If set, app will be exposed to the internet",
+)
 def compute_create(
     entity: str,
     gpu: int,
@@ -272,8 +349,15 @@ def compute_create(
     cpu: int,
     memory: int,
     volumes: list[str],
+    volume_full_path: str,
     resource_data: list[str],
+    config_maps_data: list[str],
     name: str,
+    shm_size: int,
+    image_name: str,
+    startup_command: str,
+    repository_secret: str,
+    node_port_enabled: bool,
 ):
     """
     Create an app in user namespace.
@@ -288,13 +372,29 @@ def compute_create(
     :type memory: int
     :param volumes: list of volumes to mount
     :type volumes: list[str]
+    :param volume_full_path: if set, full path will be used for volume mount
+    :type volume_full_path: str
     :param resource_data: list of optional arguments to be passed to the app
     :type resource_data: list[str]
+    :param config_maps_data: list of optional arguments to be passed to the app
+    :type config_maps_data: list[str]
     :param name: name of app
     :type name: str
+    :param shm_size: size of shared memory
+    :type shm_size: int
+    :param image_name: name of image to be used by the app
+    :type image_name: str
+    :param startup_command: command to be executed on app startup; it is stdin input
+    :type startup_command: str
+    :param repository_secret: use secret to pull image from private repository
+    :type repository_secret: str
+    :param node_port_enabled: if set, app ports will be exposed to the network via node addresses
+    :type node_port_enabled: bool
     """
     api_url, headers = get_api_url_and_prepare_headers()
     url = f"{api_url}/v1/api/resource/create"
+    if startup_command != "-":
+        startup_command = process_stdin(startup_command)
     metric = "compute.create"
     __payload = compute_create_payload(
         name=name,
@@ -303,8 +403,15 @@ def compute_create(
         memory=memory,
         gpu=gpu,
         volumes=volumes,
+        volume_full_path=volume_full_path,
         resource_data=resource_data,
+        config_maps_data=config_maps_data,
         gpu_type=gpu_type,
+        shm_size=shm_size,
+        image_name=image_name,
+        startup_command=startup_command,
+        repository_secret=repository_secret,
+        node_port_enabled=node_port_enabled,
     )
     # Extra keys allowed for payload:
     # 1.
@@ -346,15 +453,15 @@ def compute_create(
 
 
 @compute_group.command("delete", cls=CustomCommand)
-@click.argument("name", type=click.STRING)
-def compute_delete_cmd(name: str):
+@click.argument("app_name", type=click.STRING)
+def compute_delete_cmd(app_name: str):
     """
     Delete an app from user namespace.
     \f
-    :param name: name of app to delete
-    :type name: str
+    :param app_name: name of app to delete
+    :type app_name: str
     """
-    resource_delete(name)
+    resource_delete(app_name)
 
 
 compute_group.add_command(filebrowser_group)
@@ -382,3 +489,23 @@ def resource_list(detailed: bool):
     )
 
     click.echo(table)
+
+
+@compute_group.command("list-mounts", cls=CustomCommand)
+def compute_list_mounts():
+    """
+    List all apps for user namespace.
+    """
+    api_url, headers = get_api_url_and_prepare_headers()
+    url = f"{api_url}/v1/api/resource/list?resource_type=compute"
+    metric = "compute.list"
+    __res = call_api(
+        request=EndpointTypes.get,
+        url=url,
+        headers=headers,
+    )
+    table = compute_list_mounts_response(
+        retrieve_and_validate_response_send_metric(__res, metric),
+    )
+
+    click.echo(table)

cgc/commands/compute/compute_models.py

@@ -9,7 +9,7 @@ class CGCEntityList(Enum):
         return [el.value for el in cls]
 
 
-class EntityList(CGCEntityList):
+class ComputesList(CGCEntityList):
     """List of templates in cgc-server
 
     :param Enum: name of template
@@ -24,7 +24,9 @@ class EntityList(CGCEntityList):
     LABEL_STUDIO = "label-studio"
     COMFY_UI = "comfy-ui"
     RAG = "rag"
-    DEEPSTREAM = "deapstream"
+    DEEPSTREAM = "deepstream"
+    T2V_TRANSFORMERS = "t2v-transformers"
+    CUSTOM = "custom"
 
 
 class DatabasesList(CGCEntityList):
@@ -37,6 +39,7 @@ class DatabasesList(CGCEntityList):
     MONGODB = "mongodb"
     POSTGRESQL = "postgresql"
     REDIS = "redis"
+    WEAVIATE = "weaviate"
     # MINIO = "minio"
 
 
@@ -47,6 +50,7 @@ class GPUsList(CGCEntityList):
     :type Enum: str
     """
 
+    V100 = "V100"
     A100 = "A100"
-    # V100 = "V100"
     A5000 = "A5000"
+    H100 = "H100"

cgc/commands/compute/compute_responses.py

@@ -1,6 +1,6 @@
 from cgc.telemetry.basic import change_gauge
 from cgc.telemetry.basic import setup_gauge
-from cgc.commands.compute.compute_utills import get_app_list
+from cgc.commands.compute.compute_utills import get_app_list, get_app_mounts
 from cgc.utils.config_utils import get_namespace
 from cgc.utils.message_utils import key_error_decorator_for_helpers
 from cgc.commands.compute import NoAppsToList
@@ -55,6 +55,22 @@ def compute_list_response(detailed: bool, data: dict) -> str:
     return tabulate_a_response(table)
 
 
+@key_error_decorator_for_helpers
+def compute_list_mounts_response(data: dict) -> str:
+    """Create response string for compute list_mounts command.
+
+    :param response: dict object from API response.
+    :type response: requests.Response
+    :return: Response string.
+    :rtype: str
+    """
+    pod_list = data["details"]["pods_list"]
+    list_of_json_data = get_app_mounts(pod_list)
+    table = fill_missing_values_in_a_response(list_of_json_data)
+
+    return tabulate_a_response(table)
+
+
 @key_error_decorator_for_helpers
 def compute_create_filebrowser_response(data: dict) -> str:
     """Create response string for compute create_filebrowser command