← 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

Triaged OCI upload documentation remains incomplete: guidance omits transport/archive forms and multi-architecture handling, while CLI help conflicts with the docs about sha256 prefixes.

Suggested action: keep open

Reason: Maintainer @lengau acknowledged the request, proposed a first how-to for uploading a rock, and identified multi-architecture uploads as the difficult part. The current guide only mentions sha256 digests or local image IDs, while the implementation and spread tests also support transport strings and OCI/Docker archives; moreover, the latest comment identifies a concrete contradiction in --image help text.

Evaluated by: mr-cal-bot

Impact: 44 Quick Win: 16 Complexity: 53 Confidence: 94 Actionability: 76

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
stealth/space-bunny-alpha
Impact: 44
Quick Win: 16
Complexity: 53
Confidence: 94
Actionability: 76
keep open Triaged OCI upload documentation remains incomplete: guidance omits transport/archive forms and multi-architecture handling, while CLI help conflicts with the docs about sha256 prefixes.
qwen/qwen3.6-35b-a3b
Impact: 30
Quick Win: 22
Complexity: 10
Confidence: 90
Actionability: 80
keep open Documentation enhancement request for uploading OCI images, addressing skopeo errors and multi-arch platform listing. Currently triaged and under discussion.
qwen/qwen3.8-27b
Impact: 40
Quick Win: 22
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.

Update history

No update history recorded yet.

Related work

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

    Merged Skopeo-based OCI resource upload support, with related remote-image and archive tests, but did not supply the requested dedicated guidance.

Related issues

Issue Project State Summary Similarity
#1952 Fix docs and help messages about OCI image uploads charmcraft open Docs/help for `upload-resource --image` are outdated: manage-resources.rst and the CLI help still claim only sha256 digests or local image IDs are accepted, while the code now supports OCI archives, directories, and any skopeo transport string.
75%