coder · matifali · Mar 28, 2024 · Mar 18, 2024 · Mar 18, 2024 · Mar 18, 2024
diff --git a/docs/guides/xray-integration.md b/docs/guides/xray-integration.md
@@ -0,0 +1,72 @@
+# Integrating JFrog Xray with Coder Kubernetes Workspaces
+
+<div>
+  <a href="https://github.com/matifali" style="text-decoration: none; color: inherit;">
+    <span style="vertical-align:middle;">Muhammad Atif Ali</span>
+    <img src="https://github.com/matifali.png" width="24px" height="24px" style="vertical-align:middle; margin: 0px;"/>
+  </a>
+</div>
+March 17, 2024
+
+---
+
+This guide will walk you through the process of adding
+[JFrog Xray](https://jfrog.com/xray/) integration to Coder Kubernetes workspaces
+using Coder's [JFrog Xray Integration](github.com/coder/coder-xray).
+
+## Prerequisites
+
+- A self-hosted JFrog Platform instance.
+- Kubernetes workspaces running on Coder.
+
+## Deploying the Coder Xray Integration
+
+1. Create a JFrog Platform
+   [Access Token](https://jfrog.com/help/r/jfrog-platform-administration-documentation/access-tokens)
+   with a user that has the read
+   [permission](https://jfrog.com/help/r/jfrog-platform-administration-documentation/permissions)
+   for the repositories you want to scan.
+2. Create a Coder
+   [token](https://coder.com/docs/v2/latest/cli/tokens_create#tokens-create)
+   with a user that has the
+   [`owner`](https://coder.com/docs/v2/latest/admin/users#roles) role.
+3. Create kubernetes secrets for the JFrog Xray and Coder tokens.
+
+```bash
+kubectl create secret generic coder-token --from-literal=coder-token='<token>'
+kubectl create secret generic jfrog-token --from-literal=user='<user>' --from-literal=token='<token>'
+```
+
+4. Deploy the Coder Xray integration.
+
+```bash
+helm repo add coder-xray https://helm.coder.com/coder-xray
+
+helm upgrade --install coder-xray coder-xray/coder-xray \
+  --namespace coder-xray \
+  --create-namespace \
+  --set namespace="<CODER_WORKSPACES_NAMESPACE>" \ # Replace with your Coder workspaces namespace
+  --set coder.url="https://<your-coder-url>" \
+  --set coder.secretName="coder-token" \
+  --set artifactory.url="https://<your-artifactory-url>" \
+  --set artifactory.secretName="jfrog-token"
+```
+
+### Updating the Coder template
+
+[`coder-xray`](https://github.com/coder/coder-xray) will scan all kubernetes
+workspaces in the specified namespace. It depends on the `image` available in
+Artifactory and indexed by Xray. To ensure that the images are available in
+Artifactory, update the Coder template to use the Artifactory registry.
+
+```tf
+image = "<ARTIFACTORY_URL>/<REPO>/<IMAGE>:<TAG>"
+```
+
+> **Note**: To authenticate with the Artifactory registry, you may need to
+> create a
+> [Docker config](https://jfrog.com/artifactory/docs/docker/#docker-login) and
+> use it in the `imagePullSecrets` field of the kubernetes pod. See this
+> [guide](./image-pull-secret.md) for more information.
+
+![Coder Xray Integration](../images/guides/xray-integration/example.png)
diff --git a/docs/images/guides/xray-integration/example.png b/docs/images/guides/xray-integration/example.png
diff --git a/docs/manifest.json b/docs/manifest.json
@@ -1099,6 +1099,11 @@
           "title": "Azure Federation",
           "description": "Federating Coder to Azure",
           "path": "./guides/azure-federation.md"
+        },
+        {
+          "title": "Scanning Coder Workspaces with Xray",
+          "description": "Integrate Coder with JFrog Xray",
+          "path": "./guides/xray-integration.md"
         }
       ]
     }