Skip to content

add arm support docs #558

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

add arm support docs #558

wants to merge 10 commits into from

Conversation

trujillo-adam
Copy link
Contributor

@trujillo-adam trujillo-adam commented Jul 10, 2025 •
edited
Loading

This PR adds docs for supporting for ARM-compiled agents.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jul 10, 2025 •
edited
Loading

Vercel Previews Deployed

Name Status Preview Updated (UTC)
Dev Portal ✅ Ready (Inspect) Visit Preview Wed Jul 16 14:40:16 UTC 2025
Unified Docs API ✅ Ready (Inspect) Visit Preview Wed Jul 16 14:34:18 UTC 2025

@github-actions GitHub Actions
Copy link

github-actions bot commented Jul 10, 2025 •
edited
Loading

Broken Link Checker

No broken links found! 🎉

@trujillo-adam trujillo-adam changed the title add v1.23 folder and arm support docs add arm support docs Jul 10, 2025
@trujillo-adam trujillo-adam marked this pull request as ready for review July 10, 2025 21:14
@trujillo-adam trujillo-adam requested a review from a team as a code owner July 10, 2025 21:14
natalie-todd
natalie-todd requested changes Jul 11, 2025
View reviewed changes
Copy link
Contributor

@natalie-todd natalie-todd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for putting this together! Let me know if you have any questions about any of my feedback and I'm happy to give it another 👀 when it is ready.

natalie-todd
natalie-todd requested changes Jul 14, 2025
View reviewed changes
natalie-todd
natalie-todd previously approved these changes Jul 15, 2025
View reviewed changes
Copy link
Contributor

@natalie-todd natalie-todd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just did a review via the preview so most of this is about formatting and section organization.

content/terraform-docs-agents/v1.22.x/docs/cloud-docs/agents/requirements.mdx Outdated

Refer to [Change the agent pool architecture](/terraform/cloud-docs/agents/agent-pools#change-the-agent-pool-architecture) for instructions on how to switch between architectures.

## Operating systems
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Operating systems
## Operating Systems

content/terraform-docs-agents/v1.22.x/docs/cloud-docs/agents/agents.mdx Outdated
Comment on lines 130 to 145
```plaintext
│ Error: Incompatible provider version
│
│ Provider registry.terraform.io/<namespace>/<name_version> does not have a package available for your current platform, <os_architecture>.
│
│ Provider releases are separate from Terraform CLI releases, so not all providers are available for all platforms. Other versions of this provider may have
│ different platforms supported.
You can call the [Terraform provider registry API](/terraform/internals/provider-registry-protocol#list-available-versions) to confirm the architectures available for a provider.
Sample request:
```shell-session
$ curl 'https://registry.terraform.io/v1/providers/hashicorp/random/versions'
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure how but I think we could reformat this to be more readable. Right now it looks like this:
Screenshot 2025-07-15 at 12 43 15 PM

I think part of the issue is this part got formatted with the error message:

You can call the Terraform provider registry API to confirm the architectures available for a provider.
Sample request:

The sample response looks good though!

content/terraform-docs-agents/v1.22.x/docs/cloud-docs/agents/requirements.mdx Outdated

## Operating systems

You can run the agent on Linux distributions for x86-64 or ARM64. You can also run the agent in a Docker container using the official [Terraform Cloud Agent image on Docker hub](https://hub.docker.com/r/hashicorp/tfc-agent).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can run the agent on Linux distributions for x86-64 or ARM64. You can also run the agent in a Docker container using the official [Terraform Cloud Agent image on Docker hub](https://hub.docker.com/r/hashicorp/tfc-agent).
[Agents](https://releases.hashicorp.com/tfc-agent/) support x86_64 bit and ARM64 Linux operating systems. You can also run the agent within Docker using our official [HCP Terraform Agent Docker container](https://hub.docker.com/r/hashicorp/tfc-agent).

@natalie-todd natalie-todd dismissed their stale review July 15, 2025 22:38

Meant to put request changes

natalie-todd
natalie-todd requested changes Jul 15, 2025
View reviewed changes
Copy link
Contributor

@natalie-todd natalie-todd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did another review with the preview to better assess formatting

@trujillo-adam
Copy link
Contributor Author

@natalie-todd - thanks for reviewing. I implemented your feedback where applicable. Some requests are in conflict with our style guide and information architecture strategy. Also, local previews are broken for me, so I can't verify some of the formatting until Vercel builds a preview. Please let me know if there are any changes to address the accuracy of the information.

radditude
radditude reviewed Jul 16, 2025
View reviewed changes
content/terraform-docs-agents/v1.22.x/docs/cloud-docs/agents/agents.mdx
@@ -123,6 +123,58 @@ The agent maintains a registration and a liveness indicator within HCP Terraform

After initiating a graceful shutdown by either of these methods, the terminal user or parent program should wait for the agent to exit. The amount of time this exit takes depends on the agent's current workload. The agent waits for any current operations to complete before deregistering and exiting.

## Address provider compatibility errors

If a provider does not support your agent’s architecture, the following error appears in the agent’s TRACE logs, the CLI, or the UI:
Copy link
Member

@radditude radditude Jul 16, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the agent’s TRACE logs

Will this error text show up in the agent logs and not just the run logs @natalie-todd? I'd think no, since those provider incompatibility errors are emitted to stdout by the Terraform CLI during terraform init, but maybe we're doing some parsing of stdout for that command that I don't know about. I'd expect that the agent logs will only show that Terraform exited with a non-zero exit code.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@radditude radditude radditude left review comments

@natalie-todd natalie-todd Awaiting requested review from natalie-todd

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@trujillo-adam @radditude @natalie-todd