Skip to content

operator.md

Latest commit

 

History

History
65 lines (42 loc) · 2.9 KB

operator.md

File metadata and controls

65 lines (42 loc) · 2.9 KB

joystream-distributor operator

Commands for performing node operator (Distribution Working Group worker) on-chain duties (like accepting bucket invitations, setting node metadata)

joystream-distributor operator:accept-invitation

Accept pending distribution bucket operator invitation.

USAGE
  $ joystream-distributor operator:accept-invitation

OPTIONS
  -B, --bucketId=bucketId      (required) Distribution bucket ID in {familyId}:{bucketIndex} format.

  -c, --configPath=configPath  [default: ./config.yml] Path to config JSON/YAML file (relative to current working
                               directory)

  -w, --workerId=workerId      (required) ID of the invited operator (distribution group worker)

  -y, --yes                    Answer "yes" to any prompt, skipping any manual confirmations

DESCRIPTION
  Requires the invited distribution group worker role key.

See code: src/commands/operator/accept-invitation.ts

joystream-distributor operator:set-metadata

Set/update distribution bucket operator metadata.

USAGE
  $ joystream-distributor operator:set-metadata

OPTIONS
  -B, --bucketId=bucketId                                                   (required) Distribution bucket ID in
                                                                            {familyId}:{bucketIndex} format.

  -c, --configPath=configPath                                               [default: ./config.yml] Path to config
                                                                            JSON/YAML file (relative to current working
                                                                            directory)

  -e, --endpoint=endpoint                                                   Root distribution node endpoint

  -i, --input=input                                                         Path to JSON metadata file

  -o, --operationalStatus=(Normal|NoService|NoServiceFrom|NoServiceDuring)  Operational status of the operator

  -w, --workerId=workerId                                                   (required) ID of the operator (distribution
                                                                            group worker)

  -y, --yes                                                                 Answer "yes" to any prompt, skipping any
                                                                            manual confirmations

DESCRIPTION
  Requires active distribution bucket operator worker role key.

See code: src/commands/operator/set-metadata.ts