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

32 lines
1.5 KiB
Markdown
Raw Normal View History

docs: initial attempt at developer docs
2019-06-06 19:18:45 +00:00
# New `jobspec` Entry Checklist
## Code
docs: explicitly callout checking for prior art Also normalize formatting.
2020-02-12 16:07:07 +00:00
* [ ] Consider similar features in Consul, Kubernetes, and other tools. Is
there prior art we should match? Terminology, structure, etc?
docs: checklists don't support numbered lists The order didn't really make sense anyway.
2019-06-12 22:35:48 +00:00
* [ ] Parse in `jobspec/parse.go`
* [ ] Test in `jobspec/parse_test.go` (preferably with a
docs: initial attempt at developer docs
2019-06-06 19:18:45 +00:00
`jobspec/text-fixtures/<feature>.hcl` test file)
docs: checklists don't support numbered lists The order didn't really make sense anyway.
2019-06-12 22:35:48 +00:00
* [ ] Add structs/fields to `api/` package
docs: initial attempt at developer docs
2019-06-06 19:18:45 +00:00
* 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
docs: checklists don't support numbered lists The order didn't really make sense anyway.
2019-06-12 22:35:48 +00:00
* [ ] Add structs/fields to `nomad/structs` package
docs: initial attempt at developer docs
2019-06-06 19:18:45 +00:00
* Validation happens in this package and must be implemented
* Implement other methods and tests from `api/` package
structs: fix compatibility between api and nomad/structs proxy definitions The field names within the structs representing the Connect proxy definition were not the same (nomad/structs/ vs api/), causing the values to be lost in translation for the 'nomad job inspect' command. Since the field names already shipped in v0.11.0 we cannot simply fix the names. Instead, use the json struct tag on the structs/ structs to remap the name to match the publicly expose api/ package on json encoding. This means existing jobs from v0.11.0 will continue to work, and the JSON API for job submission will remain backwards compatible.
2020-04-10 23:44:19 +00:00
* Note that analogous struct field names should match with `api/` package
docs: checklists don't support numbered lists The order didn't really make sense anyway.
2019-06-12 22:35:48 +00:00
* [ ] Add conversion between `api/` and `nomad/structs` in `command/agent/job_endpoint.go`
add note to check for job diff
2020-03-04 17:06:32 +00:00
* [ ] Add check for job diff in `nomad/structs/diff.go`
doc: add a reminder about field order for diff comparisons After spending hours re-learning this lesson more than once, update the jobspec contribution guide with a reminder about how to configure FieldDiff comparisons.
2020-03-25 15:33:27 +00:00
* Note that fields must be listed in alphabetical order in `FieldDiff` slices in `nomad/structs/diff_test.go`
docs: checklists don't support numbered lists The order didn't really make sense anyway.
2019-06-12 22:35:48 +00:00
* [ ] Test conversion
docs: initial attempt at developer docs
2019-06-06 19:18:45 +00:00
## Docs
docs: checklists don't support numbered lists The order didn't really make sense anyway.
2019-06-12 22:35:48 +00:00
* [ ] Changelog
* [ ] Jobspec entry https://www.nomadproject.io/docs/job-specification/index.html
docs: add sidebar to jobspec checklist
2019-10-08 17:55:53 +00:00
* [ ] Jobspec sidebar entry https://github.com/hashicorp/nomad/blob/master/website/source/layouts/docs.erb
docs: checklists don't support numbered lists The order didn't really make sense anyway.
2019-06-12 22:35:48 +00:00
* [ ] Job JSON API entry https://www.nomadproject.io/api/json-jobs.html
* [ ] Sample Response output in API https://www.nomadproject.io/api/jobs.html
* [ ] Consider if it needs a guide https://www.nomadproject.io/guides/index.html