You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Sep 4, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: website/docs/cloud-docs/agents/requirements.mdx
+25Lines changed: 25 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,6 +30,31 @@ Use the following specifications as a reference:
30
30
- This provides the agent with enough memory to complete run operations, such as `terraform plan`, `git clone`, and `sentinel apply`. This also supports operations such as uploading and downloading artifacts, constructing temporary execution environments, and parsing configurations.
31
31
- If you enable request forwarding, we recommend that you add at least 250MB of additional memory. The agent may hold multiple forwarded requests and responses in memory until they are successfully executed and relayed to HCP Terraform.
32
32
33
+
## Software Requirements
34
+
35
+
Agents may depend on third-party tooling for certain features and functionality.
36
+
The tfc-agent itself does not have any direct dependency on any of the following
37
+
tools, though most common uses of Terraform will require them. The agent makes
38
+
the assumption that the following utilities are pre-installed, and their
39
+
respective CLI commands available on the `$PATH` of the user running tfc-agent.
40
+
41
+
*`git` - The Git CLI. May be used by the Terraform CLI when downloading modules
42
+
from remote Git servers. Git version 2.3 or greater is required.
43
+
*`ssh` - The SSH CLI. Used by `git` when the remote source uses the SSH
44
+
protocol.
45
+
46
+
In addition to the above tools, it is often useful to install the following
47
+
optional software to support a broad range of uses. These tools may be used by
48
+
Terraform's `local-exec` provisioners, an `external` data source, or a tfc-agent
*`gzip` - Decompression utility for gzipped archives.
57
+
33
58
## Networking Requirements
34
59
35
60
In order for an agent to function properly, it must be able to make outbound TCP connections to the HCP Terraform application APIs. These requests may require perimeter networking as well as container host networking changes, depending on your environment. Refer to the [HCP Terraform IP Ranges documentation](/terraform/cloud-docs/architectural-details/ip-ranges) for more details on the IP ranges.
0 commit comments