Support HCLv2 for Nomad jobs #9142
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -50,6 +50,9 @@ type JobsParseRequest struct { | |
| // JobHCL is an hcl jobspec | ||
| JobHCL string | ||
|
|
||
| // HCLv1 indicates whether the JobHCL should be parsed with the hcl v1 parser | ||
| HCLv1 bool `json:"hclv1,omitempty"` | ||
|
|
||
| // Canonicalize is a flag as to if the server should return default values | ||
| // for unset fields | ||
| Canonicalize bool | ||
|
|
@@ -439,15 +442,15 @@ type periodicForceResponse struct { | |
|
|
||
| // UpdateStrategy defines a task groups update strategy. | ||
| type UpdateStrategy struct { | ||
| Stagger *time.Duration `mapstructure:"stagger" hcl:"stagger,optional"` | ||
| MaxParallel *int `mapstructure:"max_parallel" hcl:"max_parallel,optional"` | ||
| HealthCheck *string `mapstructure:"health_check" hcl:"health_check,optional"` | ||
| MinHealthyTime *time.Duration `mapstructure:"min_healthy_time" hcl:"min_healthy_time,optional"` | ||
| HealthyDeadline *time.Duration `mapstructure:"healthy_deadline" hcl:"healthy_deadline,optional"` | ||
| ProgressDeadline *time.Duration `mapstructure:"progress_deadline" hcl:"progress_deadline,optional"` | ||
| Canary *int `mapstructure:"canary" hcl:"canary,optional"` | ||
| AutoRevert *bool `mapstructure:"auto_revert" hcl:"auto_revert,optional"` | ||
| AutoPromote *bool `mapstructure:"auto_promote" hcl:"auto_promote,optional"` | ||
| } | ||
|
|
||
| // DefaultUpdateStrategy provides a baseline that can be used to upgrade | ||
|
|
@@ -640,8 +643,8 @@ func (u *UpdateStrategy) Empty() bool { | |
| } | ||
|
|
||
| type Multiregion struct { | ||
| Strategy *MultiregionStrategy `hcl:"strategy,block"` | ||
| Regions []*MultiregionRegion `hcl:"region,block"` | ||
| } | ||
|
|
||
| func (m *Multiregion) Canonicalize() { | ||
|
|
@@ -700,24 +703,24 @@ func (m *Multiregion) Copy() *Multiregion { | |
| } | ||
|
|
||
| type MultiregionStrategy struct { | ||
| MaxParallel *int `mapstructure:"max_parallel" hcl:"max_parallel,optional"` | ||
| OnFailure *string `mapstructure:"on_failure" hcl:"on_failure,optional"` | ||
| } | ||
|
|
||
| type MultiregionRegion struct { | ||
| Name string `hcl:",label"` | ||
| Count *int `hcl:"count,optional"` | ||
| Datacenters []string `hcl:"datacenters,optional"` | ||
| Meta map[string]string `hcl:"meta,block"` | ||
| } | ||
|
|
||
| // PeriodicConfig is for serializing periodic config for a job. | ||
| type PeriodicConfig struct { | ||
| Enabled *bool `hcl:"enabled,optional"` | ||
| Spec *string `hcl:"cron,optional"` | ||
| SpecType *string | ||
| ProhibitOverlap *bool `mapstructure:"prohibit_overlap" hcl:"prohibit_overlap,optional"` | ||
| TimeZone *string `mapstructure:"time_zone" hcl:"time_zone,optional"` | ||
| } | ||
|
|
||
| func (p *PeriodicConfig) Canonicalize() { | ||
|
|
@@ -779,38 +782,43 @@ func (p *PeriodicConfig) GetLocation() (*time.Location, error) { | |
|
|
||
| // ParameterizedJobConfig is used to configure the parameterized job. | ||
| type ParameterizedJobConfig struct { | ||
| Payload string `hcl:"payload,optional"` | ||
| MetaRequired []string `mapstructure:"meta_required" hcl:"meta_required,optional"` | ||
| MetaOptional []string `mapstructure:"meta_optional" hcl:"meta_optional,optional"` | ||
| } | ||
|
|
||
| // Job is used to serialize a job. | ||
| type Job struct { | ||
| /* Fields parsed from HCL config */ | ||
|
|
||
| Region *string `hcl:"region,optional"` | ||
| Namespace *string `hcl:"namespace,optional"` | ||
| ID *string `hcl:"id,optional"` | ||
| Name *string `hcl:"name,optional"` | ||
| Type *string `hcl:"type,optional"` | ||
| Priority *int `hcl:"priority,optional"` | ||
| AllAtOnce *bool `mapstructure:"all_at_once" hcl:"all_at_once,optional"` | ||
| Datacenters []string `hcl:"datacenters,optional"` | ||
| Constraints []*Constraint `hcl:"constraint,block"` | ||
| Affinities []*Affinity `hcl:"affinity,block"` | ||
| TaskGroups []*TaskGroup `hcl:"group,block"` | ||
| Update *UpdateStrategy `hcl:"update,block"` | ||
| Multiregion *Multiregion `hcl:"multiregion,block"` | ||
| Spreads []*Spread `hcl:"spread,block"` | ||
| Periodic *PeriodicConfig `hcl:"periodic,block"` | ||
| ParameterizedJob *ParameterizedJobConfig `hcl:"parameterized,block"` | ||
| Reschedule *ReschedulePolicy `hcl:"reschedule,block"` | ||
| Migrate *MigrateStrategy `hcl:"migrate,block"` | ||
| Meta map[string]string `hcl:"meta,block"` | ||
| ConsulToken *string `mapstructure:"consul_token" hcl:"consul_token,optional"` | ||
| VaultToken *string `mapstructure:"vault_token" hcl:"vault_token,optional"` | ||
|
|
||
| /* Fields set by server, not sourced from job config file */ | ||
|
There was a problem hiding this comment. 👍 Good comment: this is definitely the sort of thing people would wander by and not remember why. 😀 |
||
|
|
||
| Stop *bool | ||
| ParentID *string | ||
| Dispatched bool | ||
| Payload []byte | ||
| VaultNamespace *string `mapstructure:"vault_namespace"` | ||
|
There was a problem hiding this comment. May require follow up for VaultNamespace. I'm a little surprised that vault_namespace field isn't a valid config option. I checked the field is rejected emperically, and confirmed it's not listed as a valid key in the hclv1 parser: https://github.com/hashicorp/nomad/blob/1d6997942992e92a0eccaec1d87cb0c1d43eeb0b/jobspec/parse_job.go#L79-L82. |
||
| NomadTokenID *string `mapstructure:"nomad_token_id"` | ||
| Status *string | ||
|
|
||
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
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.
This is interesting: we parse this in HCLv1 but it's not documented in the jobspec. Another one to follow up later on I think.