文件列表:

defaults/
handlers/
meta/
molecule/
tasks/
templates/
vars/
.ansible-lint
.yamllint.yml

- [Intro](https://github.com/rlex/ansible-role-victoriametrics/blob/master/#intro) - [Compatibility](https://github.com/rlex/ansible-role-victoriametrics/blob/master/#compatibility) - [Warning about configuration mode change](https://github.com/rlex/ansible-role-victoriametrics/blob/master/#warning-about-configuration-mode-change) - [Single node](https://github.com/rlex/ansible-role-victoriametrics/blob/master/#single-node) - [Cluster](https://github.com/rlex/ansible-role-victoriametrics/blob/master/#cluster) - [vmutils](https://github.com/rlex/ansible-role-victoriametrics/blob/master/#vmutils) - [vmauth](https://github.com/rlex/ansible-role-victoriametrics/blob/master/#vmauth) - [vmagent](https://github.com/rlex/ansible-role-victoriametrics/blob/master/#vmagent) - [vmalert](https://github.com/rlex/ansible-role-victoriametrics/blob/master/#vmalert) ## Intro Ansible role for [VictoriaMetrics](https://github.com/rlex/ansible-role-victoriametrics/blob/master/https://victoriametrics.com/) This role can manage: * Single-node installations * Cluster installations * Vmutils installations: * vmalert * vmagent * vmauth * vmbackup (installation only) * vmrestore (installation only) * vmctl (installation only) Or even all of that at once on single node, if for some reason you need it. ## Compatibility This role is compatible with any modern systemd-based distro using arm64 or amd64. ### Warning about configuration mode change At 12/12/2023, old method of configuring apps with arguments was deprecated. Instead, environment variables will be used. Transition to new env-based mode _should_ be smooth (at least i tried to keep full compatibility), since it should support all old parameters, but if you want to preserve old arguments-based configuration system, set ``` victoriametrics_global_config_mode: args ``` You can also override it per service (search for "_config_mode" in variables). However, there is no guarantee that this method of configuration won't be removed in the future. Old _args variables, like victoriametrics_cluster_vmstorage_args, will still work with both old and new configuration method, however, you can also use new _envs variables like victoriametrics_cluster_vmstorage_envs to configure additional parameters for victoriametrics components. For info about that parameters, refer to [official victoriametrics docs](https://github.com/rlex/ansible-role-victoriametrics/blob/master/https://docs.victoriametrics.com/?highlight=envflag.enable#environment-variables) ## Single node Installing victoriametrics in single mode is as easy as setting ``` victoriametrics_singlenode: true ``` And running this role. It will create user, systemd config, create folder for data and start listening on 127.0.0.1:8428 for both write and read requests. Role variables related to single-node setup: | Variable name | Default value | Description | | --------------------------------- | ------------------------------------ | ---------------------------------------- | | victoriametrics_singlenode | `false` | installs single node if set to true | | victoriametrics_user | `victoriametrics` | victoriametrics system user | | victoriametrics_group | `{{ victoriametrics_cluster_user }}` | victoriametrics system group | | victoriametrics_version | `1.95.1` | victoriametrics version | | victoriametrics_retention_period | `3` | data retention period in months | | victoriametrics_storage_data_path | `/var/lib/victoria-metrics` | path to victoriametrics data dir | | victoriametrics_args | `{}` | optional args to pass to victoriametrics | | victoriametrics_http_listen_addr | `127.0.0.1:8428` | port to listen on | ## Cluster Role variables related to cluster: | Variable name | Default value | Description | | --------------------------------------------------- | ------------------------------- | -------------------------------------------------- | | victoriametrics_cluster | `false` | indicates this node is part of cluster | | victoriametrics_cluster_user | `{{ victoriametrics_user }}` | victoriametrics system user | | victoriametrics_cluster_group | `{{ victoriametrics_group }}` | victoriametrics system group | | victoriametrics_cluster_version | `{{ victoriametrics_version }}` | victoriametrics version | | victoriametrics_cluster_vmstorage | `false` | installs and configures vmstorage if set to true | | victoriametrics_cluster_vmstorage_retention_period | `3` | vmstorage retention period (months) | | victoriametrics_cluster_vmstorage_storage_data_path | `/var/lib/victoria-metrics` | directory where vmstorage stores metrics | | victoriametrics_cluster_vmstorage_http_listen_addr | `0.0.0.0:8482` | address where vmstorage http should listen | | victoriametrics_cluster_vmstorage_vminsert_addr | `0.0.0.0:8400` | address where vmstorage should listen for vminsert | | victoriametrics_cluster_vmstorage_vmselect_addr | `0.0.0.0:8401` | address where vmstorage should listen for vmselect | | victoriametrics_cluster_vmstorage_args | `{}` | additional arguments for vmstorage | | victoriametrics_cluster_vmstorage_envs | `{}` | additional environment variables for vmstorage | | victoriametrics_cluster_vminsert | `false` | installs and configures vminsert if set to true | | victoriametrics_cluster_vminsert_http_listen_addr | `0.0.0.0:8480` | address where vminsert http should listen | | victoriametrics_cluster_vminsert_storage_node | `- localhost:8400` | array of vmstorage nodes to connect | | victoriametrics_cluster_vminsert_args | `{}` | additional arguments for vminsert | | victoriametrics_cluster_vminsert_envs | `{}` | additional environment variables for vminsert | | victoriametrics_cluster_vmselect | `false` | installs and configure vmselect if set to true | | victoriametrics_cluster_vmselect_http_listen_addr | `0.0.0.0:8481` | address where vmselect http should listen | | victoriametrics_cluster_vmselect_storage_node | `- localhost:8401` | array of vmstorage nodes to connect | | victoriametrics_cluster_vmselect_args | `{}` | additional arguments for vmselect | | victoriametrics_cluster_vmselect_envs | `{}` | additional environment variables for vmselect | Installing cluster is a bit more complex. You will need setting at least this parameters to true: ```yaml victoriametrics_cluster: true victoriametrics_cluster_vmstorage: true victoriametrics_cluster_vminsert: true victoriametrics_cluster_vmselect: true ``` This will install vmstorage, vminsert, vmselect, create directory for vmstorage, configure vmselect and vminsert to connect to local vmstorage node. Victoriametrics cluster version will be inherited from victoriametrics_version by default. Essentially you will get single-node "cluster". But if you're looking at cluster settings you're probably looking to spread them among multiple servers, so here is an example on how to do that: Example inventory: ```ini [victoriametrics:children] victoriametrics-vmstorage victoriametrics-vmselect victoriametrics-vminsert [victoriametrics-vmstorage] storage_node1 storage_node2 storage_node3 [victoriametrics-vminsert] insert_node1 insert_node2 [victoriametrics-vmselect] select_node1 select_node2 ``` In victoriametrics define following group_vars: ```yaml victoriametric_cluster: true victoriametrics_cluster_vmselect_storage_node: - storage_node1:8400 - storage_node2:8400 - storage_node3:8400 victoriametrics_cluster_vminsert_storage_node: - storage_node1:8401 - storage_node2:8401 - storage_node3:8401 ``` In victoriametrics-vmstorage group_vars: ```yaml victoriametrics_cluster_vmstorage: true ``` In victoriametrics-vminsert group_vars: ```yaml victoriametrics_cluster_vminsert: true ``` In victoriametrics-vmselect group_vars: ```yaml victoriametrics_cluster_vmselect: true ``` This will end up with 2 select and 2 insert nodes, connected to 3 storage nodes. Of course this is just an example and you're free to use those vars wherever you want - in playbook vars, directly in inventory or in host_vars. ## vmutils Setting ```yaml victoriametrics_vmutils: true ``` Will install victoriametrics vmutils binaries (vmbackup, vmrestore, vmagent, vmauth, vmalert). It inherits version from victoriametrics_version and permissions from victoriametrics_users/victoriametrics_group. You can control which packages to install with victoriametrics_vmutils_files array, ie: ```yaml victoriametrics_vmutils_files: - vmagent - vmalert - vmauth - vmbackup - vmrestore ``` ## vmauth vmauth-related variables: | Variable name | Default value | Description | | ---------------------------- | ------------- | --------------------------------------- | | victoriametrics_vmauth | `false` | enables vmauth if set to true | | victoriametrics_vmauth_users | `{}` | YAML with users, follow original format | | victoriametrics_vmauth_args | `{}` | additional arguments to pass to vmauth | Sample config: ```yaml victoriametrics_vmauth: true victoriametrics_vmauth_users: - username: "local-single-node" password: "password" url_prefix: "http://localhost:8428" - username: "cluster-select-account-123" password: "password" url_prefix: "http://vmselect:8481/select/123/prometheus" - username: "cluster-insert-account-42" password: "password" url_prefix: "http://vminsert:8480/insert/42/prometheus" ``` ## vmagent vmagent-related variables: | Variable name | Default value | Description | | ----------------------------------------------- | ------------------------------------ | --------------------------------------------------- | | victoriametrics_vmagent | `false` | enables vmagent if set to true | | victoriametrics_vmagent_global | `{}` | YAML with vmagent global settings | | victoriametrics_vmagent_external_labels | `{}` | YAML with vmagent external labels | | victoriametrics_vmagent_remotewrite_url | `http://localhost:8428/api/v1/write` | URL to victoriametrics instance for writing | | victoriametrics_vmagent_remotewrite_tmpdatapath | `{}` | Folder to keep metrics if remotewrite_url is down | | victoriametrics_vmagent_scrape_configs | `{}` | YAML with prometheus scrape_configs | | victoriametrics_vmagent_args | `{}` | additional arguments to pass to vmagent | | victoriametrics_vmagent_envs | `{}` | additional environment variables to pass to vmagent | Sample config, adding prometheus label environment=production, setting tmp folder to /var/lib/vmagent/tmp (folder will be created by role with proper permissions), and adding single scrape job from localhost: ```yaml victoriametrics_vmagent: true victoriametrics_vmagent_global: scrape_interval: 15s scrape_timeout: 10s victoriametrics_vmagent_external_labels: environment: production victoriametrics_vmagent_remotewrite_url: http://localhost:8428/api/v1/write victoriametrics_vmagent_remotewrite_tmpdatapath: /var/lib/vmagent/tmp victoriametrics_vmagent_scrape_configs: - job_name: "vmagent-scrape" metrics_path: /metrics basic_auth: username: username password: password static_configs: - targets: - localhost:8429 ``` ## vmalert vmalert-related variables: | Variable name | Default value | Description | | --------------------------------------- | ----------------------- | ---------------------------------------------------------- | | victoriametrics_vmalert | `false` | enables vmalert if set to true | | victoriametrics_vmalert_datasource_url | `http://localhost:8428` | URL with datasource from which vmalert will read metrics | | victoriametrics_vmalert_notifier_url | `http://localhost:9093` | URL with alertmanager instance | | victoriametrics_vmalert_remotewrite_url | `http://localhost:8428` | URL with victoriametrics instance to persist vmalert state | | victoriametrics_vmalert_remoteread_url | `http://localhost:8428` | URL with victoriametrics instance to read vmalert state | | victoriametrics_vmalert_alert_rules | `{}` | YAML with prometheus alert rules | | victoriametrics_vmalert_args | `{}` | additional arguments to pass to vmalert | | victoriametrics_vmalert_envs | `{}` | additional environment variables to pass to vmalert | Sample config, pointing to local victoriametrics instance for both streaming metrics, persisting vmalert state and local alertmanager instance for sending alerts, with single rule to check for exporters in "down" state: ```yaml victoriametrics_vmalert: true victoriametrics_vmalert_datasource_url: http://localhost:8428 victoriametrics_vmalert_notifier_url: http://localhost:9093 victoriametrics_vmalert_remotewrite_url: http://localhost:8428 victoriametrics_vmalert_remoteread_url: http://localhost:8428 victoriametrics_vmalert_alert_rules: - alert: Instance down expr: 'up == 0' for: 5m labels: severity: critical annotations: summary: '{% raw %}Exporter down{% endraw %}' description: '{% raw %}Prometheus node {{ $labels.instance }} is down{% endraw %}' ```

近期下载者：

相关文件：

评论：[我要评论] [举报此文件]

收藏者：