Skip to content

Commit

Permalink
Merge pull request #160 from hyphacoop/fix/152-variables-list
Browse files Browse the repository at this point in the history 
Update Playbook Variables Overview
- Closes #152
  • Loading branch information
@dasanchez
dasanchez authored Jul 29, 2022
2 parents 3803b5d + 678c38e commit d0f9a8f
Show file tree
Hide file tree
Showing 2 changed files with 119 additions and 38 deletions.
143 changes: 112 additions & 31 deletions docs/Playbook-Variables.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,34 +7,115 @@ For example, to specify a Gaia version for all the hosts in the play:
ansible-playbook gaia.yml -i examples/inventory-local.yml --extra-vars "gaiad_version=v7.0.2"
```

| Variable | Description | Example Value |
|--------------------------|-----------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------|
| `target` | Target server IP/domain | `example.com` |
| `chain_registry` | When set it will automatically define `gaiad_version`, `chain_id` and `genesis_url` variables from the chain registry file | `https://registry.ping.pub/testnets/theta/chain.json` |
| `gaiad_version` | Gaia repo tag, commit, or branch to check out and compile | `v6.0.4` |
| `gaiad_repository` | Gaia source repo | `https://github.com/cosmos/gaia.git` |
| `chain_id` | Sets the chain ID | `my-testnet` |
| `use_cosmovisor` | Uses cosmovisor when `true`, raw `gaiad` service when `false` | `true` |
| `genesis_url` | URL to download the gzipped genesis file from | `"https://github.com/cosmos/testnets/raw/master/v7-theta/public-testnet/genesis.json.gz"` |
| `genesis_file` | File path to the genesis file* | `"examples/genesis-three-node.json"` |
| `addrbook_url` | URL to download the addrbook.json file from | `"https://quicksync.io/addrbook.cosmos.json"` |
| `addrbook_file` | File path to the addrbook.json file to use | `"addresses.json"` |
| `p2p_pex` | p2p peer exchange is enabled | `true` |
| `p2p_persistent_peers` | list of peers to connect to | "`[email protected]:26656,[email protected]:26656`" |
| `fast_sync` | Enable/disable fast sync | `true` |
| `gaiad_gov_testing` | Set minimum deposit to `1` and voting period to `gaiad_voting_period` when `true` | `true` |
| `gaiad_voting_period` | Voting period for gov proposals | `60s` |
| `enable_swap` | Enable/disable swap | `false` |
| `swap_size` | Swap file size in MB (8 GB default) | `8192` |
| `cosmovisor_skip_backup` | Skip Cosmovisor backups | `true` |
| `monitoring_prometheus` | Configure Prometheus / Grafana monitoring | `false` |
| `gaiad_use_ssl_proxy` | Enable SSL proxy using nginx to gaiad endpoints | `false` |
| `gaiad_api_host` | Sets the subdomain for rest API (e.g. `rest.testnet.com`)** | `rest` |
| `gaiad_rpc_host` | Sets the subdomain for rpc (e.g. `rpc.testnet.com`)** | `rpc` |
| `reboot` | If true, reboots the machine after all tasks are done*** | `false` |
| `monitoring_panic` | Configure PANIC monitoring | `false` |
| `panic_is_validator` | Set host as a validator for PANIC | `no` |

- *The file will not be copied if there already is an existing file with the same length.
- **Configure DNS before provisioning.
- ***Recommended for initial deployment: this makes sure all services start up and pending system updates are applied.
- Default values and less commonly used variables can be found in the defaults [main.yml file](/roles/gaia/defaults/main.yml).
- Update the [ansible_vars template](/roles/gaia/templates/ansible_vars.json.j2) to modify additional variables in the gaia config files.

## Target

| Variable | Description | Example Value |
|-----------------------|-----------------------------------------------------------|---------------|
| `target` | Target server IP/domain (for single node inventory files) | `example.com` |
| `go_version` | Golang version to install | `"1.18.1"` |
| `enable_swap` | Enable/disable swap | `false` |
| `swap_size` | Swap file size in MB (8 GB default) | `8192` |
| `gaiad_use_ssl_proxy` | Enable SSL proxy for gaiad endpoints using Nginx* | `false` |
| `gaiad_api_host` | Set the subdomain for REST API (e.g. `rest.testnet.com`)* | `rest` |
| `gaiad_rpc_host` | Set the subdomain for RPC (e.g. `rpc.testnet.com`)* | `rpc` |
| `gaiad_grpc_host` | Set the subdomain for GRPC (e.g. `grpc.testnet.com`)* | `grpc` |
| `gaiad_p2p_host` | Set the subdomain for P2P (e.g. `p2p.testnet.com`)* | `p2p` |
| `reboot` | Reboot the machine after all tasks are done when `true`** | `false` |

*Configure DNS before provisioning.
**Recommended for initial deployment: this makes sure all services start up and pending system updates are applied.

## Chain Binary Installation
| Variable | Description | Example Value |
|------------------------|---------------------------------------------------------------------------------|------------------------------------------------------------------------------------|
| `gaiad_user` | User account to install the chain binary in | `gaia` |
| `gaiad_user_home` | Path to the user account home | `/home/gaia` |
| `gaiad_home` | Path to Gaia home folder home | `/home/gaia/.gaia` |
| `gaiad_home_autoclear` | Clear the `gaiad_home` folder before install when `true` | `false` |
| `gaiad_unsafe_reset` | Clear the chain database before install when `true` | `true` |
| `chain_registry` | Define `gaiad_version`, `chain_id` and `genesis_url` using the chain registry | `https://registry.ping.pub/testnets/theta/chain.json` |
| `gaiad_version` | Gaia repo tag, commit, or branch to check out and compile | `v6.0.4` |
| `gaiad_repository` | URL for Gaia repo repo | `https://github.com/cosmos/gaia.git` |
| `gaiad_binary_release` | URL of the binary to install | `https://github.com/cosmos/gaia/releases/download/v7.0.2/gaiad-v7.0.2-linux-amd64` |
| `gaiad_binary_source` | Build the binary from source if set to `build`, download it if set to `release` | `build` |
| `gaiad_service_name` | Chain service name when `use_cosmovisor` is `false` | `gaiad`
| `gaiad_bin` | Full path for the gaia binary | `/home/gaia/go/bin/gaiad` |
| `chain_id` | ID | `my-testnet` |
| `addrbook_url` | URL to download the addrbook.json file from | `"https://quicksync.io/addrbook.cosmos.json"` |
| `addrbook_file` | File path to the addrbook.json file to use | `"addresses.json"` |

## Chain Configuration: `genesis.json`

| Variable | Description | Example Value |
|-------------------------------|-------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------|
| `genesis_url` | URL to download the gzipped genesis file from | `"https://github.com/cosmos/testnets/raw/master/v7-theta/public-testnet/genesis.json.gz"` |
| `genesis_file` | File path to the genesis file*** | `"examples/genesis-three-node.json"` |
| `gaiad_voting_period` | Voting period for gov proposals | `60s` |
| `gaiad_gov_testing` | Set minimum deposit to `1`<br> and voting period to <br>`gaiad_voting_period` when `true` | `false` |
| `gaiad_bond_denom` | Set denom to replace `stake` with | `uatom` |
| `gaiad_create_validator` | Create a validator when starting from fresh state | `true` |
| `gaiad_gentx_validator_stake` | Tokens validator will self-delegate at genesis | `"1000000uatom"` |
| `gaiad_validator_coins` | Funds assigned to validator through genesis | `"11000000uatom"`
| `gaiad_validator_keyring` | Keyring for the validator keypair | `test` |
| `gaiad_airdrop` | Airdrop tokens to accounts list when `true` | `false` |
| `gaiad_airdrop_coins` | Amount to airdrop to specified accounts | `"10000uatom"` |
| `gaiad_airdrop_accounts` | List of accounts to airdrop tokens to | `[address-1,address-2,address-3]`

***The file will not be copied if there already is an existing file with the same length.

## Chain Configuration: `config.toml`

| Variable | Example Value |
|-------------------------|-------------------------------------------------------------------------------------|
| `fast_sync` | `true` |
| `rpc_port` | `26657` |
| `p2p_port` | `26656` |
| `p2p_seeds` | `"node-id@http://seed-1.testnet.com:26656,node-id@http://seed-2.testnet.com:26656"` |
| `p2p_persistent_peers` | `"node-id@http://p2p-1.testnet.com:26656,node-id@http://p2p-2.testnet.com:26656`" |
| `statesync_enabled` | `true` |
| `statesync_rpc_servers` | `"http://rpc.sentry-1.testnet.com:26657,http://rpc.sentry-2.testnet.com"` |

## Chain Configuration: `app.toml`

| Variable | Example Value |
|----------------------|---------------|
| `minimum_gas_prices` | `"10uatom"` |
| `api_enabled` | `true` |
| `api_port` | `1317` |
| `grpc_enabled` | `true` |
| `grpc_port` | `9090` |

## Chain Configuration: `client.toml`

| Variable | Example Value |
|--------------------------|---------------|
| `client_keyring_backend` | `os` |
| `client_broadcast_mode` | `sync` |

## Faucet

| Variable | Description | Example Value |
|-----------------------|------------------------------------------------------|----------------|
| `faucet_enabled` | Create faucet account and install REST server for it | `true` |
| `faucet_version` | Cosmos REST faucet version to install | `v0.2.1` |
| `faucet_service_name` | Service name for faucet REST server | `token-faucet` |

## Cosmovisor

| Variable | Description | Example Value |
|--------------------------|------------------------------------------------------------------------|---------------|
| `use_cosmovisor` | Use cosmovisor service when `true`, standalone binary one when `false` | `true` |
| `cosmovisor_skip_backup` | Skip Cosmovisor backups | `true` |

## Monitoring and Alerting

| Variable | Description | Example Value |
|-------------------------|-------------------------------------------|---------------------------------------------------------|
| `monitoring_prometheus` | Configure Prometheus / Grafana monitoring | `false` |
| `monitoring_panic` | Configure PANIC monitoring | `false` |
| `panic_ssh_url` | User and address for PANIC server | `[email protected]` |
| `panic_config_file` | Path on PANIC server | `/home/panic/panic_cosmos/config/user_config_nodes.ini` |
| `panic_is_validator` | Set host as a validator for PANIC | `no` |
14 changes: 7 additions & 7 deletions roles/gaia/defaults/main.yml
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
---
binary_arch_map:
aarch64: "linux-arm64"
x86_64: "linux-amd64"

# General Gaiad settings
gaiad_user: gaia
gaiad_user_home: "/home/{{gaiad_user}}"
Expand All @@ -20,13 +16,13 @@ gaiad_voting_period: 10s
gaiad_bond_denom: uatom
chain_id: "theta-devnet"

# Default vaiables for creating a validator
# Default variables for creating a validator
gaiad_create_validator: false
gaiad_gentx_validator_stake: "8000000000{{ gaiad_bond_denom }}"
gaiad_validator_keyring: "test"
gaiad_validator_coins: "1000000000000{{ gaiad_bond_denom }}"

# Default variables for aidropping tokens
# Default variables for airdropping tokens
gaiad_airdrop: false
gaiad_airdrop_coins: "1000000000{{ gaiad_bond_denom }}"
gaiad_airdrop_accounts: []
Expand All @@ -46,7 +42,6 @@ go_arch: "{{binary_arch_map[ansible_architecture]}}"
go_version: "1.18.1"

## config.toml variables
# monicker: "" (taken from hostname on init)
fast_sync: true
abci: socket

Expand Down Expand Up @@ -150,3 +145,8 @@ reboot: true
# addrbook_url: "https://quicksync.io/addrbook.cosmos.json"
# node_key_file: ""
# priv_validator_key_file

# Architecture mapping
binary_arch_map:
aarch64: "linux-arm64"
x86_64: "linux-amd64"

0 comments on commit d0f9a8f

Please sign in to comment.