Add instance_max_run_duration_seconds config #242
Conversation
This pr adds a new `instance_max_run_duration_seconds` config field that gets piped down into the builder instance's `maxRunDuration` schedule. This will allow for an instance to automatically be stopped or deleted, even if the packer build process is killed. It also adds an `instance_termination_action` which must be set if `instance_max_run_duration_seconds` config is set. This will tell GCP to either `STOP` or `DELETE` the instance once the max duration has been reached.
|
|
|
@nywilken - I saw you commenting on another PR. Is this something you can look at or pass off to someone that can? My team is running packer in a github action and people will cancel the action sometimes while it is running, which doesn't give packer the opportunity to clean up instances correctly. |
@phoenixuprising I’m no longer working on this project. But I’m cc’ing @lbajolet-hashicorp to help get eyes on the pull-request. Please be mindful that the team’s priority might be elsewhere at the moment. So he made need time to review and respond. |
| @@ -632,6 +637,18 @@ func (c *Config) Prepare(raws ...interface{}) ([]string, error) { | |||
| c.WindowsPasswordTimeout = 3 * time.Minute | |||
| } | |||
|
|
|||
| if c.InstanceMaxRunDurationSeconds < 0 { | |||
There was a problem hiding this comment.
My suggestion here would be to include a high default value and possibly validate the the provided value is not lower than the default timeouts set for SSH or other Packer processes. To avoid terminating the machine before establishing a connection. It might not be so straightforward to know all the timeouts so I would suggest documenting it as well. Within the configuration option that at minimum the value should be set to X number of seconds. Possibly even hours or days.
I’ll leave this question for @lbajolet-hashicorp Should this be an unsigned int?
There was a problem hiding this comment.
It seems that if it is not straightforward to know all the timeouts, setting a high default without checking the other config values would be the best path forward to me. I could set the default to something like 2 days and add documentation to the config values. I also like the idea of setting the default termination option to STOP so I'll add that.
Should this be an unsigned int?
Probably. I don't believe that maxRunDuration can be negative.
| errs = packersdk.MultiErrorAppend(fmt.Errorf("'instance_termination_action' must be set if 'instance_max_run_duration_seconds' is set")) | ||
| } | ||
|
|
||
| if c.InstanceTerminationAction != "" && !(c.InstanceTerminationAction == "STOP" || c.InstanceTerminationAction == "DELETE") { |
There was a problem hiding this comment.
It might be worth adding constants for these values.
that aside would it make sense to defaulting to STOP after x days.
|
@lbajolet-hashicorp - Just wanted to check in and see if you could look over this PR. Thanks. |
This pr adds a new
instance_max_run_duration_secondsconfig fieldthat gets piped down into the builder instance's
maxRunDurationschedule. This will allow for an instance to automatically be stopped
or deleted, even if the packer build process is killed.
It also adds an
instance_termination_actionwhich must be set ifinstance_max_run_duration_secondsconfig is set. This will tell GCPto either
STOPorDELETEthe instance once the max duration hasbeen reached.