Configure ClickHouse
Overview
Follow the steps in this guide to update the /etc/nms/nms.conf
file if you used a custom address, username, or password or enabled TLS when installing ClickHouse. F5 NGINX Management Suite requires this information to connect to ClickHouse.
Default ClickHouse Values
Unless specified differently in the /etc/nms/nms.conf
file, NGINX Management Suite uses the following values for ClickHouse by default:
Configuration | Default | Notes |
---|---|---|
clickhouse.address | tcp://localhost:9000 | |
clickhouse.username | ||
clickhouse.password | ||
clickhouse.tls_mode | false | |
clickhouse.tls.address | tcp://localhost:9440 | |
clickhouse.tls.skip_verify | false | clickhouse.tls.skip_verify should be used only for self-signed certificates and is never recommended for production use. When set to true , certificates are not verified, which exposes the connection to man-in-the-middle attacks. |
clickhouse.tls.key_path | ||
clickhouse.tls.cert_path | ||
clickhouse.tls.ca_path | /etc/ssl/certs/ca-certificates.crt | The default value for clickhouse.tls.ca_path works out-of-the-box for Ubuntu and Debian. You’ll need to configure a different Certificate Authority for other distributions. Refer to your distribution’s documentation for additional information. |
Use Custom Address, Username, Password
If your ClickHouse installation has a different address, username, or password than the default values, you need to configure NGINX Management Suite to connect to ClickHouse.
To set custom values for the ClickHouse address, username, and password:
-
On the NGINX Management Suite server, open the
/etc/nms/nms.conf
file for editing. -
Change the following settings to match your ClickHouse configuration:
clickhouse: address: tcp://localhost:9000 username: <INSERT USERNAME HERE> password: <INSERT PASSWORD HERE>
-
Save the changes and close the file.
Configure TLS
If you configured ClickHouse to work with TLS, take the following steps to update the settings in the NGINX Management Suite nms.conf
file:
-
On the NGINX Management Suite server, open the
/etc/nms/nms.conf
file for editing. -
Configure the
clickhouse
TSL settings to suit your environment:clickhouse: # Sets the log level for ClickHouse processes within NMS. log_level: debug # Sets the address that will be used to connect to ClickHouse. address: 127.0.0.1:9001 ## Note: Username and password should only be set, if you have custom defined username and password for ClickHouse. ## Ensure that any configured username or password is wrapped in single quotes. # Sets the username that will be used to connect to ClickHouse. username: 'test-1' # Sets the password that will be used to connect to ClickHouse. password: 'test-2' # Activates or deactivates TLS for connecting to ClickHouse. # Note: `tls_mode` will be deprecated in the future, use the `tls` key to enable TLS connection for ClickHouse. tls_mode: true tls: # Sets the address (form <ip-address:port>)used to connect to ClickHouse with a TLS connection. address: 127.0.0.1:9441 # Activates or deactivates TLS verification of ClickHouse connection. skip_verify: false # Sets the path of the certificate used for TLS connections in PEM encoded format. cert_path: /etc/certs # Sets the path of the client key used for TLS connections in PEM encoded format. key_path: /etc/key # Sets the path of the Certificate Authority installed on the system for verifying certificates. cert_ca: /etc/ca # Sets directory containing ClickHouse migration files. migrations_path: /test/migrations
-
Save the changes and close the file.