Skip to content

Commit 2e143d9

Browse files
committed
Update Artifactory integration instructions
1 parent 5c7ef15 commit 2e143d9

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

docs/guides/artifactory-integration.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -116,16 +116,24 @@ This module makes use of the
116116
[Artifactory terraform provider](https://registry.terraform.io/providers/jfrog/artifactory/latest/docs)
117117
and an admin-scoped token to create user-scoped tokens for each user by matching
118118
their Coder email or username with Artifactory. This can be used for both SaaS
119-
and self-hosted(on-premises) Artifactory instances. For Instructions on how to
120-
configure this, please see the details at:
121-
https://registry.coder.com/modules/jfrog-token
119+
and self-hosted(on-premises) Artifactory instances.
120+
121+
To set this up, follow these steps:
122+
123+
1. Get a JFrog access token from your Artifactory instance. The token must be an [admin token](https://registry.terraform.io/providers/jfrog/artifactory/latest/docs#access-token) with scope `applied-permissions/admin`.
124+
2. Create or edit a Coder template and use the [JFrog-Token](https://registry.coder.com/modules/jfrog-token) module to configure the integration and pass the admin token. It is recommended to store the token in a sensitive terraform variable to prevent it from being displayed in plain text in the terraform state.
122125

123126
```hcl
127+
variable "artifactory_access_token" {
128+
type = string
129+
sensitive = true
130+
}
131+
124132
module "jfrog" {
125133
source = "registry.coder.com/modules/jfrog-token/coder"
126134
version = "1.0.0"
127135
agent_id = coder_agent.example.id
128-
jfrog_url = "https://XXXX.jfrog.io"
136+
jfrog_url = "https://example.jfrog.io"
129137
configure_code_server = true # this depends on the code-server
130138
artifactory_access_token = var.artifactory_access_token
131139
package_managers = {
@@ -141,9 +149,7 @@ The admin-level access token is used to provision user tokens and is never expos
141149
developers or stored in workspaces.
142150
</blockquote>
143151

144-
The full example template uses Docker as the underlying compute. But, these
145-
concepts apply to any compute platform. Please check
146-
[here](https://github.com/coder/coder/tree/main/examples/jfrog/docker).
152+
If you do not want to use the official modules, you can check example template that uses Docker as the underlying compute [here](https://github.com/coder/coder/tree/main/examples/jfrog/docker). The same concepts apply to all compute types.
147153

148154
## Offline Deployments
149155

0 commit comments

Comments
 (0)