From 478d49c19cc4112a2b357a9d2b5a62116c025344 Mon Sep 17 00:00:00 2001 From: Bruno Quaresma Date: Tue, 13 Sep 2022 17:45:17 -0300 Subject: [PATCH] docs: Custom resource icon (#4041) * Fix missed unresolved conflict * docs: Custom resource icons * Fix title * Apply suggestions from code review Co-authored-by: Ben Potter Co-authored-by: Ben Potter --- docs/templates.md | 7 +------ docs/templates/resource-metadata.md | 26 ++++++++++++++++++++++++++ 2 files changed, 27 insertions(+), 6 deletions(-) diff --git a/docs/templates.md b/docs/templates.md index 24e98bbc9c..bd3184c283 100644 --- a/docs/templates.md +++ b/docs/templates.md @@ -225,14 +225,9 @@ resource "kubernetes_pod" "podName" { ### Delete templates -<<<<<<< HEAD You can delete a template using both the coder CLI and UI. Only [template admins and owners](./admin/users.md) can delete a template, and the template must not have any running workspaces associated to it. -======= -You can delete a template using both the Coder CLI and UI. Only -[template admins and owners](./admin/users.md) can delete a template. ->>>>>>> 0407c2294c5c7321071c17013f2e39bd70568165 Using the CLI, login to Coder and run the following command to delete a template: @@ -322,7 +317,7 @@ We recommend source controlling your templates as you would other code. CI is as simple as running `coder templates push` with the appropriate credentials. - ## Next Steps + - Learn about [Authentication & Secrets](templates/authentication.md) - Learn about [Workspaces](workspaces.md) diff --git a/docs/templates/resource-metadata.md b/docs/templates/resource-metadata.md index f33d3c68d9..a5870a9925 100644 --- a/docs/templates/resource-metadata.md +++ b/docs/templates/resource-metadata.md @@ -71,6 +71,32 @@ resource "coder_metadata" "hide_serviceaccount" { } ``` +## Using custom resource icon + +To use custom icons on your resources, use the `icon` attribute (must be a valid path or URL): + +```hcl +resource "coder_metadata" "resource_with_icon" { + count = data.coder_workspace.me.start_count + resource_id = kubernetes_service_account.user_data.id + icon = "/icon/database.svg" + item { + key = "name" + value = kubernetes_deployment.coder[0].metadata[0].name + } +} +``` + +To make easier for you to customize your resource we added some built-in icons: + +- Folder `/icon/folder.svg` +- Memory `/icon/memory.svg` +- Image `/icon/image.svg` +- Widgets `/icon/widgets.svg` +- Database `/icon/database.svg` + +We also have other icons related to the IDEs. You can see all the icons [here](https://github.com/coder/coder/tree/main/site/static/icon). + ## Up next - Learn about [secrets](../secrets.md)