Update READMEs of examples - #244
Draft
procub3r wants to merge 4 commits into
Draft
Conversation
Signed-off-by: Sriprad Potukuchi <sripradp@proton.me>
Signed-off-by: Sriprad Potukuchi <sripradp@proton.me>
procub3r
changed the title
Signed-off-by: Sriprad Potukuchi <sripradp@proton.me>
…er READMEs Signed-off-by: Sriprad Potukuchi <sripradp@proton.me>
There was a problem hiding this comment.
Pull request overview
Updates example READMEs to better reflect current Unikraft Cloud deployment steps and example structure, improving the accuracy of instructions users follow when running these examples.
Changes:
- Expanded the Express (Node 21) example README into a step-by-step deploy + customization guide.
- Adjusted the Debian SSH example deploy command to explicitly expose the SSH port with TLS routing.
- Corrected the Redis example directory path and updated the testing instructions to use a TLS-capable tunnel command.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| expressjs4.18-node21/README.md | Reworked into a detailed deploy/customization walkthrough for the Express example. |
| debian-ssh/README.md | Updates the deploy command to include explicit port mapping for SSH exposure. |
| database-redis7.2/README.md | Fixes the example directory path and adjusts testing flow for TLS access. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
|
||
| ## Learn more | ||
|
|
||
| - [Express's Documentation](https://expressjs.com/en/5x/api.html) |
|
|
||
| * `Kraftfile`: the Unikraft Cloud specification | ||
| * `Dockerfile`: the Docker-specified app filesystem | ||
| * `app/index.js`: the Express server program |
| In this case, the instance name is `node21-expressjs-c34b9` and the address is `https://holy-silence-vr9fp0zt.fra.unikraft.app`. | ||
| They're different for each run. | ||
|
|
||
| Use `curl` to query the Unikraft Cloud instance of the Express: |
Comment on lines
9
to
+13
| 2. Clone the [`examples` repository](https://github.com/unikraft-cloud/examples) and `cd` into the `examples/redis/` directory: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/unikraft-cloud/examples | ||
| cd examples/redis/ | ||
| cd examples/database-redis7.2/ |
| In this case, the instance name is `redis-alb4r` and the address is `rough-wind-8vxrd1ms.fra.unikraft.app`. They are different for every run. | ||
|
|
||
| To test the deployment, first forward the port with the `kraft cloud tunnel` command: | ||
| To test the deployment, first setup a tunnel that handles a TLS connection to the `redis-alb4r` instance: |
|
|
||
| ```bash | ||
| kraft cloud tunnel 6379:memcached-arkv7:6379 | ||
| socat TCP-LISTEN:6379,reuseaddr,fork OPENSSL:rough-wind-8vxrd1ms.fra.unikraft.app:6379,verify=0 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updating the READMEs of examples to be more accurate.