- Notifications
You must be signed in to change notification settings - Fork1k
refactor: refactor JFrog docs and template#11336
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
5 commits Select commitHold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
46 changes: 25 additions & 21 deletionsdocs/platforms/jfrog.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -41,33 +41,35 @@ terraform { | ||
| required_providers { | ||
| coder = { | ||
| source = "coder/coder" | ||
| } | ||
| docker = { | ||
| source = "kreuzwerker/docker" | ||
| } | ||
| artifactory = { | ||
| source = "registry.terraform.io/jfrog/artifactory" | ||
| } | ||
| } | ||
| } | ||
| variable "jfrog_url" { | ||
bpmct marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| type = string | ||
| description = "JFrog instance URL. e.g. https://jfrog.example.com" | ||
| # validate the URL to ensure it starts with https:// or http:// | ||
| validation { | ||
| condition = can(regex("^https?://", var.jfrog_url)) | ||
| error_message = "JFrog URL must start with https:// or http://" | ||
| } | ||
| } | ||
| variable "artifactory_admin_access_token" { | ||
| type = string | ||
| description = "The admin-level access token to use for JFrog with scope applied-permissions/admin" | ||
| } | ||
| # Configure the Artifactory provider | ||
| provider "artifactory" { | ||
| url = "${var.jfrog_url}/artifactory" | ||
| access_token = "${var.artifactory_admin_access_token}" | ||
| } | ||
| resource "artifactory_scoped_token" "me" { | ||
| @@ -80,7 +82,7 @@ resource "artifactory_scoped_token" "me" { | ||
| When pushing the template, you can pass in the variables using the `--var` flag: | ||
| ```shell | ||
| coder templates push --var 'jfrog_url=https://YYY.jfrog.io' --var 'artifactory_admin_access_token=XXX' | ||
| ``` | ||
| ## Installing JFrog CLI | ||
| @@ -118,6 +120,10 @@ locals { | ||
| python = "pypi" | ||
| go = "go" | ||
| } | ||
| # Make sure to use the same field as the username field in the Artifactory | ||
| # It can be either the username or the email address. | ||
| artifactory_username = data.coder_workspace.me.owner_email | ||
| jfrog_host = replace(var.jfrog_url, "^https://", "") | ||
| } | ||
| ``` | ||
| @@ -133,7 +139,7 @@ resource "coder_agent" "main" { | ||
| set -e | ||
| # install and start code-server | ||
| curl -fsSL https://code-server.dev/install.sh | sh -s -- --method=standalone --prefix=/tmp/code-server | ||
| /tmp/code-server/bin/code-server --auth none --port 13337 >/tmp/code-server.log 2>&1 & | ||
| # The jf CLI checks $CI when determining whether to use interactive | ||
| @@ -142,26 +148,26 @@ resource "coder_agent" "main" { | ||
| jf c rm 0 || true | ||
| echo ${artifactory_scoped_token.me.access_token} | \ | ||
| jf c add --access-token-stdin --url ${var.jfrog_url} 0 | ||
| # Configure the `npm` CLI to use the Artifactory "npm" repository. | ||
| cat << EOF > ~/.npmrc | ||
| email = ${data.coder_workspace.me.owner_email} | ||
| registry = ${var.jfrog_url}/artifactory/api/npm/${local.artifactory_repository_keys["npm"]} | ||
| EOF | ||
| jf rt curl /api/npm/auth >> .npmrc | ||
| # Configure the `pip` to use the Artifactory "python" repository. | ||
| mkdir -p ~/.pip | ||
| cat << EOF > ~/.pip/pip.conf | ||
| [global] | ||
| index-url = https://${local.artifactory_username}:${artifactory_scoped_token.me.access_token}@${local.jfrog_host}/artifactory/api/pypi/${local.artifactory_repository_keys["python"]}/simple | ||
| EOF | ||
| EOT | ||
| # Set GOPROXY to use the Artifactory "go" repository. | ||
| env = { | ||
| GOPROXY : "https://${local.artifactory_username}:${artifactory_scoped_token.me.access_token}@${local..jfrog_host}/artifactory/api/go/${local.artifactory_repository_keys["go"]}" | ||
| } | ||
| } | ||
| ``` | ||
| @@ -192,9 +198,7 @@ following lines into your `startup_script`: | ||
| # Install the JFrog VS Code extension. | ||
| # Find the latest version number at | ||
| # https://open-vsx.org/extension/JFrog/jfrog-vscode-extension. | ||
| /tmp/code-server/bin/code-server --install-extension jfrog.jfrog-vscode-extension | ||
| ``` | ||
| Note that this method will only work if your developers use code-server. | ||
| @@ -208,7 +212,7 @@ Artifactory: | ||
| # Configure the `npm` CLI to use the Artifactory "npm" registry. | ||
| cat << EOF > ~/.npmrc | ||
| email = ${data.coder_workspace.me.owner_email} | ||
| registry = ${var.jfrog_url}/artifactory/api/npm/npm/ | ||
| EOF | ||
| jf rt curl /api/npm/auth >> .npmrc | ||
| ``` | ||
| @@ -227,7 +231,7 @@ Artifactory: | ||
| mkdir -p ~/.pip | ||
| cat << EOF > ~/.pip/pip.conf | ||
| [global] | ||
| index-url = https://${data.coder_workspace.me.owner}:${artifactory_scoped_token.me.access_token}@${local.jfrog_host}/artifactory/api/pypi/pypi/simple | ||
| EOF | ||
| ``` | ||
| @@ -243,7 +247,7 @@ Add the following environment variable to your `coder_agent` block to configure | ||
| ```hcl | ||
| env = { | ||
| GOPROXY : "https://${data.coder_workspace.me.owner}:${artifactory_scoped_token.me.access_token}@${local.jfrog_host}/artifactory/api/go/go" | ||
| } | ||
| ``` | ||
4 changes: 2 additions & 2 deletionsexamples/jfrog/docker/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
45 changes: 24 additions & 21 deletionsexamples/jfrog/docker/main.tf
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.