https://github.com/simplificator/ansible-role-netdata_node
Ansible role which can provision Netdata as a sending client.
https://github.com/simplificator/ansible-role-netdata_node
Last synced: 4 months ago
JSON representation
Ansible role which can provision Netdata as a sending client.
- Host: GitHub
- URL: https://github.com/simplificator/ansible-role-netdata_node
- Owner: simplificator
- License: mit
- Created: 2022-01-26T15:35:19.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-31T08:36:58.000Z (almost 2 years ago)
- Last Synced: 2025-06-02T15:51:06.983Z (about 1 year ago)
- Language: Jinja
- Size: 20.5 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Ansible Role: Netdata Node
[](https://github.com/simplificator/ansible-role-netdata_node/actions?query=workflow%3ACI)
This role configures an existing Netdata base installation as a client which streams its data to another Netdata server.
Its companion role is the [Netdata collector](https://github.com/simplificator/ansible-role-netdata_collector).
## Requirements
An empty Netdata installation, see dependencies.
## Role Variables
The role requires a few variables that are set:
* `netdata_registry_to_announce`: The central registry where this client should be registered. More information is available [here](https://learn.netdata.cloud/docs/agent/registry).
* `netdata_client_stream_key`: API key which will be used to identify the traffic at the server. Can be generated with `uuidgen`. The server needs to know about this UUID as well, otherwise the monitoring data of this client will be rejected.
* `netdata_client_stream_destination`: URL of the server that Netdata will sent its data.
Optional variables:
* `netdata_hostname`: Allows to overwrite the hostname for the client. Default value is "auto-detected".
Additionally, we expect that a certificate is placed at `/etc/netdata/ssl/cert.pem`. It'll be used to encrypt the traffic between node and collector.
## Dependencies
- [simplificator.netdata_installation](https://github.com/simplificator/ansible-role-netdata_installation)
## Example Playbook
```yaml
- hosts: myserver
roles:
- { role: simplificator.netdata_node }
vars:
netdata_registry_to_announce: "https://registry.example.com"
netdata_client_stream_key: "958D31F0-C066-42CD-AE71-10D293E43F79"
netdata_client_stream_destination: "collector.example.com:19999:SSL"
```
## Development
### Variable naming
To ensure that our Netdata roles remain compatible with each other, follow this variable naming convention:
* Role-specific variables are prefixed with the role name (`netdata_node_` in this case).
* General variables that are used in multiple roles will be prefixed with just `netdata_`.
## License
MIT / BSD