From 98a428ae891c375463207a4be15dc8ae1680a295 Mon Sep 17 00:00:00 2001
From: Muhammad Atif Ali <atif@coder.com>
Date: Mon, 18 Mar 2024 13:35:18 +0300
Subject: [PATCH] chore(jfrog-token): set token description (#198)

---
 jfrog-token/README.md | 20 ++++++++++++++++++++
 jfrog-token/main.tf   |  7 +++++++
 2 files changed, 27 insertions(+)

diff --git a/jfrog-token/README.md b/jfrog-token/README.md
index bfebd13..d58cb19 100644
--- a/jfrog-token/README.md
+++ b/jfrog-token/README.md
@@ -87,6 +87,26 @@ module "jfrog" {
 }
 ```
 
+### Add a custom token description
+
+```tf
+data "coder_workspace" "me" {}
+
+module "jfrog" {
+  source                   = "registry.coder.com/modules/jfrog-token/coder"
+  version                  = "1.0.5"
+  agent_id                 = coder_agent.example.id
+  jfrog_url                = "https://XXXX.jfrog.io"
+  artifactory_access_token = var.artifactory_access_token
+  token_description        = "Token for Coder workspace: ${data.coder_workspace.me.owner}/${data.coder_workspace.me.name}"
+  package_managers = {
+    "npm" : "npm",
+    "go" : "go",
+    "pypi" : "pypi"
+  }
+}
+```
+
 ### Using the access token in other terraform resources
 
 JFrog Access token is also available as a terraform output. You can use it in other terraform resources. For example, you can use it to configure an [Artifactory docker registry](https://jfrog.com/help/r/jfrog-artifactory-documentation/docker-registry) with the [docker terraform provider](https://registry.terraform.io/providers/kreuzwerker/docker/latest/docs).
diff --git a/jfrog-token/main.tf b/jfrog-token/main.tf
index 1caca4d..d1f99f1 100644
--- a/jfrog-token/main.tf
+++ b/jfrog-token/main.tf
@@ -34,6 +34,12 @@ variable "artifactory_access_token" {
   description = "The admin-level access token to use for JFrog."
 }
 
+variable "token_description" {
+  type        = string
+  description = "Free text token description. Useful for filtering and managing tokens."
+  default     = "Token for Coder workspace"
+}
+
 variable "check_license" {
   type        = bool
   description = "Toggle for pre-flight checking of Artifactory license. Default to `true`."
@@ -107,6 +113,7 @@ resource "artifactory_scoped_token" "me" {
   scopes      = ["applied-permissions/user"]
   refreshable = var.refreshable
   expires_in  = var.expires_in
+  description = var.token_description
 }
 
 data "coder_workspace" "me" {}