Skip to content

Commit 39e3ea1

Browse files
authored
Add GAR section to JS global config docs (#3299)
[ ] Check if this is a typo or other quick fix and ignore the rest :) ## Type of change Update to JS global config docs ### What should this PR do? Add guidance for setting up GAR as a repo manager ### Why are we making this change? Customer reported issue. Thread here: https://chainguard-dev.slack.com/archives/C085187D8RE/p1777996617471599 ### What are the acceptance criteria? Content should be clear and accurate ### How should this PR be tested? View deploy preview --------- Signed-off-by: s-stumbo <sally.stumbo@chainguard.dev> Signed-off-by: s-stumbo <100295939+s-stumbo@users.noreply.github.com>
1 parent a5d07d2 commit 39e3ea1

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

content/chainguard/libraries/javascript/global-configuration.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,8 @@ repository:
181181
with chainctl](/chainguard/libraries/access/).
182182
1. Click **Create Remote Repository**.
183183

184+
185+
184186
Create a virtual repository, or add the remote repository to an existing
185187
virtual repository used for npm packages. A virtual repository may also include private npm packages or
186188
additional upstream sources, depending on your configuration.
@@ -225,7 +227,7 @@ To prevent this:
225227

226228
After creating and configuring the `javascript-chainguard` remote repository, validate that Artifactory is successfully proxying through to Chainguard before proceeding. Because Artifactory falls back to the upstream npm registry when a connection to a remote repository fails, a misconfigured repository may silently resolve packages from npm rather than Chainguard — and the build will succeed without any visible error.
227229

228-
Common sources of misconfiguration include invalid or expired credentials, an incorrect or incomplete URL, and mosconfigured [settings in the Advanced tab](#advanced-settings-for-redirect-handling). The Artifactory **Test** button on the repository configuration screen is not a reliable indicator; it may fail for a correctly configured repository, and may pass for an incorrectly configured one. Instead, use the following steps to verify that fetching an artifact through Artifactory produces the same checksum as fetching it directly from `libraries.cgr.dev`.
230+
Common sources of misconfiguration include invalid or expired credentials, an incorrect or incomplete URL, and misconfigured [settings in the Advanced tab](#advanced-settings-for-redirect-handling). The Artifactory **Test** button on the repository configuration screen is not a reliable indicator; it may fail for a correctly configured repository, and may pass for an incorrectly configured one. Instead, use the following steps to verify that fetching an artifact through Artifactory produces the same checksum as fetching it directly from `libraries.cgr.dev`.
229231

230232
1. Fetch the artifact directly from Chainguard and compute its checksum, using the same credentials you configured in Artifactory. This example uses `picocolors-1.1.1`. You can substitute any artifact you know to be available.
231233

@@ -360,3 +362,11 @@ Use the URL of the repository group, such as
360362
configuration](/chainguard/libraries/javascript/build-configuration/) and build a
361363
first test project. In a working setup the `javascript-chainguard` proxy
362364
repository contains all libraries retrieved from Chainguard.
365+
366+
## Google Artifact Registry
367+
368+
Google Artifact Registry (GAR) is not an officially supported repository manager for Chainguard Libraries for JavaScript. However, it has been shown to work with the following configuration.
369+
370+
Configure two GAR remote repositories, with upstream validation disabled on the second:
371+
* First remote repository: `javascript-chainguard` pointing to `https://libraries.cgr.dev/javascript` with upstream validation enabled
372+
* Second remote repository: `javascript-chainguard-upstream` pointing to `https://libraries.cgr.dev/javascript-upstream` with upstream validation disabled.

0 commit comments

Comments
 (0)