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.

Sign up for GitHub

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

Update index.md #27

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update index.md #27

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dcbe6b0
Update index.md
Rajakavitha1 Aug 30, 2024
c27d527
incorporated the changes suggested
Rajakavitha1 Sep 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 18 additions & 49 deletions setting-up/workload-onboarding/container/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,63 +1,32 @@
---
description: How to use the Bacalhau Docker image
description: How to use the Bacalhau CLI in Docker
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure this adds clarity?

---

# Bacalhau Docker Image
# Bacalhau CLI from Docker
Copy link
Contributor

Choose a reason for hiding this comment

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

It's not "from Docker" - it's a docker image?


This documentation explains how to use the Bacalhau Docker image to run tasks and manage them using the Bacalhau client.
This documentation explains how to use Bacalhau CLI from docker.
Copy link
Contributor

Choose a reason for hiding this comment

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

The former i think is clearer.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

rewrote for making it more clear.


## Prerequisites

To get started, you need to install the Bacalhau client (see more information [here](../../../getting-started/installation.md)) and Docker.
Install the [Bacalhau CLI in Docker](../../..//getting-started/installation#step-1.1-install-the-bacalhau-cli).
Copy link
Contributor

Choose a reason for hiding this comment

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

Why do we need to install the bacalhau client at all? aren't we using the pre-built image?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I had to install bacalhau client else I kept getting the error: rkodhand@blr-mpe5j ~ % docker run -t ghcr.io/bacalhau-project/bacalhau:latest \ docker run \ --id-only \ --wait \ ubuntu:latest \ -- sh -c 'uname -a && echo "Hello from Docker Bacalhau!"' 12:02:36.828 | INF pkg/repo/fs.go:93 > Initializing repo at '/root/.bacalhau' for environment 'production' publicapi: after posting request: "This endpoint is deprecated. See the migration guide at https://docs.bacalhau.org/references/cli-reference/command-migration for more information"


## 1. Pull the Bacalhau Docker image

The first step is to pull the Bacalhau Docker image from the [Github container registry](https://github.com/orgs/bacalhau-project/packages/container/package/bacalhau).

```
docker pull ghcr.io/bacalhau-project/bacalhau:latest
```

Expected output:

```shell
latest: Pulling from bacalhau-project/bacalhau
d14ccdd25413: Pull complete
621f190d05c8: Pull complete
Digest: sha256:3cda5619984de9b56c738c50f94188684170f54f7e417f8dcbe74ff8ec8eb434
Status: Downloaded newer image for ghcr.io/bacalhau-project/bacalhau:latest
ghcr.io/bacalhau-project/bacalhau:latest
```

You can also pull a specific version of the image, e.g.:

```bash
docker pull ghcr.io/bacalhau-project/bacalhau:v0.3.16
Copy link
Contributor

Choose a reason for hiding this comment

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

why are we pinning to such an old version?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Exactly that is why these instructions were removed from the guide and only the latest version is retained.

```

{% hint style="warning" %}
Remember that the "latest" tag is just a string. It doesn't refer to the latest version of the Bacalhau client, it refers to an image that has the "latest" tag. Therefore, if your machine has already downloaded the "latest" image, it won't download it again. To force a download, you can use the `--no-cache` flag.
{% endhint %}

## 2. Check version

To check the version of the Bacalhau client, run:
## 1. Check the version of Bacalhau CLI

```bash
docker run -t ghcr.io/bacalhau-project/bacalhau:latest version
```

Expected Output:
The output is similar to:
Copy link
Contributor

Choose a reason for hiding this comment

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

This is "Expected Output" - the change is too wordy. If there are variables that will change, then just mention them.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I just followed the standard documentation guidelines https://developers.google.com/style/code-in-text


```shell
13:38:54.518 | INF pkg/repo/fs.go:81 > Initializing repo at '/root/.bacalhau' for environment 'production'
Copy link
Contributor

Choose a reason for hiding this comment

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

this is horrible - @wdbaruni @frrist for your tracking. We should NEVER EVER print out raw go logs like this when starting. It is horribly confusing.

CLIENT SERVER UPDATE MESSAGE
v1.2.0 v1.2.0
```

## 3. Running a Bacalhau Job
## 2. Run a Bacalhau Job

In the example below, an Ubuntu-based job runs to print the message 'Hello from Docker Bacalhau':
For example to run an Ubuntu-based job that prints the message 'Hello from Docker Bacalhau':
Copy link
Contributor

Choose a reason for hiding this comment

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

I like the former language better.


```shell
docker run -t ghcr.io/bacalhau-project/bacalhau:latest \
Expand All @@ -77,7 +46,7 @@ docker run -t ghcr.io/bacalhau-project/bacalhau:latest \
5. `--`: Separate Bacalhau parameters from the command to be executed inside the container
6. `sh -c 'uname -a && echo "Hello from Docker Bacalhau!"'`: The command executed inside the container

Let's have a look at the command execution in the terminal:
The command execution in the terminal is similar to:
Copy link
Contributor

Choose a reason for hiding this comment

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

The former feels friendlier.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Followed the word standard writing guidelines. https://developers.google.com/style/accessibility


```shell
13:53:46.478 | INF pkg/repo/fs.go:81 > Initializing repo at '/root/.bacalhau' for environment 'production'
Expand All @@ -86,27 +55,27 @@ ab95a5cc-e6b7-40f1-957d-596b02251a66

The output you're seeing is in two parts: **The first line:** `13:53:46.478 | INF pkg/repo/fs.go:81 > Initializing repo at '/root/.bacalhau' for environment 'production'` is an informational message indicating the initialization of a repository at the specified directory `('/root/.bacalhau')` for the `production` environment. **The second line:** `ab95a5cc-e6b7-40f1-957d-596b02251a66` is a `job ID`, which represents the result of executing a command inside a Docker container. It can be used to obtain additional information about the executed job or to access the job's results. We store that in an environment variable so that we can reuse it later on (env: `JOB_ID=ab95a5cc-e6b7-40f1-957d-596b02251a66`)

To print out the **content of the Job ID**, run the following command:
To print the **content of the Job ID**, execute the following command:

```
docker run -t ghcr.io/bacalhau-project/bacalhau:latest \
describe ab95a5cc-e6b7-40f1-957d-596b02251a66 \
| grep -A 2 "stdout: |"
```

Expected Output:
The output is similar to:
Copy link
Contributor

Choose a reason for hiding this comment

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

Not "is similar to"


```shell
stdout: |
Linux fff680719453 6.2.0-1019-gcp #21~22.04.1-Ubuntu SMP Thu Nov 16 18:18:34 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux
Hello from Docker Bacalhau!
```

## 4. Submit a Job With Output Files
## 3. Submit a Job With Output Files

One inconvenience that you'll see is that you'll need to mount directories into the container to access files. This is because the container is running in a separate environment from your host machine. Let's take a look at the example below:
You always need to mount directories into the container to access files. This is because the container is running in a separate environment from your host machine.

The first part of the example should look familiar, except for the Docker commands.
The first part of this example should look familiar, except for the Docker commands.

```shell
docker run -t ghcr.io/bacalhau-project/bacalhau:latest \
Expand All @@ -118,14 +87,14 @@ docker run -t ghcr.io/bacalhau-project/bacalhau:latest \
python main.py --o ./outputs --p "A Docker whale and a cod having a conversation about the state of the ocean"
```

When a job is submitted, Bacalhau prints out the related `job_id` (`a46a9aa9-63ef-486a-a2f8-6457d7bafd2e`):
When a job is submitted, Bacalhau prints the related `job_id` (`a46a9aa9-63ef-486a-a2f8-6457d7bafd2e`):

```shell
09:05:58.434 | INF pkg/repo/fs.go:81 > Initializing repo at '/root/.bacalhau' for environment 'production'
a46a9aa9-63ef-486a-a2f8-6457d7bafd2e
```

## 5. Checking the State of your Jobs
## 4. Check the State of your Jobs

**Job status**: You can check the status of the job using `bacalhau job list`.

Expand All @@ -134,7 +103,7 @@ docker run -t ghcr.io/bacalhau-project/bacalhau:latest \
list $JOB_ID \
```

When it says `Completed`, that means the job is done, and we can get the results.
When it reads `Completed`, that means the job is done, and you can get the results.

**Job information**: You can find out more information about your job by using `bacalhau job describe`.

Expand All @@ -149,7 +118,7 @@ docker run -t ghcr.io/bacalhau-project/bacalhau:latest \
bacalhau job get ${JOB_ID} --output-dir result
```

After the download has finished, you should see the following contents in the results directory.
After the download is complete, you should see the following contents in the results directory.

![png](../../../.gitbook/assets/index\_25\_0.png)

Expand Down