opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: Custom resource icon (#4041)

Browse Source 
* Fix missed unresolved conflict

* docs: Custom resource icons

* Fix title

* Apply suggestions from code review

Co-authored-by: Ben Potter <ben@coder.com>

Co-authored-by: Ben Potter <ben@coder.com>
This commit is contained in:
Bruno Quaresma
2022-09-13 20:45:17 +00:00
committed by GitHub
co-authored by Ben Potter
parent 0552c36e29
commit 478d49c19c
2 changed files with 27 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/templates/resource-metadata.md
Vendored
+26
View File
@@ -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)