https://github.com/standardweb3/ansible-role-substrate-deployer
Ansible Role used to deploy Substrate node.
https://github.com/standardweb3/ansible-role-substrate-deployer
Last synced: 11 months ago
JSON representation
Ansible Role used to deploy Substrate node.
- Host: GitHub
- URL: https://github.com/standardweb3/ansible-role-substrate-deployer
- Owner: standardweb3
- License: mit
- Created: 2021-06-21T14:41:37.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-03-31T09:11:22.000Z (about 4 years ago)
- Last Synced: 2025-01-16T04:26:02.440Z (over 1 year ago)
- Language: Jinja
- Size: 74.2 KB
- Stars: 1
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Ansible Role: Substrate Node
This role deploys and sets up Substrate Node on a target Virtual Machine.
**Note:** This role is still in active development. There may be unidentified issues and the role variables may change as development continues.
## Requirements
- Ansible >= 2.7 (It might work on previous versions, but we cannot guarantee it)
## Considerations
- If downloading an archive, expectation is that it will contain only one binary and no other files, otherwise workflow will fail in unexpected ways.
## Role Variables
All variables which can be overridden are stored in [defaults/main.yml](defaults/main.yml) and are listed in the table below.
| Name | Default Value | Description |
| ---------------------------------------- | ------------------------ | --------------------------------------------------------------------------------- |
| `substrate_node_install` | `true` | Set if you want to download release and replace it with existing if it differs. |
| `substrate_node_configure` | `true` | Set if you want to do configuration part. |
| `substrate_node_version` | `0.0.9` | Version of the release to download and use. Also accepts latest as parameter. |
| `substrate_node_bin_dir` | `/usr/local/bin/` | Folder where binary will be put. |
| `substrate_node_bin_name` | `opportunity-standalone` | Name of the binary and service to use. |
| `substrate_node_logging` | `syslog` | Logging to use with systemd - can be 'syslog' or 'file'. |
| `substrate_node_restart` | `always` | Restart option for systemd service. |
| `substrate_node_logrotate_conf_enable` | `true` | Enable logrotate config for log files. Needs `substrate_node_logging` == `"file"` |
| `substrate_node_logrotate_conf` | `redacted` | Logrotate config, syntax available in defaults. |
| `substrate_node_role` | `Validator` | Choose role for node: "Validator", "Collator, "RPC" |
| `substrate_node_bootnodes` | `` | Supply a list of bootnodes if required |
| `substrate_node_friendly_name` | `null` | Name which is used by the Telemetry service. |
| `substrate_node_data_dir` | `/data` | Data directory in which chain state will be stored. |
| `substrate_node_substrate_node_identity` | `` | Identity to be used by the node - "alice","bob", etc. |
| `substrate_node_use_root` | `true` | Whether to use root as a Linux user for permissions/running binary. |
| `substrate_node_pruning` | `` | Pruning mode to use - archive or constained |
| `substrate_node_chain` | `opportunity` | Chain to use by the node. |
| `substrate_node_p2p_port` | `30333` | libp2p port used by the node. |
| `substrate_node_rpc_port` | `9933` | HTTP RPC port used by the node. |
| `substrate_node_rpc_external` | `false` | Specify if we want to open up HTTP RPC outside of localhost/polkadot.js. |
| `substrate_node_ws_port` | `9944` | WebSocket port used by the node. |
| `substrate_node_ws_external` | `false` | Specify if we want to open up WebSocket RPC outside of localhost/polkadot.js. |
| `substrate_node_rpc_cors` | `` | Specify list of origins for external RPCs or 'all'. |
| `substrate_node_rpc_methods` | `` | Specify RPC mode - Auto, Safe, Unsafe. |
| `substrate_node_prometheus_port` | `9615` | Specify which port we want to use for Prometheus endpoint. |
| `substrate_node_prometheus_disable` | `false` | Specify if we want to disable Prometheus endpoint. |
| `substrate_node_prometheus_external` | `false` | Specify if we want to open up Prometheus outside of localhost/polkadot.js. |
## Installation
### Ansible Galaxy
Use `ansible-galaxy install standardtech_bot.substrate_deployer` to install the latest stable release of the role on your system.
### Requirements file
Add it to the requirements file:
```yaml
roles:
- name: substrate_deployer
src: https://github.com/digitalnativeinc/ansible-role-substrate-deployer.git
version: 0.6.0
```
Install requirements:
```bash
ansible-galaxy install -r requirements.yml
```
## Playbook
Use it in a playbook as follows:
```yaml
- hosts: all
roles:
- substrate_deployer
vars:
substrate_node_version: latest
substrate_node_role: "Validator"
substrate_node_friendly_name: "Standard Validator"
substrate_node_logging: "file"
substrate_node_data_dir: "/data"
substrate_node_rpc_port: 9933
substrate_node_bin_name: "opportunity-standalone"
```
## License
This project is licensed under MIT License. See [LICENSE](/LICENSE) for more details.