Skip to content

fix: Modernize READMEs#303

Merged
dragosgheorghioiu merged 2 commits intomainfrom
nurof3n/fix/modern-readmes
Apr 20, 2026
Merged

fix: Modernize READMEs#303
dragosgheorghioiu merged 2 commits intomainfrom
nurof3n/fix/modern-readmes

Conversation

@nurof3n
Copy link
Copy Markdown
Contributor

@nurof3n nurof3n commented Apr 17, 2026

@nurof3n nurof3n force-pushed the nurof3n/fix/modern-readmes branch from ccde995 to c7561c1 Compare April 17, 2026 17:27
Signed-off-by: Alex-Andrei Cioc <andrei.cioc@unikraft.io>
@nurof3n nurof3n force-pushed the nurof3n/fix/modern-readmes branch from c7561c1 to be993e8 Compare April 17, 2026 17:38
Comment thread mongodb/README.md Outdated
Comment thread mongodb/README.md Outdated
Comment thread mongodb/README.md Outdated
@nurof3n nurof3n force-pushed the nurof3n/fix/modern-readmes branch 2 times, most recently from 389b012 to ab170cf Compare April 20, 2026 08:55
Comment thread mongodb/README.md Outdated
Comment thread postgres/Kraftfile
@danielvallance
Copy link
Copy Markdown
Contributor

Also requesting a review from Copilot as it is a lot to read

@nurof3n nurof3n force-pushed the nurof3n/fix/modern-readmes branch 2 times, most recently from 2b7726a to cafe612 Compare April 20, 2026 09:12
Copy link
Copy Markdown

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

This PR modernizes the repository’s example READMEs and deployment metadata to align with current Unikraft CLI/kraft usage, clarify BuildKit requirements, and update scale-to-zero guidance across examples.

Changes:

  • Update many READMEs with standardized “Install the CLI + BuildKit builder” prerequisites and refreshed deploy/run commands and sample outputs.
  • Remove scale-to-zero-related labels: (and some name: fields) from numerous Kraftfiles, shifting scale-to-zero configuration into CLI flags in docs/workflows.
  • Add a Redis 7.2 example rootfs configuration (Dockerfile + redis.conf + Kraftfile) and update select CI workflows’ scale-to-zero settings.

Reviewed changes

Copilot reviewed 158 out of 160 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
wordpress-compose/README.md Update prerequisites to include BuildKit and new CLI docs links.
wordpress-all-in-one/README.md Refresh deploy/run commands, scale-to-zero flags, and sample outputs; add instance list/delete section.
wordpress-all-in-one/Kraftfile Remove name and scale-to-zero labels.
wazero-import-go/README.md Update prerequisites, deploy commands, and sample outputs; add instance list output.
wazero-import-go/Kraftfile Remove scale-to-zero labels.
tyk/README.md Update prerequisites; remove lengthy compose output example.
tyk/Kraftfile Remove scale-to-zero labels.
traefik/Kraftfile Remove scale-to-zero labels.
spin-wagi-http/Kraftfile Remove scale-to-zero labels.
skipper0.18/README.md Update prerequisites, deploy commands, and sample outputs.
skipper0.18/Kraftfile Remove scale-to-zero labels.
ruby3.2-rails/Kraftfile Remove scale-to-zero labels.
redis7.2/fs/etc/redis/redis.conf Add Redis configuration for the new Redis 7.2 example.
redis7.2/Kraftfile Add Kraftfile for Redis 7.2 example (rootfs + cmd).
redis7.2/Dockerfile Add minimal scratch-based rootfs build for Redis 7.2.
python-playwright-chromium/Kraftfile Remove scale-to-zero labels.
postgres/README.md Update prerequisites and sample outputs; adjust memory units in kraft commands.
postgres/Kraftfile Remove name and scale-to-zero labels.
opentelemetry-collector/README.md Update prerequisites, deploy commands, and outputs; document service behavior.
opentelemetry-collector/Kraftfile Remove scale-to-zero labels.
novnc-browser/README.md Update prerequisites, memory unit, and sample outputs.
node24-karaoke/README.md Update prerequisites, deploy commands, and sample outputs.
node24-karaoke/Kraftfile Remove scale-to-zero labels.
node21-websocket/Kraftfile Remove scale-to-zero labels.
node18-wingsio/Kraftfile Remove name and scale-to-zero labels.
node18-agario/Kraftfile Remove name and scale-to-zero labels.
node-playwright-webkit/Kraftfile Remove scale-to-zero labels.
httpserver-python3.12-FastAPI-0.121.3/.gitignore Remove ignore rules (file deleted).
httpserver-python3.12-FastAPI-0.121.3/.dockerignore Remove ignore rules (file deleted).
httpserver-prisma-expressjs4.19-node18/Kraftfile Remove name and scale-to-zero labels.
httpserver-php8.2/README.md Update prerequisites, deploy commands, and sample outputs.
httpserver-php8.2/Kraftfile Remove scale-to-zero labels.
httpserver-perl5.42/README.md Update prerequisites, deploy commands, and sample outputs.
httpserver-perl5.42/Kraftfile Normalize file and remove scale-to-zero labels while keeping cmd/rootfs.
httpserver-node25/README.md Update prerequisites, deploy commands, and sample outputs.
httpserver-node25/Kraftfile Remove scale-to-zero labels.
httpserver-node21-sveltekit/README.md Update prerequisites, deploy commands, and sample outputs.
httpserver-node21-sveltekit/Kraftfile Remove scale-to-zero labels.
httpserver-node21-solid-start/README.md Update prerequisites, deploy commands, and sample outputs.
httpserver-node21-solid-start/Kraftfile Remove scale-to-zero labels.
httpserver-node21-remix/README.md Update prerequisites, deploy commands, and sample outputs.
httpserver-node21-remix/Kraftfile Remove scale-to-zero labels.
httpserver-node21-nextjs/Kraftfile Remove scale-to-zero labels.
httpserver-node-vite-vanilla/Kraftfile Remove name and scale-to-zero labels.
httpserver-node-vite-ssr-vanilla/Kraftfile Remove name and scale-to-zero labels.
httpserver-node-express-puppeteer/Kraftfile Remove scale-to-zero labels.
httpserver-nginx-vite-vanilla/Kraftfile Remove name and scale-to-zero labels.
httpserver-lua5.1/README.md Update prerequisites, deploy commands, and sample outputs.
httpserver-lua5.1/Kraftfile Remove scale-to-zero labels.
httpserver-java21/README.md Update prerequisites, deploy commands, and sample outputs.
httpserver-java21/Kraftfile Remove scale-to-zero labels and stale comment.
httpserver-java17-springboot3.5.x/README.md Update prerequisites, deploy commands, and sample outputs.
httpserver-java17-springboot3.5.x/Kraftfile Remove scale-to-zero labels.
httpserver-java17-spring-petclinic/Kraftfile Remove scale-to-zero labels.
httpserver-gpp13.2/README.md Update prerequisites, deploy commands, and sample outputs.
httpserver-gpp13.2/Kraftfile Remove scale-to-zero labels.
httpserver-go1.22-redis/README.md Update prerequisites to include BuildKit and new CLI docs links.
httpserver-go1.22-redis/Kraftfile Remove scale-to-zero labels.
httpserver-go1.21/README.md Update prerequisites, deploy commands, and sample outputs.
httpserver-go1.21/Kraftfile Remove scale-to-zero labels.
httpserver-gcc13.2/README.md Update prerequisites, deploy commands, and sample outputs.
httpserver-gcc13.2/Kraftfile Remove scale-to-zero labels.
httpserver-flask-redis/README.md Update prerequisites to include BuildKit and new CLI docs links.
httpserver-flask-redis/Kraftfile Remove scale-to-zero labels.
httpserver-expressjs4.18-node21/Kraftfile Remove scale-to-zero labels.
httpserver-erlang26.2/README.md Update prerequisites, deploy commands, and sample outputs.
httpserver-erlang26.2/Kraftfile Remove scale-to-zero labels.
httpserver-elixir1.16/README.md Update prerequisites, deploy commands, and sample outputs.
httpserver-elixir1.16/Kraftfile Remove name and scale-to-zero labels.
httpserver-dotnet10.0/README.md Update prerequisites, deploy commands, and sample outputs.
httpserver-dotnet10.0/Kraftfile Remove scale-to-zero labels.
httpserver-c-debug/README.md Update prerequisites, deploy commands, and sample outputs.
httpserver-c-debug/Kraftfile Remove scale-to-zero labels.
httpserver-bun/README.md Update prerequisites, deploy commands, and sample outputs.
httpserver-bun/Kraftfile Remove scale-to-zero labels.
httpserver-boost1.74-gpp13.2/Kraftfile Remove scale-to-zero labels.
haproxy/README.md Update prerequisites, deploy commands, and sample outputs.
haproxy/Kraftfile Remove scale-to-zero labels.
grafana/README.md Update prerequisites, deploy commands, and sample outputs.
grafana/Kraftfile Remove scale-to-zero labels.
github-webhook-node/Kraftfile Remove scale-to-zero labels.
duckdb-go1.21/README.md Update prerequisites, deploy commands, and sample outputs.
duckdb-go1.21/Kraftfile Remove scale-to-zero labels.
dragonflydb/README.md Fix wording/grammar; update prerequisites, deploy commands, and sample outputs.
dragonflydb/Kraftfile Remove scale-to-zero labels.
debian-ssh/README.md Update prerequisites, deploy commands, and sample outputs.
debian-ssh/Kraftfile Remove scale-to-zero labels.
chromium-cdp/README.md Update prerequisites and sample outputs; add metro comment line.
caddy2.7-go1.21/README.md Update prerequisites, deploy commands, and sample outputs.
caddy2.7-go1.21/Kraftfile Remove scale-to-zero labels.
.github/workflows/example-visual-studio-code-server-staging.yaml Reduce scale-to-zero cooldown value.
.github/workflows/example-visual-studio-code-server-stable.yaml Reduce scale-to-zero cooldown value.
.github/workflows/example-grafana-stable.yaml Switch scale-to-zero policy to idle and reduce cooldown.
mcp-server-simple/README.md Update prerequisites, deploy commands, and sample outputs.
mcp-server-simple/Kraftfile Remove name and scale-to-zero labels.
mcp-server-arxiv/Kraftfile Remove scale-to-zero labels.
mariadb/Kraftfile Remove scale-to-zero labels.
imaginary/README.md Update prerequisites, deploy commands, and sample outputs.
imaginary/Kraftfile Remove scale-to-zero labels.
hugo0.122/README.md Update prerequisites, deploy commands, and sample outputs.
hugo0.122/Kraftfile Remove scale-to-zero labels.
httpserver-rust1.91/README.md Update prerequisites, deploy commands, and sample outputs.
httpserver-rust1.91/Kraftfile Remove scale-to-zero labels.
httpserver-rust1.87-actix-web4/Kraftfile Remove scale-to-zero labels.
httpserver-rust1.81-rocket0.5/Kraftfile Remove scale-to-zero labels.
httpserver-rust1.75-tokio/README.md Update prerequisites, deploy commands, and sample outputs.
httpserver-rust1.75-tokio/Kraftfile Remove scale-to-zero labels.
httpserver-rust-trunkrs-leptos/Kraftfile Remove scale-to-zero labels.
httpserver-ruby3.2/README.md Update prerequisites, deploy commands, and sample outputs.
httpserver-ruby3.2/Kraftfile Remove scale-to-zero labels.
httpserver-python3.12/Kraftfile Remove scale-to-zero labels.
httpserver-python3.12-flask3.0/Kraftfile Remove scale-to-zero labels.
httpserver-python3.12-flask3.0-sqlite/Kraftfile Remove scale-to-zero labels.
httpserver-python3.12-fastapi-0.121.3/Kraftfile Remove scale-to-zero labels.
httpserver-python3.12-django5.0/Kraftfile Remove scale-to-zero labels.
memcached1.6/README.md Update prerequisites, deploy commands, and sample outputs.
memcached1.6/Kraftfile Remove scale-to-zero labels.
minio/README.md Update prerequisites, deploy commands, and sample outputs.
minio/Kraftfile Remove scale-to-zero labels.
mongodb/Kraftfile Remove scale-to-zero labels.
nginx/README.md Update prerequisites, deploy commands, and sample outputs.
nginx/Kraftfile Remove scale-to-zero labels.

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

Comment thread httpserver-node21-solid-start/README.md Outdated
Comment thread opentelemetry-collector/README.md
Comment thread wazero-import-go/README.md Outdated
Comment thread wazero-import-go/README.md Outdated
@nurof3n nurof3n force-pushed the nurof3n/fix/modern-readmes branch 2 times, most recently from 033c6da to a900d44 Compare April 20, 2026 09:42
Copy link
Copy Markdown

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

Copilot reviewed 158 out of 160 changed files in this pull request and generated 7 comments.


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

Comment thread redis7.2/README.md
Comment thread httpserver-node21-remix/README.md Outdated
Comment thread opentelemetry-collector/README.md Outdated
Comment thread opentelemetry-collector/README.md Outdated
Comment thread httpserver-rust1.75-tokio/README.md Outdated
Comment thread httpserver-rust1.75-tokio/README.md
Comment thread redis7.2/README.md
Signed-off-by: Alex-Andrei Cioc <andrei.cioc@unikraft.io>
Copy link
Copy Markdown

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

Copilot reviewed 158 out of 160 changed files in this pull request and generated no new comments.


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

Copy link
Copy Markdown
Contributor

@dragosgheorghioiu dragosgheorghioiu left a comment

Choose a reason for hiding this comment

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

LGTM!

Reviewed-by: Dragos Gheorghioiu dragosg@unikraft.com
Approved-by: Dragos Gheorghioiu dragosg@unikraft.com

@dragosgheorghioiu dragosgheorghioiu merged commit 641d634 into main Apr 20, 2026
95 of 99 checks passed
@dragosgheorghioiu dragosgheorghioiu deleted the nurof3n/fix/modern-readmes branch April 20, 2026 17:20
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.

4 participants