← Back to issue list

docs: dedicated doc for uploading of OCI images

View original Github issue

Metadata

Project
charmcraft
Number
#2428
Type
issue
State
open
Author
sed-i
Labels
Status: Triaged Type: Documentation Type: Enhancement
Created
Updated
Closed

Current evaluation

Request for a dedicated doc on uploading OCI images as charm resources, plus two reported gaps: skopeo digest method failing with 'Unknown OCI image reference' and multi-arch images listing only amd64. Triaged; maintainer suggested a 'rock as resource' doc; reporter noted --help text conflicts with docs.

Suggested action: keep open

Reason: The issue is triaged (Status: Triaged, Type: Documentation/Enhancement) and a maintainer (lengau) gave concrete direction: start with a 'How to upload a rock as a resource' doc, noting multi-arch OCI upload is complex. The underlying multi-arch bug appears addressed by merged PR #2037 ('fix: upload all images (not just current arch) with skopeo'), but the dedicated doc and the --help/docs inconsistency (help says 'exclude sha256:' while docs allow long-form digests) remain open, with the reporter's latest comment only 73 days ago.

Impact: 40 Quick Win: 22.0 Staleness: 35 Complexity: 45 Confidence: 70 Support Request: 30

Issue body

*Please describe the question or issue you're facing with "Manage resources - Charmcraft 3.5.3 documentation".* Trying to upload an oci image, I encountered two issues which I didn't find reference of in the docs: 1. The skopeo method (`DIGEST=$(skopeo inspect $IMAGE | jq -r '.Digest')`) for ghcr returned `Unknown OCI image reference`. 2. With the docker method (`IMAGE_ID=$(docker images -q $IMAGE)`) the upload succeeded, but `resource-revisions` lists amd64 only under platform, even though the tag is multiarch. It would be handy to have a dedicated doc for uploading OCI images. --- *Reported from: https://documentation.ubuntu.com/charmcraft/stable/howto/manage-resources/*

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.8-27b
Impact: 40
Quick Win: 22.0
Staleness: 35
Complexity: 45
Confidence: 70
Support Request: 30
keep open Request for a dedicated doc on uploading OCI images as charm resources, plus two reported gaps: skopeo digest method failing with 'Unknown OCI image reference' and multi-arch images listing only amd64. Triaged; maintainer suggested a 'rock as resource' doc; reporter noted --help text conflicts with docs.
qwen/qwen3.6-35b-a3b
Staleness: 45
Complexity: 40
Confidence: 90
Support Request: 20
keep open Request for dedicated documentation on uploading OCI images. Triaged and under discussion, with maintainer guidance on scope and a recent contributor note about a help/doc mismatch.
qwen3.6-35b-a3b-mtp-q6
Staleness: 15
Complexity: 25
Confidence: 90
Support Request: 15
keep open Request for dedicated documentation on uploading OCI images to Charmcraft resources, addressing skopeo and docker method limitations. Currently triaged, under discussion with maintainer suggestions for scope and workflow.
qwen3.6-35b-a3b-mtp-q6
Staleness: 45
Complexity: 25
Confidence: 85
Support Request: 10
keep open Request for dedicated documentation on uploading OCI images, including multi-arch workflows. Currently triaged as an enhancement, with maintainer feedback on scope and a recent contributor note about CLI help text discrepancies.
qwen3.6-35b-a3b-mtp-q6
Staleness: 75
Complexity: 40
Confidence: 90
Support Request: 20
keep open Request for documentation on uploading OCI images and multi-arch rocks to Charmcraft. Addresses tool errors and complex multi-architecture handling. Triaged and under discussion, currently pending implementation.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/charmcraft#1696 (confidence 80%)

    Merged PR 'feat: upload OCI image resources with skopeo' introduced the skopeo-based upload path that the docs request covers.

  • Likely Fixed By: canonical/charmcraft#2037 (confidence 75%)

    Merged PR 'fix: upload all images (not just current arch) with skopeo' resolves the multi-arch platform listing reported in point 2.

Related issues

Issue Project State Summary Similarity
#1952 Fix docs and help messages about OCI image uploads charmcraft open Docs and help messages for OCI image uploads in Charmcraft 3 are slightly wrong per a discourse thread. Filed by maintainer lengau, no labels or assignee, only an auto Jira-sync comment. Docs still reference dockerd while code now uses skopeo.
75%
#1685 Multi-arch OCI image incorrectly uploaded to Charmhub registry charmcraft closed Fixed in Charmcraft 2.7. The upload-resource command now correctly pushes full multi-arch OCI images to Charmhub instead of only the host architecture layer. Future versions may require explicit local Docker daemon paths.
70%