From 7b0912c225e41949b4fba31a0d7fe2874d73cd13 Mon Sep 17 00:00:00 2001 From: hatemosphere Date: Wed, 6 Mar 2024 15:34:13 +0100 Subject: [PATCH] proper optional vars example usage --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 5de0514..be5e312 100644 --- a/README.md +++ b/README.md @@ -30,14 +30,14 @@ If you want to use monitoring (which we highly recommend), you have to change th ```yaml # Monitoring options section -enable_monitoring: false -node_name: "" -prometheus_remote_write: false -prometheus_remote_write_url: "" -prometheus_remote_write_auth: false -prometheus_remote_write_auth_username: "" -prometheus_remote_write_auth_password: "" -prometheus_remote_write_common_label: "" +enable_monitoring: true +node_name: "some-unique-node-identifier" +prometheus_remote_write: true +prometheus_remote_write_url: "https://metrics.example.org" +prometheus_remote_write_auth: true +prometheus_remote_write_auth_username: "admin" +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 @@ -45,13 +45,13 @@ to use some load balancer in front of your node, while not having fancy cloud se ```yaml # Security options -use_predefined_iptables: false -disable_ssh_password_auth: false +use_predefined_iptables: true +disable_ssh_password_auth: true iptables_packages: - iptables - iptables-persistent # Variable to be used to accept external traffic only from single specified IP -loadbalancer_ip: "" +loadbalancer_ip: "1.2.3.4" ``` In most of cases, you'd want to change PostgreSQL parameters (we recommend to use with "Online transaction processing system" preset as sane defaults), so you can do it using `postgres_arguments` variable, eg: