Add JFrog (OAuth) integration module (#97)
Muhammad Atif Ali
1 year ago
committed by
GitHub
parent
4e7f1e0ffd
commit
73ef0dc7d0
Binary file not shown.
|
After Width: | Height: | Size: 74 KiB |
@ -0,0 +1,61 @@
|
||||
---
|
||||
display_name: JFrog (OAuth)
|
||||
description: Install the JF CLI and authenticate with Artifactory using OAuth.
|
||||
icon: ../.icons/jfrog.svg
|
||||
maintainer_github: coder
|
||||
partner_github: jfrog
|
||||
verified: true
|
||||
tags: [integration, jfrog]
|
||||
---
|
||||
|
||||
# JFrog
|
||||
|
||||
Install the JF CLI and authenticate package managers with Artifactory using OAuth configured via the Coder `external-auth` feature.
|
||||
|
||||
|
||||
|
||||
```hcl
|
||||
module "jfrog" {
|
||||
source = "https://registry.coder.com/modules/jfrog-oauth"
|
||||
agent_id = coder_agent.example.id
|
||||
jfrog_url = "https://jfrog.example.com"
|
||||
auth_method = "oauth"
|
||||
username_field = "username" # If you are using GitHub to login to both Coder and Artifactory, use username_field = "username"
|
||||
package_managers = {
|
||||
"npm": "npm",
|
||||
"go": "go",
|
||||
"pypi": "pypi"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Coder [`external-auth`](https://docs.coder.com/docs/admin/external-auth/) configured with Artifactory. This requires a [custom integration](https://jfrog.com/help/r/jfrog-installation-setup-documentation/enable-new-integrations) in Artifactory with **Callback URL** set to `https://<your-coder-url>/external-auth/jfrog/callback`.
|
||||
|
||||
## Examples
|
||||
|
||||
Configure the Python pip package manager to fetch packages from Artifactory while mapping the Coder email to the Artifactory username.
|
||||
|
||||
```hcl
|
||||
module "jfrog" {
|
||||
source = "https://registry.coder.com/modules/jfrog-oauth"
|
||||
agent_id = coder_agent.example.id
|
||||
jfrog_url = "https://jfrog.example.com"
|
||||
auth_method = "oauth"
|
||||
username_field = "email"
|
||||
package_managers = {
|
||||
"pypi": "pypi"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
You should now be able to install packages from Artifactory using both the `jf pip` and `pip` command.
|
||||
|
||||
```shell
|
||||
jf pip install requests
|
||||
```
|
||||
|
||||
```shell
|
||||
pip install requests
|
||||
```
|
||||
@ -0,0 +1,17 @@
|
||||
import { serve } from "bun";
|
||||
import { describe } from "bun:test";
|
||||
import {
|
||||
createJSONResponse,
|
||||
runTerraformInit,
|
||||
testRequiredVariables,
|
||||
} from "../test";
|
||||
|
||||
describe("jfrog-oauth", async () => {
|
||||
await runTerraformInit(import.meta.dir);
|
||||
|
||||
testRequiredVariables(import.meta.dir, {
|
||||
agent_id: "some-agent-id",
|
||||
jfrog_url: "http://localhost:8081",
|
||||
package_managers: "{}",
|
||||
});
|
||||
});
|
||||
@ -0,0 +1,77 @@
|
||||
terraform {
|
||||
required_version = ">= 1.0"
|
||||
|
||||
required_providers {
|
||||
coder = {
|
||||
source = "coder/coder"
|
||||
version = ">= 0.12"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
variable "jfrog_url" {
|
||||
type = string
|
||||
description = "JFrog instance URL. e.g. https://jfrog.example.com"
|
||||
}
|
||||
|
||||
variable "username_field" {
|
||||
type = string
|
||||
description = "The field to use for the artifactory username. i.e. Coder username or email."
|
||||
default = "username"
|
||||
validation {
|
||||
condition = can(regex("^(email|username)$", var.username_field))
|
||||
error_message = "username_field must be either 'email' or 'username'"
|
||||
}
|
||||
}
|
||||
|
||||
variable "external_auth_id" {
|
||||
type = string
|
||||
description = "JFrog external auth ID. Default: 'jfrog'"
|
||||
default = "jfrog"
|
||||
}
|
||||
|
||||
variable "agent_id" {
|
||||
type = string
|
||||
description = "The ID of a Coder agent."
|
||||
}
|
||||
|
||||
variable "package_managers" {
|
||||
type = map(string)
|
||||
description = <<EOF
|
||||
A map of package manager names to their respective artifactory repositories.
|
||||
For example:
|
||||
{
|
||||
"npm": "npm-local",
|
||||
"go": "go-local",
|
||||
"pypi": "pypi-local"
|
||||
}
|
||||
EOF
|
||||
}
|
||||
|
||||
locals {
|
||||
# The username field to use for artifactory
|
||||
username = var.username_field == "email" ? data.coder_workspace.me.owner_email : data.coder_workspace.me.owner
|
||||
}
|
||||
|
||||
data "coder_workspace" "me" {}
|
||||
|
||||
data "coder_external_auth" "jfrog" {
|
||||
id = var.external_auth_id
|
||||
}
|
||||
|
||||
resource "coder_script" "jfrog" {
|
||||
agent_id = var.agent_id
|
||||
display_name = "jfrog"
|
||||
icon = "/icon/jfrog.svg"
|
||||
script = templatefile("${path.module}/run.sh", {
|
||||
JFROG_URL : var.jfrog_url,
|
||||
JFROG_HOST : replace(var.jfrog_url, "https://", ""),
|
||||
ARTIFACTORY_USERNAME : local.username,
|
||||
ARTIFACTORY_EMAIL : data.coder_workspace.me.owner_email,
|
||||
ARTIFACTORY_ACCESS_TOKEN : data.coder_external_auth.jfrog.access_token,
|
||||
REPOSITORY_NPM : lookup(var.package_managers, "npm", ""),
|
||||
REPOSITORY_GO : lookup(var.package_managers, "go", ""),
|
||||
REPOSITORY_PYPI : lookup(var.package_managers, "pypi", ""),
|
||||
})
|
||||
run_on_start = true
|
||||
}
|
||||
@ -0,0 +1,58 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
BOLD='\033[0;1m'
|
||||
|
||||
# check if JFrog CLI is already installed
|
||||
if command -v jf >/dev/null 2>&1; then
|
||||
echo "✅ JFrog CLI is already installed, skipping installation."
|
||||
else
|
||||
echo "📦 Installing JFrog CLI..."
|
||||
# Install the JFrog CLI.
|
||||
curl -fL https://install-cli.jfrog.io | sudo sh
|
||||
sudo chmod 755 /usr/local/bin/jf
|
||||
fi
|
||||
|
||||
# The jf CLI checks $CI when determining whether to use interactive
|
||||
# flows.
|
||||
export CI=true
|
||||
# Authenticate with the JFrog CLI.
|
||||
jf c rm 0 || true
|
||||
echo "${ARTIFACTORY_ACCESS_TOKEN}" | jf c add --access-token-stdin --url "${JFROG_URL}" 0
|
||||
|
||||
if [ -z "${REPOSITORY_NPM}" ]; then
|
||||
echo "🤔 REPOSITORY_NPM is not set, skipping npm configuration."
|
||||
else
|
||||
# check if npm is installed and configure it to use the Artifactory "npm" repository.
|
||||
if command -v npm >/dev/null 2>&1; then
|
||||
echo "📦 Configuring npm..."
|
||||
jf npmc --global --repo-resolve "${REPOSITORY_NPM}"
|
||||
fi
|
||||
cat <<EOF >~/.npmrc
|
||||
email = ${ARTIFACTORY_EMAIL}
|
||||
registry = ${JFROG_URL}/artifactory/api/npm/${REPOSITORY_NPM}
|
||||
EOF
|
||||
jf rt curl /api/npm/auth >>~/.npmrc
|
||||
fi
|
||||
|
||||
# Configure the `pip` to use the Artifactory "python" repository.
|
||||
if [ -z "${REPOSITORY_PYPI}" ]; then
|
||||
echo "🤔 REPOSITORY_PYPI is not set, skipping pip configuration."
|
||||
else
|
||||
echo "🐍 Configuring pip..."
|
||||
jf pipc --global --repo-resolve "${REPOSITORY_PYPI}"
|
||||
mkdir -p ~/.pip
|
||||
cat <<EOF >~/.pip/pip.conf
|
||||
[global]
|
||||
index-url = https://${ARTIFACTORY_USERNAME}:${ARTIFACTORY_ACCESS_TOKEN}@${JFROG_HOST}/artifactory/api/pypi/${REPOSITORY_PYPI}/simple
|
||||
EOF
|
||||
fi
|
||||
|
||||
# Set GOPROXY to use the Artifactory "go" repository.
|
||||
if [ -z "${REPOSITORY_GO}" ]; then
|
||||
echo "🤔 REPOSITORY_GO is not set, skipping go configuration."
|
||||
else
|
||||
echo "🐹 Configuring go..."
|
||||
jf go-config --global --repo-resolve "${REPOSITORY_GO}"
|
||||
export GOPROXY="https://${ARTIFACTORY_USERNAME}:${ARTIFACTORY_ACCESS_TOKEN}@${JFROG_HOST}/artifactory/api/go/${REPOSITORY_GO}"
|
||||
fi
|
||||
echo "🥳 Configuration complete!"
|
||||
Loading…
Reference in New Issue