Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -175,11 +175,12 @@ Sample response:
}
```

<!--
<!--
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
WARNING: This the CLI options section is auto-generated during agent release process.
Do not edit this section directly as your changes will be overwritten.
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
-->

# CLI options


Expand Down Expand Up @@ -314,146 +315,6 @@ Sample response:
Environment variable: `TFC_AGENT_REQUEST_FORWARDING`


* `-h`:
Display this message and exit.

* `-v`:
Display the version and exit.

# CLI Options


* `-name <name>`:
An optional user-specified name for the agent. This name may be used in
the HCP Terraform user interface to help easily identify the agent.

Default: `The agent's ephemeral ID, assigned during boot.`

Environment variable: `TFC_AGENT_NAME`


* `-log-level <level>`:
The log verbosity expressed as a level string. Level options include
"trace", "debug", "info", "warn", and "error". Log levels have a
progressive level of data sensitivy. The "info", "warn", and "error" levels
are considered generally safe for log collection and don't include
sensitive information. The "debug" log level may include internal system
details, such as specific commands and arguments including paths to user
data on the local filesystem. The "trace" log level is the most sensitive
and may include personally identifiable information, secrets,
pre-authorized internal URLs, and other sensitive material.

Default: `info`

Environment variable: `TFC_AGENT_LOG_LEVEL`


* `-log-json`:
Enable JSON logging mode.

Default: `false`

Environment variable: `TFC_AGENT_LOG_JSON`


* `-data-dir <path>`:
The path to a directory to store all agent-related data, including
Terraform configurations, cached Terraform release archives, etc. It is
important to ensure that the given directory is backed by plentiful
storage.

Default: `~/.tfc-agent`

Environment variable: `TFC_AGENT_DATA_DIR`


* `-cache-dir <path>`:
The path to a directory to store all agent-related cache data, including
cached Terraform release archives, policy binaries, etc. It is important to
ensure that the given directory is backed by plentiful storage.

Default: `<data-dir>/cache`

Environment variable: `TFC_AGENT_CACHE_DIR`


* `-single`:
Enable single mode. This causes the agent to handle at most one job and
immediately exit thereafter. Useful for running agents as ephemeral
containers, VMs, or other isolated contexts with a higher-level scheduler
or process supervisor.

Default: `false`

Environment variable: `TFC_AGENT_SINGLE`


* `-auto-update`:
Controls automatic core updates behavior. Acceptable values include
"disabled", "patch", and "minor".

Default: `minor`

Environment variable: `TFC_AGENT_AUTO_UPDATE`


* `-address <addr>`:
The HTTP or HTTPS address of the HCP Terraform API.

Default: `https://app.terraform.io`

Environment variable: `TFC_ADDRESS`


* `-token <token>`:
The agent token to use when making requests to the HCP Terraform API.
This token must be obtained from the API or UI. It is recommended to use
the environment variable whenever possible for configuring this setting due
to the sensitive nature of API tokens.

Required, no default.
Environment variable: `TFC_AGENT_TOKEN`


* `-otlp-address <addr>`:
Optional host:port address of an OpenTelemetry collector to send telemetry
data to, including metrics and tracing. Currently the agent connects to
this address using the gRPC protocol.

Default: `none`

Environment variable: `TFC_AGENT_OTLP_ADDRESS`


* `-otlp-cert-file <path>`:
Optional path to a client TLS certificate file to load. When present, the
given certificate is used to encrypt the client connection to the
OpenTelemetry collector. When omitted, client connections are not secure.

Default: `none`

Environment variable: `TFC_AGENT_OTLP_CERT_FILE`


* `-accept <job_types>`:
Optional string of comma-separated job types that this agent may run.
Acceptable job types are "plan", "apply", "policy", "assessment", "ingress",
and "test". Do not put whitespace in between entries.

Default: `plan,apply,policy,assessment`

Environment variable: `TFC_AGENT_ACCEPT`


* `-request-forwarding`:
Enable handling of forwarded HTTP requests. Enable this option only if you
are using product features which require it.

Default: `false`

Environment variable: `TFC_AGENT_REQUEST_FORWARDING`


* `-hyok`:
Enable handling HYOK requests for generating, re-encrypting, or decrypting data
keys using your KMS. This is not required to handle runs on HYOK workspaces.
Expand All @@ -469,4 +330,3 @@ Sample response:

* `-v`:
Display the version and exit.

Loading