diff --git a/website/data/docs-navigation.js b/website/data/docs-navigation.js index 43e059852..158cb7d3b 100644 --- a/website/data/docs-navigation.js +++ b/website/data/docs-navigation.js @@ -122,6 +122,8 @@ export default [ 'promote', 'revert', 'run', + 'scale', + 'scaling-events', 'status', 'stop', 'validate', diff --git a/website/pages/docs/commands/job/scale.mdx b/website/pages/docs/commands/job/scale.mdx new file mode 100644 index 000000000..17b33e2c3 --- /dev/null +++ b/website/pages/docs/commands/job/scale.mdx @@ -0,0 +1,91 @@ +--- +layout: docs +page_title: 'Commands: job scale' +sidebar_title: scale +description: | + The job scale command is used to change the count of a Nomad job group. +--- + +# Command: job scale + +The `job scale` command is used to alter the number of running allocations within +a Nomad task group. + +## Usage + +```plaintext +nomad job scale [options] +``` + +The `job scale` commands requires at least two arguments and potentially three +depending on the job specification. The first argument will be the job ID of the +job you wish to scale. If the job contains a single task group, you can omit +including the task group name as the second argument and the command will perform +the required lookup. The final argument is the count that you wish the job task +group to be changed to. The count is the absolute value that will be reflected in +the job specification. + +Scale will issue a request to update the matched job and then invoke an interactive +monitor that exits automatically once the scheduler has processed the request. +It is safe to exit the monitor early using ctrl+c. + +## General Options + +@include 'general_options.mdx' + +## Scale Options + +- `-detach`: Return immediately instead of entering monitor mode. After the + scale command is submitted, a new evaluation ID is printed to the screen, + which can be used to examine the evaluation using the [eval status] command. + +- `-verbose`: Show full information. + +## Examples + +Scale the job with ID "job1" which contains a single task group to a count of 8: + +```shell-session +$ nomad job scale job1 8 +==> Monitoring evaluation "529cc88e" + Evaluation triggered by job "job1" + Evaluation within deployment: "28a3378f" + Allocation "2a4df8ca" created: node "2f0a2f93", group "group1" + Allocation "b7eefe49" created: node "2f0a2f93", group "group1" + Allocation "bd54a83d" created: node "2f0a2f93", group "group1" + Allocation "fadeaea8" created: node "2f0a2f93", group "group1" + Allocation "4bd1397b" modified: node "2f0a2f93", group "group1" + Allocation "93684511" modified: node "2f0a2f93", group "group1" + Allocation "b409f0a2" modified: node "2f0a2f93", group "group1" + Allocation "18f50054" created: node "2f0a2f93", group "group1" + Evaluation status changed: "pending" -> "complete" +==> Evaluation "529cc88e" finished with status "complete" +``` + +Scale the job with ID "job1" which contains a single task group to a count of 8 +and return immediately: + +```shell-session +$ nomad job scale -detach job1 8 +Evaluation ID: b754d6b3-8960-5652-60d8-d47df6eaed13 +``` + +Scale the job with ID "job1" and the task group "group1" to a count of 8: +```shell-session +$ nomad job scale job1 group1 8 +==> Monitoring evaluation "529cc88e" + Evaluation triggered by job "job1" + Evaluation within deployment: "28a3378f" + Allocation "2a4df8ca" created: node "2f0a2f93", group "group1" + Allocation "b7eefe49" created: node "2f0a2f93", group "group1" + Allocation "bd54a83d" created: node "2f0a2f93", group "group1" + Allocation "fadeaea8" created: node "2f0a2f93", group "group1" + Allocation "4bd1397b" modified: node "2f0a2f93", group "group1" + Allocation "93684511" modified: node "2f0a2f93", group "group1" + Allocation "b409f0a2" modified: node "2f0a2f93", group "group1" + Allocation "18f50054" created: node "2f0a2f93", group "group1" + Evaluation status changed: "pending" -> "complete" +==> Evaluation "529cc88e" finished with status "complete" +``` + +[eval status]: /docs/commands/eval-status diff --git a/website/pages/docs/commands/job/scaling-events.mdx b/website/pages/docs/commands/job/scaling-events.mdx new file mode 100644 index 000000000..564d41041 --- /dev/null +++ b/website/pages/docs/commands/job/scaling-events.mdx @@ -0,0 +1,49 @@ +--- +layout: docs +page_title: 'Commands: job scaling-events' +sidebar_title: scaling-events +description: | + The job scaling-events command details scaling events for a given job. +--- + +# Command: job scaling-events + +The `job scaling-events` command is used display the recent scaling events for +a given job. + +## Usage + +```plaintext +nomad job scaling-events [options] +``` + +The `job scaling-events` command requires a single argument, a submitted job's +ID, and will output the stored scaling events for the job if there are any. + +## General Options + +@include 'general_options.mdx' + +## Scaling-Events Options + +- `-verbose`: Show full information. + +## Examples + +Display the scaling events for the job with ID "job1": + +```shell-session +$ nomad job scaling-events job1 +Task Group Count PrevCount Date +group1 8 8 2020-10-23T09:06:47+02:00 +group1 8 3 2020-10-23T09:02:42+02:00 +``` + +Display the scaling events for the job with ID "job1" using the `verbose` flag: + +```shell-session +$ nomad job scaling-events -verbose job1 +Task Group Count PrevCount Error Message Eval ID Date +group1 8 8 false submitted using the Nomad CLI b754d6b3-8960-5652-60d8-d47df6eaed13 2020-10-23T09:06:47+02:00 +group1 8 3 false submitted using the Nomad CLI 529cc88e-8887-725e-2a79-4997f50df153 2020-10-23T09:02:42+02:00 +```