oak-cli 0.2.6__tar.gz → 0.2.9__tar.gz

{oak_cli-0.2.6 → oak_cli-0.2.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: oak_cli
-Version: 0.2.6
+Version: 0.2.9
 Summary: 
 Author: Alexander Malyuk
 Author-email: malyuk.alexander1999@gmail.com
@@ -10,20 +10,22 @@ 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)
+Requires-Dist: pydantic (>=2.6.4,<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 a interface for the API as well as a development tool.
+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.
+Currently, it supports the creation, deletion, inspection, and (un)deployment of applications and services.
 
 E.g. To deploy a default application with two services:
 ```
@@ -81,7 +83,7 @@ All current services: '2'
    instances: '1'
 ```
 
-For a more detailed explanation have a try out the CLI and use the `-h` flag.
+For a more detailed explanation try out the CLI and use the `-h` flag.
 
 ## [Installation](https://pypi.org/project/oak-cli/)
 ```

{oak_cli-0.2.6 → oak_cli-0.2.9}/README.md

@@ -2,14 +2,14 @@
 
 **oakestra-cli** is a very basic command line tool for controlling your [Oakestra](https://github.com/oakestra/oakestra) setup. 
 
-It is intended to be a interface for the API as well as a development tool.
+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.
+Currently, it supports the creation, deletion, inspection, and (un)deployment of applications and services.
 
 E.g. To deploy a default application with two services:
 ```
@@ -67,7 +67,7 @@ All current services: '2'
    instances: '1'
 ```
 
-For a more detailed explanation have a try out the CLI and use the `-h` flag.
+For a more detailed explanation try out the CLI and use the `-h` flag.
 
 ## [Installation](https://pypi.org/project/oak-cli/)
 ```

{oak_cli-0.2.6 → oak_cli-0.2.9}/oak_cli/args_parser/apps/delete.py

@@ -14,8 +14,8 @@ _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):
-        if args.all:
+    def aux_delete_applications(args: Any):
+        if args.all or not args.app_id:
             delete_all_applications()
         else:
             delete_application(args.app_id)
@@ -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.6 → oak_cli-0.2.9}/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.9/oak_cli/args_parser/docker/main.py

@@ -0,0 +1,25 @@
+import argparse
+from typing import Any
+
+from oak_cli.args_parser.docker.rebuild import prepare_docker_rebuild_argparser
+from oak_cli.utils.types import Subparsers
+
+
+def prepare_docker_argparsers(subparsers: Subparsers) -> None:
+    docker_parser = subparsers.add_parser(
+        "docker",
+        aliases=["d"],
+        help="command for docker(compose) related activities",
+        formatter_class=argparse.RawTextHelpFormatter,
+    )
+
+    def docker_parser_print_help(_: Any) -> None:
+        docker_parser.print_help()
+
+    docker_parser.set_defaults(func=docker_parser_print_help)
+
+    docker_subparsers = docker_parser.add_subparsers(
+        dest="services commands",
+    )
+
+    prepare_docker_rebuild_argparser(docker_subparsers)

oak_cli-0.2.9/oak_cli/args_parser/docker/rebuild.py

@@ -0,0 +1,66 @@
+import argparse
+from typing import Any
+
+from oak_cli.commands.docker.enums import ClusterOrchestratorService, RootOrchestratorService
+from oak_cli.commands.docker.rebuild import rebuild_docker_service
+from oak_cli.commands.docker.restart import restart_docker_service
+from oak_cli.utils.types import Subparsers
+
+
+def aux_rebuild_docker_service(args: Any):
+    if args.only_restart:
+        restart_docker_service(args.service)
+    else:
+        rebuild_docker_service(args.service)
+
+
+def prepare_docker_rebuild_root_orchestrator_service_parser(
+    docker_rebuild_subparser: Subparsers,
+) -> None:
+    docker_rebuild_root_orchestrator_service_parser = docker_rebuild_subparser.add_parser(
+        "root_orchestrator",
+        aliases=["ro"],
+    )
+    docker_rebuild_root_orchestrator_service_parser.add_argument(
+        "service",
+        help="testing",
+        type=RootOrchestratorService,
+        choices=RootOrchestratorService,
+    )
+    docker_rebuild_root_orchestrator_service_parser.set_defaults(func=aux_rebuild_docker_service)
+
+
+def prepare_docker_rebuild_cluster_orchestrator_service_parser(
+    docker_rebuild_subparser: Subparsers,
+) -> None:
+    docker_rebuild_cluster_orchestrator_service_parser = docker_rebuild_subparser.add_parser(
+        "cluster_orchestrator",
+        aliases=["co"],
+    )
+    docker_rebuild_cluster_orchestrator_service_parser.add_argument(
+        "service",
+        help="testing",
+        type=ClusterOrchestratorService,
+        choices=ClusterOrchestratorService,
+    )
+    docker_rebuild_cluster_orchestrator_service_parser.set_defaults(func=aux_rebuild_docker_service)
+
+
+def prepare_docker_rebuild_argparser(docker_subparsers: Subparsers) -> None:
+    HELP_TEXT = "rebuilds a docker compose service"
+    docker_restart_parser = docker_subparsers.add_parser(
+        "rebuilds",
+        aliases=["r"],
+        help=HELP_TEXT,
+        description=HELP_TEXT,
+        formatter_class=argparse.RawTextHelpFormatter,
+    )
+    docker_restart_parser.add_argument(
+        "-o",
+        "--only-restart",
+        help="only restart without rebuilding the service",
+        action="store_true",
+    )
+    docker_restart_subparsers = docker_restart_parser.add_subparsers()
+    prepare_docker_rebuild_root_orchestrator_service_parser(docker_restart_subparsers)
+    prepare_docker_rebuild_cluster_orchestrator_service_parser(docker_restart_subparsers)

{oak_cli-0.2.6 → oak_cli-0.2.9}/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) # WIP
 
     argcomplete.autocomplete(parser)
     args = parser.parse_args()

oak_cli-0.2.9/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 project - 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.9/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.9/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.6 → oak_cli-0.2.9}/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.6 → oak_cli-0.2.9}/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.9/oak_cli/commands/apps/main.py

@@ -0,0 +1,86 @@
+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.exceptions.types import OakCLIExceptionTypes
+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}'",
+            oak_cli_exception_type=OakCLIExceptionTypes.APP_GET,
+        ),
+    ).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",
+            oak_cli_exception_type=OakCLIExceptionTypes.APP_GET,
+        ),
+    ).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,
+            oak_cli_exception_type=OakCLIExceptionTypes.APP_CREATE,
+        ),
+    ).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,
+            oak_cli_exception_type=OakCLIExceptionTypes.APP_DELETE,
+        ),
+    ).execute()
+
+
+def delete_all_applications() -> None:
+    for app in get_applications():
+        delete_application(app["applicationID"])

oak_cli-0.2.9/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.9/oak_cli/commands/docker/aux_dockers/node_engine_log_observer.docker-compose.yml

@@ -0,0 +1,18 @@
+version: "3.3"
+
+services:
+
+  node_engine_log_observer:
+    image: node_engine_log_observer
+    build:
+      context: .
+      dockerfile_inline: |
+        FROM alpine
+        CMD tail -f node_engine_logs
+    hostname: node_engine_log_observer
+    container_name: node_engine_log_observer
+    volumes:
+      - /tmp/node_engine_logs:/node_engine_logs
+
+volumes:
+  node_engine_logs:

oak_cli-0.2.9/oak_cli/commands/docker/common.py

@@ -0,0 +1,29 @@
+import json
+import shlex
+import subprocess
+
+from oak_cli.commands.docker.enums import OakestraDockerComposeService
+from oak_cli.utils.logging import logger
+
+
+def check_docker_service_status(
+    docker_service: OakestraDockerComposeService, docker_operation: str
+):
+    inspect_cmd = 'docker inspect -f "{{ json .State }}" ' + str(docker_service)
+    result = subprocess.run(
+        shlex.split(inspect_cmd),
+        check=True,
+        stderr=subprocess.PIPE,
+        stdout=subprocess.PIPE,
+        text=True,
+    )
+    result_output = json.loads(result.stdout)
+    service_status = result_output["Status"]
+    if service_status == "running":
+        logger.info(
+            f"'{docker_service}' successfully '{docker_operation}' - status: '{service_status}'"
+        )
+    else:
+        logger.error(
+            f"'{docker_service}' failed to '{docker_operation}' - status: '{service_status}'"
+        )

oak_cli-0.2.9/oak_cli/commands/docker/enums.py

@@ -0,0 +1,30 @@
+from enum import EnumMeta
+
+from oak_cli.utils.types import CustomEnum
+
+
+class OakestraDockerComposeService(CustomEnum, metaclass=EnumMeta):
+    pass
+
+
+class RootOrchestratorService(OakestraDockerComposeService):
+    SYSTEM_MANAGER = "system_manager"
+    MONGO_ROOT = "mongo_root"
+    MONGO_ROOTNET = "mongo_rootnet"
+    ROOT_SERVICE_MANAGER = "root_service_manager"
+    REDIS = "redis"
+    GRAFANA = "grafana"
+    DASHBOARD = "dashboard"
+    CLOUD_SCHEDULER = "cloud_scheduler"
+    RESOURCE_ABSTRACTOR = "resource_abstractor"
+
+
+class ClusterOrchestratorService(OakestraDockerComposeService):
+    MQTT = "mqtt"
+    MONGO_CLUSTER = "mongo_cluster"
+    MONGO_CLUSTERNET = "mongo_clusternet"
+    CLUSTER_SERVICE_MANAGER = "cluster_service_manager"
+    CLUSTER_MANAGER = "cluster_manager"
+    CLUSTER_SCHEDULER = "cluster_scheduler"
+    CLUSTER_REDIS = "cluster_redis"
+    PROMETHEUS = "prometheus"

oak_cli-0.2.9/oak_cli/commands/docker/rebuild.py

@@ -0,0 +1,38 @@
+import pathlib
+import shlex
+import subprocess
+import sys
+
+from oak_cli.commands.docker.common import check_docker_service_status
+from oak_cli.commands.docker.enums import OakestraDockerComposeService, RootOrchestratorService
+from oak_cli.utils.logging import logger
+
+ROOT_ORCHESTRATOR_DOCKER_COMPOSE_FILE_PATH = pathlib.Path(
+    "/home/alex/oakestra/root_orchestrator/docker-compose.yml"
+)
+CLUSTER_ORCHESTRATOR_DOCKER_COMPOSE_FILE_PATH = pathlib.Path(
+    "/home/alex/oakestra/cluster_orchestrator/docker-compose.yml"
+)
+
+
+def rebuild_docker_service(docker_service: OakestraDockerComposeService) -> None:
+    rebuild_flags = "-d --build --no-deps --force-recreate"
+    if isinstance(docker_service, RootOrchestratorService):
+        compose_path = ROOT_ORCHESTRATOR_DOCKER_COMPOSE_FILE_PATH
+    else:
+        compose_path = CLUSTER_ORCHESTRATOR_DOCKER_COMPOSE_FILE_PATH
+
+    final_cmd = f"docker compose -f {compose_path} up {rebuild_flags} {docker_service}"
+
+    result = subprocess.run(
+        shlex.split(final_cmd),
+        check=False,
+        stderr=subprocess.PIPE,
+        stdout=subprocess.PIPE,
+        text=True,
+    )
+    if result.returncode != 0:
+        logger.critical(f"Docker service '{docker_service}' rebuild failed due to: '{result}")
+        sys.exit(1)
+
+    check_docker_service_status(docker_service, "rebuild")

oak_cli-0.2.9/oak_cli/commands/docker/restart.py

@@ -0,0 +1,17 @@
+import shlex
+import subprocess
+
+from oak_cli.commands.docker.common import check_docker_service_status
+from oak_cli.commands.docker.enums import OakestraDockerComposeService
+
+
+def restart_docker_service(docker_service: OakestraDockerComposeService) -> None:
+    docker_cmd = f"docker restart {docker_service}"
+    subprocess.run(
+        shlex.split(docker_cmd),
+        check=True,
+        stderr=subprocess.PIPE,
+        stdout=subprocess.PIPE,
+        text=True,
+    )
+    check_docker_service_status(docker_service, "restarted")

oak_cli-0.2.9/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.9/oak_cli/commands/plugins/flops/main.py

@@ -0,0 +1,31 @@
+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
+from oak_cli.utils.exceptions.types import OakCLIExceptionTypes
+
+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 project",
+            show_msg_on_success=True,
+            oak_cli_exception_type=OakCLIExceptionTypes.FLOPS_PLUGIN,
+        ),
+    ).execute()

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

@@ -0,0 +1,42 @@
+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.exceptions.types import OakCLIExceptionTypes
+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,
+            oak_cli_exception_type=OakCLIExceptionTypes.SERVICE_DEPLOYMENT,
+        ),
+    ).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,
+            oak_cli_exception_type=OakCLIExceptionTypes.SERVICE_UNDEPLOYMENT,
+        ),
+    ).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"])