Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added docs for Kubernetes+containerd+runwasi setup and updated runwasi setup #240

Merged
merged 1 commit into from
Aug 5, 2024

Conversation

shiveshcodes
Copy link
Contributor

Signed-off-by: Shivesh Gupta [email protected]

Explanation

  • Added docs for running Wasmedge in Kubernetes with containerd-shim-wasmedge using runwasi
  • Updated the containerd+runwasi page with a line to run setup script for building runwasi

Related issue

address #214

What type of PR is this

/kind documentation

Proposed Changes

Added instructions for running Wasmedge using runwasi with kubernetes and updated build instruction for runwasi

Copy link
Collaborator

alabulei1 commented Jul 9, 2024

Hello, I am a code review bot on flows.network. Here are my reviews of code commits in this PR.


Commit ca7a0d6e2cad06a042a22f0b1374886a4046fd60

Key Changes:

  1. Added detailed documentation for setting up Kubernetes + Containerd + Runwasi in the file kubernetes-containerd-runwasi.md.
  2. Updated the setup steps for runwasi in the containerd.md file.
  3. Provided a quick start guide and detailed steps for prerequisites, installing Kubernetes, testing the cluster, configuring Containerd and Kubernetes for Wasmedge runtime, and running a WebAssembly-based HTTP service in Kubernetes.

Potential Problems:

  1. Size of Changes: The PR introduces a significant number of insertions and changes which may be difficult to review thoroughly at once. It might be beneficial to break down the changes into smaller, more manageable chunks.
  2. Accuracy of Instructions: The detailed setup steps provided should be reviewed carefully for accuracy and potential issues that might arise during implementation.
  3. Compatibility and Versions: Ensure that the instructions provided are compatible with the latest versions of Kubernetes, Containerd, and other tools mentioned.
  4. Security Concerns: Review the commands that require elevated permissions (sudo) to ensure they are safe and do not introduce security vulnerabilities.
  5. Consistency and Formatting: Check for consistency in formatting, language, and code snippets throughout the documentation to maintain a professional and cohesive look.

Overall, the PR seems comprehensive and informative, but attention to the above points will help ensure the quality and correctness of the documentation.

@shiveshcodes shiveshcodes force-pushed the k8s-containerd-runwasi-docs branch 3 times, most recently from 05c8c08 to de217a7 Compare July 9, 2024 03:49
@shiveshcodes
Copy link
Contributor Author

@CaptainVincent I would appreciate your feedback

@alabulei1
Copy link
Collaborator

Hi @shiveshcodes

The DCO failed. Could you please check it out?

@shiveshcodes shiveshcodes force-pushed the k8s-containerd-runwasi-docs branch 2 times, most recently from f3d7c13 to 2da597a Compare July 9, 2024 06:11
@shiveshcodes
Copy link
Contributor Author

shiveshcodes commented Jul 9, 2024

Thank You @alabulei1
I tried following the suggested steps to check that out besides my commit message has a Signed-off-by message. Am I missing something here ?

@shiveshcodes shiveshcodes force-pushed the k8s-containerd-runwasi-docs branch 2 times, most recently from 253d5dd to 5c4a823 Compare July 9, 2024 06:20
@shiveshcodes shiveshcodes force-pushed the k8s-containerd-runwasi-docs branch from 5c4a823 to ca7a0d6 Compare July 9, 2024 06:29
@shiveshcodes
Copy link
Contributor Author

@alabulei1 I have fixed the DCO issue, Sorry for the trouble.

@shiveshcodes
Copy link
Contributor Author

shiveshcodes commented Jul 10, 2024

@alabulei1 @CaptainVincent A friendly reminder to please review this update as and when you have time. Thank you

@CaptainVincent
Copy link
Member

Verification done. No issues encountered. LGTM.

@hydai hydai merged commit 6b2d860 into WasmEdge:main Aug 5, 2024
6 checks passed
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