Skip to content

Playbook options

Jump to bottom
phahulin edited this page Apr 23, 2018 · 12 revisions

Table of contents

All options at once

access_key

  • roles: all
  • scope: user
  • description: AWS Access Key Id

secret_key

  • roles: all
  • scope: user
  • description: AWS Secret Access Key

awskeypair_name

  • roles: all
  • scope: user
  • description: AWS Keypair name

image

region

  • roles: all
  • scope: instance
  • description: AWS Region

vpc_subnet_id

  • roles: all
  • scope: user
  • description: AWS VPC Subnet ID
  • notes: Run: aws ec2 describe-subnets and find "AvailabilityZone". With related "SubnetId": "subnet-XXXXXX"

NODE_FULLNAME

  • roles: bootnode, moc, validator
  • scope: user
  • description: Node's descriptive name
  • notes: Publicly visible in netstats

NODE_ADMIN_EMAIL

  • roles: bootnode, moc, validator
  • scope: user
  • description: Node owner's email
  • notes: Publicly visible in netstats

NETSTATS_SERVER

  • roles: bootnode, moc, validator
  • scope: user
  • description: URL of netstats server
  • notes: Should be provided to users by Master of Ceremony

NETSTATS_SECRET

  • roles: bootnode, moc, validator, netstats
  • description: Secret code to join netstats
  • scope: user
  • notes: For netstats role this option sets the password of the netstats. Master of Ceremony later provides it to other nodes.

MINING_KEYFILE

  • roles: validator
  • scope: user
  • description: Validator's mining keyfile content (json string)
  • notes: Content of the keyfile should be provided, not path to the file

MINING_ADDRESS

  • roles: validator
  • scope: user
  • description: Validator's mining key address
  • notes: Hex-encoded address, including 0x prefix

MINING_KEYPASS

  • roles: validator
  • scope: user
  • description: Validator's mining key password

MAIN_REPO_FETCH

  • roles: all
  • scope: network
  • description: github account from which all repositories will be downloaded

GENESIS_BRANCH

  • roles: all
  • scope: network
  • description: github branch that store genesis file (aka genesis.json, spec.json, chain.json, ...)

GENESIS_NETWORK_NAME

  • roles: all
  • scope: network
  • description: NetworkName as specified in genesis file

MOC_ADDRESS

  • roles: all
  • scope: network
  • description: Master of Ceremony's account address
  • notes: Hex-encoded address, including 0x prefix. For moc role it is used as mining key, for other nodes is used in other scripts.

MOC_KEYPASS

  • roles: moc
  • scope: user
  • description: Master of Ceremony's account password

MOC_KEYFILE

  • roles: moc
  • scope: user
  • description: Master of Ceremony's account keyfile

SCRIPTS_MOC_BRANCH

SCRIPTS_VALIDATOR_BRANCH

BLK_GAS_LIMIT

  • roles: moc, validator
  • scope: network
  • description: block gas limit

NODE_PWD

  • roles: validator, moc
  • scope: network
  • descrition: name of the file to store password

NODE_SOURCE_DEB

  • roles: all
  • scope: network
  • description: url of the nodejs deb package to use, most importantly - version number

PARITY_BIN_LOC

  • roles: all
  • scope: network
  • description: url of the parity binary file to use, most importantly - version number

PARITY_BIN_SHA256

  • roles: all
  • scope: network
  • description: sha256 checksum of parity binary

ORCHESTRATOR_BIN_LOC

  • roles: all
  • scope: network
  • description: url of the parity-orchestrator binary file to use

ORCHESTRATOR_BIN_SHA256

  • roles: all
  • scope: network
  • description: sha256 checksum of the parity-orchestrator binary

bootnode_instance_type

  • roles: bootnode
  • scope: instance
  • description: AWS instance type

bootnode_instance_name

  • roles: bootnode
  • scope: instance
  • description: AWS instance name

bootnode_count_instances

  • roles: bootnode
  • scope: instance
  • description: number of instances to create

bootnode_security_group

  • roles: bootnode
  • scope: instance
  • description: security group name

bootnode_archive

  • roles: bootnode
  • scope: instance
  • values: "on"/"off"
  • description: should this node be created with additional parameters to work as archive

bootnode_orchestrator

  • roles: bootnode
  • scope: instance
  • values: "on"/"off"
  • description: should parity-orchestrator be installed on this node and parity configured to use whisper

netstat_instance_type

  • roles: netstats
  • scope: instance
  • description: AWS instance type

netstat_instance_name

  • roles: netstats
  • scope: instance
  • description: AWS instance name

netstat_count_instances

  • roles: netstats
  • scope: instance
  • description: number of instances to create

netstat_security_group

  • roles: netstats
  • scope: instance
  • description: security group name

validator_instance_type

  • roles: validator
  • scope: instance
  • description: AWS instance type

validator_instance_name

  • roles: validator
  • scope: instance
  • description: AWS instance name

validator_count_instances

  • roles: validator
  • scope: instance
  • description: number of instances to create

validator_security_group

  • roles: validator
  • scope: instance
  • description: security group name

validator_archive

  • roles: validator
  • scope: instance
  • values: "on"/"off"
  • description: should this node be created with additional parameters to work as archive

moc_instance_type

  • roles: moc
  • scope: instance
  • description: AWS instance type

moc_instance_name

  • roles: moc
  • scope: instance
  • description: AWS instance name

moc_count_instances

  • roles: moc
  • scope: instance
  • description: number of instances to create

moc_security_group

  • roles: moc
  • scope: instance
  • description: security group name

moc_archive

  • roles: moc
  • scope: instance
  • possible values: "on"/"off"
  • description: should this node be created with additional parameters to work as archive

explorer_instance_type

  • roles: explorer
  • scope: instance
  • description: AWS instance type

explorer_instance_name

  • roles: explorer
  • scope: instance
  • description: AWS instance name

explorer_count_instances

  • roles: explorer
  • scope: instance
  • description: number of instances to create

explorer_security_group

  • roles: explorer
  • scope: instance
  • description: security group name

allow_bootnode_ssh

  • roles: bootnode
  • scope: instance
  • description: keep port 22 opened to allow ssh access

allow_bootnode_p2p

  • roles: bootnode
  • scope: instance
  • description: keep port 30303 opened to allow peer discovery

allow_bootnode_rpc

  • roles: bootnode
  • scope: instance
  • description: keep port 8545 opened to allow rpc on this port

associate_bootnode_elastic_ip

  • roles: bootnode
  • scope: instance
  • values: true/false
  • description: configure AWS elastic IP for this node

allow_explorer_ssh

  • roles: explorer
  • scope: instance
  • description: keep port 22 opened to allow ssh access

allow_explorer_p2p

  • roles: explorer
  • scope: instance
  • description: keep port 30303 opened to allow peer discovery

allow_explorer_http

  • roles: explorer
  • scope: instance
  • description: keep port 3000 opened to allow http access on this port

allow_moc_ssh

  • roles: moc
  • scope: instance
  • description: keep port 22 opened to allow ssh access

allow_moc_p2p

  • roles: moc
  • scope: instance
  • description: keep port 30303 opened to allow peer discovery

allow_netstat_ssh

  • roles: netstat
  • scope: instance
  • description: keep port 22 opened to allow ssh access

allow_netstat_http

  • roles: netstat
  • scope: instance
  • description: keep port 3000 opened to allow http access on this port

allow_validator_ssh

  • roles: validator
  • scope: instance
  • description: keep port 22 opened to allow ssh access

allow_validator_p2p

  • roles: validator
  • scope: instance
  • description: keep port 30303 opened to allow peer discovery

associate_validator_elastic_ip

  • roles: validator
  • scope: instance
  • description: configure AWS elastic IP for this node

ABC list

Grouped by roles

Grouped by scope

Home

Clone this wiki locally