diff --git a/content/nomad/v1.11.x/content/docs/configuration/client.mdx b/content/nomad/v1.11.x/content/docs/configuration/client.mdx index 74274bc9bb..1d8e0e7b6a 100644 --- a/content/nomad/v1.11.x/content/docs/configuration/client.mdx +++ b/content/nomad/v1.11.x/content/docs/configuration/client.mdx @@ -227,6 +227,11 @@ client { `data-dir`][top_level_data_dir] suffixed with `common_plugins`, like `"/opt/nomad/common_plugins"`. This must be an absolute path. +- `fingerprint` ([Fingerprint](#fingerprint-parameters): nil) - + Provides configuration for fingerprinters used by the client and applies to + `"env_aws"`, `"env_azure"`, `"env_digitalocean"`, and `"env_gce"` + fingerprinters. + - `host_volume` ([host_volume](#host_volume-block): nil) - Exposes paths from the host as volumes that can be mounted into jobs. @@ -520,6 +525,39 @@ refer to the [drivers documentation](/nomad/docs/job-declare/task-driver). the Nomad client's environment. By default a minimal environment is set including a `PATH` appropriate for the operating system. +### `fingerprint` Parameters + +- `name` `(string: "")` - The name of the fingerprinter the configuration + applies to. This field is required and is part of the block label. + It supports `"env_aws"`, `"env_azure"`, `"env_digitalocean"`, and `"env_gce"`. + +- `retry_attempts` `(int: 0)` - Specifies the maximum number of retry attempts + to make before giving up. This field supports `-1` for unlimited retries, but + we do not recommend `-1` as this may cause the client to hang indefinitely on + startup if the fingerprinting source is unavailable. The default value of `0` + means no retries are made. + +- `retry_interval` `(string: "2s")` - Specifies the amount of time to wait + between retry attempts. + +- `exit_on_failure` `(bool: false)` - Specifies whether the client should exit + if fingerprinter fails to probe the envrionment endpoint service. + + Nomad tries to identify if its running within the named environment on startup + by probing the environment's metadata endpoint. If the endpoint is + unreachable, Nomad by default skips fingerprinting for that environment + and continue startup. Setting this option to `true` causes Nomad to exit + in this situation. This is useful if you want to ensure that Nomad + only starts when it can successfully fingerprint the environment. + +```hcl +fingerprinter "env_aws" { + retry_attempts = "5" + retry_interval = "1s" + exit_on_failure = true +} +``` + ### `template` Parameters - `function_denylist` `([]string: ["plugin", "executeTemplate",