From 3db9f11c3765b215da0fb0646b6054c4264e1491 Mon Sep 17 00:00:00 2001 From: Phil Renaud Date: Thu, 2 Feb 2023 10:37:40 -0500 Subject: [PATCH] [feat] Nomad Job Templates (#15746) * Extend variables under the nomad path prefix to allow for job-templates (#15570) * Extend variables under the nomad path prefix to allow for job-templates * Add job-templates to error message hinting * RadioCard component for Job Templates (#15582) * chore: add * test: component API * ui: component template * refact: remove bc naming collission * styles: remove SASS var causing conflicts * Disallow specific variable at nomad/job-templates (#15681) * Disallows variables at exactly nomad/job-templates * idiomatic refactor * Expanding nomad job init to accept a template flag (#15571) * Adding a string flag for templates on job init * data-down actions-up version of a custom template editor within variable * Dont force grid on job template editor * list-templates flag started * Correctly slice from end of path name * Pre-review cleanup * Variable form acceptance test for job template editing * Some review cleanup * List Job templates test * Example from template test * Using must.assertions instead of require etc * ui: add choose template button (#15596) * ui: add new routes * chore: update file directory * ui: add choose template button * test: button and page navigation * refact: update var name * ui: use `Button` component from `HDS` (#15607) * ui: integrate buttons * refact: remove helper * ui: remove icons on non-tertiary buttons * refact: update normalize method for key/value pairs (#15612) * `revert`: `onCancel` for `JobDefinition` The `onCancel` method isn't included in the component API for `JobEditor` and the primary cancel behavior exists outside of the component. With the exception of the `JobDefinition` page where we include this button in the top right of the component instead of next to the `Plan` button. * style: increase button size * style: keep lime green * ui: select template (#15613) * ui: deprecate unused component * ui: deprecate tests * ui: jobs.run.templates.index * ui: update logic to handle templates * refact: revert key/value changes * style: padding for cards + buttons * temp: fixtures for mirage testing * Revert "refact: revert key/value changes" This reverts commit 124e95d12140be38fc921f7e15243034092c4063. * ui: guard template for unsaved job * ui: handle reading template variable * Revert "refact: update normalize method for key/value pairs (#15612)" This reverts commit 6f5ffc9b610702aee7c47fbff742cc81f819ab74. * revert: remove test fixtures * revert: prettier problems * refact: test doesnt need filter expression * styling: button sizes and responsive cards * refact: remove route guarding * ui: update variable adapter * refact: remove model editing behavior * refact: model should query variables to populate editor * ui: clear qp on exit * refact: cleanup deprecated API * refact: query all namespaces * refact: deprecate action * ui: rely on collection * refact: patch deprecate transition API * refact: patch test to expect namespace qp * styling: padding, conditionals * ui: flashMessage on 404 * test: update for o(n+1) query * ui: create new job template (#15744) * refact: remove unused code * refact: add type safety * test: select template flow * test: add data-test attrs * chore: remove dead code * test: create new job flow * ui: add create button * ui: create job template * refact: no need for wildcard * refact: record instead of delete * styling: spacing * ui: add error handling and form validation to job create template (#15767) * ui: handle server side errors * ui: show error to prevent duplicate * refact: conditional namespace * ui: save as template flow (#15787) * bug: patches failing tests associated with `pretender` (#15812) * refact: update assertion * refact: test set-up * ui: job templates manager view (#15815) * ui: manager list view * test: edit flow * refact: deprecate column-helper * ui: template edit and delete flow (#15823) * ui: manager list view * refact: update title * refact: update permissions * ui: template edit page * bug: typo * refact: update toast messages * bug: clear selections on exit (#15827) * bug: clear controllers on exit * test: mirage config changes (#15828) * refact: deprecate column-helper * style: update z-index for HDS * Revert "style: update z-index for HDS" This reverts commit d3d87ceab6d083f7164941587448607838944fc1. * refact: update delete button * refact: edit redirect * refact: patch reactivity issues * styling: fixed width * refact: override defaults * styling: edit text causing overflow * styling: add inline text Co-authored-by: Phil Renaud * bug: edit `text` to `template` Co-authored-by: Phil Renaud Co-authored-by: Phil Renaud * test: delete flow job templates (#15896) * refact: edit names * bug: set correct ref to store * chore: trim whitespace: * test: delete flow * bug: reactively update view (#15904) * Initialized default jobs (#15856) * Initialized default jobs * More jobs scaffolded * Better commenting on a couple example job specs * Adapter doing the work * fall back to epic config * Label format helper and custom serialization logic * Test updates to account for a never-empty state * Test suite uses settled and maintain RecordArray in adapter return * Updates to hello-world and variables example jobspecs * Parameterized job gets optional payload output * Formatting changes for param and service discovery job templates * Multi-group service discovery job * Basic test for default templates (#15965) * Basic test for default templates * Percy snapshot for manage page * Some late-breaking design changes * Some copy edits to the header paragraphs for job templates (#15967) * Added some init options for job templates (#15994) * Async method for populating default job templates from the variable adapter --------- Co-authored-by: Jai <41024828+ChaiWithJai@users.noreply.github.com> --- .changelog/15746.txt | 3 + command/job_init.go | 105 +++- command/job_init_test.go | 80 ++++ nomad/structs/variables.go | 56 ++- nomad/structs/variables_test.go | 2 + ui/app/adapters/variable.js | 87 +++- ui/app/components/job-editor.js | 3 + ui/app/components/variable-form.hbs | 131 ++--- ui/app/components/variable-form.js | 23 +- .../variable-form/job-template-editor.hbs | 32 ++ .../variable-form/job-template-editor.js | 23 + ui/app/controllers/jobs/run.js | 13 +- ui/app/controllers/jobs/run/index.js | 21 + .../controllers/jobs/run/templates/index.js | 16 + .../controllers/jobs/run/templates/manage.js | 48 ++ ui/app/controllers/jobs/run/templates/new.js | 82 ++++ .../jobs/run/templates/template.js | 80 ++++ ui/app/helpers/format-template-label.js | 14 + ui/app/helpers/invoke-fn.js | 8 + ui/app/router.js | 8 +- ui/app/routes/jobs/run.js | 34 -- ui/app/routes/jobs/run/index.js | 73 +++ ui/app/routes/jobs/run/templates/index.js | 28 ++ ui/app/routes/jobs/run/templates/manage.js | 23 + ui/app/routes/jobs/run/templates/new.js | 62 +++ ui/app/routes/jobs/run/templates/template.js | 28 ++ ui/app/serializers/variable.js | 8 + ui/app/styles/app.scss | 1 + ui/app/styles/components.scss | 4 +- .../{badge.scss => badge-nomad-internal.scss} | 0 ui/app/styles/components/codemirror.scss | 25 +- ...down.scss => dropdown-nomad-internal.scss} | 0 ui/app/styles/components/variables.scss | 19 + ui/app/styles/core/forms.scss | 38 +- ui/app/templates/components/job-editor.hbs | 55 +-- .../templates/jobs/{run.hbs => run/index.hbs} | 2 +- ui/app/templates/jobs/run/templates/index.hbs | 34 ++ .../templates/jobs/run/templates/manage.hbs | 57 +++ ui/app/templates/jobs/run/templates/new.hbs | 51 ++ .../templates/jobs/run/templates/template.hbs | 84 ++++ ui/app/utils/default-job-templates.js | 62 +++ ui/app/utils/default_jobs/hello-world.js | 61 +++ ui/app/utils/default_jobs/parameterized.js | 41 ++ .../utils/default_jobs/service-discovery.js | 80 ++++ ui/app/utils/default_jobs/variables.js | 48 ++ ui/ember-cli-build.js | 6 + ui/mirage/config.js | 7 +- ui/mirage/scenarios/default.js | 49 ++ ui/package.json | 1 + ui/tests/acceptance/job-run-test.js | 450 +++++++++++++++++- ui/tests/acceptance/variables-test.js | 53 +++ ui/yarn.lock | 203 +++++++- website/content/docs/commands/job/init.mdx | 2 + 53 files changed, 2342 insertions(+), 182 deletions(-) create mode 100644 .changelog/15746.txt create mode 100644 ui/app/components/variable-form/job-template-editor.hbs create mode 100644 ui/app/components/variable-form/job-template-editor.js create mode 100644 ui/app/controllers/jobs/run/index.js create mode 100644 ui/app/controllers/jobs/run/templates/index.js create mode 100644 ui/app/controllers/jobs/run/templates/manage.js create mode 100644 ui/app/controllers/jobs/run/templates/new.js create mode 100644 ui/app/controllers/jobs/run/templates/template.js create mode 100644 ui/app/helpers/format-template-label.js create mode 100644 ui/app/helpers/invoke-fn.js delete mode 100644 ui/app/routes/jobs/run.js create mode 100644 ui/app/routes/jobs/run/index.js create mode 100644 ui/app/routes/jobs/run/templates/index.js create mode 100644 ui/app/routes/jobs/run/templates/manage.js create mode 100644 ui/app/routes/jobs/run/templates/new.js create mode 100644 ui/app/routes/jobs/run/templates/template.js rename ui/app/styles/components/{badge.scss => badge-nomad-internal.scss} (100%) rename ui/app/styles/components/{dropdown.scss => dropdown-nomad-internal.scss} (100%) rename ui/app/templates/jobs/{run.hbs => run/index.hbs} (68%) create mode 100644 ui/app/templates/jobs/run/templates/index.hbs create mode 100644 ui/app/templates/jobs/run/templates/manage.hbs create mode 100644 ui/app/templates/jobs/run/templates/new.hbs create mode 100644 ui/app/templates/jobs/run/templates/template.hbs create mode 100644 ui/app/utils/default-job-templates.js create mode 100644 ui/app/utils/default_jobs/hello-world.js create mode 100644 ui/app/utils/default_jobs/parameterized.js create mode 100644 ui/app/utils/default_jobs/service-discovery.js create mode 100644 ui/app/utils/default_jobs/variables.js diff --git a/.changelog/15746.txt b/.changelog/15746.txt new file mode 100644 index 000000000..b19da1647 --- /dev/null +++ b/.changelog/15746.txt @@ -0,0 +1,3 @@ +```release-note:improvement +ui, cli: Adds Job Templates to the "Run Job" Web UI and makes them accessible via new flags on nomad job init +``` diff --git a/command/job_init.go b/command/job_init.go index 94522ae7e..531c9eeea 100644 --- a/command/job_init.go +++ b/command/job_init.go @@ -6,6 +6,7 @@ import ( "os" "strings" + "github.com/hashicorp/nomad/api" "github.com/posener/complete" ) @@ -36,6 +37,14 @@ Init Options: -connect If the connect flag is set, the jobspec includes Consul Connect integration. + + -template + Specifies a predefined template to initialize. Must be a Nomad Variable that + lives at nomad/job-templates/