Utilizing NATS.io within Bacalhau

NATS.io networking fundamentals in Bacalhau

Starting from the v.1.3.0 to communicate with other nodes on the network Bacalhau uses NATS.io, a powerful open-source messaging system designed to streamline communication across complex network environments.

Our initial NATS integration focuses on simplifying communication between orchestrator and compute nodes. By embedding NATS within orchestrators, we streamline the network. Now, compute nodes need only connect to one or a few orchestrators and dynamically discover others at runtime, dramatically cutting down on configuration complexity.

How This Benefits Users

1. Easier Setup: Compute nodes no longer need to be directly accessible by orchestrators, removing deployment barriers in diverse environments (on-premises, edge locations, etc.).

2. Increased Reliability: Network changes are less disruptive, as compute nodes can easily switch between orchestrators if needed.

3. Future-Proof: This sets the stage for more advanced NATS features like global clusters and multi-orchestrator setups.

How This Affects Current Users

The aim of integrating NATS into Bacalhau is to keep user experience with Bacalhau's HTTP APIs and CLIs for job submission and queries consistent. This ensures a smooth transition, allowing you to continue your work without any disruptions.

For users, already running Bacalhau networks

NATS now serves as the primary network protocol, simplifying setup and centralizing public access requirements to orchestrator nodes. This change not only simplifies network configurations but also enhances the overall security and efficiency of Bacalhau deployments.

We understand that adapting to new technologies takes time. Therefore, we’ll keep supporting libp2p as an alternative during the transition, giving you the flexibility to migrate at your own pace:

To maintain use of libp2p, simply launch your network with the -network option set to libp2p.

bacalhau serve --network libp2p

This approach provides a bridge, giving you the necessary time and flexibility to adjust your workflows to NATS, all while continuing to benefit from the ongoing support and enhancements within the Bacalhau ecosystem.

This approach provides a bridge, giving you the necessary time and flexibility to adjust your workflows to NATS, all while continuing to benefit from the ongoing support and enhancements within the Bacalhau ecosystem.

Getting Started with NATS

1. Generate an Authentication Token:

Start by creating a secure token. This token will be used for authentication between the orchestrator and compute nodes during their communications:

bacalhau config set "node.network.authsecret" your_secure_token

Make sure to securely store this token and share it only with authorized parties in your network.

2. Running an Orchestrator Node with Authentication:

With the authentication token set, launch your orchestrator node as follows:

bacalhau serve --node-type=requester

This command sets up an orchestrator node with an embedded NATS server, using the given auth token to secure communications. It defaults to port 4222, but you can customize this using the --network-port flag if needed.

3. Initiating Compute Nodes with Authentication:

Compute nodes can authenticate using one of the following methods, depending on your preferred configuration setup:

Option 1: Read authsecret from the Config:

bacalhau serve --node-type=compute --orchestrators=<HOST>

This method assumes the authsecret is already configured in the Bacalhau settings on the compute node, allowing for a seamless authentication process.

Option 2: Pass authsecret Directly in the Orchestrator URI:

bacalhau serve --node-type=compute --orchestrators=your_secure_token@<HOST>

Here, the authsecret is directly included in the command line, providing an alternative for instances where it's preferable to specify the token explicitly rather than rely on the configuration file.

Both methods ensure that compute nodes, acting as NATS clients, securely authenticate with the orchestrator node(s), establishing a trusted communication channel within your Bacalhau network.

More Authentication Options

We're committed to providing a secure and flexible distributed computing environment. Future Bacalhau versions will expand authentication choices, including TLS certificates and JWT, catering to varied security needs and further strengthening network security.

Looking Ahead with NATS

Global Connectivity and Scalability: NATS opens avenues for Bacalhau to operate smoothly across all scales, from local deployments to international networks. Its self-healing capabilities and dynamic mesh networking form the foundation for a future of resilient and flexible distributed computing.

Unlocking New Possibilities: The integration heralds a new era of possibilities for Bacalhau, from global clusters to multiple orchestrator nodes, tackling the complexities of distributed computing with innovation and community collaboration.

Conclusion

The shift to NATS is a step toward making distributed computing more accessible, resilient, and scalable. As we start this new chapter, we're excited to explore the advanced features NATS brings to Bacalhau and welcome our community to join us on this transformative journey.

Support

If you’re interested in learning more about distributed computing and how it can benefit your work, there are several ways to connect with us. Visit our website, sign up to our bi-weekly office hour, join our Slack or send us a message.