bprotocol

Documentation

Index

• Constants
• Variables
• func ComputeHeartbeatTopic(nodeID string) string
• func CreateMessageRegistry() (*envelope.Registry, error)
• func MustCreateMessageRegistry() *envelope.Registry
• func OrchestratorHeartbeatSubscription() string
• type ManagementEndpoint

Constants

const HeartbeatTopicFormat = "bacalhau.global.compute.%s.out.heartbeat"

Variables

var ErrUpgradeAvailable = fmt.Errorf("node supports NCLv1 protocol - legacy protocol disabled")

ErrUpgradeAvailable indicates that the orchestrator supports the NCLv1 protocol

Functions

func ComputeHeartbeatTopic

func ComputeHeartbeatTopic(nodeID string) string

ComputeHeartbeatTopic returns the subject to publish heartbeat messages to. it publishes to the outgoing heartbeat subject of a specific compute node, which the orchestrator subscribes to.

func CreateMessageRegistry

func CreateMessageRegistry() (*envelope.Registry, error)

CreateMessageRegistry creates a new payload registry.

func MustCreateMessageRegistry

func MustCreateMessageRegistry() *envelope.Registry

MustCreateMessageRegistry creates a new payload registry.

func OrchestratorHeartbeatSubscription

func OrchestratorHeartbeatSubscription() string

OrchestratorHeartbeatSubscription returns the subject to subscribe for compute heartbeats. it subscribes for heartbeat messages from all compute nodes

Types

type ManagementEndpoint

type ManagementEndpoint interface {
	// Register registers a compute node with the requester node.
	Register(context.Context, legacy.RegisterRequest) (*legacy.RegisterResponse, error)
	// UpdateInfo sends an update of node info to the requester node
	UpdateInfo(context.Context, legacy.UpdateInfoRequest) (*legacy.UpdateInfoResponse, error)
	// UpdateResources updates the resources currently in use by a specific node
	UpdateResources(context.Context, legacy.UpdateResourcesRequest) (*legacy.UpdateResourcesResponse, error)
}

ManagementEndpoint is the transport-based interface for compute nodes to register with the requester node, update information and perform heartbeats.