luxolus
/
open-nomad
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity
open-nomad/contributing/checklist-jobspec.md

1.8 KiB
Raw Blame History

New jobspec Entry Checklist

Code

  • Consider similar features in Consul, Kubernetes, and other tools. Is there prior art we should match? Terminology, structure, etc?
  • Add structs/fields to api/ package
    • structs usually have Canonicalize, Copy, and Merge methods
    • New fields should be added to existing Canonicalize, Copy, and Merge methods
    • Test the struct/field via all methods mentioned above
  • Add structs/fields to nomad/structs package
    • Validation happens in this package and must be implemented
    • Implement other methods and tests from api/ package
    • Note that analogous struct field names should match with api/ package
  • Add conversion between api/ and nomad/structs in command/agent/job_endpoint.go
  • Add check for job diff in nomad/structs/diff.go
    • Note that fields must be listed in alphabetical order in FieldDiff slices in nomad/structs/diff_test.go
  • Test conversion

HCL1 (deprecated)

New jobspec entries should only be added to jobspec2. It makes use of HCL2 and the api package for automatic parsing. Before, additional parsing was required in the original jobspec package.

  • Parse in jobspec/parse.go (HCL1 only)
  • Test in jobspec/parse_test.go (preferably with a jobspec/text-fixtures/<feature>.hcl test file) (HCL1 only)

Docs