joystream/distributor-node/docs/schema/definition.md

Distributor node configuration Type

object (Distributor node configuration)

Distributor node configuration Properties

Property	Type	Required	Nullable	Defined by
id	string	Required	cannot be null	Distributor node configuration
endpoints	object	Required	cannot be null	Distributor node configuration
directories	object	Required	cannot be null	Distributor node configuration
log	object	Optional	cannot be null	Distributor node configuration
limits	object	Required	cannot be null	Distributor node configuration
intervals	object	Required	cannot be null	Distributor node configuration
port	integer	Required	cannot be null	Distributor node configuration
keys	array	Required	cannot be null	Distributor node configuration
buckets	Merged	Required	cannot be null	Distributor node configuration
workerId	integer	Required	cannot be null	Distributor node configuration

id

Node identifier used when sending elasticsearch logs and exposed on /status endpoint

id

• is required

• Type: string

• cannot be null

• defined in: Distributor node configuration

id Type

string

id Constraints

minimum length: the minimum number of characters for this string is: 1

endpoints

Specifies external endpoints that the distributor node will connect to

endpoints

• is required

• Type: object (Details)

• cannot be null

• defined in: Distributor node configuration

endpoints Type

object (Details)

directories

Specifies paths where node's data will be stored

directories

• is required

• Type: object (Details)

• cannot be null

• defined in: Distributor node configuration

directories Type

object (Details)

log

Specifies minimum log levels by supported log outputs

log

• is optional

• Type: object (Details)

• cannot be null

• defined in: Distributor node configuration

log Type

object (Details)

limits

Specifies node limits w.r.t. storage, outbound connections etc.

limits

• is required

• Type: object (Details)

• cannot be null

• defined in: Distributor node configuration

limits Type

object (Details)

intervals

Specifies how often periodic tasks (for example cache cleanup) are executed by the node.

intervals

• is required

• Type: object (Details)

• cannot be null

• defined in: Distributor node configuration

intervals Type

object (Details)

port

Distributor node http api port

port

• is required

• Type: integer

• cannot be null

• defined in: Distributor node configuration

port Type

integer

port Constraints

minimum: the value of this number must greater than or equal to: 0

keys

Specifies the keys available within distributor node CLI.

keys

• is required

• Type: an array of merged types (Details)

• cannot be null

• defined in: Distributor node configuration

keys Type

an array of merged types (Details)

keys Constraints

minimum number of items: the minimum number of items for this array is: 1

buckets

Specifies the buckets distributed by the node

buckets

• is required

• Type: merged type (Details)

• cannot be null

• defined in: Distributor node configuration

buckets Type

merged type (Details)

one (and only one) of

• Bucket ids

• All buckets

workerId

ID of the node operator (distribution working group worker)

workerId

• is required

• Type: integer

• cannot be null

• defined in: Distributor node configuration

workerId Type

integer

workerId Constraints

minimum: the value of this number must greater than or equal to: 0