Skip to content
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

backport(docs): clarify coder_metadata usage #274

Merged
merged 1 commit into from
Aug 29, 2024
Merged

backport(docs): clarify coder_metadata usage #274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions docs/resources/metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,15 @@
page_title: "coder_metadata Resource - terraform-provider-coder"
subcategory: ""
description: |-
Use this resource to attach metadata to a resource. They will be displayed in the Coder dashboard.
Use this resource to attach metadata to a resource. They will be displayed in the Coder dashboard alongside the resource. The resource containing the agent, and it's metadata, will be shown by default.
Alternatively, to attach metadata to the agent, use a metadata block within a coder_agent resource.
---

# coder_metadata (Resource)

Use this resource to attach metadata to a resource. They will be displayed in the Coder dashboard.
Use this resource to attach metadata to a resource. They will be displayed in the Coder dashboard alongside the resource. The resource containing the agent, and it's metadata, will be shown by default.

Alternatively, to attach metadata to the agent, use a `metadata` block within a `coder_agent` resource.

## Example Usage

Expand Down Expand Up @@ -82,7 +85,7 @@ Required:
Optional:

- `sensitive` (Boolean) Set to `true` to for items such as API keys whose values should be hidden from view by default. Note that this does not prevent metadata from being retrieved using the API, so it is not suitable for secrets that should not be exposed to workspace users.
- `value` (String) The value of this metadata item.
- `value` (String) The value of this metadata item. Supports basic Markdown, including hyperlinks.

Read-Only:

Expand Down
6 changes: 4 additions & 2 deletions provider/metadata.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ func metadataResource() *schema.Resource {
SchemaVersion: 1,

Description: "Use this resource to attach metadata to a resource. They will be " +
"displayed in the Coder dashboard.",
"displayed in the Coder dashboard alongside the resource. " +
"The resource containing the agent, and it's metadata, will be shown by default. " + "\n\n" +
"Alternatively, to attach metadata to the agent, use a `metadata` block within a `coder_agent` resource.",
CreateContext: func(c context.Context, resourceData *schema.ResourceData, i interface{}) diag.Diagnostics {
resourceData.SetId(uuid.NewString())

Expand Down Expand Up @@ -86,7 +88,7 @@ func metadataResource() *schema.Resource {
},
"value": {
Type: schema.TypeString,
Description: "The value of this metadata item.",
Description: "The value of this metadata item. Supports basic Markdown, including hyperlinks.",
ForceNew: true,
Optional: true,
},
Expand Down
Loading