Compare versions by name and version number with the nomad history command #23889

philrenaud · 2024-08-28T18:33:11Z

Adds diff_tag and diff_version flags for the nomad job versions API endpoint, ~~and for the nomad job plan~~ and nomad job history commands.
Adds Tag info to nomad job history output

Usage:

(Prerequisite tag a version of your job with nomad job tag apply, per #23863)

~~### Diff against a specific tag~~

nomad job plan -diff-tag=my-tag-name difftester.nomad.hcl

N.B.: Decided against this, as plan implies "looking to change things against currently-running. To implement later: nomad job diff CLI command.

~~### Diff against a specific version, whether tagged or not~~

nomad job plan -diff-version=2 difftester.nomad.hcl

N.B.: Decided against this, as plan implies "looking to change things against currently-running. To implement later: nomad job diff CLI command.

See history including tag info, with diffs

(each version will show a diff to its predecessor, except for version 0 / first non-GC'd version, which has no known predecessor)

nomad job history -p difftester

See history with diffs against a specific tag

nomad job history -p -diff-tag=my-tag-name difftester

See history with diffs against a specific version, whether tagged or not

nomad job history -p -diff-version=2 difftester

Resolves #23879

* TaggedVersion information in structs, rather than job_endpoint * Test for taggedVersion description length * Some API plumbing

…sting struct

…requests

… command

api/jobs.go

command/job_history.go

nomad/job_endpoint.go

nomad/structs/structs.go

nomad/job_endpoint.go

api/jobs.go

command/job_history.go

nomad/job_endpoint.go

…ffs from CLI

… eye toward making them a new top-level CLI command soon

nomad/job_endpoint.go

tgross

LGTM!

I've left some suggestions to improve the tests but nothing blocking once you've got those resolved.

command/job_history_test.go

aimeeu · 2024-09-19T14:43:22Z

@philrenaud I added the theme/golden-versions tag so I don't lose track of this when creating the new feature docs.

philrenaud and others added 6 commits August 25, 2024 23:48

TaggedVersion information in structs, rather than job_endpoint (#23841)

17e3baf

* TaggedVersion information in structs, rather than job_endpoint * Test for taggedVersion description length * Some API plumbing

Tag and Untag at API level on down, but am I unblocking the wrong thing?

233f051

Code and comment cleanup

bb9ef81

msgtypes generated

1f8960b

Unset methods generally now I stare long into the namespace abyss

34b0d70

Namespace passes through with QueryOptions removed from a write reque…

0db9d4e

…sting struct

philrenaud self-assigned this Aug 28, 2024

Comment and PR review cleanup

b40c036

philrenaud force-pushed the 23879-nomad-job-plan-version-flag branch from 247e670 to 0e6233a Compare August 29, 2024 18:48

vercel bot deployed to Preview – nomad-ui August 29, 2024 18:50 View deployment

Version back to VersionStr

a6da85c

vercel bot deployed to Preview – nomad-ui August 29, 2024 21:36 View deployment

philrenaud added 2 commits August 29, 2024 19:26

First pass at passing a tagname and/or diff version to plan/versions …

cd0441b

…requests

versions API now takes compare_to flags

16b4b26

philrenaud force-pushed the 23879-nomad-job-plan-version-flag branch from f331d39 to 16b4b26 Compare August 29, 2024 23:26

vercel bot deployed to Preview – nomad-ui August 29, 2024 23:28 View deployment

Job history command output can have tag names and descriptions

82101ec

vercel bot deployed to Preview – nomad-ui September 3, 2024 14:13 View deployment

compare_to to diff-tag and diff-version, plus adding flags to history…

d67e9d0

… command

vercel bot deployed to Preview – nomad-ui September 3, 2024 19:11 View deployment

vercel bot deployed to Preview – nomad-ui September 4, 2024 14:16 View deployment

philrenaud force-pushed the 23879-nomad-job-plan-version-flag branch from 6089729 to 967fc86 Compare September 4, 2024 14:17

vercel bot deployed to Preview – nomad-ui September 4, 2024 14:18 View deployment

philrenaud requested review from tgross and Juanadelacuesta September 4, 2024 14:27

0th version now shows a diff if a specific diff target is requested

c579b96

philrenaud force-pushed the 23879-nomad-job-plan-version-flag branch from 967fc86 to c579b96 Compare September 4, 2024 14:32

vercel bot deployed to Preview – nomad-ui September 4, 2024 14:33 View deployment

tgross reviewed Sep 4, 2024

View reviewed changes

vercel bot deployed to Preview – nomad-ui September 6, 2024 15:04 View deployment

philrenaud requested a review from tgross September 6, 2024 17:07

vercel bot deployed to Preview – nomad-ui September 6, 2024 17:08 View deployment

philrenaud commented Sep 6, 2024

View reviewed changes

nomad/job_endpoint.go Outdated Show resolved Hide resolved

tgross reviewed Sep 6, 2024

View reviewed changes

api/jobs.go Outdated Show resolved Hide resolved

command/job_history.go Outdated Show resolved Hide resolved

command/job_history.go Outdated Show resolved Hide resolved

nomad/job_endpoint.go Outdated Show resolved Hide resolved

tgross reviewed Sep 6, 2024

View reviewed changes

nomad/job_endpoint.go Outdated Show resolved Hide resolved

Addressing some PR comments

4251ea8

philrenaud force-pushed the 23879-nomad-job-plan-version-flag branch from 6b57647 to 4251ea8 Compare September 6, 2024 19:58

vercel bot deployed to Preview – nomad-ui September 6, 2024 19:59 View deployment

Simplify the diff-appending part of jobVersions and hide None-type di…

6b10144

…ffs from CLI

vercel bot deployed to Preview – nomad-ui September 7, 2024 13:41 View deployment

Remove the diff-tag and diff-version parts of nomad job plan, with an…

69fd05c

… eye toward making them a new top-level CLI command soon

vercel bot deployed to Preview – nomad-ui September 9, 2024 00:05 View deployment

Version diff tests

3ca16de

vercel bot deployed to Preview – nomad-ui September 9, 2024 19:43 View deployment

philrenaud requested a review from tgross September 9, 2024 19:43

philrenaud marked this pull request as ready for review September 9, 2024 19:43

tgross reviewed Sep 9, 2024

View reviewed changes

nomad/job_endpoint.go Outdated Show resolved Hide resolved

re-implement JobVersionByTagName

2c92244

vercel bot deployed to Preview – nomad-ui September 9, 2024 20:43 View deployment

philrenaud changed the title ~~Compare versions by name with nomad plan and nomad history~~ Compare versions by name and version number with the nomad history command Sep 9, 2024

philrenaud mentioned this pull request Sep 9, 2024

Compare versions by name and version number with a nomad job diff command #23939

Open

tgross approved these changes Sep 9, 2024

View reviewed changes

Test mods and simplification

655d509

vercel bot deployed to Preview – nomad-ui September 10, 2024 14:08 View deployment

philrenaud requested review from gulducat and removed request for Juanadelacuesta September 17, 2024 20:17

philrenaud mentioned this pull request Sep 19, 2024

☂️ Golden Versions #23794

Open

22 tasks

aimeeu added the theme/golden-versions Tagging and preserving job versions label Sep 19, 2024

philrenaud force-pushed the 23846-nomad-job-tag-cli-command-scaffolding branch from 21ec042 to 7568f47 Compare September 20, 2024 14:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Compare versions by name and version number with the nomad history command #23889

Compare versions by name and version number with the nomad history command #23889

philrenaud commented Aug 28, 2024 •

edited

Loading

tgross left a comment

aimeeu commented Sep 19, 2024

Compare versions by name and version number with the nomad history command #23889

Are you sure you want to change the base?

Compare versions by name and version number with the nomad history command #23889

Conversation

philrenaud commented Aug 28, 2024 • edited Loading

Usage:

See history including tag info, with diffs

See history with diffs against a specific tag

See history with diffs against a specific version, whether tagged or not

tgross left a comment

Choose a reason for hiding this comment

aimeeu commented Sep 19, 2024

philrenaud commented Aug 28, 2024 •

edited

Loading