-
Notifications
You must be signed in to change notification settings - Fork 15
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.
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
Added a table describing possible agent job types #117
base: main
Are you sure you want to change the base?
Added a table describing possible agent job types #117
Conversation
@henryk-rychlik is attempting to deploy a commit to the HashiCorp Team on Vercel. A member of the Team first needs to authorize it. |
Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement Learn more about why HashiCorp requires a CLA and what the CLA includes Have you signed the CLA already but the status is still pending? Recheck it. |
1 similar comment
Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement Learn more about why HashiCorp requires a CLA and what the CLA includes Have you signed the CLA already but the status is still pending? Recheck it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left a comment about placement! Let me know what you think!
@@ -95,6 +95,16 @@ You can configure the agent to accept forwarded requests from HCP Terraform. Req | |||
|
|||
Agents handle forwarded requests separately from other workloads and may process requests in parallel to plans, applies, policy checks, etc. You can modify this behavior by enabling or disabling certain workload types via the `-accept` parameter, and selectively setting the `-request-forwarding` flag on certain agent(s) only. For example, you may have a pool of 4 agents, where two are configured to handle only plans and applies, and the other two are configured to handle only request forwarding. | |||
|
|||
|
|||
| Job type name | Description | Terraform CLI equivalent | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So, the page does describe the allowed job types below, but I agree a table could be a better way to display this! This doesn't feel like quite the place for this information though, since it doesn't really relate to request forwarding.
What do you think about placing it on the Manage agent pool page? If you like that, could you write write descriptive sentences for each Description
, instead of using links? In docs we try to have all the information on one page if we can to avoid folks having to open many tabs to get the context they need.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left a comment, please let me know if you have questions or anything doesn't feel good!
|
||
## Agent job types | ||
|
||
| Job type name | Description | Relevant documentation | Terraform CLI equivalent | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Sorry to nit, but could you remove the "Relevant documentation" column and instead make the descriptions full sentences with in-line references in the table? For accessibility reasons it's better to have links in context so that those using screen readers know where the link will lead here is another example of a table.
So, for example, in the first description:
The agent is [applying a run](/terraform/cli/commands/apply) in a workspace.
Let me know if that makes sense or if you have any other questions!
- Do you think we need the "Terraform CLI equivalent" column if we have links to the accompanying docs? I'm inclined to say no, but curious what you think.
What
Added a table describing possible agent job types
Why
Customer asked about it and it seems this doesn't exist
Screenshots
Merge Checklist
If items do not apply to your changes, add (N/A) and mark them as complete.
Pull Request
Content
terraform-website
repositoryredirects.next.js
file.Reviews