added autoscale scale commands

Author: allmightyspiff

SoftLayer/CLI/autoscale/detail.py

@@ -1,28 +1,23 @@
-"""List Autoscale groups."""
+"""Get details of an Autoscale groups."""
 # :license: MIT, see LICENSE for more details.
 
 import click
 
 import SoftLayer
-from SoftLayer.CLI import columns as column_helper
 from SoftLayer.CLI import environment
 from SoftLayer.CLI import formatting
-from SoftLayer.CLI import helpers
 from SoftLayer.managers.autoscale import AutoScaleManager
 from SoftLayer import utils
 
-from pprint import pprint as pp 
 
 @click.command()
 @click.argument('identifier')
 @environment.pass_env
 def cli(env, identifier):
-    """List AutoScale Groups."""
+    """Get details of an Autoscale groups."""
 
     autoscale = AutoScaleManager(env.client)
     group = autoscale.details(identifier)
-    # print(groups)
-    # pp(group)
 
     # Group Config Table
     table = formatting.KeyValueTable(["Group", "Value"])
@@ -46,7 +41,6 @@ def cli(env, identifier):
 
     env.fout(table)
 
-
     # Template Config Table
     config_table = formatting.KeyValueTable(["Template", "Value"])
     template = group.get('virtualGuestMemberTemplate')
@@ -75,25 +69,14 @@ def cli(env, identifier):
 
     env.fout(config_table)
 
-
     # Policy Config Table
     policy_table = formatting.KeyValueTable(["Policy", "Cooldown"])
     policies = group.get('policies')
-    # pp(policies)
     for policy in policies:
         policy_table.add_row([policy.get('name'), policy.get('cooldown') or group.get('cooldown')])
-        # full_policy = autoscale.get_policy(policy.get('id'))
-        # pp(full_policy)
 
     env.fout(policy_table)
 
-    # LB Config Table
-    # Not sure if this still still a thing?
-    # lb_table = formatting.KeyValueTable(["Load Balancer", "Value"])
-    # loadbal = group.get('loadBalancers')
-
-    # env.fout(lb_table)
-
     # Active Guests
     member_table = formatting.Table(['Id', 'Hostname', 'Created'], title="Active Guests")
     guests = group.get('virtualGuestMembers')

SoftLayer/CLI/autoscale/list.py

@@ -4,14 +4,11 @@
 import click
 
 import SoftLayer
-from SoftLayer.CLI import columns as column_helper
 from SoftLayer.CLI import environment
 from SoftLayer.CLI import formatting
-from SoftLayer.CLI import helpers
 from SoftLayer.managers.autoscale import AutoScaleManager
 from SoftLayer import utils
 
-from pprint import pprint as pp 
 
 @click.command()
 @environment.pass_env

SoftLayer/CLI/autoscale/scale.py

@@ -0,0 +1,56 @@
+"""Scales an Autoscale group"""
+# :license: MIT, see LICENSE for more details.
+
+import click
+
+import SoftLayer
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import formatting
+from SoftLayer.managers.autoscale import AutoScaleManager
+from SoftLayer import utils
+
+
+@click.command()
+@click.argument('identifier')
+@click.option('--up/--down', 'scale_up', is_flag=True, default=True,
+              help="'--up' adds guests, '--down' removes guests.")
+@click.option('--by/--to', 'scale_by', is_flag=True, required=True,
+              help="'--by' will add/remove the specified number of guests." \
+              " '--to' will add/remove a number of guests to get the group's guest count to the specified number.")
+@click.option('--amount', required=True, type=click.INT, help="Number of guests for the scale action.")
+@environment.pass_env
+def cli(env, identifier, scale_up, scale_by, amount):
+    """Scales an Autoscale group. Bypasses a scale group's cooldown period."""
+
+    autoscale = AutoScaleManager(env.client)
+
+    # Scale By, and go down, need to use negative amount
+    if not scale_up and scale_by:
+        amount = amount * -1
+
+    result = []
+    if scale_by:
+        click.secho("Scaling group {} by {}".format(identifier,  amount), fg='green')
+        result = autoscale.scale(identifier, amount)
+    else:
+        click.secho("Scaling group {} to {}".format(identifier,  amount), fg='green')
+        result = autoscale.scale_to(identifier, amount)
+
+    try:
+        # Check if the first guest has a cancellation date, assume we are removing guests if it is.
+        cancellationDate = result[0]['virtualGuest']['billingItem']['cancellationDate'] or False
+    except (IndexError, KeyError, TypeError) as e:
+        cancellationDate = False
+
+    if cancellationDate:
+        member_table = formatting.Table(['Id', 'Hostname', 'Created'], title="Cancelled Guests")
+    else:
+        member_table = formatting.Table(['Id', 'Hostname', 'Created'], title="Added Guests")
+
+    for guest in result:
+        real_guest = guest.get('virtualGuest')
+        member_table.add_row([
+            guest.get('id'), real_guest.get('hostname'), utils.clean_time(real_guest.get('createDate'))
+        ])
+
+    env.fout(member_table)

SoftLayer/CLI/routes.py

@@ -306,6 +306,7 @@
     ('autoscale', 'SoftLayer.CLI.autoscale'),
     ('autoscale:list', 'SoftLayer.CLI.autoscale.list:cli'),
     ('autoscale:detail', 'SoftLayer.CLI.autoscale.detail:cli'),
+    ('autoscale:scale', 'SoftLayer.CLI.autoscale.scale:cli'),
 ]
 
 ALL_ALIASES = {

SoftLayer/managers/autoscale.py

@@ -15,12 +15,23 @@ def __init__(self, client):
 
 
     def list(self, mask=None):
+        """Calls SoftLayer_Account getScaleGroups()_
+
+        :param mask: optional SoftLayer_Scale_Group objectMask
+        .. getScaleGroups(): https://sldn.softlayer.com/reference/services/SoftLayer_Account/getScaleGroups/
+        """
         if not mask:
             mask = "mask[status,virtualGuestMemberCount]"
 
         return self.client.call('SoftLayer_Account', 'getScaleGroups', mask=mask, iter=True)
 
     def details(self, identifier, mask=None):
+        """Calls SoftLayer_Scale_Group getObject()_
+
+        :param identifier: SoftLayer_Scale_Group id
+        :param mask: optional SoftLayer_Scale_Group objectMask
+        .. _getObject(): https://sldn.softlayer.com/reference/services/SoftLayer_Scale_Group/getObject/
+        """
         if not mask:
             mask = """mask[virtualGuestMembers[id,virtualGuest[hostname,domain,provisionDate]], terminationPolicy,
                    virtualGuestMemberCount, virtualGuestMemberTemplate[sshKeys],
@@ -30,9 +41,34 @@ def details(self, identifier, mask=None):
         return self.client.call('SoftLayer_Scale_Group', 'getObject', id=identifier, mask=mask)
 
     def get_policy(self, identifier, mask=None):
+        """Calls SoftLayer_Scale_Policy getObject()_
+
+        :param identifier: SoftLayer_Scale_Policy id
+        :param mask: optional SoftLayer_Scale_Policy objectMask
+        .. _getObject(): https://sldn.softlayer.com/reference/services/SoftLayer_Scale_Policy/getObject/
+        """
         if not mask:
             mask = """mask[cooldown, createDate, id, name, actions, triggers[type]
 
             ]"""
 
         return self.client.call('SoftLayer_Scale_Policy', 'getObject', id=identifier, mask=mask)
+
+    def scale(self, identifier, amount):
+        """Calls SoftLayer_Scale_Group scale()_
+
+        :param identifier: SoftLayer_Scale_Group Id
+        :param amount: positive or negative number to scale the group by
+
+        .. _scale(): https://sldn.softlayer.com/reference/services/SoftLayer_Scale_Group/scale/
+        """
+        return self.client.call('SoftLayer_Scale_Group', 'scale', amount, id=identifier)
+
+    def scale_to(self, identifier, amount):
+        """Calls SoftLayer_Scale_Group scaleTo()_
+
+        :param identifier: SoftLayer_Scale_Group Id
+        :param amount: number to scale the group to.
+        .. _scaleTo(): https://sldn.softlayer.com/reference/services/SoftLayer_Scale_Group/scaleTo/
+        """
+        return self.client.call('SoftLayer_Scale_Group', 'scaleTo', amount, id=identifier)