jleony/ansible-en-role
1
0
Fork 1
mirror of https://github.com/matter-labs/ansible-en-role.git synced 2025-12-06 10:59:56 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update doc

Browse Source
This commit is contained in:
otani
2024-03-07 10:20:27 +02:00
parent 4f54d8a139
commit 7cd995dfb5
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,6 +1,6 @@
# ansible-en-role # ansible-en-role
Ansible role to deploy and configure zkSync Era External Node, including DB isntance setup on the same machine, Traefik as reverse proxy, and Prometheus monitoring (PostgreSQL exporter, Node exporter, cAdvisor, Traefik, External Node native metrics, and VictoriaMetrics vmagent to scrape all of them). Ansible role to deploy and configure zkSync Era External Node, including DB instance setup on the same machine, Traefik as reverse proxy, and Prometheus monitoring (PostgreSQL exporter, Node exporter, cAdvisor, Traefik, External Node native metrics, and VictoriaMetrics vmagent to scrape all of them).
Make sure to configure Prometheus remote write endpoint to send metrics to centralized metrics storage. Make sure to configure Prometheus remote write endpoint to send metrics to centralized metrics storage.
@ -14,7 +14,7 @@ This role has been tested on:
## Usage ## Usage
This role contains variables which has to be set: This role contains variables that have to be set:
```yaml ```yaml
database_name: "" database_name: ""
@ -40,7 +40,7 @@ prometheus_remote_write_auth_password: "password"
prometheus_remote_write_common_label: "matterlabs" prometheus_remote_write_common_label: "matterlabs"
``` ```
This role also has option to secure your server and allow traffic only from specified IP address in case if you want This role also has the option to secure your server and allow traffic only from specified IP address in case if you want
to use some load balancer in front of your node, while not having fancy cloud security groups at your disposal: to use some load balancer in front of your node, while not having fancy cloud security groups at your disposal:
```yaml ```yaml
@ -54,7 +54,7 @@ iptables_packages:
loadbalancer_ip: "1.2.3.4" loadbalancer_ip: "1.2.3.4"
``` ```
In most of a cases, you'd want to change PostgreSQL parameters (we recommend to use <https://pgtune.leopard.in.ua/> with "Online transaction processing system" preset as sane defaults), so you can do it using `postgres_arguments` variable, eg: In most of a cases, you'd want to change PostgreSQL parameters (we recommend to use <https://pgtune.leopard.in.ua/> with "Online transaction processing system" preset as valid defaults), so you can do it using `postgres_arguments` variable, eg:
```yaml ```yaml
postgres_arguments: postgres_arguments:
@ -79,17 +79,17 @@ Basic auth secret can be generated by `htpasswd` and `sed` for interpolation:
## Step-by-step guide ## Step-by-step guide
1. Install ansible collection on your machine from where you will run ansible: 1. Install the ansible collection on your machine from where you will run ansible:
`ansible-galaxy collection install community.general` `ansible-galaxy collection install community.general`
2. Prepare latest database backup on your host. you can download it from our [public GCS bucket](https://storage.googleapis.com/zksync-era-mainnet-external-node-backups/external_node_latest.pgdump). 2. Prepare the latest database backup on your host. you can download it from our [public GCS bucket](https://storage.googleapis.com/zksync-era-mainnet-external-node-backups/external_node_latest.pgdump).
you should place it to `{{ storage_directory }}/pg_backups` directory. By default, `{{ storage_directory }}` is `/usr/src/en` you should place it to `{{ storage_directory }}/pg_backups` directory. By default, `{{ storage_directory }}` is `/usr/src/en`
3. **OPTIONAL**: If you already have external-node, you can copy tree directory to new host. Copy external-node database tree to `{{ storage_directory }}/db`. 3. **OPTIONAL**: If you already have external-node, you can copy tree directory to new host. Copy external-node database tree to `{{ storage_directory }}/db`.
**Keep in mind, tree should be older than PostgreSQL database backup.** **Keep in mind, tree should be older than PostgreSQL database backup.**
4. Run ansible-playbook using this role. We recommend to encrypt next variables with ansible-vault or some another way: 4. Run ansible-playbook using this role. We recommend encrypting next variables with ansible-vault or some another way:
``` ```
database_username database_username