|
|
|
|
@ -1,6 +1,6 @@
|
|
|
|
|
# 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, 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.
|
|
|
|
|
|
|
|
|
|
@ -14,7 +14,7 @@ This role has been tested on:
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
This role contains variables which has to be set:
|
|
|
|
|
Minimal required variables that has to be set:
|
|
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
database_name: ""
|
|
|
|
|
@ -26,6 +26,8 @@ l1_chain_id: ""
|
|
|
|
|
l2_chain_id: ""
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Please refer to [External Node docs](https://github.com/matter-labs/zksync-era/tree/main/docs/guides/external-node/prepared_configs) to find values for different zkSync Era chains.
|
|
|
|
|
|
|
|
|
|
If you want to use monitoring (which we highly recommend), you have to change these variables:
|
|
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
@ -40,7 +42,7 @@ prometheus_remote_write_auth_password: "password"
|
|
|
|
|
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:
|
|
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
@ -54,7 +56,7 @@ iptables_packages:
|
|
|
|
|
loadbalancer_ip: "1.2.3.4"
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
In most of 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 cases, you'd want to change PostgreSQL parameters, so you can do it using `postgres_arguments` variable, eg:
|
|
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
postgres_arguments:
|
|
|
|
|
@ -66,21 +68,37 @@ postgres_arguments:
|
|
|
|
|
- -c
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
We recommend using pgtune [online]<https://pgtune.leopard.in.ua/> or [self-hosted](https://github.com/le0pard/pgtune) version with with "Online transaction processing system" preset as a good starting point for generating optimal config for your hardware.
|
|
|
|
|
We recommend using pgtune [online](https://pgtune.leopard.in.ua/) or [self-hosted](https://github.com/le0pard/pgtune) version with "Online transaction processing system" preset as a good starting point for generating optimal config for your hardware.
|
|
|
|
|
|
|
|
|
|
If you want to use basic auth for inbound requests, you have to change next variables:
|
|
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
# Enable basic auth for external node
|
|
|
|
|
enable_basic_auth: true
|
|
|
|
|
basic_auth_secret: "htpasswd-generated-secret"
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Basic auth secret can be generated by `htpasswd` and `sed` for interpolation:
|
|
|
|
|
```echo $(htpasswd -nb <username> <password>) | sed -e s/\\$/\\$\\$/g```
|
|
|
|
|
|
|
|
|
|
## 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`
|
|
|
|
|
|
|
|
|
|
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).
|
|
|
|
|
you should place it to `{{ storage_directory }}/pg_backups` directory. By default, `{{ storage_directory }}` is `/usr/src/en`
|
|
|
|
|
2. Prepare the latest database backup on your host. you can download it from our public GCS buckets:
|
|
|
|
|
|
|
|
|
|
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`.
|
|
|
|
|
* [Era Mainnet latest dump](https://storage.googleapis.com/zksync-era-mainnet-external-node-backups/external_node_latest.pgdump)
|
|
|
|
|
* [Era Sepolia Testnet latest dump](https://storage.googleapis.com/zksync-era-boojnet-external-node-snapshots/external_node_latest.pgdump)
|
|
|
|
|
* [Era Goerli Testnet latest dump](https://storage.googleapis.com/zksync-era-testnet-external-node-backups/external_node_latest.pgdump)
|
|
|
|
|
|
|
|
|
|
**Keep in mind, tree should be older than PostgreSQL database backup.**
|
|
|
|
|
Downloaded dump file should be placed into `{{ storage_directory }}/pg_backups` directory (`/usr/src/en/pg_backups` by default)
|
|
|
|
|
|
|
|
|
|
4. Run ansible-playbook using this role. We recommend to encrypt next variables with ansible-vault or some another way:
|
|
|
|
|
3. **OPTIONAL**: If you already have running node, you can copy its tree and state directory to a new host's `{{ storage_directory }}/db`. (`/usr/src/en/db` by default)
|
|
|
|
|
|
|
|
|
|
**Keep in mind that tree and state should be older than PostgreSQL database backup.**
|
|
|
|
|
|
|
|
|
|
4. Run ansible-playbook using this role. We recommend encrypting next variables with ansible-vault or some another way:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
database_username
|
|
|
|
|
|