Skip to content

docs(eng-11208): Adds format & upstream documentation for Alpine and Wolfi#375

Open
poconnor-cloud wants to merge 6 commits intomainfrom
poc_ENG-11208_alpine_upstream_docs
Open

docs(eng-11208): Adds format & upstream documentation for Alpine and Wolfi#375
poconnor-cloud wants to merge 6 commits intomainfrom
poc_ENG-11208_alpine_upstream_docs

Conversation

@poconnor-cloud
Copy link
Copy Markdown
Contributor

@poconnor-cloud poconnor-cloud commented Mar 30, 2026

What's Changed

Updated and Added to our Alpine Format Documentation:

  • Additional detail on how to handle upload/download of packages, with wolfi examples
  • Added Upstream Proxying guidelines for Alpine / WOLFI
  • Tested and verified examples, including setup script, basic (token, api_key) and cli authentication.
  • Updated Index file

co-authored by @apoclyps

relates to:

@vercel
Copy link
Copy Markdown

vercel bot commented Mar 30, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
cloudsmith-docs Ready Ready Preview, Comment Apr 1, 2026 2:08pm

Request Review

@poconnor-cloud
Copy link
Copy Markdown
Contributor Author

TODO -

  • Add details on how to configure Upstream via Web UI (Old and New)
  • Add some images and screenshots

Copy link
Copy Markdown
Contributor

@apoclyps apoclyps left a comment

Choose a reason for hiding this comment

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

As part of the documentation, it's worth verifying that each of the mechanisms being documented works as expected e.g. adding a distribution, the auth mechanisms, etc. The ticket can be used to track that these work using the input + output to avoid adding a bunch of unnecessary context to the PR.

@apoclyps apoclyps added feature: upstreams format: alpine documentation Improvements or additions to documentation labels Mar 30, 2026
@apoclyps apoclyps changed the title Alpine & WOLFI Upstream docs docs(eng-11208): Adds format & upstream documentation for Alpine and Wolfi Mar 30, 2026
@apoclyps apoclyps force-pushed the poc_ENG-11208_alpine_upstream_docs branch from 03520ea to 81963df Compare March 31, 2026 09:16
@apoclyps apoclyps force-pushed the poc_ENG-11208_alpine_upstream_docs branch from 81963df to 0a9bfa3 Compare March 31, 2026 09:19
@apoclyps apoclyps force-pushed the poc_ENG-11208_alpine_upstream_docs branch from 0a9bfa3 to 8323cc1 Compare March 31, 2026 09:47
@apoclyps apoclyps force-pushed the poc_ENG-11208_alpine_upstream_docs branch from 8323cc1 to 5f9c30d Compare March 31, 2026 09:57
@apoclyps apoclyps self-assigned this Mar 31, 2026
@apoclyps apoclyps force-pushed the poc_ENG-11208_alpine_upstream_docs branch from 5f9c30d to 5da85fe Compare March 31, 2026 10:18
@apoclyps apoclyps force-pushed the poc_ENG-11208_alpine_upstream_docs branch from 5da85fe to 8175392 Compare March 31, 2026 10:19
@poconnor-cloud poconnor-cloud marked this pull request as ready for review March 31, 2026 11:24
Copilot AI review requested due to automatic review settings March 31, 2026 11:24
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates Cloudsmith documentation to clarify Alpine/Wolfi APK usage and adds guidance for configuring Alpine/Wolfi upstream proxying and caching.

Changes:

  • Adds Alpine upstream creation guidance and updates the upstreams index to include Alpine.
  • Expands Alpine format docs to cover Wolfi, including upload/install instructions and upstream proxying/caching guidance.
  • Refactors portions of existing upstream documentation for generic upstream fields and notes.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 8 comments.

File Description
src/content/repositories/upstreams/index.mdx Adds Alpine to supported upstream formats and documents how to configure an Alpine/Wolfi upstream.
src/content/formats/alpine-repository.mdx Reworks Alpine format docs to include Wolfi details, updated upload/install flows, and upstream proxying/caching instructions.
Comments suppressed due to low confidence (1)

src/content/formats/alpine-repository.mdx:255

  • The removal instructions delete /etc/apk/keys/REPOSITORY@cloudsmith-FINGERPRINT.rsa.pub, but earlier setup instructions create /etc/apk/keys/REPOSITORY@OWNER-FINGERPRINT.rsa.pub. This mismatch means the documented cleanup step may not actually remove the installed key.

Remove the cloudsmith repository line, save then execute:

rm -f /etc/apk/keys/REPOSITORY@cloudsmith-FINGERPRINT.rsa.pub
apk update

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@apoclyps
Copy link
Copy Markdown
Contributor

apoclyps commented Mar 31, 2026

Looks good to me 👍

I paired on part of this and pushed commits so unable to give an approval. Some changes to note:

  • username:password as an auth mechanism isn't supported. It's not in the classic or new ui contextual docs (nor does it work when provided) so it's been removed here
  • CLI changes were manually tested for alpine + wolfi

Copy link
Copy Markdown
Contributor

@ertzL ertzL left a comment

Choose a reason for hiding this comment

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

I've just left too comments on removing the EA banner & adding a screenshot for configuring the upstream - but other than that LGTM!

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

Labels

documentation Improvements or additions to documentation feature: upstreams format: alpine

Development

Successfully merging this pull request may close these issues.

4 participants