Command: job scale
The job scale command is used to alter the number of running allocations within
a Nomad task group.
Usage
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.
When ACLs are enabled, this command requires a token with the
read-job-scaling and either the scale-job or submit-job capabilities
for the job's namespace. The list-jobs capability is required to run the
command with a job prefix instead of the exact job ID. The read-job
capability is required to monitor the resulting evaluation when -detach is
not used.
General Options
-address=<addr>: The address of the Nomad server. Overrides theNOMAD_ADDRenvironment variable if set. Defaults tohttp://127.0.0.1:4646.-region=<region>: The region of the Nomad server to forward commands to. Overrides theNOMAD_REGIONenvironment variable if set. Defaults to the Agent's local region.-namespace=<namespace>: The target namespace for queries and actions bound to a namespace. Overrides theNOMAD_NAMESPACEenvironment variable if set. If set to'*', subcommands which support this functionality query all namespaces authorized to user. Defaults to the "default" namespace.-no-color: Disables colored command output. Alternatively,NOMAD_CLI_NO_COLORmay be set. This option takes precedence over-force-color.-force-color: Forces colored command output. This can be used in cases where the usual terminal detection fails. Alternatively,NOMAD_CLI_FORCE_COLORmay be set. This option has no effect if-no-coloris also used.-ca-cert=<path>: Path to a PEM encoded CA cert file to use to verify the Nomad server SSL certificate. Overrides theNOMAD_CACERTenvironment variable if set.-ca-path=<path>: Path to a directory of PEM encoded CA cert files to verify the Nomad server SSL certificate. If both-ca-certand-ca-pathare specified,-ca-certis used. Overrides theNOMAD_CAPATHenvironment variable if set.-client-cert=<path>: Path to a PEM encoded client certificate for TLS authentication to the Nomad server. Must also specify-client-key. Overrides theNOMAD_CLIENT_CERTenvironment variable if set.-client-key=<path>: Path to an unencrypted PEM encoded private key matching the client certificate from-client-cert. Overrides theNOMAD_CLIENT_KEYenvironment variable if set.-tls-server-name=<value>: The server name to use as the SNI host when connecting via TLS. Overrides theNOMAD_TLS_SERVER_NAMEenvironment variable if set.-tls-skip-verify: Do not verify TLS certificate. This is highly not recommended. Verification will also be skipped ifNOMAD_SKIP_VERIFYis set.-token: The SecretID of an ACL token to use to authenticate API requests with. Overrides theNOMAD_TOKENenvironment variable if set.
Scale Options
-check-index: If set, the job is only scaled if the passed job modify index matches the server side version. Ignored if value of zero is passed. If a non-zero value is passed, it ensures that the job is being updated from a known state.-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:
Scale the job with ID "job1" which contains a single task group to a count of 8 and return immediately:
Scale the job with ID "job1" and the task group "group1" to a count of 8: