Merge branch '19.09'

Author: achimnol

CHANGELOG.rst

@@ -44,6 +44,14 @@ Changes
 * BREAKING CHANGE: Now the client SDK runs on Python 3.6, 3.7, and 3.8 and
   dropped support for Python 3.5.
 
+19.09.6 (2020-03-16)
+--------------------
+
+* NEW: Add ``-f`` / ``--forced`` option to ``backend.ai terminate`` command
+  and add an optional ``forced`` keyword-argument to SDK API (``Kernel.destroy()``). (#89)
+
+* IMPROVE: Prettify the console output for admin CLI commands. (#91)
+
 19.09.5 (2020-03-08)
 --------------------
 

src/ai/backend/client/cli/admin/images.py

@@ -4,7 +4,7 @@
 
 from . import admin
 from ...session import Session
-from ..pretty import print_error
+from ..pretty import print_done, print_warn, print_fail, print_error
 
 
 @admin.command()
@@ -29,7 +29,7 @@ def images(operation):
             print_error(e)
             sys.exit(1)
         if len(items) == 0:
-            print('There are no registered images.')
+            print_warn('There are no registered images.')
             return
         print(tabulate((item.values() for item in items),
                        headers=(item[0] for item in fields),
@@ -49,9 +49,9 @@ def rescan_images(registry):
             print_error(e)
             sys.exit(1)
         if result['ok']:
-            print("kernel image metadata updated")
+            print_done("Updated the image metadata from the configured registries.")
         else:
-            print("rescanning failed: {0}".format(result['msg']))
+            print_fail(f"Rescanning has failed: {result['msg']}")
 
 
 @admin.command()
@@ -66,9 +66,9 @@ def alias_image(alias, target):
             print_error(e)
             sys.exit(1)
         if result['ok']:
-            print("alias {0} created for target {1}".format(alias, target))
+            print_done(f"An alias has created: {alias} -> {target}")
         else:
-            print(result['msg'])
+            print_fail(f"Aliasing has failed: {result['msg']}")
 
 
 @admin.command()
@@ -82,6 +82,6 @@ def dealias_image(alias):
             print_error(e)
             sys.exit(1)
         if result['ok']:
-            print("alias {0} removed.".format(alias))
+            print_done(f"The alias has been removed: {alias}")
         else:
-            print(result['msg'])
+            print_fail(f"Dealiasing has failed: {result['msg']}")

src/ai/backend/client/cli/admin/keypairs.py

@@ -5,7 +5,7 @@
 
 from . import admin
 from ...session import Session
-from ..pretty import print_error, print_fail
+from ..pretty import print_done, print_warn, print_error, print_fail
 
 
 @admin.command()
@@ -79,8 +79,8 @@ def keypairs(ctx, user_id, is_active):
             print_error(e)
             sys.exit(1)
         if len(items) == 0:
-            print('There are no matching keypairs associated '
-                  'with the user ID {0}'.format(user_id))
+            print_warn('There are no matching keypairs associated '
+                       'with the user ID {0}'.format(user_id))
             return
         print(tabulate((item.values() for item in items),
                        headers=(item[0] for item in fields)))
@@ -151,7 +151,7 @@ def update(access_key, resource_policy, is_admin, is_active,  rate_limit):
         if not data['ok']:
             print_fail('KeyPair update has failed: {0}'.format(data['msg']))
             sys.exit(1)
-        print('Key pair is updated: ' + access_key + '.')
+        print_done('Key pair is updated: ' + access_key + '.')
 
 
 @keypairs.command()
@@ -171,7 +171,7 @@ def delete(access_key):
         if not data['ok']:
             print_fail('KeyPair deletion has failed: {0}'.format(data['msg']))
             sys.exit(1)
-        print('Key pair is deleted: ' + access_key + '.')
+        print_done('Key pair is deleted: ' + access_key + '.')
 
 
 @keypairs.command()
@@ -191,7 +191,7 @@ def activate(access_key):
         if not data['ok']:
             print_fail('KeyPair activation has failed: {0}'.format(data['msg']))
             sys.exit(1)
-        print('Key pair is activated: ' + access_key + '.')
+        print_done('Key pair is activated: ' + access_key + '.')
 
 
 @keypairs.command()
@@ -211,4 +211,4 @@ def deactivate(access_key):
         if not data['ok']:
             print_fail('KeyPair deactivation has failed: {0}'.format(data['msg']))
             sys.exit(1)
-        print('Key pair is deactivated: ' + access_key + '.')
+        print_done('Key pair is deactivated: ' + access_key + '.')

src/ai/backend/client/cli/admin/resource_policies.py

@@ -5,7 +5,7 @@
 
 from . import admin
 from ...session import Session
-from ..pretty import print_error, print_fail
+from ..pretty import print_done, print_warn, print_error, print_fail
 
 
 @admin.command()
@@ -37,7 +37,7 @@ def keypair_resource_policy(name):
             sys.exit(1)
         rows = []
         if info is None:
-            print('No such resource policy.')
+            print_warn('No such resource policy.')
             sys.exit(1)
         for name, key in fields:
             rows.append((name, info[key]))
@@ -72,7 +72,7 @@ def keypair_resource_policies(ctx):
             print_error(e)
             sys.exit(1)
         if len(items) == 0:
-            print('There are no keypair resource policies.')
+            print_warn('There are no keypair resource policies.')
             return
         print(tabulate((item.values() for item in items),
                        headers=(item[0] for item in fields)))
@@ -129,7 +129,7 @@ def add(name, default_for_unspecified, total_resource_slots, max_concurrent_sess
                        .format(data['msg']))
             sys.exit(1)
         item = data['resource_policy']
-        print('Keypair resource policy ' + item['name'] + ' is created.')
+        print_done('Keypair resource policy ' + item['name'] + ' is created.')
 
 
 @keypair_resource_policies.command()
@@ -179,7 +179,7 @@ def update(name, default_for_unspecified, total_resource_slots,
             print_fail('KeyPair Resource Policy creation has failed: {0}'
                        .format(data['msg']))
             sys.exit(1)
-        print('Update succeeded.')
+        print_done('Update succeeded.')
 
 
 @keypair_resource_policies.command()
@@ -203,4 +203,4 @@ def delete(name):
             print_fail('KeyPair Resource Policy deletion has failed: {0}'
                        .format(data['msg']))
             sys.exit(1)
-        print('Resource policy ' + name + ' is deleted.')
+        print_done('Resource policy ' + name + ' is deleted.')

src/ai/backend/client/cli/admin/scaling_groups.py

@@ -4,7 +4,7 @@
 from tabulate import tabulate
 
 from . import admin
-from ..pretty import print_error, print_fail
+from ..pretty import print_done, print_warn, print_error, print_fail
 from ...session import Session
 
 
@@ -18,7 +18,7 @@ def list_scaling_groups(group):
             print_error(e)
             sys.exit(1)
         if len(resp) < 1:
-            print('There is no scaling group available.')
+            print_warn('There is no scaling group available.')
             return
         print(resp)
 
@@ -127,7 +127,7 @@ def add(name, description, inactive,
             print_fail('Scaling group creation has failed: {0}'.format(data['msg']))
             sys.exit(1)
         item = data['scaling_group']
-        print('Scaling group name {0} is created.'.format(item['name']))
+        print_done('Scaling group name {0} is created.'.format(item['name']))
 
 
 @scaling_groups.command()
@@ -168,7 +168,7 @@ def update(name, description, inactive,
         if not data['ok']:
             print_fail('Scaling group update has failed: {0}'.format(data['msg']))
             sys.exit(1)
-        print('Scaling group {0} is updated.'.format(name))
+        print_done('Scaling group {0} is updated.'.format(name))
 
 
 @scaling_groups.command()
@@ -188,7 +188,7 @@ def delete(name):
         if not data['ok']:
             print_fail('Scaling group deletion has failed: {0}'.format(data['msg']))
             sys.exit(1)
-        print('Scaling group is deleted: ' + name + '.')
+        print_done('Scaling group is deleted: ' + name + '.')
 
 
 @scaling_groups.command()
@@ -211,7 +211,7 @@ def associate_scaling_group(scaling_group, domain):
         if not data['ok']:
             print_fail('Associating scaling group with domain failed: {0}'.format(data['msg']))
             sys.exit(1)
-        print('Scaling group {} is assocatiated with domain {}.'.format(scaling_group, domain))
+        print_done('Scaling group {} is assocatiated with domain {}.'.format(scaling_group, domain))
 
 
 @scaling_groups.command()
@@ -234,4 +234,4 @@ def dissociate_scaling_group(scaling_group, domain):
         if not data['ok']:
             print_fail('Dissociating scaling group from domain failed: {0}'.format(data['msg']))
             sys.exit(1)
-        print('Scaling group {} is dissociated from domain {}.'.format(scaling_group, domain))
+        print_done('Scaling group {} is dissociated from domain {}.'.format(scaling_group, domain))

src/ai/backend/client/cli/run.py

@@ -1036,11 +1036,13 @@ def start_template(
 
 @main.command(aliases=['rm', 'kill'])
 @click.argument('session_names', metavar='SESSID', nargs=-1)
+@click.option('-f', '--forced', is_flag=True,
+              help='Force-terminate the errored sessions (only allowed for admins)')
 @click.option('-o', '--owner', '--owner-access-key', metavar='ACCESS_KEY',
               help='Specify the owner of the target session explicitly.')
 @click.option('-s', '--stats', is_flag=True,
               help='Show resource usage statistics after termination')
-def terminate(session_names, owner, stats):
+def terminate(session_names, forced, owner, stats):
     '''
     Terminate the given session.
 
@@ -1055,7 +1057,7 @@ def terminate(session_names, owner, stats):
         for session_name in session_names:
             try:
                 compute_session = session.ComputeSession(session_name, owner)
-                ret = compute_session.destroy()
+                ret = compute_session.destroy(forced=forced)
             except BackendAPIError as e:
                 print_error(e)
                 if e.status == 404:

src/ai/backend/client/func/session.py

@@ -363,7 +363,7 @@ def __init__(self, name: str, owner_access_key: str = None):
         self.owner_access_key = owner_access_key
 
     @api_function
-    async def destroy(self):
+    async def destroy(self, *, forced: bool = False):
         '''
         Destroys the compute session.
         Since the server literally kills the container(s), all ongoing executions are
@@ -373,6 +373,8 @@ async def destroy(self):
         if self.owner_access_key:
             params['owner_access_key'] = self.owner_access_key
         prefix = get_naming(self.session.api_version, 'path')
+        if forced:
+            params['forced'] = 'true'
         rqst = Request(
             self.session,
             'DELETE', f'/{prefix}/{self.name}',