cgcsdk 1.0.9__tar.gz → 1.0.10__tar.gz

{cgcsdk-1.0.9/cgcsdk.egg-info → cgcsdk-1.0.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cgcsdk
-Version: 1.0.9
+Version: 1.0.10
 Summary: Comtegra GPU Cloud REST API client
 Author: Comtegra AI Team
 Author-email: ai@comtegra.pl

{cgcsdk-1.0.9 → cgcsdk-1.0.10}/cgc/.env

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

{cgcsdk-1.0.9 → cgcsdk-1.0.10}/cgc/CHANGELOG.md

@@ -1,10 +1,20 @@
 # Change Log
 
+## 1.0.10
+
+Release on April 24, 2024
+
+* added new command group: cgc secrets
+  * add - add new secret
+  * list - list all secrets in the namespace
+  * delete - delete secret (requires to be owner of the secret)
+  * update - update secret (requires to be owner of the secret)
+
 ## 1.0.9
 
 Release on April 23, 2024
 
-* updated cgc to work with cgc-server 1.1.0
+* updated cgc to work with cgc-server 1.0.10
 * updated registration process
 * updated available apps, so it reflects changes in cgc-server
 * hotfix: listening jobs, which are not Running

{cgcsdk-1.0.9 → cgcsdk-1.0.10}/cgc/cgc.py

@@ -19,7 +19,8 @@ from cgc.commands.cgc_cmd import (
     resource_events,
     context_group,
 )
-from cgc.commands.keys.keys_cmd import keys_group
+from cgc.commands.user.keys_cmd import keys_group
+from cgc.commands.user.secret_cmd import secret_group
 
 from cgc.utils.version_control import check_version, _get_version
 from cgc.utils.click_group import CustomGroup
@@ -48,6 +49,7 @@ cli.add_command(sending_telemetry_permission)
 cli.add_command(cgc_logs)
 cli.add_command(job_group)
 cli.add_command(keys_group)
+cli.add_command(secret_group)
 
 if __name__ == "__main__" or __name__ == "cgc.cgc":
     cli()

{cgcsdk-1.0.9 → cgcsdk-1.0.10}/cgc/commands/compute/compute_cmd.py

@@ -10,7 +10,7 @@ from cgc.commands.compute.compute_responses import (
     compute_list_response,
     get_compute_port_list,
 )
-from cgc.commands.compute.compute_utills import (
+from cgc.commands.compute.compute_utils import (
     compute_create_payload,
     port_delete_payload,
     port_modification_payload,

{cgcsdk-1.0.9 → cgcsdk-1.0.10}/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, get_app_mounts
+from cgc.commands.compute.compute_utils 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

{cgcsdk-1.0.9 → cgcsdk-1.0.10}/cgc/commands/db/db_cmd.py

@@ -4,7 +4,7 @@ import click
 from cgc.commands.compute.compute_responses import compute_list_response
 from cgc.commands.db.db_models import DatabasesList
 from cgc.commands.compute.compute_responses import compute_create_response
-from cgc.commands.compute.compute_utills import compute_create_payload
+from cgc.commands.compute.compute_utils import compute_create_payload
 from cgc.commands.exceptions import DatabaseCreationException
 from cgc.commands.resource.resource_cmd import resource_delete
 from cgc.utils.prepare_headers import get_api_url_and_prepare_headers

{cgcsdk-1.0.9 → cgcsdk-1.0.10}/cgc/commands/jobs/job_utils.py

@@ -1,5 +1,5 @@
 from typing import Optional
-from cgc.commands.compute.compute_utills import list_get_mounted_volumes
+from cgc.commands.compute.compute_utils import list_get_mounted_volumes
 import cgc.utils.consts.env_consts as env_consts
 
 

{cgcsdk-1.0.9 → cgcsdk-1.0.10}/cgc/commands/resource/resource_cmd.py

@@ -10,7 +10,7 @@ from cgc.commands.compute.compute_responses import (
     compute_delete_response,
 )
 
-from cgc.commands.compute.compute_utills import compute_delete_payload
+from cgc.commands.compute.compute_utils import compute_delete_payload
 from cgc.commands.resource.resource_responses import get_ingress_list_from_response
 
 from cgc.utils.prepare_headers import get_api_url_and_prepare_headers

cgcsdk-1.0.10/cgc/commands/user/__init__.py

@@ -0,0 +1,14 @@
+from cgc.commands.exceptions import ResponseException
+
+
+class KeysCommandException(ResponseException):
+    """Base exception for all key commands."""
+
+
+class SecretsCommandException(ResponseException):
+    """Base exception for all secret commands."""
+
+
+class NoSecretsToList(SecretsCommandException):
+    def __init__(self) -> None:
+        super().__init__("No secrets to list.")

{cgcsdk-1.0.9/cgc/commands/keys → cgcsdk-1.0.10/cgc/commands/user}/keys_cmd.py

@@ -1,14 +1,14 @@
 import json
 import click
 from typing import Optional
-from cgc.commands.keys.keys_responses import (
+from cgc.commands.user.keys_responses import (
     create_ssh_key_response,
     delete_ssh_key_response,
     list_ssh_keys_response,
     update_ssh_key_response,
 )
-from cgc.commands.keys.keys_utils import create_ssh_key_payload, update_ssh_key_payload
-from cgc.commands.keys.keys_models import SSHKeyTypes
+from cgc.commands.user.keys_utils import create_ssh_key_payload, update_ssh_key_payload
+from cgc.commands.user.keys_models import SSHKeyTypes
 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.utils.click_group import CustomGroup, CustomCommand
@@ -84,7 +84,8 @@ def create_ssh_key(
     click.echo(
         create_ssh_key_response(
             retrieve_and_validate_response_send_metric(__res, metric)
-        )
+        ),
+        color="green",
     )
 
 
@@ -135,7 +136,8 @@ def update_ssh_key(
     click.echo(
         update_ssh_key_response(
             retrieve_and_validate_response_send_metric(__res, metric)
-        )
+        ),
+        color="green",
     )
 
 
@@ -154,7 +156,8 @@ def delete_ssh_key(key_id: str):
     click.echo(
         delete_ssh_key_response(
             retrieve_and_validate_response_send_metric(__res, metric)
-        )
+        ),
+        color="green",
     )
 
 

{cgcsdk-1.0.9/cgc/commands/keys → cgcsdk-1.0.10/cgc/commands/user}/keys_responses.py

@@ -1,6 +1,6 @@
 import click
 from cgc.utils.message_utils import key_error_decorator_for_helpers
-from cgc.commands.keys.keys_utils import get_user_ssh_keys
+from cgc.commands.user.keys_utils import get_user_ssh_keys
 from cgc.utils.response_utils import (
     fill_missing_values_in_a_response,
     tabulate_a_response,
@@ -8,7 +8,7 @@ from cgc.utils.response_utils import (
 
 
 @key_error_decorator_for_helpers
-def create_ssh_key_response(data: dict) -> dict:
+def create_ssh_key_response(data: dict) -> str:
     """Create a response for creating a new SSH key"""
     try:
         key_id = data["details"]["key_id"]
@@ -18,7 +18,7 @@ def create_ssh_key_response(data: dict) -> dict:
 
 
 @key_error_decorator_for_helpers
-def delete_ssh_key_response(data: dict) -> dict:
+def delete_ssh_key_response(data: dict) -> str:
     """Create a response for deleting an SSH key"""
     try:
         key_id = data["details"]["key_id"]
@@ -28,20 +28,17 @@ def delete_ssh_key_response(data: dict) -> dict:
 
 
 @key_error_decorator_for_helpers
-def list_ssh_keys_response(data: dict) -> dict:
+def list_ssh_keys_response(data: dict) -> str:
     """Create a response for listing all SSH keys"""
     list_of_json_data = get_user_ssh_keys(data["details"])
+    if not list_of_json_data:
+        return "No keys found."
     table = fill_missing_values_in_a_response(list_of_json_data)
 
     return tabulate_a_response(table)
 
 
 @key_error_decorator_for_helpers
-def update_ssh_key_response(data: dict) -> dict:
+def update_ssh_key_response(_: dict) -> str:
     """Create a response for updating an SSH key"""
-    try:
-        key_id = data["details"]["key_id"]
-    except KeyError:
-        return "Key updated."
-    else:
-        return f"Key updated. New key ID: {key_id}."
+    return "Key updated."

{cgcsdk-1.0.9/cgc/commands/keys → cgcsdk-1.0.10/cgc/commands/user}/keys_utils.py

@@ -1,6 +1,6 @@
 from typing import Optional
 import click
-from cgc.commands.keys.keys_models import SSHKeyTypes
+from cgc.commands.user.keys_models import SSHKeyTypes
 
 
 def create_ssh_key_payload(

cgcsdk-1.0.10/cgc/commands/user/secret_cmd.py

@@ -0,0 +1,154 @@
+import json
+from typing import Optional, Set
+import click
+
+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.utils.click_group import CustomGroup, CustomCommand
+from cgc.utils.requests_helper import call_api, EndpointTypes
+from cgc.commands.user.secret_utils import create_secret_payload, update_secret_payload
+from cgc.commands.user.secret_responses import (
+    create_secret_response,
+    update_secret_response,
+    delete_secret_response,
+    list_secrets_response,
+)
+
+
+@click.group(name="secret", cls=CustomGroup)
+def secret_group():
+    """
+    Management of secrets.
+    """
+
+
+@secret_group.command("create", cls=CustomCommand)
+@click.argument("secret_name", type=click.STRING)
+@click.option(
+    "-r",
+    "--registry-list",
+    "registry_list",
+    multiple=True,
+    help="URL of the registry",
+    required=True,
+)
+@click.option(
+    "-u",
+    "--username",
+    "username",
+    type=click.STRING,
+    help="Username for the registry",
+    required=True,
+)
+@click.option(
+    "-p",
+    "--password",
+    "password",
+    type=click.STRING,
+    help="Password for the username",
+    required=True,
+)
+def create_secret(
+    secret_name: str, registry_list: Set[str], username: str, password: str
+):
+    """Create a new secret in the namespace"""
+    api_url, headers = get_api_url_and_prepare_headers()
+    url = f"{api_url}/v1/api/secret/create"
+    metric = "user.secret.create"
+    __payload = create_secret_payload(secret_name, registry_list, username, password)
+    __res = call_api(
+        request=EndpointTypes.post,
+        url=url,
+        headers=headers,
+        data=json.dumps(__payload).encode("utf-8"),
+    )
+    click.echo(
+        create_secret_response(
+            retrieve_and_validate_response_send_metric(__res, metric)
+        ),
+        color="green",
+    )
+
+
+@secret_group.command("update", cls=CustomCommand)
+@click.argument("secret_name", type=click.STRING)
+@click.option(
+    "-r",
+    "--registry-list",
+    "registry_list",
+    multiple=True,
+    help="URL of the registry",
+)
+@click.option(
+    "-u",
+    "--username",
+    "username",
+    type=click.STRING,
+    help="Username for the registry",
+)
+@click.option(
+    "-p",
+    "--password",
+    "password",
+    type=click.STRING,
+    help="Password for the username",
+)
+def update_secret(
+    secret_name: str,
+    registry_list: Optional[Set[str]] = None,
+    username: Optional[str] = None,
+    password: Optional[str] = None,
+):
+    """Update an existing secret in the namespace"""
+    api_url, headers = get_api_url_and_prepare_headers()
+    url = f"{api_url}/v1/api/secret/manage/{secret_name}"
+    metric = "user.secret.update"
+    __payload = update_secret_payload(registry_list, username, password)
+    __res = call_api(
+        request=EndpointTypes.put,
+        url=url,
+        headers=headers,
+        data=json.dumps(__payload).encode("utf-8"),
+    )
+    click.echo(
+        update_secret_response(
+            retrieve_and_validate_response_send_metric(__res, metric)
+        ),
+        color="green",
+    )
+
+
+@secret_group.command("delete", cls=CustomCommand)
+@click.argument("secret_name", type=click.STRING)
+def delete_secret(secret_name: str):
+    """Delete an secret"""
+    api_url, headers = get_api_url_and_prepare_headers()
+    url = f"{api_url}/v1/api/secret/manage/{secret_name}"
+    metric = "user.secret.delete"
+    __res = call_api(
+        request=EndpointTypes.delete,
+        url=url,
+        headers=headers,
+    )
+    click.echo(
+        delete_secret_response(
+            retrieve_and_validate_response_send_metric(__res, metric)
+        ),
+        color="green",
+    )
+
+
+@secret_group.command("list", cls=CustomCommand)
+def list_secrets():
+    """List all secrets in the namespace"""
+    api_url, headers = get_api_url_and_prepare_headers()
+    url = f"{api_url}/v1/api/secret/list"
+    metric = "user.secret.list"
+    __res = call_api(
+        request=EndpointTypes.get,
+        url=url,
+        headers=headers,
+    )
+    click.echo(
+        list_secrets_response(retrieve_and_validate_response_send_metric(__res, metric))
+    )

cgcsdk-1.0.10/cgc/commands/user/secret_responses.py

@@ -0,0 +1,44 @@
+import click
+
+from cgc.commands.user import NoSecretsToList
+from cgc.commands.user.secret_utils import get_secret_list
+from cgc.telemetry.basic import setup_gauge
+from cgc.utils.config_utils import get_namespace
+from cgc.utils.message_utils import key_error_decorator_for_helpers
+from cgc.utils.response_utils import (
+    fill_missing_values_in_a_response,
+    tabulate_a_response,
+)
+
+
+@key_error_decorator_for_helpers
+def create_secret_response(data: dict) -> str:
+    """Create a response for creating a new secret in the namespace"""
+    return f'Secret {data.get("details", {}).get("secret_name")} successfully created.'
+
+
+@key_error_decorator_for_helpers
+def update_secret_response(data: dict) -> str:
+    """Create a response for updating a secret in the namespace"""
+    return f'Secret {data.get("details", {}).get("secret_name")} successfully updated.'
+
+
+@key_error_decorator_for_helpers
+def delete_secret_response(data: dict) -> str:
+    """Create a response for deleting a secret in the namespace"""
+    return f'Secret {data.get("details", {}).get("secret_name")} successfully deleted.'
+
+
+@key_error_decorator_for_helpers
+def list_secrets_response(data: dict) -> str:
+    """Create a response for listing all secrets in the namespace"""
+    secret_list = data.get("details", {}).get("secret_names", [])
+    setup_gauge(f"{get_namespace()}.secret.count", len(secret_list))
+
+    if not secret_list:
+        raise NoSecretsToList()
+
+    list_of_json_data = get_secret_list(secret_list)
+    table = fill_missing_values_in_a_response(list_of_json_data)
+
+    return tabulate_a_response(table)

cgcsdk-1.0.10/cgc/commands/user/secret_utils.py

@@ -0,0 +1,60 @@
+from typing import Set
+
+
+def create_secret_payload(
+    secret_name: str, registry_list: Set[str], username: str, password: str
+) -> dict:
+    """Create a payload for creating a new secret"""
+    payload = {
+        "name": secret_name,
+        "registry_list": registry_list,
+        "username": username,
+        "password": password,
+    }
+    return payload
+
+
+def update_secret_payload(
+    registry_list: Set[str], username: str, password: str
+) -> dict:
+    """Create a payload for updating a secret"""
+    payload = {}
+    if registry_list:
+        payload["registry_list"] = registry_list
+    if username:
+        payload["username"] = username
+    if password:
+        payload["password"] = password
+    return payload
+
+
+def _get_secret_json_data(secret_list: list):
+    """Formats and returns list of secrets to print.
+
+    :param job_list: list of secrets
+    :type job_list: list
+    :return: formatted list of secrets
+    :rtype: list
+    """
+    output_data = []
+
+    for secret in secret_list:
+        try:
+
+            secret_data = {
+                "name": secret.get("secret"),
+                "secret_type": secret.get("secret_type"),
+                "registry_list": secret.get("registry_list", []),
+                "secret_admin": secret.get("secret_admin"),
+                "date_created": f'{secret.get("date_created")} UTC',
+                "whitelist": secret.get("whitelist", ["*"]),
+            }
+            output_data.append(secret_data)
+        except KeyError:
+            pass
+
+    return output_data
+
+
+def get_secret_list(secret_list: list):
+    return _get_secret_json_data(secret_list)

{cgcsdk-1.0.9 → cgcsdk-1.0.10}/cgc/sdk/resource.py

@@ -2,7 +2,7 @@ import json as _json
 import cgc.sdk.exceptions as _exceptions
 from cgc.utils.custom_exceptions import CUSTOM_EXCEPTIONS
 import cgc.utils.prepare_headers as _prepare_headers
-import cgc.commands.compute.compute_utills as _compute_utills
+import cgc.commands.compute.compute_utils as _compute_utils
 import cgc.utils.requests_helper as _requests_helper
 import cgc.utils.response_utils as _response_utils
 from enum import Enum as _Enum
@@ -243,7 +243,7 @@ def compute_create_custom(
     gpu_type = gpu_type.upper()
     if gpu_type not in GPUsList.get_list():
         raise _exceptions.SDKException(-3, f"Invalid GPU type: {gpu_type}")
-    __payload = _compute_utills.compute_create_payload(
+    __payload = _compute_utils.compute_create_payload(
         name=name,
         entity="custom",
         cpu=cpu,
@@ -291,7 +291,7 @@ def resource_update_port(
     api_url, headers = _prepare_headers.get_api_url_and_prepare_headers()
     url = f"{api_url}/v1/api/resource/ports?port_modification_mode=UPDATE"
     metric = "resource.ports.update"
-    __payload = _compute_utills.port_modification_payload(
+    __payload = _compute_utils.port_modification_payload(
         port_name=port_name,
         port_number=new_port,
         ingress=ingress,
@@ -325,7 +325,7 @@ def resource_add_port(name: str, port_name: str, new_port: int, ingress: bool =
     api_url, headers = _prepare_headers.get_api_url_and_prepare_headers()
     url = f"{api_url}/v1/api/resource/ports?port_modification_mode=ADD"
     metric = "resource.ports.add"
-    __payload = _compute_utills.port_modification_payload(
+    __payload = _compute_utils.port_modification_payload(
         port_name=port_name,
         port_number=new_port,
         ingress=ingress,
@@ -360,7 +360,7 @@ def resource_delete_port(
     api_url, headers = _prepare_headers.get_api_url_and_prepare_headers()
     url = f"{api_url}/v1/api/resource/ports?port_modification_mode=DELETE"
     metric = "resource.ports.delete"
-    __payload = _compute_utills.port_delete_payload(
+    __payload = _compute_utils.port_delete_payload(
         port_name=port_name,
         app_name=name,
     )
@@ -411,7 +411,7 @@ def resource_delete(name: str):
     api_url, headers = _prepare_headers.get_api_url_and_prepare_headers()
     url = f"{api_url}/v1/api/resource/delete"
     metric = "resource.delete"
-    __payload = _compute_utills.compute_delete_payload(name=name)
+    __payload = _compute_utils.compute_delete_payload(name=name)
     __res = _requests_helper.call_api(
         request=_requests_helper.EndpointTypes.delete,
         url=url,

{cgcsdk-1.0.9 → cgcsdk-1.0.10}/cgc/tests/responses_tests.py

@@ -27,7 +27,7 @@ from cgc.utils.response_utils import (
     tabulate_a_response,
     fill_missing_values_in_a_response,
 )
-from cgc.commands.compute.compute_utills import get_app_list
+from cgc.commands.compute.compute_utils import get_app_list
 
 
 class TestVolumeResponses(unittest.TestCase):

{cgcsdk-1.0.9 → cgcsdk-1.0.10}/cgc/utils/requests_helper.py

@@ -18,10 +18,12 @@ from cgc.utils.consts.message_consts import (
 
 urllib3.disable_warnings(urllib3.exceptions.SecurityWarning)
 
+
 class EndpointTypes(Enum):
     get = requests.get
     post = requests.post
     delete = requests.delete
+    put = requests.put
 
 
 def _process_endpoint_kwargs(**kwargs):

{cgcsdk-1.0.9 → cgcsdk-1.0.10/cgcsdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cgcsdk
-Version: 1.0.9
+Version: 1.0.10
 Summary: Comtegra GPU Cloud REST API client
 Author: Comtegra AI Team
 Author-email: ai@comtegra.pl

{cgcsdk-1.0.9 → cgcsdk-1.0.10}/cgcsdk.egg-info/SOURCES.txt

@@ -27,7 +27,7 @@ cgc/commands/compute/__init__.py
 cgc/commands/compute/compute_cmd.py
 cgc/commands/compute/compute_models.py
 cgc/commands/compute/compute_responses.py
-cgc/commands/compute/compute_utills.py
+cgc/commands/compute/compute_utils.py
 cgc/commands/db/__init__.py
 cgc/commands/db/db_cmd.py
 cgc/commands/db/db_models.py
@@ -37,14 +37,18 @@ cgc/commands/jobs/__init__.py
 cgc/commands/jobs/job_utils.py
 cgc/commands/jobs/jobs_cmd.py
 cgc/commands/jobs/jobs_responses.py
-cgc/commands/keys/__init__.py
-cgc/commands/keys/keys_cmd.py
-cgc/commands/keys/keys_models.py
-cgc/commands/keys/keys_responses.py
-cgc/commands/keys/keys_utils.py
 cgc/commands/resource/__init__.py
 cgc/commands/resource/resource_cmd.py
 cgc/commands/resource/resource_responses.py
+cgc/commands/user/__init__.py
+cgc/commands/user/keys_cmd.py
+cgc/commands/user/keys_models.py
+cgc/commands/user/keys_responses.py
+cgc/commands/user/keys_utils.py
+cgc/commands/user/secret_cmd.py
+cgc/commands/user/secret_models.py
+cgc/commands/user/secret_responses.py
+cgc/commands/user/secret_utils.py
 cgc/commands/volume/__init__.py
 cgc/commands/volume/data_model.py
 cgc/commands/volume/volume_cmd.py

cgcsdk-1.0.9/cgc/commands/keys/__init__.py

@@ -1,5 +0,0 @@
-from cgc.commands.exceptions import ResponseException
-
-
-class KeysCommandException(ResponseException):
-    pass