Job revert command and API endpoint can take a string version tag name #24059
Conversation
This file contains 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
philrenaud
commented
Sep 24, 2024
api/jobs.go
Outdated
| @@ -531,7 +531,7 @@ func (j *Jobs) Dispatch(jobID string, meta map[string]string, | |||
| // Revert is used to revert the given job to the passed version. If | |||
| // enforceVersion is set, the job is only reverted if the current version is at | |||
| // the passed version. | |||
| func (j *Jobs) Revert(jobID string, version uint64, enforcePriorVersion *uint64, | |||
| func (j *Jobs) Revert(jobID string, version *uint64, versionTag *string, enforcePriorVersion *uint64, | |||
There was a problem hiding this comment.
version becomes optional, and therefore now a pointer.
There was a problem hiding this comment.
We can't change the signature of api package methods. We'll need a new Revert-like method to do this.
Better yet, we can do what we did on the Tag/Untag Versions PR and query for the version for a given tag in the CLI/UI and then leave this unchanged.
philrenaud
force-pushed
the
24053-expand-nomad-job-revert-to-take-a-tag-string
branch
from
671ae9b to
d186b13
Compare
philrenaud
force-pushed
the
23879-nomad-job-plan-version-flag
branch
from
2c59fa7 to
81b3e44
Compare
philrenaud
force-pushed
the
24053-expand-nomad-job-revert-to-take-a-tag-string
branch
from
d186b13 to
b1255f0
Compare
tgross
reviewed
Sep 25, 2024
Base automatically changed from
23879-nomad-job-plan-version-flag
to
23846-nomad-job-tag-cli-command-scaffolding
September 25, 2024 17:50
Base automatically changed from
23846-nomad-job-tag-cli-command-scaffolding
to
epic/23794-golden-versions
September 25, 2024 18:02
philrenaud
force-pushed
the
24053-expand-nomad-job-revert-to-take-a-tag-string
branch
from
bb3a3dc to
04dbb05
Compare
philrenaud
force-pushed
the
24053-expand-nomad-job-revert-to-take-a-tag-string
branch
from
04dbb05 to
697348f
Compare
philrenaud
force-pushed
the
24053-expand-nomad-job-revert-to-take-a-tag-string
branch
from
64a38dc to
69dfec6
Compare
tgross
approved these changes
Sep 25, 2024
| @@ -270,6 +270,23 @@ func (j *Jobs) Versions(jobID string, diffs bool, q *QueryOptions) ([]*Job, []*J | |||
| return j.VersionsOpts(jobID, opts, q) | |||
| } | |||
|
|
|||
| // VersionByTag is used to retrieve a job version by its TaggedVersion name. | |||
There was a problem hiding this comment.
Nice little helper! Mirrors what we needed in the state store. 👍
Comment on lines
+659
to
+660
| // Clear out the TaggedVersion to prevent tag duplication | ||
| revJob.TaggedVersion = nil |
philrenaud
force-pushed
the
24053-expand-nomad-job-revert-to-take-a-tag-string
branch
from
69dfec6 to
97bb6da
Compare
philrenaud
deleted the
24053-expand-nomad-job-revert-to-take-a-tag-string
branch
philrenaud
added a commit
that referenced
this pull request
Sep 25, 2024
* TaggedVersion information in structs, rather than job_endpoint (#23841) * TaggedVersion information in structs, rather than job_endpoint * Test for taggedVersion description length * Some API plumbing * Tag and Untag job versions (#23863) * Tag and Untag at API level on down, but am I unblocking the wrong thing? * Code and comment cleanup * Unset methods generally now I stare long into the namespace abyss * Namespace passes through with QueryOptions removed from a write requesting struct * Comment and PR review cleanup * Version back to VersionStr * Generally consolidate unset logic into apply for version tagging * Addressed some PR comments * Auth check and RPC forwarding * uint64 instead of pointer for job version after api layer and renamed copy * job tag command split into apply and unset * latest-version convenience handling moved to CLI command level * CLI tests for tagging/untagging * UI parts removed * Add to job table when unsetting job tag on latest version * Vestigial no more * Compare versions by name and version number with the nomad history command (#23889) * First pass at passing a tagname and/or diff version to plan/versions requests * versions API now takes compare_to flags * Job history command output can have tag names and descriptions * compare_to to diff-tag and diff-version, plus adding flags to history command * 0th version now shows a diff if a specific diff target is requested * Addressing some PR comments * Simplify the diff-appending part of jobVersions and hide None-type diffs from CLI * Remove the diff-tag and diff-version parts of nomad job plan, with an eye toward making them a new top-level CLI command soon * Version diff tests * re-implement JobVersionByTagName * Test mods and simplification * Documentation for nomad job history additions * Prevent pruning and reaping of TaggedVersion jobs (#23983) tagged versions should not count against JobTrackedVersions i.e. new job versions being inserted should not evict tagged versions and GC should not delete a job if any of its versions are tagged Co-authored-by: Daniel Bennett <[email protected]> --------- Co-authored-by: Daniel Bennett <[email protected]> * [ui] Version Tags on the job versions page (#24013) * Timeline styles and their buttons modernized, and tags added * styled but not yet functional version blocks * Rough pass at edit/unedit UX * Styles consolidated * better UX around version tag crud, plus adapter and serializers * Mirage and acceptance tests * Modify percy to not show time-based things --------- Co-authored-by: Daniel Bennett <[email protected]> * Job revert command and API endpoint can take a string version tag name (#24059) * Job revert command and API endpoint can take a string version tag name * RevertOpts as a signature-modified alternative to Revert() * job revert CLI test * Version pointers in endpoint tests * Dont copy over the tag when a job is reverted to a version with a tag * Convert tag name to version number at CLI level * Client method for version lookup by tag * No longer double-declaring client * [ui] Add tag filter to the job versions page (#24064) * Rough pass at the UI for version diff dropdown * Cleanup and diff fetching via adapter method * TaggedVersion now VersionTag (#24066) --------- Co-authored-by: Daniel Bennett <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Allows the second argument on
nomad job revertto be the string name of a job version tagFixes an issue where reverting (either by number or by tag name) to an older job version with a tag, duplicated that tag on the newly-run version.
(This is not desirable for, among other reasons, a same-tag-name situation making
tag unsetunreliable)Resolves #24053