23 Commits

Author SHA1 Message Date
94db2c0a69 feat!: remove node exporter from monitoring stack (#9)
## What 
Remove node exporter from monitoring

## Why 
Redundant for this context 

## Checklist

<!-- Check your PR fulfills the following items. -->
<!-- For draft PRs check the boxes as you complete them. -->

- [x] PR title corresponds to the body of PR (we generate changelog
entries from PRs).
- [x] Documentation comments have been added / updated.
2024-03-12 17:06:09 +02:00
26319af6d7 Merge pull request #8 from matter-labs/docs-envs
chore(docs): Better explain chain settings, minor tweaks
2024-03-08 09:24:14 +01:00
37bbe33ad7 minor tweaks 2024-03-08 09:18:55 +01:00
e776080ba4 typo fix 2024-03-08 09:17:00 +01:00
991e7ba587 typo fix 2024-03-08 09:16:24 +01:00
9f7f0bb6cd prettify dump links 2024-03-08 09:15:58 +01:00
ea06fe4c67 chore(docs): Better explain env settings, minor tweaks 2024-03-08 09:13:20 +01:00
254085bea2 Merge pull request #7 from matter-labs/pgtune-docs-fix
chore(docs): Fix duplicated pgtune block in README
2024-03-07 09:51:48 +01:00
b5cb15078b chore(docs): Fix duplicated pgtune block in README 2024-03-07 09:40:57 +01:00
46cd390d3d Merge pull request #6 from matter-labs/add_basic_auth
feat: add basic auth for external node
2024-03-07 09:36:13 +01:00
9fff909803 Update README.md 2024-03-07 09:35:33 +01:00
873119a54c Update README.md 2024-03-07 09:35:05 +01:00
3e46648470 Merge branch 'main' into add_basic_auth 2024-03-07 10:23:42 +02:00
86c976e375 chore(docs): README grammar fix (#5)
## What 

- Minor README grammar fix

## Checklist

<!-- Check your PR fulfills the following items. -->
<!-- For draft PRs check the boxes as you complete them. -->

- [x] PR title corresponds to the body of PR (we generate changelog
entries from PRs).
- [x] Documentation comments have been added / updated.
2024-03-07 10:23:12 +02:00
831de81f98 update doc 2024-03-07 10:21:24 +02:00
7cd995dfb5 update doc 2024-03-07 10:20:27 +02:00
4f54d8a139 update doc 2024-03-07 10:12:20 +02:00
586fe6d4dc Update README.md 2024-03-07 09:03:52 +01:00
bb74dfc55f Update README.md 2024-03-07 09:03:29 +01:00
1114c9a4c6 update doc 2024-03-07 09:55:10 +02:00
950cbd4f7d update doc 2024-03-07 09:53:03 +02:00
e3f7fe3c87 update doc 2024-03-07 09:50:05 +02:00
118523076b feat: add basic auth for external node 2024-03-07 09:49:38 +02:00
5 changed files with 37 additions and 32 deletions

View File

@ -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

View File

@ -13,7 +13,6 @@ traefik_version: 2.11
postgres_version: 14
external_node_version: 21.0.2
vmagent_version: 1.95.1
node_exporter_version: 1.7.0
cadvisor_version: 0.47.2
postgres_exporter_version: 0.15.0
@ -62,6 +61,10 @@ enable_tls: false
acme_email: ""
domain_name: ""
# Enable basic auth for external node
enable_basic_auth: false
basic_auth_secret: ""
# Force restore pg database
force_pg_restore: false

View File

@ -69,6 +69,10 @@ services:
- "traefik.http.routers.external_node_health.rule=PathPrefix(`/`)"
- "traefik.http.routers.external_node_health.entrypoints=external_node_health"
- "traefik.http.routers.external_node_health.service=external_node_health"
{% if enable_basic_auth %}
- "traefik.http.routers.external_node_main.middlewares=external_node_auth"
- "traefik.http.middlewares.external_node_auth.basicauth.users={{ basic_auth_secret }}"
{% endif %}
expose:
- {{ rpc_http_port }}
- {{ rpc_ws_port }}

View File

@ -21,18 +21,6 @@ services:
- "--remoteWrite.vmProtoCompressLevel=2"
restart: always
node-exporter:
image: "prom/node-exporter:v{{ node_exporter_version }}"
volumes:
- /proc:/host/proc:ro
- /sys:/host/sys:ro
- /:/rootfs:ro
restart: unless-stopped
command:
- '--path.procfs=/host/proc'
- '--path.sysfs=/host/sys'
- '--collector.filesystem.ignored-mount-points=^/(sys|proc|dev|host|etc)($$|/)'
cadvisor:
image: "gcr.io/cadvisor/cadvisor:v{{ cadvisor_version }}"
volumes:

View File

@ -14,14 +14,6 @@ scrape_configs:
- source_labels: [instance]
target_label: instance
replacement: '{{ node_name | mandatory }}'
- job_name: node-exporter
static_configs:
- targets:
- "node-exporter:9100"
relabel_configs:
- source_labels: [instance]
target_label: instance
replacement: '{{ node_name | mandatory }}'
- job_name: cadvisor
static_configs:
- targets: