1 of 7

Node

Node Overview

Description

The bacalhau node command provides a set of sub-commands to query and manage node-related information within Bacalhau. With these tools, users can access specific details about nodes, list all network nodes, and more.

Usage

Available Commands

:
- Description: Approves a single node to join the cluster.
- Usage:
:
- Description: Deletes a node from the cluster using its ID.
- Usage:
:
- Description: Retrieves detailed information of a node using its ID.
- Usage:
:
- Description: Lists the details of all nodes present in the network.
- Usage:
:

Description: Reject a specific node's request to join the cluster.
Usage:

For comprehensive details on any of the sub-commands, run:

Flags

-h, --help:
- Description: Shows the help information for the node command.

Global Flags

--api-host string:
- Description: Specifies the host for RESTful communication between the client and server. The flag will be ignored if the BACALHAU_API_HOST environment variable is set.
- Default: bootstrap.production.bacalhau.org
--api-port int:
- Description: Designates the port for RESTful communication. The flag will be bypassed if the BACALHAU_API_PORT environment variable is active.
- Default: 1234
--log-mode logging-mode:
- Description: Chooses the preferred log format. Available choices are: default, station, json, combined, and event.
- Default: default
--repo string:
- Description: Specifies the path to the bacalhau repository.
- Default: /Users/walid/.bacalhau

Node Approve

The bacalhau node approve command offers administrators the ability to approve the cluster membership for a node using its name.

Description:

Using the approve sub-command under the bacalhau node umbrella, users can allow a node in the pending state to join the cluster and receive work. This feature is crucial for system administrators to manage the cluster.

Usage:

Flags:

[id]:
- The unique identifier of the node you wish to describe.
-h, --help:
- Displays the help documentation for the describe command.
-m message:
- A message to be attached to the approval action.

Global Flags:

--api-host string:
- Specifies the host for client-server communication through REST. This flag is overridden if the BACALHAU_API_HOST environment variable is set.
- Default: "bootstrap.production.bacalhau.org"
--api-port int:
- Designates the port for REST-based communication between client and server. This flag is overlooked if the BACALHAU_API_PORT environment variable is defined.
- Default: 1234
--log-mode logging-mode:
- Determines the log format preference.
- Options: 'default','station','json','combined','event'
- Default: 'default'
--repo string:
- Points to the bacalhau repository's path.
- Default: "$HOME/.bacalhau"`

Examples:

Approve a Node with ID nodeID123:
Approve a Node with an audit message:

Node Delete

The bacalhau node delete command offers administrators the ability to remove a node from the cluster using its name.

Description:

Using the delete sub-command, administrators can remove a node from the list of available compute nodes in the cluster. This feature is necessary for the management of the infrastructure.

Usage:

Flags:

[id]:
- The unique identifier of the node you wish to describe.
-h, --help:
- Displays the help documentation for the describe command.
-m message:
- A message to be attached to the deletion action.

Global Flags:

--api-host string:
- Specifies the host for client-server communication through REST. This flag is overridden if the BACALHAU_API_HOST environment variable is set.
- Default: "bootstrap.production.bacalhau.org"
--api-port int:
- Designates the port for REST-based communication between client and server. This flag is overlooked if the BACALHAU_API_PORT environment variable is defined.
- Default: 1234
--log-mode logging-mode:
- Determines the log format preference.
- Options: 'default','station','json','combined','event'
- Default: 'default'
--repo string:
- Points to the bacalhau repository's path.
- Default: "$HOME/.bacalhau"`

Examples:

Delete the Node with ID nodeID123:
Delete a Node with an audit message:

Node List

The bacalhau node list command is designed to provide users with a comprehensive list of network nodes along with details based on specified flags.

Description:

The list sub-command under the bacalhau node category enumerates information about nodes in the network. It supports various filtering, ordering, and output formatting options, allowing users to tailor the output to their needs.

Usage:

Flags:

-h, --help:
- Show the help message for the list command.
--hide-header:
- Do not display the column headers in the output.
--filter-approval:
- Only show nodes with the specified approval status. Valid values are: approved, pending, rejected.
--filter-status:
- Only show nodes with the specified state. Valid values are: healthy, unhealthy, unknown.
--labels string:
- Filter nodes based on labels. This follows the filtering format provided by Kubernetes, as shown in their documentation about labels.
--limit uint32:
- Restrict the number of results displayed.
--next-token string:
- Provide the next token for pagination.
--no-style:
- Output the table without any style.
--order-by string:
- Sort the results based on a specific field. Valid sorting fields are: id, type, available_cpu, available_memory, available_disk, available_gpu.
--order-reversed:
- Display the results in reverse order.
--output format:
- Choose the output format. Available options: table, csv, json, yaml.
- Default: table.
--pretty:
- Enhance the visual appeal of the output. This is applicable only to json and yaml formats.
--show strings:
- Determine the column groups to be displayed. Acceptable values are: labels, version, features, capacity.
- Default: labels, capacity.
--wide:
- Display full values in the output table, without truncation.

Global Flags:

--api-host string:
- Specify the host for client-server communication via REST. This gets ignored if the BACALHAU_API_HOST environment variable is defined.
- Default: "bootstrap.production.bacalhau.org".
--api-port int:
- Specify the port for RESTful communication between client and server. Gets overlooked if the BACALHAU_API_PORT environment variable is set.
- Default: 1234.
--log-mode logging-mode:
- Choose the desired log format.
- Options: 'default', 'station', 'json', 'combined', 'event'.
- Default: 'default'.
--repo string:
- Point to the directory path of the bacalhau repository.
- Default: "$HOME/.bacalhau"`.

Examples

Retrieve the list of nodes:
Execute the command to get a list of all nodes:
Expected output:
Filter the list of nodes by labels:
Execute the command to get a list of nodes with specific labels:
Expected output:
Order the list of nodes by available memory:
Execute the command to get the list of nodes ordered by available memory:
Expected output:
Limit the number of nodes displayed and output in JSON format:
Execute the command to get a limited list of nodes in JSON format:
Expected output:

Node Describe

The bacalhau node describe command offers users the ability to retrieve detailed information about a specific node using its unique identifier.

Description:

Using the describe sub-command under the bacalhau node umbrella, users can get comprehensive details of a node by providing its ID. This information is crucial for system administrators and network managers to understand the state, specifications, and other attributes of nodes in their infrastructure.

Usage:

bacalhau node describe [id] [flags]

Flags:

[id]:
- The unique identifier of the node you wish to describe.
-h, --help:
- Displays the help documentation for the describe command.
--output format:
- Defines the desired format for the command's output.
- Options: "json" or "yaml"
- Default: "yaml"
--pretty:
- When this flag is used, the command will pretty print the output. This is applicable only for outputs in json and yaml formats.

Global Flags:

--api-host string:
- Specifies the host for client-server communication through REST. This flag is overridden if the BACALHAU_API_HOST environment variable is set.
- Default: "bootstrap.production.bacalhau.org"
--api-port int:
- Designates the port for REST-based communication between client and server. This flag is overlooked if the BACALHAU_API_PORT environment variable is defined.
- Default: 1234
--log-mode logging-mode:
- Determines the log format preference.
- Options: 'default','station','json','combined','event'
- Default: 'default'
--repo string:
- Points to the bacalhau repository's path.
- Default: "$HOME/.bacalhau"`

Examples:

Describing a Node with ID nodeID123:
```
bacalhau node describe nodeID123
```

Describing a Node with Output in JSON Format:

bacalhau node describe nodeID123 --output json

Pretty Printing the Description of a Node:
```
bacalhau node describe nodeID123 --pretty
```

Node Reject

The bacalhau node reject command offers administrators the ability to reject a compute node's request to join the cluster.

Description:

Using the reject sub-command, administrators can reject a node in the pending state from joining the cluster and receiving work. This feature is crucial for system administrators to manage the cluster and will stop the node from taking part in the cluster until approved.

Usage:

Flags:

[id]:
- The unique identifier of the node you wish to describe.
-h, --help:
- Displays the help documentation for the describe command.
-m message:
- A message to be attached to the rejection action.

Global Flags:

--api-host string:
- Specifies the host for client-server communication through REST. This flag is overridden if the BACALHAU_API_HOST environment variable is set.
- Default: "bootstrap.production.bacalhau.org"
--api-port int:
- Designates the port for REST-based communication between client and server. This flag is overlooked if the BACALHAU_API_PORT environment variable is defined.
- Default: 1234
--log-mode logging-mode:
- Determines the log format preference.
- Options: 'default','station','json','combined','event'
- Default: 'default'
--repo string:
- Points to the bacalhau repository's path.
- Default: "$HOME/.bacalhau"`

Examples:

Reject a Node with ID nodeID123:
Reject a Node with an audit message:

Node List

The bacalhau node list command is designed to provide users with a comprehensive list of network nodes along with details based on specified flags.

Description:

Usage:

Flags:

-h, --help:
- Show the help message for the list command.
--hide-header:
- Do not display the column headers in the output.
--filter-approval:
- Only show nodes with the specified approval status. Valid values are: approved, pending, rejected.
--filter-status:
- Only show nodes with the specified state. Valid values are: healthy, unhealthy, unknown.
--labels string:
- Filter nodes based on labels. This follows the filtering format provided by Kubernetes, as shown in their documentation about labels.
--limit uint32:
- Restrict the number of results displayed.
--next-token string:
- Provide the next token for pagination.
--no-style:
- Output the table without any style.
--order-by string:
- Sort the results based on a specific field. Valid sorting fields are: id, type, available_cpu, available_memory, available_disk, available_gpu.
--order-reversed:
- Display the results in reverse order.
--output format:
- Choose the output format. Available options: table, csv, json, yaml.
- Default: table.
--pretty:
- Enhance the visual appeal of the output. This is applicable only to json and yaml formats.
--show strings:
- Determine the column groups to be displayed. Acceptable values are: labels, version, features, capacity.
- Default: labels, capacity.
--wide:
- Display full values in the output table, without truncation.

Global Flags:

--api-host string:
- Specify the host for client-server communication via REST. This gets ignored if the BACALHAU_API_HOST environment variable is defined.
- Default: "bootstrap.production.bacalhau.org".
--api-port int:
- Specify the port for RESTful communication between client and server. Gets overlooked if the BACALHAU_API_PORT environment variable is set.
- Default: 1234.
--log-mode logging-mode:
- Choose the desired log format.
- Options: 'default', 'station', 'json', 'combined', 'event'.
- Default: 'default'.
--repo string:
- Point to the directory path of the bacalhau repository.
- Default: "$HOME/.bacalhau"`.

Examples

Retrieve the list of nodes:

Execute the command to get a list of all nodes:

bacalhau node list

Expected output:

 ID        TYPE     LABELS                                              CPU     MEMORY      DISK         GPU
 QmTSJgdN  Compute  Architecture=amd64 Operating-System=linux           3.2 /   11.7 GB /   77.8 GB /    1 /
                    git-lfs=True owner=bacalhau                         3.2     11.7 GB     77.8 GB      1
 QmVXwmdZ  Compute  Architecture=amd64 Operating-System=linux           3.2 /   12.5 GB /   77.8 GB /    0 /
                    git-lfs=True owner=bacalhau                         3.2     12.5 GB     77.8 GB      0
 QmXRdLru  Compute  Architecture=amd64 Operating-System=linux           3.2 /   12.5 GB /   78.0 GB /    0 /
                    git-lfs=True owner=bacalhau                         3.2     12.5 GB     78.0 GB      0
 ... [Additional nodes information] ...

Filter the list of nodes by labels:

Execute the command to get a list of nodes with specific labels:

bacalhau node list --labels "Operating-System=linux,owner=bacalhau"

Expected output:

ID        TYPE     LABELS                                              CPU     MEMORY      DISK         GPU
QmTSJgdN  Compute  Architecture=amd64 Operating-System=linux           3.2 /   11.7 GB /   77.8 GB /    1 /
                   git-lfs=True owner=bacalhau                         3.2     11.7 GB     77.8 GB      1
... [Additional nodes information] ...

Order the list of nodes by available memory:

Execute the command to get the list of nodes ordered by available memory:

bacalhau node list --order-by available_memory

Expected output:

ID        TYPE     LABELS                                              CPU     MEMORY      DISK         GPU
QmVXwmdZ  Compute  Architecture=amd64 Operating-System=linux           3.2 /   12.5 GB /   77.8 GB /    0 /
                   git-lfs=True owner=bacalhau                         3.2     12.5 GB     77.8 GB      0
... [Additional nodes information] ...

Limit the number of nodes displayed and output in JSON format:

Execute the command to get a limited list of nodes in JSON format:

bacalhau node list  --limit 3 --output json --pretty

Expected output:

[
  {
    "PeerInfo": {
      "ID": "QmTSJgdN7zCPAqBCkmdsdpFbiJV8bJ6zhoxK9N5xfar1sz",
      ... [Additional node details] ...
    },
    ... [Other nodes] ...
  }
]