Skip to content

docs: clarify docker artifact-type registry requirement#183

Merged
AlexKantor87 merged 2 commits intomainfrom
docs/repo-digest-unavailable
Apr 28, 2026
Merged

docs: clarify docker artifact-type registry requirement#183
AlexKantor87 merged 2 commits intomainfrom
docs/repo-digest-unavailable

Conversation

@AlexKantor87
Copy link
Copy Markdown
Contributor

Summary

A customer hit Error: repo digest unavailable for the image, has it been pushed to or pulled from a registry? after running kosli attest artifact ... --artifact-type=docker in GitHub Actions, where the image had been built but never pushed. The same command appeared to work locally (because the image had been pushed at some earlier point and the digest was cached on the machine).

The registry requirement for --artifact-type=docker is currently implicit. The closest the docs come is the line "for docker images that are pulled on the machine" on the Artifacts page, which is easy to read past after a fresh docker build. The actual constraint, that the image must have a registry-derived digest, is only stated in the error message itself.

This PR makes that constraint explicit:

  • Adds a <Warning> callout to getting_started/artifacts.md immediately after the artifact-type bullet list, covering the constraint and four alternatives (push, oci, dir, --fingerprint).
  • Adds troubleshooting/repo_digest_unavailable.md so the error message itself is googleable and gives users a clear set of fixes.
  • Adds the troubleshooting page to config/navigation.json.

I did not edit client_reference/kosli_attest_artifact.md because it is regenerated by kosli docs --mintlify from the CLI source. A follow-up against kosli-dev/cli could improve the inline help text for --artifact-type to mention the registry requirement; happy to do that as a separate PR if useful.

mint broken-links errors out on a pre-existing parse issue in helm/k8s_reporter.md:161 that is unrelated to this change, so I have not run it cleanly. Cross-references between the new troubleshooting page, the navigation entry, and the link from the artifacts page have been verified manually.

Test plan

  • Render the docs locally and confirm the new <Warning> callout displays on /getting_started/artifacts
  • Confirm the new troubleshooting page renders at /troubleshooting/repo_digest_unavailable
  • Confirm the troubleshooting page appears in the sidebar under "Troubleshooting"
  • Confirm the link from artifacts.md to the troubleshooting page resolves

🤖 Generated with Claude Code

Customer hit "repo digest unavailable" in CI after kosli attest artifact
with --artifact-type=docker. The constraint that the image must have been
pushed to or pulled from a registry was only implicit in the existing copy.
Add a Warning callout on the artifacts page covering the constraint and
alternatives, plus a dedicated troubleshooting page for the error message.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@AlexKantor87 AlexKantor87 requested a review from a team as a code owner April 28, 2026 13:40
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented Apr 28, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
kosli 🟢 Ready View Preview Apr 28, 2026, 1:42 PM

Source-dir fingerprinting only works as an end-to-end identity if the
runtime side also fingerprints the source dir. Standard Kosli runtime
reporters (K8s, ECS, Lambda, S3, etc.) fingerprint the running image,
so a dir-fingerprinted attestation never links to runtime — the
attested artifact and the running artifact end up as separate rows in
Kosli with no provenance trail between them.

Push and oci are the only safe answers for users running standard
docker workflows hitting this error. Drop dir from the alternatives in
both the artifacts page Warning and the troubleshooting page.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@AlexKantor87 AlexKantor87 merged commit a27e3b1 into main Apr 28, 2026
4 checks passed
@AlexKantor87 AlexKantor87 deleted the docs/repo-digest-unavailable branch April 28, 2026 15:50
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