oak-cli 0.2.5__tar.gz → 0.2.8__tar.gz

oak_cli-0.2.8/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.1
+Name: oak_cli
+Version: 0.2.8
+Summary: 
+Author: Alexander Malyuk
+Author-email: malyuk.alexander1999@gmail.com
+Requires-Python: >=3.10,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: argcomplete (>=3.2.3,<4.0.0)
+Requires-Dist: icecream (>=2.1.3,<3.0.0)
+Description-Content-Type: text/markdown
+
+# [Oakestra CLI](https://github.com/oakestra/oakestra-cli)
+
+**oakestra-cli** is a very basic command line tool for controlling your [Oakestra](https://github.com/oakestra/oakestra) setup. 
+
+It is intended to be an interface for the API as well as a development tool.
+
+The CLI supports command (tab) autocompletion.
+
+## Usage
+The package can be called via `oak`.
+
+Currently, it supports the creation, deletion, inspection, and (un)deployment of applications and services.
+
+E.g. To deploy a default application with two services:
+```
+oak applications create default_app_with_services --deploy
+```
+Note: The CLI supports short command aliases. The command above can be shortened like this:
+```
+oak a c default_app_with_services -d
+```
+
+You should see a similar output if the command was successful:
+```bash
+Success: Create new application based on 'default_app_with_services'
+Success: Deploy a new instance for the service '66040243c7723114bb83b914'
+Success: Deploy a new instance for the service '66040243c7723114bb83b919'
+```
+You can inspect the services like this:
+```bash
+oak services status
+```
+Or like this: `oak s s`
+
+Service status output:
+```yaml
+All current services: '2'
+ Service '0':
+   - microservice -
+   id: '66040243c7723114bb83b914'
+   name: 'curl'
+   ns: 'test'
+   parent app: 'clientsrvr: 660402439df62d60bb95452b'
+   - resources -
+   memory: '100'
+   vcpus: '1'
+   - container -
+   image: 'docker.io/curlimages/curl:7.82.0'
+   - networking -
+   port: '9080'
+   - instances -
+   instances: '1'
+ Service '1':
+   - microservice -
+   id: '66040243c7723114bb83b919'
+   name: 'nginx'
+   ns: 'test'
+   parent app: 'clientsrvr: 660402439df62d60bb95452b'
+   - resources -
+   memory: '100'
+   vcpus: '1'
+   - container -
+   image: 'docker.io/library/nginx:latest'
+   - networking -
+   port: '6080:60/tcp'
+   - instances -
+   instances: '1'
+```
+
+For a more detailed explanation try out the CLI and use the `-h` flag.
+
+## [Installation](https://pypi.org/project/oak-cli/)
+```
+pip install oak-cli
+```
+
+# For CLI Contributors/Developers
+For local development with "hot-reload" functionality simply install the package via poetry.
+
+## Useful commands
+
+```bash
+poetry install
+```
+```bash
+poetry build
+```
+```
+twine upload dist/*
+```
+

oak_cli-0.2.8/README.md

@@ -0,0 +1,90 @@
+# [Oakestra CLI](https://github.com/oakestra/oakestra-cli)
+
+**oakestra-cli** is a very basic command line tool for controlling your [Oakestra](https://github.com/oakestra/oakestra) setup. 
+
+It is intended to be an interface for the API as well as a development tool.
+
+The CLI supports command (tab) autocompletion.
+
+## Usage
+The package can be called via `oak`.
+
+Currently, it supports the creation, deletion, inspection, and (un)deployment of applications and services.
+
+E.g. To deploy a default application with two services:
+```
+oak applications create default_app_with_services --deploy
+```
+Note: The CLI supports short command aliases. The command above can be shortened like this:
+```
+oak a c default_app_with_services -d
+```
+
+You should see a similar output if the command was successful:
+```bash
+Success: Create new application based on 'default_app_with_services'
+Success: Deploy a new instance for the service '66040243c7723114bb83b914'
+Success: Deploy a new instance for the service '66040243c7723114bb83b919'
+```
+You can inspect the services like this:
+```bash
+oak services status
+```
+Or like this: `oak s s`
+
+Service status output:
+```yaml
+All current services: '2'
+ Service '0':
+   - microservice -
+   id: '66040243c7723114bb83b914'
+   name: 'curl'
+   ns: 'test'
+   parent app: 'clientsrvr: 660402439df62d60bb95452b'
+   - resources -
+   memory: '100'
+   vcpus: '1'
+   - container -
+   image: 'docker.io/curlimages/curl:7.82.0'
+   - networking -
+   port: '9080'
+   - instances -
+   instances: '1'
+ Service '1':
+   - microservice -
+   id: '66040243c7723114bb83b919'
+   name: 'nginx'
+   ns: 'test'
+   parent app: 'clientsrvr: 660402439df62d60bb95452b'
+   - resources -
+   memory: '100'
+   vcpus: '1'
+   - container -
+   image: 'docker.io/library/nginx:latest'
+   - networking -
+   port: '6080:60/tcp'
+   - instances -
+   instances: '1'
+```
+
+For a more detailed explanation try out the CLI and use the `-h` flag.
+
+## [Installation](https://pypi.org/project/oak-cli/)
+```
+pip install oak-cli
+```
+
+# For CLI Contributors/Developers
+For local development with "hot-reload" functionality simply install the package via poetry.
+
+## Useful commands
+
+```bash
+poetry install
+```
+```bash
+poetry build
+```
+```
+twine upload dist/*
+```

{oak_cli-0.2.5 → oak_cli-0.2.8}/oak_cli/args_parser/apps/delete.py

@@ -14,7 +14,7 @@ _DELETION_HELP_TEXT = "deletes one or all applications" + _APP_ID_HELP_TEXT
 def prepare_applications_deletion_argparser(
     applications_subparsers: Subparsers,
 ) -> None:
-    def aux_delete_appliacations(args: Any):
+    def aux_delete_applications(args: Any):
         if args.all:
             delete_all_applications()
         else:
@@ -30,7 +30,5 @@ def prepare_applications_deletion_argparser(
     applications_deletion_parser.add_argument(
         "-a", "--all", action="store_true", help="delete all applications"
     )
-    applications_deletion_parser.add_argument(
-        "app_id", nargs="?", type=str, help=_APP_ID_HELP_TEXT
-    )
-    applications_deletion_parser.set_defaults(func=aux_delete_appliacations)
+    applications_deletion_parser.add_argument("app_id", nargs="?", type=str, help=_APP_ID_HELP_TEXT)
+    applications_deletion_parser.set_defaults(func=aux_delete_applications)

{oak_cli-0.2.5 → oak_cli-0.2.8}/oak_cli/args_parser/apps/status.py

@@ -13,6 +13,4 @@ def prepare_applications_display_argparser(applications_subparsers: Subparsers)
         description=HELP_TEXT,
         formatter_class=argparse.RawTextHelpFormatter,
     )
-    applications_status_parser.set_defaults(
-        func=lambda _: display_current_applications()
-    )
+    applications_status_parser.set_defaults(func=lambda _: display_current_applications())

{oak_cli-0.2.5 → oak_cli-0.2.8}/oak_cli/args_parser/main.py

@@ -5,6 +5,9 @@ import argparse
 import argcomplete
 
 from oak_cli.args_parser.apps.main import prepare_applications_argparsers
+
+# from oak_cli.args_parser.docker.main import prepare_docker_argparsers
+from oak_cli.args_parser.plugins.main import prepare_plugins_argparsers
 from oak_cli.args_parser.services.main import prepare_services_argparsers
 
 
@@ -19,6 +22,8 @@ def parse_arguments_and_execute() -> None:
 
     prepare_applications_argparsers(subparsers)
     prepare_services_argparsers(subparsers)
+    prepare_plugins_argparsers(subparsers)
+    #    prepare_docker_argparsers(subparsers)
 
     argcomplete.autocomplete(parser)
     args = parser.parse_args()

oak_cli-0.2.8/oak_cli/args_parser/plugins/flops/create.py

@@ -0,0 +1,16 @@
+import argparse
+
+from oak_cli.commands.plugins.flops.main import create_new_fl_service
+from oak_cli.utils.types import Subparsers
+
+
+def prepare_flops_create_argparser(flops_subparser: Subparsers) -> None:
+    HELP_TEXT = "creates a new FLOps process - i.e. triggers the init FLOps API"
+    flops_create_parser = flops_subparser.add_parser(
+        "create",
+        aliases=["c"],
+        help=HELP_TEXT,
+        description=HELP_TEXT,
+        formatter_class=argparse.RawTextHelpFormatter,
+    )
+    flops_create_parser.set_defaults(func=lambda _: create_new_fl_service())

oak_cli-0.2.8/oak_cli/args_parser/plugins/flops/main.py

@@ -0,0 +1,25 @@
+import argparse
+from typing import Any
+
+from oak_cli.args_parser.plugins.flops.create import prepare_flops_create_argparser
+from oak_cli.utils.types import Subparsers
+
+
+def prepare_flops_argparsers(subparsers: Subparsers) -> None:
+    flops_parser = subparsers.add_parser(
+        "flops",
+        aliases=["fl"],
+        help="command for FLOps related activities",
+        formatter_class=argparse.RawTextHelpFormatter,
+    )
+
+    def flops_parser_print_help(_: Any) -> None:
+        flops_parser.print_help()
+
+    flops_parser.set_defaults(func=flops_parser_print_help)
+
+    flops_subparser = flops_parser.add_subparsers(
+        dest="FLOps commands",
+    )
+
+    prepare_flops_create_argparser(flops_subparser)

oak_cli-0.2.8/oak_cli/args_parser/plugins/main.py

@@ -0,0 +1,25 @@
+import argparse
+from typing import Any
+
+from oak_cli.args_parser.plugins.flops.main import prepare_flops_argparsers
+from oak_cli.utils.types import Subparsers
+
+
+def prepare_plugins_argparsers(subparsers: Subparsers) -> None:
+    plugins_parser = subparsers.add_parser(
+        "plugins",
+        aliases=["p"],
+        help="command for plugin related activities",
+        formatter_class=argparse.RawTextHelpFormatter,
+    )
+
+    def plugins_parser_print_help(_: Any) -> None:
+        plugins_parser.print_help()
+
+    plugins_parser.set_defaults(func=plugins_parser_print_help)
+
+    plugins_subparsers = plugins_parser.add_subparsers(
+        dest="plugins commands",
+    )
+
+    prepare_flops_argparsers(plugins_subparsers)

{oak_cli-0.2.5 → oak_cli-0.2.8}/oak_cli/args_parser/services/deployment.py

@@ -19,9 +19,7 @@ def prepare_services_deployment_argparser(services_subparsers: Subparsers) -> No
         formatter_class=argparse.RawTextHelpFormatter,
     )
     services_deployment_parser.add_argument("service_id", type=str)
-    services_deployment_parser.set_defaults(
-        func=lambda args: deploy_new_instance(args.service_id)
-    )
+    services_deployment_parser.set_defaults(func=lambda args: deploy_new_instance(args.service_id))
 
 
 def prepare_services_undeployment_argparser(services_subparsers: Subparsers) -> None:

{oak_cli-0.2.5 → oak_cli-0.2.8}/oak_cli/args_parser/services/status.py

@@ -2,10 +2,7 @@ import argparse
 from typing import Any
 
 from oak_cli.commands.services.get import get_single_service
-from oak_cli.commands.services.status import (
-    display_all_current_services,
-    display_single_service,
-)
+from oak_cli.commands.services.status import display_all_current_services, display_single_service
 from oak_cli.utils.types import Subparsers
 
 

oak_cli-0.2.8/oak_cli/commands/apps/main.py

@@ -0,0 +1,81 @@
+import enum
+import json
+from typing import List
+
+import oak_cli.utils.api.custom_requests as custom_requests
+from oak_cli.utils.api.common import SYSTEM_MANAGER_URL
+from oak_cli.utils.api.custom_http import HttpMethod
+from oak_cli.utils.logging import logger
+from oak_cli.utils.SLAs.common import get_SLAs_path
+from oak_cli.utils.types import Application, ApplicationId
+
+
+def get_application(app_id: ApplicationId) -> Application:
+    return custom_requests.CustomRequest(
+        custom_requests.RequestCore(
+            base_url=SYSTEM_MANAGER_URL,
+            api_endpoint=f"/api/application/{app_id}",
+        ),
+        custom_requests.RequestAuxiliaries(
+            what_should_happen=f"Get application '{app_id}'",
+        ),
+    ).execute()
+
+
+def get_applications() -> List[Application]:
+    apps = custom_requests.CustomRequest(
+        custom_requests.RequestCore(
+            base_url=SYSTEM_MANAGER_URL,
+            api_endpoint="/api/applications",
+        ),
+        custom_requests.RequestAuxiliaries(
+            what_should_happen="Get all applications",
+        ),
+    ).execute()
+    if not apps:
+        logger.info("No applications exist yet")
+    return apps
+
+
+def send_sla(sla_enum: enum) -> List[Application]:
+    sla_file_name = f"{sla_enum}.SLA.json"
+    SLA = ""
+    with open(get_SLAs_path() / sla_file_name, "r") as f:
+        SLA = json.load(f)
+    sla_apps = SLA["applications"]
+    sla_app_names = [app["application_name"] for app in sla_apps]
+    # Note: The API endpoint returns all user apps and not just the newly posted ones.
+    all_user_apps = custom_requests.CustomRequest(
+        custom_requests.RequestCore(
+            http_method=HttpMethod.POST,
+            base_url=SYSTEM_MANAGER_URL,
+            api_endpoint="/api/application",
+            data=SLA,
+        ),
+        custom_requests.RequestAuxiliaries(
+            what_should_happen=f"Create new application based on '{sla_enum}'",
+            show_msg_on_success=True,
+        ),
+    ).execute()
+
+    newly_added_apps = [app for app in all_user_apps if (app["application_name"] in sla_app_names)]
+    return newly_added_apps
+
+
+def delete_application(app_id: ApplicationId) -> None:
+    custom_requests.CustomRequest(
+        custom_requests.RequestCore(
+            http_method=HttpMethod.DELETE,
+            base_url=SYSTEM_MANAGER_URL,
+            api_endpoint=f"/api/application/{app_id}",
+        ),
+        custom_requests.RequestAuxiliaries(
+            what_should_happen=f"Delete application '{app_id}'",
+            show_msg_on_success=True,
+        ),
+    ).execute()
+
+
+def delete_all_applications() -> None:
+    for app in get_applications():
+        delete_application(app["applicationID"])

oak_cli-0.2.8/oak_cli/commands/apps/status.py

@@ -0,0 +1,11 @@
+from icecream import ic
+
+from oak_cli.commands.apps.main import get_applications
+
+ic.configureOutput(prefix="")
+
+
+def display_current_applications() -> None:
+    current_applications = get_applications()
+    for i, application in enumerate(current_applications):
+        ic(i, application)

oak_cli-0.2.8/oak_cli/commands/plugins/flops/flops.SLA.json

@@ -0,0 +1,13 @@
+{
+    "verbose": true,
+    "customerID": "Admin",
+    "applicationID": "",
+    "code": "https://github.com/Malyuk-A/mlflower-test-a",
+    "memory": 100,
+    "vcpus": 1,
+    "vgpus": 0,
+    "vtpus": 0,
+    "bandwidth_in": 0,
+    "bandwidth_out": 0,
+    "storage": 0
+}

oak_cli-0.2.8/oak_cli/commands/plugins/flops/main.py

@@ -0,0 +1,29 @@
+import json
+import os
+import pathlib
+
+import oak_cli.utils.api.custom_requests as custom_requests
+from oak_cli.utils.api.custom_http import HttpMethod
+
+ROOT_FL_MANAGER_URL = f"http://{os.environ.get('SYSTEM_MANAGER_URL')}:5072"
+
+
+def create_new_fl_service() -> None:
+    sla_file_name = "flops.SLA.json"
+    current_file_path = pathlib.Path(__file__).resolve()
+    sla_file_path = current_file_path.parent / sla_file_name
+    with open(sla_file_path, "r") as f:
+        SLA = json.load(f)
+
+    custom_requests.CustomRequest(
+        custom_requests.RequestCore(
+            http_method=HttpMethod.POST,
+            base_url=ROOT_FL_MANAGER_URL,
+            api_endpoint="/api/flops",
+            data=SLA,
+        ),
+        custom_requests.RequestAuxiliaries(
+            what_should_happen="Init new FLOps processes",
+            show_msg_on_success=True,
+        ),
+    ).execute()

oak_cli-0.2.8/oak_cli/commands/services/deployment.py

@@ -0,0 +1,39 @@
+import oak_cli.utils.api.custom_requests as custom_requests
+from oak_cli.commands.services.get import get_single_service
+from oak_cli.utils.api.common import SYSTEM_MANAGER_URL
+from oak_cli.utils.api.custom_http import HttpMethod
+from oak_cli.utils.types import Id, ServiceId
+
+
+def deploy_new_instance(service_id: ServiceId) -> None:
+    custom_requests.CustomRequest(
+        custom_requests.RequestCore(
+            http_method=HttpMethod.POST,
+            base_url=SYSTEM_MANAGER_URL,
+            api_endpoint=f"/api/service/{service_id}/instance",
+        ),
+        custom_requests.RequestAuxiliaries(
+            what_should_happen=f"Deploy a new instance for the service '{service_id}'",
+            show_msg_on_success=True,
+        ),
+    ).execute()
+
+
+def undeploy_instance(service_id: ServiceId, instance_id: Id = None) -> None:
+    custom_requests.CustomRequest(
+        custom_requests.RequestCore(
+            http_method=HttpMethod.DELETE,
+            base_url=SYSTEM_MANAGER_URL,
+            api_endpoint=f"/api/service/{service_id}/instance/{instance_id or 0}",
+        ),
+        custom_requests.RequestAuxiliaries(
+            what_should_happen=f"Undeploy instance '{instance_id or 0}' for service '{service_id}'",
+            show_msg_on_success=True,
+        ),
+    ).execute()
+
+
+def undeploy_all_instances_of_service(service_id: ServiceId) -> None:
+    service = get_single_service(service_id)
+    for instance in service["instance_list"]:
+        undeploy_instance(service_id, instance["instance_number"])

oak_cli-0.2.8/oak_cli/commands/services/get.py

@@ -0,0 +1,38 @@
+from typing import List
+
+import oak_cli.utils.api.custom_requests as custom_requests
+from oak_cli.utils.api.common import SYSTEM_MANAGER_URL
+from oak_cli.utils.logging import logger
+from oak_cli.utils.types import Service, ServiceId
+
+
+def get_single_service(service_id: ServiceId) -> Service:
+    return custom_requests.CustomRequest(
+        custom_requests.RequestCore(
+            base_url=SYSTEM_MANAGER_URL,
+            api_endpoint=f"/api/service/{service_id}",
+        ),
+        custom_requests.RequestAuxiliaries(
+            what_should_happen=f"Get single service '{service_id}'",
+        ),
+    ).execute()
+
+
+def get_all_services(app_id: ServiceId = None) -> List[Service]:
+    what_should_happen = "Get all services"
+    if app_id:
+        what_should_happen += f" of app '{app_id}'"
+
+    services = custom_requests.CustomRequest(
+        custom_requests.RequestCore(
+            base_url=SYSTEM_MANAGER_URL,
+            api_endpoint=f"/api/services/{app_id or ''}",
+        ),
+        custom_requests.RequestAuxiliaries(
+            what_should_happen=what_should_happen,
+        ),
+    ).execute()
+
+    if not services:
+        logger.info("No applications exist yet")
+    return services

oak_cli-0.2.8/oak_cli/commands/services/status.py

@@ -0,0 +1,41 @@
+from icecream import ic
+
+from oak_cli.commands.services.get import get_all_services
+from oak_cli.utils.types import ApplicationId, Service
+
+ic.configureOutput(prefix="")
+
+
+def display_single_service(service: Service, verbose: bool = False) -> None:
+    if verbose:
+        for instance in service["instance_list"]:
+            instance["cpu_history"] = "..."
+            instance["memory_history"] = "..."
+            instance["logs"] = "..."
+    else:
+        mask = [
+            "addresses",
+            "app_name",
+            "app_ns",
+            "applicationID",
+            "service_name",
+            "service_ns",
+            "service_ns",
+            "one_shot",
+            "microserviceID",
+            "cmd",
+            "code",
+            "image",
+        ]
+        service = {key: service[key] for key in mask if key in service}
+    ic(service)
+
+
+def display_all_current_services(
+    verbose: bool = False,
+    app_id: ApplicationId = None,
+) -> None:
+    all_current_services = get_all_services(app_id)
+    for i, service in enumerate(all_current_services):
+        ic(i)
+        display_single_service(service, verbose)

oak_cli-0.2.8/oak_cli/main.py

@@ -0,0 +1,28 @@
+#!/usr/bin/env python3
+# PYTHON_ARGCOMPLETE_OK
+
+from oak_cli.args_parser.main import parse_arguments_and_execute
+from oak_cli.utils.argcomplete import handle_argcomplete
+from oak_cli.utils.exceptions import OakCliException
+from oak_cli.utils.logging import logger
+
+
+def main():
+    handle_argcomplete()
+    # Potential Future Work:
+    # This implementation uses argparse & argcomplete for user friendly CLI behavior.
+    # However especially argparse comes with a lot of additional boilerplate code.
+    # It might be useful to look into more modern solutions for python CLI's like
+    # https://github.com/pallets/click
+
+    try:
+        parse_arguments_and_execute()
+    except OakCliException as e:
+        logger.fatal(f"{e.msg}, {e.http_status}")
+    except Exception as e:
+        err_msg = f"Unexpected error occured: {e}"
+        logger.fatal(err_msg)
+
+
+if __name__ == "__main__":
+    main()

oak_cli-0.2.8/oak_cli/utils/api/common.py

@@ -0,0 +1,3 @@
+import os
+
+SYSTEM_MANAGER_URL = f"http://{os.environ.get('SYSTEM_MANAGER_URL')}:10000"

oak_cli-0.2.5/oak_cli/utils/api/common.py → oak_cli-0.2.8/oak_cli/utils/api/custom_http.py

@@ -1,12 +1,7 @@
-import os
-
 import requests
 
 from oak_cli.utils.types import CustomEnum
 
-GITHUB_PREFIX = "https://github.com/"
-SYSTEM_MANAGER_URL = f"http://{os.environ.get('SYSTEM_MANAGER_URL')}:10000"
-
 
 class HttpMethod(CustomEnum):
     GET = "get"