Skip to content

docs: explain DHI OIDC access and Scout compatibility exceptions (DXT-1716) - #26383

Open
brianru wants to merge 5 commits into
docker:mainfrom
brianru:fix/dxt-1716-oidc-compatibility-docs
Open

brianru wants to merge 5 commits into
docker:mainfrom
brianru:fix/dxt-1716-oidc-compatibility-docs

Conversation

@brianru

@brianru brianru commented Oct 19, 2026 •

Copy link
Copy Markdown

Description

Document how to use Docker-issued OIDC access tokens for DHI image and attestation reads, and explain the destination-repository permissions required for customization reads and changes.

The GitHub Actions example reads a mirrored Docker Hub image and its private Scout attestations. Separate instructions cover free images served through dhi.io. The permissions reference explains additive grants, pull-only public access, and the distinction between registry push and customization permissions.

Compatibility limitations are documented once in the permissions reference, rather than repeated throughout the tutorials. This section identifies authenticated free-DHI access and names the Scout GraphQL operations that remain available independently of image grants: listEnabledRepos, listBlockedRepos, and ingestImagePackages. It explains their organization boundary and distinguishes those operations from repository-filtered queries, customization changes, and registry push.

This replaces the closed draft #26306. The corrected Packit, Jynx, Regirock policy, and dhi-proxy releases have been deployed to production. Rollout health and ordinary traffic were verified; the full production OIDC smoke remains unverified.

Related issues or tickets

DXT-1716, previous draft #26306, Packit #1565, Jynx #1616, rego-policy #174, and dhi-proxy #131.

Reviews

Rebased onto main at f90928eb2040c4638e188868a612fd47e6a061a4; range-diff confirms all four patches are unchanged. Scoped rumdl and Vale 3.17.0 checks pass across all five changed Markdown files, with no new warnings. Existing warnings and one suggestion are outside changed lines. git diff --check passes. No full Hugo build was run; preview CI will run on the pushed head.

The named Scout compatibility behavior is covered by the Packit data-ingestion and Jynx repository-inventory regression tests. Independent correctness review checked the preceding draft against source; the explicit compatibility documentation has not received a separate independent review.

  • Technical review
  • Editorial review
  • Product review

@netlify

netlify Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 8d809d4
🔍 Latest deploy log https://app.netlify.com/projects/docsdocker/deploys/6ae37303bca5fe148d8c7ea7
😎 Deploy Preview https://deploy-preview-26383--docsdocker.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.

Comment thread content/manuals/dhi/how-to/use.md Outdated
Comment thread content/manuals/dhi/how-to/verify.md Outdated
Comment thread content/manuals/security/authentication/oidc-connections/rulesets-claims.md Outdated
Comment thread content/manuals/security/authentication/oidc-connections/rulesets-claims.md Outdated
Comment thread content/manuals/security/authentication/oidc-connections/rulesets-claims.md Outdated
@brianru
brianru force-pushed the fix/dxt-1716-oidc-compatibility-docs branch from 7bb8506 to 6902318 Compare October 26, 2026 12:32
@brianru
brianru force-pushed the fix/dxt-1716-oidc-compatibility-docs branch from 6902318 to 7b241e7 Compare October 29, 2026 01:36
@brianru
brianru marked this pull request as ready for review October 29, 2026 13:45
@craig-osterhout craig-osterhout added the status/review Pull requests that are ready for review label Oct 29, 2026

@craig-osterhout craig-osterhout left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @brianru.

For the additions to the DHI manual, one suggestion about content location/framing, and the rest lgtm.

Comment thread content/manuals/dhi/how-to/verify.md Outdated
>
> Run `docker login dhi.io` to authenticate.
## Authenticate with OIDC in GitHub Actions

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section seems misplaced because most of its content and framing focuses on OIDC authentication. As written, I suggest moving it to use.md under Use a DHI in CI/CD pipelines.

If you want to keep it in verify.md, consider reframing it as Verify DHI attestations with OIDC, and open with a small intro about verification while treating OIDC as the authentication method. Then, add an actual attestation verification command to the workflow.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. Moved the OIDC section into use.md under “Use a DHI in CI/CD pipelines,” retained a short authentication link in verify.md, and updated the customization and OIDC setup references. The workflow remains focused on authentication and attestation discovery. Addressed in 8d809d4.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/dhi area/security status/review Pull requests that are ready for review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants