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
logs	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
publicApi	object	Required	cannot be null	Distributor node configuration
operatorApi	object	Optional	cannot be null	Distributor node configuration
keys	array	Optional	cannot be null	Distributor node configuration
buckets	array	Optional	cannot be null	Distributor node configuration
workerId	integer	Optional	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)

logs

Specifies the logging configuration

logs

• is optional

• Type: object (Details)

• cannot be null

• defined in: Distributor node configuration

logs 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)

publicApi

Public api configuration

publicApi

• is required

• Type: object (Details)

• cannot be null

• defined in: Distributor node configuration

publicApi Type

object (Details)

operatorApi

Operator api configuration

operatorApi

• is optional

• Type: object (Details)

• cannot be null

• defined in: Distributor node configuration

operatorApi Type

object (Details)

keys

Specifies the keys available within distributor node CLI.

keys

• is optional

• 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

Set of bucket ids distributed by the node. If not specified, all buckets currently assigned to worker specified in config.workerId will be distributed. Expected bucket id format is: {familyId}:{bucketIndex}

buckets

• is optional

• Type: string[]

• cannot be null

• defined in: Distributor node configuration

buckets Type

string[]

buckets Constraints

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

unique items: all items in this array must be unique. Duplicates are not allowed.

workerId

ID of the node operator (distribution working group worker)

workerId

• is optional

• 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