Add documentation

[efrecon]

Summary by CodeRabbit

• Documentation
  • Added a comprehensive README explaining the project's purpose, features, and limitations.
• Bug Fixes
  • Improved error handling across various scripts, including better handling for missing RUNNER_PAT and enhanced logging.
• Refactor
  • Modified usage function calls across multiple scripts for clearer, context-specific help outputs.
• Chores
  • Enhanced the orchestrator script to handle runner lifecycle more effectively, including setting default runner counts and ensuring runners are properly shut down.

Closes #5

[coderabbitai]

Warning

Rate Limit Exceeded

@efrecon has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 16 minutes and 13 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 5902dd7 and 69d5d8d.

Walkthrough

This project introduces a new system for creating self-hosted GitHub runners using krunvm, providing a secure and isolated environment within microVMs. It's designed for Linux, with a focus on performance and compatibility. The updates across various scripts mainly refine the user help functionality, improve error handling, and enhance the management of runners, including their creation, installation, and token handling. These changes aim to streamline operations and offer clearer guidance for users.

Changes

File(s)	Change Summary
README.md	Introduced a project for creating isolated GitHub runners with krunvm on Linux.
base/base.sh, runner/...sh	Modified the usage function call by adding specific arguments for better help output.
lib/common.sh	Added functionality to display current state by printing variables with a specific prefix.
orchestrator.sh	Improved help option handling, error handling for RUNNER_PAT, and runner management.

Assessment against linked issues

Objective	Addressed	Explanation
Documentation (Issue #5)	✅

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 50fd848 and 62426f3.

Files selected for processing (8)

• README.md (1 hunks)
• base/base.sh (1 hunks)
• lib/common.sh (1 hunks)
• orchestrator.sh (5 hunks)
• runner.sh (1 hunks)
• runner/install.sh (1 hunks)
• runner/runner.sh (1 hunks)
• runner/token.sh (1 hunks)

Additional comments: 11

runner/token.sh (1)

• 76-76: The addition of the "TOKEN" argument to the usage function call is appropriate for providing context-specific help. Ensure that the usage function is updated accordingly to handle this new argument.

runner/install.sh (1)

• 68-68: The addition of the "INSTALL" argument to the usage function call is appropriate for providing context-specific help. Ensure that the usage function is updated accordingly to handle this new argument.

base/base.sh (1)

• 68-68: The addition of the "BASE" argument to the usage function call is appropriate for providing context-specific help. Ensure that the usage function is updated accordingly to handle this new argument.

runner.sh (1)

• 120-120: The addition of the "RUNNER" argument to the usage function call is appropriate for providing context-specific help. Ensure that the usage function is updated accordingly to handle this new argument.

README.md (1)

• 1-148: The README.md provides a thorough overview of the project, its features, requirements, limitations, architecture, and design. Ensure all external links are valid and the documentation is kept up-to-date with the project's development.

orchestrator.sh (5)

• 150-150: The usage function is now called with additional parameters. Ensure that the usage function definition has been updated to handle these parameters correctly.
• 180-180: Setting the number of runners to 0 by default if not provided is a logical default. This change is approved.
• 216-218: The error handling for missing RUNNER_PAT when the number of runners is greater than 0 is correct and improves the script's robustness.
• 191-191: The logging statement for creating microVMs provides valuable information for debugging and operational monitoring. Ensure that the verbose function efficiently handles varying levels of verbosity.
• 256-259: Waiting for runners to terminate before script completion is a good practice for clean resource management. This change is approved.

runner/runner.sh (1)

• 131-131: The modification to the usage function call with the "RUNNER" argument is intended to provide more specific usage information. Ensure that the usage function is updated accordingly to handle this argument.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 62426f3 and 6244586.

Files selected for processing (2)

• lib/common.sh (1 hunks)
• orchestrator.sh (6 hunks)

Files skipped from review as they are similar to previous changes (2)

• lib/common.sh
• orchestrator.sh

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 6244586 and 5902dd7.

Files selected for processing (3)

• demo/demo-magic/demo-magic.sh (1 hunks)
• demo/demo-magic/license.txt (1 hunks)
• demo/demo.sh (1 hunks)

Files skipped from review due to trivial changes (2)

• demo/demo-magic/demo-magic.sh
• demo/demo-magic/license.txt

Additional comments: 4

demo/demo.sh (4)

• 3-3: Ensure that the command -v -- "$0" command correctly resolves the path of the script in all intended execution environments, as behavior might vary in different shells or OS.
• 5-5: Verify that demo-magic.sh script exists at the specified path and is accessible from DEMO_ROOTDIR. If this script is critical for the demo's operation, consider adding error handling to check if the sourcing operation succeeds.
• 7-7: The prompt customization using DEMO_PROMPT is a good touch for clarity in demonstrations. Ensure that the GREEN, CYAN, and COLOR_RESET variables are defined either in this script or in the sourced demo-magic.sh to avoid undefined variable errors.
• 16-17: The use of pe (presumably a function from demo-magic.sh) to simulate command execution is appropriate for a demo script. Ensure that the orchestrator.sh script is correctly referenced and accessible from the location this demo script is executed. Additionally, verify that the -v and -p flags, along with their arguments, are correctly implemented in orchestrator.sh.