From 184e7dbce001ebe11db454079c97a0b798c866ba Mon Sep 17 00:00:00 2001 From: Bruno Quaresma Date: Mon, 12 Sep 2022 14:57:53 -0300 Subject: [PATCH] docs: Add docs about coder_metadata hide attribute (#3985) --- docs/templates/resource-metadata.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/templates/resource-metadata.md b/docs/templates/resource-metadata.md index e38aee92f4..f33d3c68d9 100644 --- a/docs/templates/resource-metadata.md +++ b/docs/templates/resource-metadata.md @@ -55,6 +55,22 @@ resource "coder_metadata" "deployment" { } ``` +## Hiding resources in the UI + +Some resources don't need to be exposed in the UI; this helps keep the workspace view clean for developers. To hide a resource, use the `hide` attribute: + +```hcl +resource "coder_metadata" "hide_serviceaccount" { + count = data.coder_workspace.me.start_count + resource_id = kubernetes_service_account.user_data.id + hide = true + item { + key = "name" + value = kubernetes_deployment.coder[0].metadata[0].name + } +} +``` + ## Up next - Learn about [secrets](../secrets.md)