search

coder / terraform-provider-coder

https://coder.com
Mozilla Public License 2.0
31 stars 20 forks source link

docs: clarify `coder_metadata` usage #267

Closed ethanndickson closed 2 months ago

ethanndickson commented 3 months ago

The coder_metadata resource is only used to apply metadata to specific template resources. To apply metadata at the workspace level, and have it be shown on the main workspace pane, a metadata block needs to be created on the coder_agent resource. Alternatively, any coder_metadata attached to the resource containing the agent will be shown on the dashboard by default (see our dogfood template), but this isn't super obvious, so we'll add a comment.

It's pretty easy to assume that the coder_metadata resource would let you apply workspace metadata, if you associated it with the agent, so we'll also add a comment mentioning this isn't the case.

ethanndickson commented 3 months ago

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @ethanndickson and the rest of your teammates on Graphite Graphite

matifali commented 2 months ago

[!IMPORTANT] We should backport this to release/1.0 branch as the main currently has breaking changes.

Also, I renamed the v1-breaking milestone to v2 to track when we want to cut a 2.0 release. cc: @stirby