Skip to content

Clarify Tag History API token retrieval for private images (DOCS-136) - #3797

Merged
matthewhelmke merged 1 commit into
chainguard-dev:mainfrom
matthewhelmke:matthewhelmke/docs-136-clarify-api-token-retrieval
Aug 18, 2026
Merged

Clarify Tag History API token retrieval for private images (DOCS-136)#3797
matthewhelmke merged 1 commit into
chainguard-dev:mainfrom
matthewhelmke:matthewhelmke/docs-136-clarify-api-token-retrieval

Conversation

@matthewhelmke

@matthewhelmke matthewhelmke commented Aug 18, 2026

Copy link
Copy Markdown
Collaborator

What this changes

Adds chainctl auth token --audience cgr.dev as the direct way to get a Tag History API token for private images, and explains why the --audience cgr.dev flag is required. Keeps the Docker credential-helper and crane methods as alternatives. Also fixes a missing closing quote in the existing crane example.

Why

Customer feedback (DOCS-136): getting an API token "feels weird" — the docs route you through configure-docker and the Docker credential helper just to call the API, and a plain chainctl auth token doesn't work. The token only needs the cgr.dev audience; the credential-helper step isn't required.

How this was tested

Verified end-to-end on a private, self-managed GitLab test instance (local k3s), calling a private Tag History API URL with an assumed Chainguard identity:

Token Tag History API
chainctl auth token --audience cgr.dev HTTP 200
docker-credential-cgr get HTTP 200
chainctl auth token (default audience) HTTP 403

Tested with chainctl 0.2.333 against the chainguard.edu org. The guidance is independent of which images GitLab itself runs on.

Refs DOCS-136.


Created in collaboration with Claude Code running Opus 4.8 on 2026-08-18.

Lead with 'chainctl auth token --audience cgr.dev' as the direct way to
get a registry-scoped token, and explain the --audience requirement (a
default-audience token gets a 403). Keep the Docker credential helper and
crane methods as alternatives. Fix a missing closing quote in the crane
example.

Refs DOCS-136.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@netlify

netlify Bot commented Aug 18, 2026

Copy link
Copy Markdown

Deploy Preview for ornate-narwhal-088216 ready!

Name Link
🔨 Latest commit f130853
🔍 Latest deploy log https://app.netlify.com/projects/ornate-narwhal-088216/deploys/6a84935073e8d300087f2ac2
😎 Deploy Preview https://deploy-preview-3797--ornate-narwhal-088216.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@matthewhelmke
matthewhelmke marked this pull request as ready for review August 18, 2026 17:34
@matthewhelmke
matthewhelmke requested a review from a team as a code owner August 18, 2026 17:34
@matthewhelmke
matthewhelmke merged commit 088da6e into chainguard-dev:main Aug 18, 2026
7 checks passed
@matthewhelmke
matthewhelmke deleted the matthewhelmke/docs-136-clarify-api-token-retrieval branch August 18, 2026 19:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants