feat: add autoscaling configuration for prebuilds #408
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -3,13 +3,18 @@ package provider | |||||
| import ( | ||||||
| "context" | ||||||
| "fmt" | ||||||
| "strings" | ||||||
| "time" | ||||||
|
|
||||||
| "github.com/hashicorp/terraform-plugin-sdk/v2/diag" | ||||||
| "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" | ||||||
| "github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation" | ||||||
| "github.com/mitchellh/mapstructure" | ||||||
| rbcron "github.com/robfig/cron/v3" | ||||||
| ) | ||||||
|
|
||||||
| var PrebuildsCRONParser = rbcron.NewParser(rbcron.Minute | rbcron.Hour | rbcron.Dom | rbcron.Month | rbcron.Dow) | ||||||
|
|
||||||
| type WorkspacePreset struct { | ||||||
| Name string `mapstructure:"name"` | ||||||
| Parameters map[string]string `mapstructure:"parameters"` | ||||||
|
|
@@ -29,12 +34,23 @@ type WorkspacePrebuild struct { | |||||
| // for utilities that parse our terraform output using this type. To remain compatible | ||||||
| // with those cases, we use a slice here. | ||||||
| ExpirationPolicy []ExpirationPolicy `mapstructure:"expiration_policy"` | ||||||
| Autoscaling []Autoscaling `mapstructure:"autoscaling"` | ||||||
| } | ||||||
|
|
||||||
| type ExpirationPolicy struct { | ||||||
| TTL int `mapstructure:"ttl"` | ||||||
| } | ||||||
|
|
||||||
| type Autoscaling struct { | ||||||
| Timezone string `mapstructure:"timezone"` | ||||||
| Schedule []Schedule `mapstructure:"schedule"` | ||||||
| } | ||||||
|
|
||||||
| type Schedule struct { | ||||||
| Cron string `mapstructure:"cron"` | ||||||
| Instances int `mapstructure:"instances"` | ||||||
| } | ||||||
|
|
||||||
| func workspacePresetDataSource() *schema.Resource { | ||||||
| return &schema.Resource{ | ||||||
| SchemaVersion: 1, | ||||||
|
|
@@ -119,9 +135,82 @@ func workspacePresetDataSource() *schema.Resource { | |||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| "autoscaling": { | ||||||
| Type: schema.TypeList, | ||||||
| Description: "Configuration block that defines autoscaling behavior for prebuilds. Use this to automatically adjust the number of prebuild instances based on a schedule.", | ||||||
| Optional: true, | ||||||
| MaxItems: 1, | ||||||
| Elem: &schema.Resource{ | ||||||
| Schema: map[string]*schema.Schema{ | ||||||
| "timezone": { | ||||||
| Type: schema.TypeString, | ||||||
| Description: "The timezone to use for the autoscaling schedule (e.g., \"UTC\", \"America/New_York\").", | ||||||
|
There was a problem hiding this comment. Nit: can you include a link to an acceptable list of TZs here? I think https://en.wikipedia.org/wiki/List_of_tz_database_time_zones suffices but I'm not sure. https://pkg.go.dev/time#LoadLocation says it references the "IANA Time Zone database". There was a problem hiding this comment. See the help output of |
||||||
| Required: true, | ||||||
| ValidateFunc: func(val interface{}, key string) ([]string, []error) { | ||||||
| timezone := val.(string) | ||||||
|
|
||||||
| _, err := time.LoadLocation(timezone) | ||||||
| if err != nil { | ||||||
| return nil, []error{fmt.Errorf("failed to load location: %w", err)} | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| } | ||||||
|
|
||||||
| return nil, nil | ||||||
| }, | ||||||
| }, | ||||||
| "schedule": { | ||||||
| Type: schema.TypeList, | ||||||
| Description: "One or more schedule blocks that define when to scale the number of prebuild instances.", | ||||||
| Required: true, | ||||||
| MinItems: 1, | ||||||
| Elem: &schema.Resource{ | ||||||
| Schema: map[string]*schema.Schema{ | ||||||
| "cron": { | ||||||
| Type: schema.TypeString, | ||||||
| Description: "A cron expression that defines when this schedule should be active. The cron expression must be in the format \"* HOUR * * DAY-OF-WEEK\" where HOUR is 0-23 and DAY-OF-WEEK is 0-6 (Sunday-Saturday). The minute, day-of-month, and month fields must be \"*\".", | ||||||
|
There was a problem hiding this comment. Why must day-of-month and month be There was a problem hiding this comment. I'm assuming this relates to the "weekly cron schedule" concept we already use for schedules? There was a problem hiding this comment. Seems so, but I think that's a strange requirement since nothing in this implementation is on a weekly cadence. |
||||||
| Required: true, | ||||||
| ValidateFunc: func(val interface{}, key string) ([]string, []error) { | ||||||
| cronSpec := val.(string) | ||||||
|
|
||||||
| err := validatePrebuildsCronSpec(cronSpec) | ||||||
| if err != nil { | ||||||
| return nil, []error{fmt.Errorf("cron spec failed validation: %w", err)} | ||||||
| } | ||||||
|
|
||||||
| _, err = PrebuildsCRONParser.Parse(cronSpec) | ||||||
| if err != nil { | ||||||
| return nil, []error{fmt.Errorf("failed to parse cron spec: %w", err)} | ||||||
| } | ||||||
|
|
||||||
| return nil, nil | ||||||
| }, | ||||||
| }, | ||||||
| "instances": { | ||||||
| Type: schema.TypeInt, | ||||||
| Description: "The number of prebuild instances to maintain during this schedule period.", | ||||||
| Required: true, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| // validatePrebuildsCronSpec ensures that the minute, day-of-month and month options of spec are all set to * | ||||||
|
There was a problem hiding this comment. It'd be good to add the why here, not just the what. There was a problem hiding this comment.
|
||||||
| func validatePrebuildsCronSpec(spec string) error { | ||||||
| parts := strings.Fields(spec) | ||||||
|
There was a problem hiding this comment. Howcome we don't use |
||||||
| if len(parts) != 5 { | ||||||
| return fmt.Errorf("cron specification should consist of 5 fields") | ||||||
| } | ||||||
| if parts[0] != "*" || parts[2] != "*" || parts[3] != "*" { | ||||||
| return fmt.Errorf("minute, day-of-month and month should be *") | ||||||
| } | ||||||
|
|
||||||
| return nil | ||||||
| } | ||||||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I love that we explicitly don't have a default value here 👍 nice.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I recommend defaulting toTZor/etc/localtime, and falling back to UTC. There's a helper functiontz.TimezoneIANAfor this.EDIT: given that this is for the provider, you might actually be correct in not specifying any default here as we can't assume that the timezone in which the provider is running is the same timezone as coderd.