Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Scaffolding actions #18639

Merged
merged 11 commits into from
Oct 11, 2023
Merged

Conversation

philrenaud
Copy link
Contributor

@philrenaud philrenaud commented Oct 2, 2023

First steps in setting up Nomad Actions (#18627)

  • Establishes the Action struct at task level and allows them to be included in a jobspec
  • Returns them under tasks on the GET job endpoint

Also includes a (temporary) workaround to get exec working on our local Ember development environment: direct forwarding to :4646. This is marked with FIXMEs and will be removed prior to merge with main.

@philrenaud philrenaud self-assigned this Oct 2, 2023
@vercel
Copy link

vercel bot commented Oct 2, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
nomad-storybook-and-ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 2, 2023 8:57pm
1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
nomad ⬜️ Ignored (Inspect) Oct 2, 2023 8:57pm

@philrenaud philrenaud force-pushed the 18627-scaffolding-task-actions branch from 2ca821e to a1e439e Compare October 6, 2023 14:05
@philrenaud philrenaud requested review from lgfa29 and tgross October 6, 2023 14:05
@philrenaud philrenaud changed the title Scaffolding task actions Scaffolding actions Oct 6, 2023
@philrenaud philrenaud marked this pull request as ready for review October 6, 2023 14:07
@github-actions
Copy link

github-actions bot commented Oct 6, 2023

Ember Test Audit comparison

18627-task-actions 817667b change
passes 1533 1533 0
failures 1 1 0
flaky 0 0 0
duration 000ms 000ms -000ms

nomad/structs/structs.go Outdated Show resolved Hide resolved
api/tasks.go Outdated Show resolved Hide resolved
command/agent/job_endpoint.go Outdated Show resolved Hide resolved
philrenaud and others added 2 commits October 7, 2023 00:19
nomad/structs/structs.go Outdated Show resolved Hide resolved
nomad/structs/structs.go Outdated Show resolved Hide resolved
nomad/structs/diff.go Outdated Show resolved Hide resolved
nomad/structs/diff.go Outdated Show resolved Hide resolved
Copy link
Member

@tgross tgross left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like we're getting close!

api/tasks.go Outdated Show resolved Hide resolved
command/agent/job_endpoint_test.go Outdated Show resolved Hide resolved
nomad/structs/diff.go Outdated Show resolved Hide resolved
Copy link
Contributor

@lgfa29 lgfa29 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Submitting some early comments. I will try to give a more in-depth review later today.

command/agent/job_endpoint.go Outdated Show resolved Hide resolved
command/agent/job_endpoint.go Outdated Show resolved Hide resolved

import "slices"

type Action struct {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hum...I feel like this name may be too generic 🤔

The structs package deal with all sorts of stuff and a struct called Action may not be obvious what it relates to. Perhaps TaskAction would be a better name?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not opposed to this (they started out with that name!) but lately we've been talking about Node Actions and similar concepts, which I think would borrow from this a bit. I'm torn!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are they similar or the same?

Reusing structs for similar concepts may result in weird interfaces, like attributes that are nil in some cases but not in others. And sometimes that's OK. So there's not right answer, just feels at this point.

My vote would be for TaskAction, but I will leave it up to you 😄

nomad/structs/diff.go Outdated Show resolved Hide resolved
Copy link
Member

@tgross tgross left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Just a bit of now-dead code to clean up and this can be merged. Nice work!

nomad/structs/diff.go Outdated Show resolved Hide resolved
nomad/structs/diff.go Outdated Show resolved Hide resolved
Copy link
Contributor

@lgfa29 lgfa29 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some additional cleanup, but good one!

command/agent/job_endpoint.go Outdated Show resolved Hide resolved

import "slices"

type Action struct {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are they similar or the same?

Reusing structs for similar concepts may result in weird interfaces, like attributes that are nil in some cases but not in others. And sometimes that's OK. So there's not right answer, just feels at this point.

My vote would be for TaskAction, but I will leave it up to you 😄

@philrenaud philrenaud force-pushed the 18627-scaffolding-task-actions branch from f5de743 to 817667b Compare October 11, 2023 14:37
@philrenaud philrenaud merged commit a0a56c9 into 18627-task-actions Oct 11, 2023
23 checks passed
@philrenaud philrenaud deleted the 18627-scaffolding-task-actions branch October 11, 2023 20:36
@philrenaud philrenaud mentioned this pull request Oct 11, 2023
32 tasks
@philrenaud philrenaud restored the 18627-scaffolding-task-actions branch October 11, 2023 20:46
philrenaud added a commit that referenced this pull request Oct 18, 2023
* Task-level actions for job submissions and retrieval

* FIXME: Temporary workaround to get ember dev server to pass exec through to 4646

* Update api/tasks.go

Co-authored-by: Tim Gross <[email protected]>

* Update command/agent/job_endpoint.go

Co-authored-by: Tim Gross <[email protected]>

* Diff and copy implementations

* Action structs get their own file, diff updates to behave like our other diffs

* Test to observe actions changes in a version update

* Tests migrated into structs/diff_test and modified with PR comments in mind

* APIActionToSTructsAction now returns a new value

* de-comment some plain parts, remove unused action lookup

* unused param in action converter

---------

Co-authored-by: Tim Gross <[email protected]>
philrenaud added a commit that referenced this pull request Oct 20, 2023
* Scaffolding actions (#18639)

* Task-level actions for job submissions and retrieval

* FIXME: Temporary workaround to get ember dev server to pass exec through to 4646

* Update api/tasks.go

Co-authored-by: Tim Gross <[email protected]>

* Update command/agent/job_endpoint.go

Co-authored-by: Tim Gross <[email protected]>

* Diff and copy implementations

* Action structs get their own file, diff updates to behave like our other diffs

* Test to observe actions changes in a version update

* Tests migrated into structs/diff_test and modified with PR comments in mind

* APIActionToSTructsAction now returns a new value

* de-comment some plain parts, remove unused action lookup

* unused param in action converter

---------

Co-authored-by: Tim Gross <[email protected]>

* New endpoint: job/:id/actions (#18690)

* unused param in action converter

* backing out of parse_job level and moved toward new endpoint level

* Adds taskName and taskGroupName to actions at job level

* Unmodified job mock actions tests

* actionless job test

* actionless job test

* Multi group multi task actions test

* HTTP method check for GET, cleaner errors in job_endpoint_test

* decomment

* Actions aggregated at job model level (#18733)

* Removal of temporary fix to proxy to 4646

* Run Action websocket endpoint (#18760)

* Working demo for review purposes

* removal of cors passthru for websockets

* Remove job_endpoint-specific ws handlers and aimed at existing alloc exec handlers instead

* PR comments adressed, no need for taskGroup pass, better group and task lookups from alloc

* early return in action validate and removed jobid from req args per PR comments

* todo removal, we're checking later in the rpc

* boolean style change on tty

* Action CLI command (#18778)

* Action command init and stuck-notes

* Conditional reqpath to aim at Job action endpoint

* De-logged

* General CLI command cleanup, observe namespace, pass action as string, get random alloc w group adherence

* tab and varname cleanup

* Remove action param from Allocations().Exec calls

* changelog

* dont nil-check acl

---------

Co-authored-by: Tim Gross <[email protected]>
@philrenaud philrenaud added this to the 1.7.0 milestone Dec 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants