types.zeek¶

ClusterController::Types¶

Namespace: ClusterController::Types

Summary¶

Types¶

`ClusterController::Types::Configuration`: `record`
`ClusterController::Types::Instance`: `record`	Configuration describing a Zeek instance running a Cluster Agent.
`ClusterController::Types::Node`: `record`	Configuration describing a Cluster Node process.
`ClusterController::Types::Option`: `record`	A Zeek-side option with value.
`ClusterController::Types::Result`: `record`
`ClusterController::Types::ResultVec`: `vector`
`ClusterController::Types::Role`: `enum`	Management infrastructure node type.
`ClusterController::Types::State`: `enum`	State that a Cluster Node can be in.

Detailed Interface¶

Types¶

ClusterController::Types::Configuration ¶

Type

record

id: string &default = Chd8EgFWk2j &optional

instances: set [ClusterController::Types::Instance]: The instances in the cluster. XXX we may be able to make this optional
nodes: set [ClusterController::Types::Node]: The set of nodes in the cluster, as distributed over the instances.

ClusterController::Types::Instance ¶

Type

record

host: addr

listen_port: port &optional

Configuration describing a Zeek instance running a Cluster Agent. Normally, there’ll be one instance per cluster system: a single physical system.

ClusterController::Types::Node ¶

Type

record

instance: string

p: port

role: Supervisor::ClusterRole

state: ClusterController::Types::State

scripts: vector of string &optional

options: set [ClusterController::Types::Option] &optional

interface: string &optional

cpu_affinity: int &optional

env: table [string] of string &default = { } &optional

Configuration describing a Cluster Node process.

ClusterController::Types::Option ¶

Type

record

value: string

A Zeek-side option with value.

ClusterController::Types::Result ¶

Type

record

reqid: string

instance: string

success: bool &default = T &optional

data: any &optional

error: string &default = "" &optional

node: string &optional

ClusterController::Types::ResultVec ¶

Type: vector of ClusterController::Types::Result

ClusterController::Types::Role ¶

Type

enum

ClusterController::Types::NONE¶

ClusterController::Types::AGENT¶

ClusterController::Types::CONTROLLER¶

Management infrastructure node type. This intentionally does not include the data cluster node types (worker, logger, etc) – those continue to be managed by the cluster framework.

ClusterController::Types::State ¶

Type

enum

ClusterController::Types::Running¶

ClusterController::Types::Stopped¶

ClusterController::Types::Failed¶

ClusterController::Types::Crashed¶

ClusterController::Types::Unknown¶

State that a Cluster Node can be in. State changes trigger an API notification (see notify_change()).