Merge branch 'main' into main

grafana · Oct 19, 2024 · 2e58764 · 2e58764
2 parents 33d6f5d + 8709543
commit 2e58764
Show file tree

Hide file tree

Showing 58 changed files with 918 additions and 680 deletions.
diff --git a/.github/workflows/alloy-molecule.yml b/.github/workflows/alloy-molecule.yml
@@ -0,0 +1,44 @@
+---
+name: Alloy Molecule
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+defaults:
+  run:
+    working-directory: roles/alloy
+
+jobs:
+  molecule:
+    name: Molecule
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        distro:
+          - rockylinux9
+          - ubuntu2204
+          - debian12
+
+    steps:
+      - name: Check out the codebase.
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Install test dependencies.
+        run: pip3 install ansible molecule molecule-plugins[docker] docker
+
+      - name: Run Molecule tests.
+        run: molecule test
+        env:
+          PY_COLORS: '1'
+          ANSIBLE_FORCE_COLOR: '1'
+          MOLECULE_DISTRO: ${{ matrix.distro }}
diff --git a/.github/workflows/mimir-molecule.yml b/.github/workflows/mimir-molecule.yml
@@ -35,7 +35,7 @@ jobs:
           python-version: '3.x'
 
       - name: Install test dependencies.
-        run: pip3 install molecule molecule-plugins[docker] docker pytest-testinfra jmespath selinux passlib
+        run: pip3 install ansible-core==2.16 'molecule-plugins[docker]' pytest-testinfra jmespath selinux passlib
 
       - name: create docker network
         run: docker network create molecule

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -4,6 +4,39 @@ Grafana.Grafana Release Notes
 
 .. contents:: Topics
 
+v5.5.1
+======
+
+Bugfixes
+-------------
+
+- Add check_mode: false to Loki "Scrape GitHub" Task by @winsmith in https://github.com/grafana/grafana-ansible-collection/pull/262
+
+v5.4.2
+======
+
+Major Changes
+-------------
+
+- fix:mimir molecule should use ansible core 2.16 by @GVengelen in https://github.com/grafana/grafana-ansible-collection/pull/254
+- promtail: add support for extra args by @harryfinbow in https://github.com/grafana/grafana-ansible-collection/pull/259
+
+v5.4.1
+======
+
+Major Changes
+-------------
+
+- fix: Updated promtail arch map for aarch64 matching by @gianmarco-mameli in https://github.com/grafana/grafana-ansible-collection/pull/257
+
+v5.4.0
+======
+
+Major Changes
+-------------
+
+- fix: Use a variable to control uninstall behavior instead of tags by @dobbi84 in https://github.com/grafana/grafana-ansible-collection/pull/253
+
 v5.3.0
 ======
 

diff --git a/CODEOWNERS b/CODEOWNERS
@@ -1,7 +1,7 @@
 ./                             @ishanjainn
 /roles/grafana                 @gardar @ishanjainn
 /roles/grafana_agent           @ishanjainn @v-zhuravlev @gardar
-/roles/alloy                   @ishanjainn @v-zhuravlev @gardar
+/roles/alloy                   @ishanjainn @v-zhuravlev @gardar @voidquark
 /roles/opentelemetry_collector @ishanjainn
 /roles/loki                    @voidquark @ishanjainn
 /roles/mimir                   @GVengelen @gardar @ishanjainn

diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
 [![GitHub Last Commit](https://img.shields.io/github/last-commit/grafana/grafana-ansible-collection)](https://github.com/grafana/grafana-ansible-collection/tags)
 [![GitHub Contributors](https://img.shields.io/github/contributors/grafana/grafana-ansible-collection)](https://github.com/grafana/grafana-ansible-collection/tags)
 
-This collection (`grafana.grafana`) contains modules and roles to assist in automating the management of resources in **Grafana**, **Grafana Agent**, **OpenTelemetry Collector**, **Loki**, **Mimir**, and **Promtail** with Ansible.
+This collection (`grafana.grafana`) contains modules and roles to assist in automating the management of resources in **Grafana**, **Grafana Agent**, **OpenTelemetry Collector**, **Loki**, **Mimir**, **Alloy**, and **Promtail** with Ansible.
 
 -   [Ansible collection Documentation](https://docs.ansible.com/ansible/latest/collections/grafana/grafana/)
 -   [Grafana](https://grafana.com)
@@ -43,10 +43,11 @@ collections:
 
 ## Roles included in the collection
 
-This collection includes the following roles to help set up and manage Grafana, Grafana Agent, OpenTelemetry Collector, Loki, Mimir and Promtail:
+This collection includes the following roles to help set up and manage Grafana, Grafana Agent, Alloy, OpenTelemetry Collector, Loki, Mimir and Promtail:
 
 - **Grafana**: Installs and configures Grafana on your target hosts.
 - **Grafana Agent**: Deploys and configures Grafana Agent, allowing for efficient metrics, logs, and trace data shipping to Grafana Cloud or other endpoints.
+- **Alloy**: The replacement for Grafana Agent and Promtail. Alloy can be used to collect traces, metrics, and logs.
 - **OpenTelemetry Collector**: Sets up and configures the OpenTelemetry Collector, enabling advanced observability features through data collection and transmission.
 - **Loki**: Deploy and manage Loki, the log aggregation system.
 - **Mimir**: Deploy and manage Mimir, the scalable long-term storage for Prometheus.

diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml
@@ -303,3 +303,23 @@ releases:
       - Bump pylint from 3.2.3 to 3.2.5 by @dependabot in https://github.com/grafana/grafana-ansible-collection/pull/234
       - Fix Grafana Configuration for Unified and Legacy Alerting Based on Version by @voidquark in https://github.com/grafana/grafana-ansible-collection/pull/215
     release_date: '2024-07-12'
+  5.4.0:
+    changes:
+      major_changes:
+      - fix: Use a variable to control uninstall behavior instead of tags by @dobbi84 in https://github.com/grafana/grafana-ansible-collection/pull/253
+    release_date: '2024-08-09'
+  5.4.1:
+    changes:
+      major_changes:
+      - fix: Updated promtail arch map for aarch64 matching by @gianmarco-mameli in https://github.com/grafana/grafana-ansible-collection/pull/257
+    release_date: '2024-08-13'
+  5.5.0:
+    changes:
+      major_changes:
+      - fix:mimir molecule should use ansible core 2.16 by @GVengelen in https://github.com/grafana/grafana-ansible-collection/pull/254
+      - promtail: add support for extra args by @harryfinbow in https://github.com/grafana/grafana-ansible-collection/pull/259
+    release_date: '2024-08-16'
+  5.5.1:
+    changes:
+      bugfixes:
+      - Add check_mode: false to Loki "Scrape GitHub" Task by @winsmith in https://github.com/grafana/grafana-ansible-collection/pull/262
diff --git a/examples/alloy.yaml b/examples/alloy.yaml
@@ -1,24 +1,21 @@
-- name: Install alloy
+---
+- name: Deploy alloy
   hosts: all
   become: true
-
+  roles:
+    - role: grafana.grafana.alloy
   tasks:
-    - name: Install alloy
+    - name: Deploy alloy
       ansible.builtin.include_role:
         name: grafana.grafana.alloy
       vars:
-        config: |
+        alloy_config: |
           prometheus.scrape "default" {
-            targets = [{"__address__" = "localhost:12345"}]
-            forward_to = [prometheus.remote_write.prom.receiver]
+              targets = [{"__address__" = "127.0.0.1:12345"}]
+              forward_to = [prometheus.remote_write.prom.receiver]
           }
           prometheus.remote_write "prom" {
             endpoint {
-                url = "https://prometheus-prod-13-prod-us-east-0.grafana.net/api/prom/push"
-
-                basic_auth {
-                username = "1493467"
-                password = "glc_eyJvIjoiNjUyOTkyIiwibiI6InN0YWNrLTg5MDA0My1obS13cml0ZS1hc2FzIiwiayI6IjIwME9NeThmWlFpMGlmQzBGMTlJNDdqSiIsIm0iOnsiciI6InByb2QtdXMtZWFzdC0wIn19"
-              }
+                url = "http://mimir:9009/api/v1/push"
             }
           }
diff --git a/galaxy.yml b/galaxy.yml
@@ -1,7 +1,7 @@
 ---
 namespace: grafana
 name: grafana
-version: 5.3.0
+version: 5.5.1
 readme: README.md
 authors:
   - Grafana Labs <grafana.com>

diff --git a/roles/alloy/README.md b/roles/alloy/README.md
@@ -1,67 +1,59 @@
-# Ansible Role for Alloy
+# Ansible role - Alloy
+
+[![License](https://img.shields.io/github/license/grafana/grafana-ansible-collection)](LICENSE)
 
 This Ansible role to install and configure [Alloy](https://grafana.com/docs/alloy/latest/), which can be used to collect traces, metrics, and logs.
+This role is tailored for operating systems such as **RedHat**, **Rocky Linux**, **AlmaLinux**, **Ubuntu**, and **Debian**.
 
-## Requirements
+## Table of Content
 
-Please ensure that `curl` is intalled on Ansible controller.
+- [Requirements](#requirements)
+- [Role Variables](#role-variables)
+- [Playbook](#playbook)
 
-## Role Variables
+## Requirements
 
-Available variables with their default values are listed below (`defaults/main.yml`):
+- Ansible 2.13+
+- `ansible.utils` collection is required. Additionally, you must install the `netaddr` Python library on the host where you are running Ansible (not on the target remote host) if is not present.
 
 ## Role Variables
 
 | Variable Name         | Description                                                          | Default Value                                                       |
 |-----------------------|----------------------------------------------------------------------|---------------------------------------------------------------------|
-| `version`             | The version of Grafana Alloy to be installed.                        | "1.0.0"                                                             |
-| `arch_mapping`        | A mapping of common architecture names to Grafana Alloy binaries.    | `{'x86_64': 'amd64', 'aarch64': 'arm64', 'armv7l': 'armhf', 'i386': 'i386', 'ppc64le': 'ppc64le'}` |
-| `arch`                | The architecture of the current machine.                             | Based on `ansible_architecture` lookup, defaults to 'amd64'.       |
-| `binary_url`          | URL to Grafana Alloy binary for the specific version and architecture. | Constructed URL based on `version` and `arch` variables.          |
-| `service_name`        | The name to be used for the Grafana Alloy service.                   | "alloy"                                                            |
-| `installation_dir`    | Directory where Grafana Alloy binary is to be installed. Must be present.   | "/usr/local/bin"                                                      |
-| `environment_file`    | Name of the environment file for the Grafana Alloy service.          | "service.env"                                                      |
-| `config_dir`          | Directory for Grafana Alloy configuration.                           | "/etc/alloy"                                                      |
-| `config_file`         | Configuration file name for Grafana Alloy.                           | "config.alloy"                                                     |
-| `service_user`        | User under which the Grafana Alloy service will run.                 | "alloy"                                                            |
-| `service_group`       | Group under which the Grafana Alloy service will run.                | "alloy"                                                            |
-| `working_dir`         | Working directory for the Grafana Alloy service.                     | "/var/lib/alloy"                                                      |
-| `env_file_vars`       | Additional environment variables to be set in the service environment file. | {} (Empty dictionary)                                          |
-| `alloy_flags_extra`   | Extra flags to pass to the Alloy service.                            | {} (Empty dictionary)                                              |
-| `start_after_service` | Specify an optional dependency service Alloy should start after.     | '' (Empty string)                                                  |
-| `config`              | Configuration template for Grafana Alloy.                            | Configuration script with Prometheus scrape and remote_write setup |
-| `alloy_user_groups`.  | Configurable user groups that the Grafana Alloy can be put in so that it can access logs.  | `[]` |
-
-
-
-## Example Playbook
-
-Including an example of how to use your role:
+| `alloy_version`             | The version of Alloy to download and deploy. Supported standard version "1.4.2" format or "latest". | `latest` |
+| `alloy_uninstall`           | If set to `true` will perfom uninstall instead of deployment. | `false` |
+| `alloy_expose_port`         | By default, this is set to false. It supports only simple firewalld configurations. If set to true, a firewalld rule is added to expose the TCP alloy port. The Port is automatically extracted from the environment variable `alloy_env_file_vars` in CUSTOM_ARGS when --server.http.listen-addr=0.0.0.0:12345 is defined. If set to false, configuration is skipped. If the firewalld.service is not active, all firewalld tasks are skipped. | `false` |
+| `alloy_user_groups`         | Appends the alloy user to specific groups. | `[]` |
+| `alloy_download_url_rpm`    | The default download URL for the Alloy rpm package from GitHub. | `"https://github.com/grafana/alloy/releases/download/v{{ aloy_version }}/alloy-{{ aloy_version }}-1.{{ __alloy_arch }}.rpm"` |
+| `alloy_download_url_deb`    | The default download URL for the Alloy deb package from GitHub. | `"https://github.com/grafana/alloy/releases/download/v{{ aloy_version }}/alloy-{{ aloy_version }}-1.{{ __alloy_arch }}.deb"` |
+| `alloy_env_file_vars`       | You can use environment variables to control the run-time behavior of Grafana Alloy. | `{}` |
+| `alloy_systemd_override`    | Systemd unit drop-in file used to override or extend the default configuration of a systemd unit. | `{}` |
+| `alloy_config`              | This is the configuration that sets up Alloy. Refer to the [configuration blocks](https://grafana.com/docs/alloy/latest/reference/config-blocks/) and [components](https://grafana.com/docs/alloy/latest/reference/components/) documentation for more details. By default, there is no configuration provided, and it is required for successful deployment. Without it, the deployment will fail. Since the purpose of using Alloy varies, no default configuration is provided. ⚠️ **This configuration is mandatory.** | `{}` |
+
+## Dependencies
+
+No Dependencies
+
+## Playbook
+
 ```yaml
-- name: Install alloy
+- name: Manage alloy service
   hosts: all
   become: true
+  vars:
+    # alloy_config: |
+    #   Your Config Content
+  roles:
+    - role: grafana.grafana.alloy
+```
+
+- Playbook execution example
+```shell
+# Deploy Alloy
+ansible-playbook function_alloy_play.yml
 
-  tasks:
-    - name: Install alloy
-      ansible.builtin.include_role:
-        name: grafana.grafana.alloy
-      vars:
-        config: |
-          prometheus.scrape "default" {
-            targets = [{"__address__" = "localhost:12345"}]
-            forward_to = [prometheus.remote_write.prom.receiver]
-          }
-          prometheus.remote_write "prom" {
-            endpoint {
-                url = "https://prometheus-prod-13-prod-us-east-0.grafana.net/api/prom/push"
-
-                basic_auth {
-                username = "149xxx"
-                password = "glc_xxx"
-              }
-            }
-          }
+# Uninstall Alloy
+ansible-playbook function_alloy_play.yml -e "alloy_uninstall=true"
 ```
 
 ## License
@@ -71,3 +63,4 @@ See [LICENSE](https://github.com/grafana/grafana-ansible-collection/blob/main/LI
 ## Author Information
 
 -   [Ishan Jain](https://github.com/ishanjainn)
+-   [VoidQuark](https://github.com/voidquark)
diff --git a/roles/alloy/defaults/main.yml b/roles/alloy/defaults/main.yml
@@ -1,48 +1,32 @@
-version: "1.0.0"
+---
+# defaults file for alloy
+alloy_version: "latest"
+alloy_uninstall: false
+alloy_expose_port: false
+alloy_download_url_rpm: "https://github.com/grafana/alloy/releases/download/v{{ alloy_version }}/alloy-{{ alloy_version }}-1.{{ __alloy_arch }}.rpm"
+alloy_download_url_deb: "https://github.com/grafana/alloy/releases/download/v{{ alloy_version }}/alloy-{{ alloy_version }}-1.{{ __alloy_arch }}.deb"
 
-arch_mapping:
-  x86_64: amd64
-  aarch64: arm64
-  armv7l: armhf
-  i386: i386
-  ppc64le: ppc64le
-
-arch: "{{ arch_mapping[ansible_architecture] | default('amd64') }}"
-
-binary_url: "https://github.com/grafana/alloy/releases/download/v{{ version }}/alloy-linux-{{ arch }}.zip"
-
-service_name: "alloy"
-
-installation_dir: "/usr/local/bin"
-
-environment_file: "service.env"
-
-config_dir: "/etc/alloy"
-
-config_file: "config.alloy"
-
-service_user: "alloy"
-
-service_group: "alloy"
-
-working_dir: "/var/lib/alloy"
-
-env_file_vars: {}
-
-alloy_flags_extra: {}
-
-start_after_service: ''
-
-config: |
-  prometheus.scrape "default" {
-      targets = [{"__address__" = "localhost:12345"}]
-      forward_to = [prometheus.remote_write.prom.receiver]
-  }
-  prometheus.remote_write "prom" {
-    endpoint {
-        url = "http://mimir:9009/api/v1/push"
-    }
-  }
-
-# Configurable user groups that the Grafana Alloy can be put in so that it can access logs.
 alloy_user_groups: []
+# alloy_user_groups:
+#   - "systemd-journal"
+
+alloy_env_file_vars: {}
+# alloy_env_file_vars:
+#   CUSTOM_ARGS: "--server.http.listen-addr=0.0.0.0:12345 --stability.level=public-preview --feature.community-components.enabled=true"
+
+alloy_systemd_override: {}
+# alloy_systemd_override: |
+#   [Service]
+#   User=root
+
+alloy_config: {}
+# alloy_config: |
+#   prometheus.scrape "default" {
+#       targets = [{"__address__" = "127.0.0.1:12345"}]
+#       forward_to = [prometheus.remote_write.prom.receiver]
+#   }
+#   prometheus.remote_write "prom" {
+#     endpoint {
+#         url = "http://mimir:9009/api/v1/push"
+#     }
+#   }