Skip to content

Commit 49d8cc6

Browse files
committed
Remove duplicated CLI Options section
1 parent 369c7a6 commit 49d8cc6

File tree

1 file changed

+0
-141
lines changed
  • content/terraform-docs-agents/v1.23.x/docs/cloud-docs/agents

1 file changed

+0
-141
lines changed

content/terraform-docs-agents/v1.23.x/docs/cloud-docs/agents/agents.mdx

Lines changed: 0 additions & 141 deletions
Original file line numberDiff line numberDiff line change
@@ -314,146 +314,6 @@ Sample response:
314314
Environment variable: `TFC_AGENT_REQUEST_FORWARDING`
315315

316316

317-
* `-h`:
318-
Display this message and exit.
319-
320-
* `-v`:
321-
Display the version and exit.
322-
323-
# CLI Options
324-
325-
326-
* `-name <name>`:
327-
An optional user-specified name for the agent. This name may be used in
328-
the HCP Terraform user interface to help easily identify the agent.
329-
330-
Default: `The agent's ephemeral ID, assigned during boot.`
331-
332-
Environment variable: `TFC_AGENT_NAME`
333-
334-
335-
* `-log-level <level>`:
336-
The log verbosity expressed as a level string. Level options include
337-
"trace", "debug", "info", "warn", and "error". Log levels have a
338-
progressive level of data sensitivy. The "info", "warn", and "error" levels
339-
are considered generally safe for log collection and don't include
340-
sensitive information. The "debug" log level may include internal system
341-
details, such as specific commands and arguments including paths to user
342-
data on the local filesystem. The "trace" log level is the most sensitive
343-
and may include personally identifiable information, secrets,
344-
pre-authorized internal URLs, and other sensitive material.
345-
346-
Default: `info`
347-
348-
Environment variable: `TFC_AGENT_LOG_LEVEL`
349-
350-
351-
* `-log-json`:
352-
Enable JSON logging mode.
353-
354-
Default: `false`
355-
356-
Environment variable: `TFC_AGENT_LOG_JSON`
357-
358-
359-
* `-data-dir <path>`:
360-
The path to a directory to store all agent-related data, including
361-
Terraform configurations, cached Terraform release archives, etc. It is
362-
important to ensure that the given directory is backed by plentiful
363-
storage.
364-
365-
Default: `~/.tfc-agent`
366-
367-
Environment variable: `TFC_AGENT_DATA_DIR`
368-
369-
370-
* `-cache-dir <path>`:
371-
The path to a directory to store all agent-related cache data, including
372-
cached Terraform release archives, policy binaries, etc. It is important to
373-
ensure that the given directory is backed by plentiful storage.
374-
375-
Default: `<data-dir>/cache`
376-
377-
Environment variable: `TFC_AGENT_CACHE_DIR`
378-
379-
380-
* `-single`:
381-
Enable single mode. This causes the agent to handle at most one job and
382-
immediately exit thereafter. Useful for running agents as ephemeral
383-
containers, VMs, or other isolated contexts with a higher-level scheduler
384-
or process supervisor.
385-
386-
Default: `false`
387-
388-
Environment variable: `TFC_AGENT_SINGLE`
389-
390-
391-
* `-auto-update`:
392-
Controls automatic core updates behavior. Acceptable values include
393-
"disabled", "patch", and "minor".
394-
395-
Default: `minor`
396-
397-
Environment variable: `TFC_AGENT_AUTO_UPDATE`
398-
399-
400-
* `-address <addr>`:
401-
The HTTP or HTTPS address of the HCP Terraform API.
402-
403-
Default: `https://app.terraform.io`
404-
405-
Environment variable: `TFC_ADDRESS`
406-
407-
408-
* `-token <token>`:
409-
The agent token to use when making requests to the HCP Terraform API.
410-
This token must be obtained from the API or UI. It is recommended to use
411-
the environment variable whenever possible for configuring this setting due
412-
to the sensitive nature of API tokens.
413-
414-
Required, no default.
415-
Environment variable: `TFC_AGENT_TOKEN`
416-
417-
418-
* `-otlp-address <addr>`:
419-
Optional host:port address of an OpenTelemetry collector to send telemetry
420-
data to, including metrics and tracing. Currently the agent connects to
421-
this address using the gRPC protocol.
422-
423-
Default: `none`
424-
425-
Environment variable: `TFC_AGENT_OTLP_ADDRESS`
426-
427-
428-
* `-otlp-cert-file <path>`:
429-
Optional path to a client TLS certificate file to load. When present, the
430-
given certificate is used to encrypt the client connection to the
431-
OpenTelemetry collector. When omitted, client connections are not secure.
432-
433-
Default: `none`
434-
435-
Environment variable: `TFC_AGENT_OTLP_CERT_FILE`
436-
437-
438-
* `-accept <job_types>`:
439-
Optional string of comma-separated job types that this agent may run.
440-
Acceptable job types are "plan", "apply", "policy", "assessment", "ingress",
441-
and "test". Do not put whitespace in between entries.
442-
443-
Default: `plan,apply,policy,assessment`
444-
445-
Environment variable: `TFC_AGENT_ACCEPT`
446-
447-
448-
* `-request-forwarding`:
449-
Enable handling of forwarded HTTP requests. Enable this option only if you
450-
are using product features which require it.
451-
452-
Default: `false`
453-
454-
Environment variable: `TFC_AGENT_REQUEST_FORWARDING`
455-
456-
457317
* `-hyok`:
458318
Enable handling HYOK requests for generating, re-encrypting, or decrypting data
459319
keys using your KMS. This is not required to handle runs on HYOK workspaces.
@@ -469,4 +329,3 @@ Sample response:
469329

470330
* `-v`:
471331
Display the version and exit.
472-

0 commit comments

Comments
 (0)