Update Hello World job as the previous version seems to be outdated. #4857

haixuanTao · 2025-02-20T00:16:47Z

The previous README getting used to give me an error.

(base) ~ ❯❯❯ bacalhau docker run ubuntu echo Hello World              
Error: server is not running or not reachable at http://127.0.0.1:1234
Hint:  to resolve this, either:
1. Ensure that the server is running and reachable at http://127.0.0.1:1234
2. Update the configuration to use a different host and port using:
   a. The '--api-host=<new_address> --api-port=<new_port>' flags with your command
   b. The '-c API.Host=<new_host> -c API.Port=<new_port>' flags with your command
   c. Set the host in a configuration file with 'bacalhau config set API.Host=<new_address>' and port with 'bacalhau config set API.Port=<new_port>'
3. If you are trying to reach the demo network, use '--api-host=bootstrap.demo.bacalhau.org' to call the network

I think I corrected it

Summary by CodeRabbit

Documentation
- Updated the quickstart guide with an enhanced command for job submission, now including options to specify a service host, wait for job completion, and use an updated Docker image for improved execution.

coderabbitai · 2025-02-20T00:16:56Z

Walkthrough

The changes update the "Getting started - Bacalhau in 1 minute" section in the README. The original command for running a "Hello World" Docker job is replaced by one that includes additional parameters: it explicitly sets the API host, adds a --wait option, and specifies a different Docker image. No modifications to any public or exported entities were made.

Changes

File	Change Summary
README.md	Updated the "Getting started - Bacalhau in 1 minute" section by replacing the old command with a new multi-parameter command for submitting a job.

Sequence Diagram(s)

Poem

I'm a rabbit in the code meadow, hopping along the trail,
Changing commands in the README without a single fail.
API hosts and waiting flags have joined my playful spree,
A Docker image new as dawn, as fresh as fresh can be.
With ASCII carrots and code delights, I cheer this change with glee!
🥕🐇 Happy coding in every byte!

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

🪧 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>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
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 testing code 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
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/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ea31142 and d64c438.

📒 Files selected for processing (1)

README.md (1 hunks)

coderabbitai · 2025-02-20T00:22:44Z

README.md

+bacalhau docker run \
+                -c API.Host=bootstrap.production.bacalhau.org \
+                --wait \
+                docker run \
+                docker.io/bacalhauproject/hello-world:latest


🧹 Nitpick (assertive)

Verify the updated Hello World command syntax.
The new command improves functionality by configuring the API host and waiting for the job. However, please verify that the repeated use of docker run is intentional (i.e. after the --wait flag) and that it correctly invokes the desired Docker image. If this repetition is a mistake, consider removing the extra docker run for clarity.

Hi @haixuanTao, Thank you for your first contribution. A simpler command might be:

bacalhau --api-host=bootstrap.demo.bacalhau.org docker run ubuntu echo Hello World

Though we should clarify that this will run a job on the demo network

Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!

FYI, I took this from the documentation of the website.

I think it would be better if both are aligned.

100%. We are currently revamping our docs and all should be fixed and up to date

Approved the PR

Update Hello World job as the previous version seems to be outdated.

d64c438

coderabbitai bot reviewed Feb 20, 2025

View reviewed changes

Merge branch 'main' into patch-1

053fef1

wdbaruni added the ok-to-test label Feb 23, 2025

wdbaruni approved these changes Feb 23, 2025

View reviewed changes

wdbaruni merged commit b1882fe into bacalhau-project:main Feb 23, 2025
13 of 14 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Hello World job as the previous version seems to be outdated. #4857

Update Hello World job as the previous version seems to be outdated. #4857

haixuanTao commented Feb 20, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Feb 20, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

coderabbitai bot Feb 20, 2025 •

edited

Loading

wdbaruni Feb 20, 2025

coderabbitai bot Feb 20, 2025

haixuanTao Feb 21, 2025

wdbaruni Feb 23, 2025

wdbaruni Feb 23, 2025

Update Hello World job as the previous version seems to be outdated. #4857

Update Hello World job as the previous version seems to be outdated. #4857

Conversation

haixuanTao commented Feb 20, 2025 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Feb 20, 2025 • edited Loading

Walkthrough

Changes

Sequence Diagram(s)

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot Feb 20, 2025 • edited Loading

Choose a reason for hiding this comment

wdbaruni Feb 20, 2025

Choose a reason for hiding this comment

coderabbitai bot Feb 20, 2025

Choose a reason for hiding this comment

haixuanTao Feb 21, 2025

Choose a reason for hiding this comment

wdbaruni Feb 23, 2025

Choose a reason for hiding this comment

wdbaruni Feb 23, 2025

Choose a reason for hiding this comment

haixuanTao commented Feb 20, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Feb 20, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

coderabbitai bot Feb 20, 2025 •

edited

Loading