Make spot product description config (#214)

* Adjusting help flag text and derive flag defaults from constants.
* Allow access to new config option in CFT and TF

autospotting.go

@@ -42,6 +42,7 @@ func run() {
 		"disallowed_instance_types=%v "+
 		"on_demand_price_multiplier=%.2f "+
 		"spot_price_buffer_percentage=%.3f "+
+		"spot_product_description=%v "+
 		"bidding_policy=%s",
 		conf.Regions,
 		conf.MinOnDemandNumber,
@@ -50,6 +51,7 @@ func run() {
 		conf.DisallowedInstanceTypes,
 		conf.OnDemandPriceMultiplier,
 		conf.SpotPriceBufferPercentage,
+		conf.SpotProductDescription,
 		conf.BiddingPolicy)
 
 	autospotting.Run(conf.Config)
@@ -100,51 +102,55 @@ func (c *cfgData) initialize() {
 func (c *cfgData) parseCommandLineFlags() {
 
 	flag.StringVar(&c.Regions, "regions", "",
-		"Regions where it should be activated (comma or whitespace separated list, "+
+		"\n\tRegions where it should be activated (comma or whitespace separated list, "+
 			"also supports globs), by default it runs on all regions.\n\t"+
-			"Example: ./autospotting -regions 'eu-*,us-east-1'")
+			"Example: ./autospotting -regions 'eu-*,us-east-1'\n")
 
-	flag.Int64Var(&c.MinOnDemandNumber, "min_on_demand_number", 0,
-		"On-demand capacity (as absolute number) ensured to be running in each of your groups.\n\t"+
+	flag.Int64Var(&c.MinOnDemandNumber, "min_on_demand_number", autospotting.DefaultMinOnDemandValue,
+		"\n\tOn-demand capacity (as absolute number) ensured to be running in each of your groups.\n\t"+
 			"Can be overridden on a per-group basis using the tag "+
-			autospotting.OnDemandNumberLong)
+			autospotting.OnDemandNumberLong+".\n")
 
 	flag.Float64Var(&c.MinOnDemandPercentage, "min_on_demand_percentage", 0.0,
-		"On-demand capacity (percentage of the total number of instances in the group) "+
+		"\n\tOn-demand capacity (percentage of the total number of instances in the group) "+
 			"ensured to be running in each of your groups.\n\t"+
 			"Can be overridden on a per-group basis using the tag "+
 			autospotting.OnDemandPercentageTag+
-			"\n\tIt is ignored if min_on_demand_number is also set.")
+			"\n\tIt is ignored if min_on_demand_number is also set.\n")
 
 	flag.StringVar(&c.AllowedInstanceTypes, "allowed_instance_types", "",
-		"If specified, the spot instances will have a specific instance type:\n"+
-			"\tcurrent: the same as initial on-demand instances\n"+
-			"\t<instance-type>: the actual instance type to use")
+		"\n\tIf specified, the spot instances will be of these types.\n"+
+			"\tIf missing, the type is autodetected frome each ASG based on it's Launch Configuration.\n"+
+			"\tAccepts a list of comma or whitespace seperated instance types (supports globs).\n"+
+			"\tExample: ./autospotting -allowed_instance_types 'c5.*,c4.xlarge'\n")
 
 	flag.StringVar(&c.DisallowedInstanceTypes, "disallowed_instance_types", "",
-		"If specified, the spot instances will _never_ be of this type. "+
-			"This should be a list of instance types (comma or whitespace separated, "+
-			"also supports globs).\n\t"+
-			"Example: ./autospotting -disallowed_instance_types 't2.*,c4.xlarge'")
+		"\n\tIf specified, the spot instances will _never_ be of these types.\n"+
+			"\tAccepts a list of comma or whitespace seperated instance types (supports globs).\n"+
+			"\tExample: ./autospotting -disallowed_instance_types 't2.*,c4.xlarge'\n")
 
 	flag.Float64Var(&c.OnDemandPriceMultiplier, "on_demand_price_multiplier", 1.0,
-		"Multiplier for the on-demand price. This is useful for volume discounts or if you want to\n"+
+		"\n\tMultiplier for the on-demand price. This is useful for volume discounts or if you want to\n"+
 			"\tset your bid price to be higher than the on demand price to reduce the chances that your\n"+
-			"\tspot instances will be terminated.")
+			"\tspot instances will be terminated.\n")
 
-	flag.Float64Var(&c.SpotPriceBufferPercentage, "spot_price_buffer_percentage", 10,
-		"Percentage Value of the bid above the current spot price. A spot bid would be placed at a value :\n"+
+	flag.Float64Var(&c.SpotPriceBufferPercentage, "spot_price_buffer_percentage", autospotting.DefaultSpotPriceBufferPercentage,
+		"\n\tPercentage Value of the bid above the current spot price. A spot bid would be placed at a value :\n"+
 			"\tcurrent_spot_price * [1 + (spot_price_buffer_percentage/100.0)]. The main benefit is that\n"+
 			"\tit protects the group from running spot instances that got significantly more expensive than\n"+
 			"\twhen they were initially launched, but still somewhat less than the on-demand price. Can be\n"+
 			"\tenforced using the tag: "+autospotting.SpotPriceBufferPercentageTag+". If the bid exceeds\n"+
-			"\tthe on-demand price, we place a bid at on-demand price itself.")
+			"\tthe on-demand price, we place a bid at on-demand price itself.\n")
 
-	flag.StringVar(&c.BiddingPolicy, "bidding_policy", "normal",
-		"Policy choice for spot bid. If set to 'normal', we bid at the on-demand price. If set to 'aggressive',\n"+
-			"\twe bid at a percentage value above the spot price. ")
+	flag.StringVar(&c.SpotProductDescription, "spot_product_description", autospotting.DefaultSpotProductDescription,
+		"\n\tThe Spot Product or operating system to use when looking up spot price history in the market.\n"+
+			"\tValid choices: Linux/UNIX | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)\n")
 
-	v := flag.Bool("version", false, "Print version number and exit.")
+	flag.StringVar(&c.BiddingPolicy, "bidding_policy", autospotting.DefaultBiddingPolicy,
+		"\n\tPolicy choice for spot bid. If set to 'normal', we bid at the on-demand price.\n"+
+			"\tIf set to 'aggressive', we bid at a percentage value above the spot price configurable using the spot_price_buffer_percentage.\n")
+
+	v := flag.Bool("version", false, "Print version number and exit.\n")
 
 	flag.Parse()
 

cloudformation/stacks/AutoSpotting/template.json

@@ -52,6 +52,11 @@
       "Description": "Percentage Value of the bid above the current spot price. A spot bid would be placed at a value = current_spot_price * [1 + (spot_price_buffer_percentage/100.0)]. The main benefit is that it protects the group from running spot instances that got significantly more expensive than when they were initially launched, but still somewhat less than the on-demand price.",
       "Type": "Number"
     },
+    "SpotProductDescription": {
+      "Default": "Linux/Unix (Amazon VPC)",
+      "Description": "The Spot Product or operating system to use when looking up spot price history in the market. Valid choices: Linux/UNIX | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)",
+      "Type": "String"
+    },
     "BiddingPolicy": {
       "Default": "normal",
       "Description": "Policy choice for spot bid. If set to 'normal', we bid at the on-demand price. If set to 'aggressive', we bid at a multiple of the spot price.",
@@ -104,6 +109,7 @@
             "MIN_ON_DEMAND_PERCENTAGE": { "Ref": "MinOnDemandPercentage" },
             "ON_DEMAND_PRICE_MULTIPLIER": { "Ref": "OnDemandPriceMultiplier" },
             "SPOT_PRICE_BUFFER_PERCENTAGE": { "Ref": "SpotPricePercentageBuffer"},
+            "SPOT_PRODUCT_DESCRIPTION": { "Ref": "SpotProductDescription"},
             "BIDDING_POLICY": { "Ref": "BiddingPolicy"},
             "REGIONS": { "Ref": "Regions" },
             "ALLOWED_INSTANCE_TYPES": { "Ref": "AllowedInstanceTypes" },

core/autoscaling.go

@@ -47,6 +47,10 @@ const (
 
 	// Default constant values should be defined below:
 
+	// DefaultSpotProductDescription stores the default operating system
+	// to use when looking up spot price history in the market.
+	DefaultSpotProductDescription = "Linux/UNIX (Amazon VPC)"
+
 	// DefaultMinOnDemandValue stores the default on-demand capacity to be kept
 	// running in a group managed by autospotting.
 	DefaultMinOnDemandValue = 0

core/config.go

@@ -28,6 +28,7 @@ type Config struct {
 	DisallowedInstanceTypes   string
 	OnDemandPriceMultiplier   float64
 	SpotPriceBufferPercentage float64
+	SpotProductDescription    string
 	BiddingPolicy             string
 
 	// This is only here for tests, where we want to be able to somehow mock

core/region.go

@@ -206,7 +206,7 @@ func (r *region) requestSpotPrices() error {
 
 	// Retrieve all current spot prices from the current region.
 	// TODO: add support for other OSes
-	err := s.fetch("Linux/UNIX", 0, nil, nil)
+	err := s.fetch(r.conf.SpotProductDescription, 0, nil, nil)
 
 	if err != nil {
 		return errors.New("Couldn't fetch spot prices in " + r.name)

terraform/autospotting.tf

@@ -6,6 +6,7 @@ module "autospotting" {
   autospotting_min_on_demand_percentage     = "${var.asg_min_on_demand_percentage}"
   autospotting_on_demand_price_multiplier   = "${var.asg_on_demand_price_multiplier}"
   autospotting_spot_price_buffer_percentage = "${var.asg_spot_price_buffer_percentage}"
+  autospotting_spot_product_description     = "${var.asg_spot_product_description}"
   autospotting_bidding_policy               = "${var.asg_bidding_policy}"
   autospotting_regions_enabled              = "${var.asg_regions_enabled}"
 

terraform/autospotting/lambda.tf

@@ -15,6 +15,7 @@ resource "aws_lambda_function" "autospotting" {
       MIN_ON_DEMAND_PERCENTAGE     = "${var.autospotting_min_on_demand_percentage}"
       ON_DEMAND_PRICE_MULTIPLIER   = "${var.autospotting_on_demand_price_multiplier}"
       SPOT_PRICE_BUFFER_PERCENTAGE = "${var.autospotting_spot_price_buffer_percentage}"
+      SPOT_PRODUCT_DESCRIPTION     = "${var.autospotting_spot_product_description}"
       BIDDING_POLICY               = "${var.autospotting_bidding_policy}"
       REGIONS                      = "${var.autospotting_regions_enabled}"
     }

terraform/variables.tf

@@ -24,6 +24,11 @@ variable "asg_on_demand_price_multiplier" {
   default     = "1.0"
 }
 
+variable "asg_spot_product_description" {
+  description = "The Spot Product or operating system to use when looking up spot price history in the market. Valid choices: Linux/UNIX | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)"
+  default     = "Linux/UNIX (Amazon VPC)"
+}
+
 variable "asg_spot_price_buffer_percentage" {
   description = "Percentage above the current spot price to place the bid"
   default     = "10.0"