synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-15 22:20:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: tweak some words and fix a typo in agent-metadata.md

Browse Source
This commit is contained in:
Ammar Bandukwala
2023-03-31 23:20:30 +00:00
parent 84956c16cc
commit ccadd0f286
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/templates/agent-metadata.md vendored
View File

@ -6,17 +6,17 @@ Agent metadata is in an alpha state and may break or disappear at any time.
![agent-metadata](../images/agent-metadata.png)
With Agent Metadata, template admin can expose operational metrics from
their workspaces to their users. It is a sibling of [Resource Metadata](./resource-metadata.md).
With Agent Metadata, template admins can expose operational metrics from
their workspaces to their users. It is the dynamic complement of [Resource Metadata](./resource-metadata.md).
See the [Terraform reference](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#metadata).
## Examples
All of these examples use [heredoc strings](https://developer.hashicorp.com/terraform/language/expressions/strings#heredoc-strings) for the script declaration. With heredoc strings you
All of these examples use [heredoc strings](https://developer.hashicorp.com/terraform/language/expressions/strings#heredoc-strings) for the script declaration. With heredoc strings, you
can script without messy escape codes, just as if you were working in your terminal.
Here are useful agent metadata snippets for Linux agents:
Here's a standard set of metadata snippets for Linux agents:
```hcl
resource "coder_agent" "main" {
@ -69,7 +69,7 @@ resource "coder_agent" "main" {
## Utilities
[vmstat](https://linux.die.net/man/8/vmstat) is available in most Linux
distributions and contains virtual memory, CPU and IO statistics. Running `vmstat`
distributions and provides virtual memory, CPU and IO statistics. Running `vmstat`
produces output that looks like:
```