HashiConf 2024 Now streaming live from Boston! Attend for free
Nomad
Nomad Home

You are viewing documentation for version v0.12.x. View latest version.

Nomad Autoscaler Command: agent

The agent command is used to start the Nomad Autoscaler which runs until an interrupt signal is received. The Nomad Autoscaler agent's configuration primarily comes from the config files used, but a subset of the options may also be passed directly as CLI arguments. See the Nomad Autoscaler Agent guide for more information on how to use this command and the options it has.

Command-line Options

A subset of the available Nomad Autoscaler agent configuration can optionally be passed in via CLI arguments. The agent command accepts the following arguments:

  • -config=<path>: The path to either a single config file or a directory of config files to use for configuring the Nomad Autoscaler agent.

  • -log-level=<level>: Specify the verbosity level of Nomad Autoscaler's logs. Valid values include DEBUG, INFO, and WARN, in decreasing order of verbosity. The default is INFO.

  • -log-json: Output logs in a JSON format. The default is false.

  • -plugin-dir=<path>: The plugin directory is used to discover Nomad Autoscaler plugins. If not specified, the plugin directory defaults to be that of <current-dir>/plugins/.

  • -http-bind-address=<addr>: The HTTP address that the health server will bind to. The default is 127.0.0.1.

  • -http-bind-port=<port>: The port that the health server will bind to. The default is 8080.

  • -nomad-address=<addr>: The address of the Nomad server in the form of protocol://addr:port. The default is http://127.0.0.1:4646.

  • -nomad-region=<region>: The region of the Nomad servers to connect with.

  • -nomad-namespace=<namespace>: The target namespace for queries and actions bound to a namespace.

  • -nomad-token=<token>: The SecretID of an ACL token to use to authenticate API requests with.

  • -nomad-http-auth=<username:password>: The authentication information to use when connecting to a Nomad API which is using HTTP authentication.

  • -nomad-ca-cert=<path>: Path to a PEM encoded CA cert file to use to verify the Nomad server SSL certificate.

  • -nomad-ca-path=<path>: Path to a directory of PEM encoded CA cert files to verify the Nomad server SSL certificate. If both -nomad-ca-cert and -nomad-ca-path are specified, -nomad-ca-cert is used.

  • -nomad-client-cert=<path>: Path to a PEM encoded client certificate for TLS authentication to the Nomad server. Must also specify -nomad-client-key.

  • -nomad-client-key=<path>: Path to an unencrypted PEM encoded private key matching the client certificate from -nomad-client-cert.

  • -nomad-tls-server-name=<name>: The server name to use as the SNI host when connecting via TLS.

  • -nomad-skip-verify: Do not verify TLS certificates. This is strongly discouraged.

  • -policy-dir=<path>: The path to a directory used to load scaling policies.

  • -policy-default-cooldown=<dur>: The default cooldown that will be applied to all scaling policies which do not specify a cooldown period. The default is 5m.

  • -policy-default-evaluation-interval=<dur>: The default evaluation interval that will be applied to all scaling policies which do not specify an evaluation interval. The default is 10s.

Nomad Autoscaler Command: version

The version command displays build information about the running binary, including the release version and the exact revision.

Usage

nomad-autoscaler version

Output

This command prints both the version number as well as the exact commit SHA used during the build. The SHA may also have the string +CHANGES appended to the end, indicating that local, uncommitted changes were detected at build time.

Examples

$ nomad-autoscaler version
Nomad Autoscaler v0.0.3-dev (da91fa9)