test

Author: jeffreyc-splunk

.github/workflows/ansible.yml

@@ -12,6 +12,7 @@ on:
       - 'deployments/ansible/galaxy.yml'
     branches:
       - main
+      - ansible-discovery-mode
   pull_request:
     paths:
       - '.github/workflows/ansible.yml'
@@ -140,7 +141,7 @@ jobs:
         scenario:
           - default
           - custom_vars
-          - with_instrumentation
+          - with_signalfx_dotnet_instrumentation
     steps:
       - name: Free up disk space for vagrant box
         uses: jlumbroso/[email protected]

deployments/ansible/contributing/requirements-dev-linux.txt

@@ -1,6 +1,6 @@
-ansible~=7.0
-ansible-lint==5.4.0
-molecule==3.3.0
-molecule-docker==0.2.4
-docker==5.0.0
-urllib3>=1.26.18,<2
+ansible~=8.7.0
+ansible-lint==6.22.2
+molecule==6.0.3
+molecule-plugins[docker]==23.5.0
+docker==7.0.0
+urllib3<2

deployments/ansible/molecule/with_instrumentation/Dockerfile.j2 renamed to deployments/ansible/molecule/custom_discovery/Dockerfile.j2

@@ -0,0 +1,16 @@
+---
+- name: Converge scenario with custom variables
+  hosts: all
+  become: yes
+  vars:
+    splunk_access_token: fake-token
+    splunk_realm: fake-realm
+    splunk_otel_auto_discovery: yes
+    splunk_otel_auto_discovery_properties_source: ./test.discovery.yaml
+    splunk_otel_auto_discovery_properties_dest: /foo/bar/test.discovery.yaml
+    splunk_otel_collector_additional_env_vars:
+      OTELCOL_OPTIONS: "--set=processors.batch.timeout=2s"
+  tasks:
+    - name: "Include signalfx.splunk_otel_collector.collector role"
+      include_role:
+        name: "signalfx.splunk_otel_collector.collector"

deployments/ansible/molecule/custom_discovery/converge.yml

@@ -0,0 +1,8 @@
+# my custom discovery properties file
+---
+splunk.discovery:
+  extensions:
+    k8s_observer:
+      enabled: false
+    docker_observer:
+      enabled: false

deployments/ansible/molecule/with_instrumentation/molecule.yml renamed to deployments/ansible/molecule/custom_discovery/molecule.yml

@@ -0,0 +1,95 @@
+---
+- name: Verify scenario with custom variables
+  hosts: all
+  gather_facts: true
+  become: yes
+  tasks:
+    - name: Populate service facts
+      ansible.builtin.service_facts:
+
+    - name: Assert splunk-otel-collector service is running
+      assert:
+        that: ansible_facts.services['splunk-otel-collector.service'].state == 'running'
+
+    - name: Assert SPLUNK_ACCESS_TOKEN env var is set
+      ansible.builtin.lineinfile:
+        line: SPLUNK_ACCESS_TOKEN=fake-token
+        dest: /etc/otel/collector/splunk-otel-collector.conf
+        state: present
+      check_mode: yes
+      register: config
+      failed_when: config is changed
+
+    - name: Assert SPLUNK_REALM env var is set
+      ansible.builtin.lineinfile:
+        line: SPLUNK_REALM=fake-realm
+        dest: /etc/otel/collector/splunk-otel-collector.conf
+        state: present
+      check_mode: yes
+      register: config
+      failed_when: config is changed
+
+    - name: Assert SPLUNK_INGEST_URL env var is set
+      ansible.builtin.lineinfile:
+        line: SPLUNK_INGEST_URL=https://ingest.fake-realm.signalfx.com
+        dest: /etc/otel/collector/splunk-otel-collector.conf
+        state: present
+      check_mode: yes
+      register: config
+      failed_when: config is changed
+
+    - name: Assert SPLUNK_API_URL env var is set
+      ansible.builtin.lineinfile:
+        line: SPLUNK_API_URL=https://api.fake-realm.signalfx.com
+        dest: /etc/otel/collector/splunk-otel-collector.conf
+        state: present
+      check_mode: yes
+      register: config
+      failed_when: config is changed
+
+    - name: Assert SPLUNK_TRACE_URL env var is set
+      ansible.builtin.lineinfile:
+        line: SPLUNK_TRACE_URL=https://ingest.fake-realm.signalfx.com/v2/trace
+        dest: /etc/otel/collector/splunk-otel-collector.conf
+        state: present
+      check_mode: yes
+      register: config
+      failed_when: config is changed
+
+    - name: Assert SPLUNK_HEC_URL env var is set
+      ansible.builtin.lineinfile:
+        line: SPLUNK_HEC_URL=https://ingest.fake-realm.signalfx.com/v1/log
+        dest: /etc/otel/collector/splunk-otel-collector.conf
+        state: present
+      check_mode: yes
+      register: config
+      failed_when: config is changed
+
+    - name: Assert discovery mode is enabled
+      ansible.builtin.lineinfile:
+        line: >-
+          OTELCOL_OPTIONS=--set=processors.batch.timeout=2s --discovery
+          --discovery-properties=/foo/bar/test.discovery.yaml
+        dest: /etc/otel/collector/splunk-otel-collector.conf
+        state: present
+      check_mode: yes
+      register: config
+      failed_when: config is changed
+
+    - name: Assert custom properties file is created
+      ansible.builtin.lineinfile:
+        line: '# my custom discovery properties file'
+        dest: /foo/bar/test.discovery.yaml
+        state: present
+      check_mode: yes
+      register: config
+      failed_when: config is changed
+
+    - name: Check collector logs
+      ansible.builtin.shell:
+        cmd: 'journalctl -u splunk-otel-collector | grep "Discovery complete"'
+      register: result
+      changed_when: false
+      until: result.stdout
+      retries: 20
+      delay: 1

deployments/ansible/molecule/custom_discovery/test.discovery.yaml

@@ -22,48 +22,62 @@
         dest: /etc/otel/collector/splunk-otel-collector.conf
         state: present
       check_mode: yes
+      register: config
+      failed_when: config is changed
 
     - name: Assert SPLUNK_INGEST_URL env var is set
       ansible.builtin.lineinfile:
         line: SPLUNK_INGEST_URL=https://fake-splunk-ingest.com
         dest: /etc/otel/collector/splunk-otel-collector.conf
         state: present
       check_mode: yes
+      register: config
+      failed_when: config is changed
 
     - name: Assert SPLUNK_API_URL env var is set
       ansible.builtin.lineinfile:
         line: SPLUNK_API_URL=https://fake-splunk-api.com
         dest: /etc/otel/collector/splunk-otel-collector.conf
         state: present
       check_mode: yes
+      register: config
+      failed_when: config is changed
 
     - name: Assert SPLUNK_TRACE_URL env var is set
       ansible.builtin.lineinfile:
         line: SPLUNK_TRACE_URL=https://fake-splunk-ingest.com/v2/trace
         dest: /etc/otel/collector/splunk-otel-collector.conf
         state: present
       check_mode: yes
+      register: config
+      failed_when: config is changed
 
     - name: Assert SPLUNK_HEC_URL env var is set
       ansible.builtin.lineinfile:
         line: SPLUNK_HEC_URL=https://fake-splunk-ingest.com/v1/log
         dest: /etc/otel/collector/splunk-otel-collector.conf
         state: present
       check_mode: yes
+      register: config
+      failed_when: config is changed
 
     - name: Assert MY_CUSTOM_VAR1 env var is set
       ansible.builtin.lineinfile:
         line: MY_CUSTOM_VAR1=value1
         dest: /etc/otel/collector/splunk-otel-collector.conf
         state: present
       check_mode: yes
+      register: config
+      failed_when: config is changed
 
     - name: Assert MY_CUSTOM_VAR2 env var is set
       ansible.builtin.lineinfile:
         line: MY_CUSTOM_VAR2=value2
         dest: /etc/otel/collector/splunk-otel-collector.conf
         state: present
       check_mode: yes
+      register: config
+      failed_when: config is changed
 
     - name: Populate package facts
       ansible.builtin.package_facts:
@@ -78,34 +92,44 @@
         dest: /etc/systemd/system/splunk-otel-collector.service.d/service-owner.conf
         state: present
       check_mode: yes
+      register: config
+      failed_when: config is changed
 
     - name: Assert custom service group is set
       ansible.builtin.lineinfile:
         line: Group=custom-group
         dest: /etc/systemd/system/splunk-otel-collector.service.d/service-owner.conf
         state: present
       check_mode: yes
+      register: config
+      failed_when: config is changed
 
     - name: Assert SPLUNK_MEMORY_TOTAL_MIB env var is set
       ansible.builtin.lineinfile:
         line: SPLUNK_MEMORY_TOTAL_MIB=256
         dest: /etc/otel/collector/splunk-otel-collector.conf
         state: present
       check_mode: yes
+      register: config
+      failed_when: config is changed
 
     - name: Assert SPLUNK_LISTEN_INTERFACE env var is set
       ansible.builtin.lineinfile:
         line: SPLUNK_LISTEN_INTERFACE=1.2.3.4
         dest: /etc/otel/collector/splunk-otel-collector.conf
         state: present
       check_mode: yes
+      register: config
+      failed_when: config is changed
 
     - name: Assert GOMEMLIMIT env var is set
       ansible.builtin.lineinfile:
         line: GOMEMLIMIT=230
         dest: /etc/otel/collector/splunk-otel-collector.conf
         state: present
       check_mode: yes
+      register: config
+      failed_when: config is changed
 
     - name: Check custom_fluentd.conf
       stat:
@@ -124,6 +148,8 @@
         state: present
       check_mode: yes
       when: fluentd_supported
+      register: config
+      failed_when: config is changed
 
     - name: Send a test log message
       ansible.builtin.uri:

deployments/ansible/molecule/custom_discovery/verify.yml

@@ -21,38 +21,59 @@
         dest: /etc/otel/collector/splunk-otel-collector.conf
         state: present
       check_mode: yes
+      register: config
+      failed_when: config is changed
 
     - name: Assert SPLUNK_REALM env var is set
       ansible.builtin.lineinfile:
         line: SPLUNK_REALM=fake-realm
         dest: /etc/otel/collector/splunk-otel-collector.conf
         state: present
       check_mode: yes
+      register: config
+      failed_when: config is changed
 
     - name: Assert SPLUNK_INGEST_URL env var is set
       ansible.builtin.lineinfile:
         line: SPLUNK_INGEST_URL=https://ingest.fake-realm.signalfx.com
         dest: /etc/otel/collector/splunk-otel-collector.conf
         state: present
       check_mode: yes
+      register: config
+      failed_when: config is changed
 
     - name: Assert SPLUNK_API_URL env var is set
       ansible.builtin.lineinfile:
-        line: SPLUNK_INGEST_URL=https://api.fake-realm.signalfx.com
+        line: SPLUNK_API_URL=https://api.fake-realm.signalfx.com
         dest: /etc/otel/collector/splunk-otel-collector.conf
         state: present
       check_mode: yes
+      register: config
+      failed_when: config is changed
 
     - name: Assert SPLUNK_TRACE_URL env var is set
       ansible.builtin.lineinfile:
         line: SPLUNK_TRACE_URL=https://ingest.fake-realm.signalfx.com/v2/trace
         dest: /etc/otel/collector/splunk-otel-collector.conf
         state: present
       check_mode: yes
+      register: config
+      failed_when: config is changed
 
     - name: Assert SPLUNK_HEC_URL env var is set
       ansible.builtin.lineinfile:
         line: SPLUNK_HEC_URL=https://ingest.fake-realm.signalfx.com/v1/log
         dest: /etc/otel/collector/splunk-otel-collector.conf
         state: present
       check_mode: yes
+      register: config
+      failed_when: config is changed
+
+    - name: Assert discovery mode is not enabled
+      ansible.builtin.lineinfile:
+        regexp: .*OTELCOL_OPTIONS=.*--discovery.*
+        dest: /etc/otel/collector/splunk-otel-collector.conf
+        state: absent
+      check_mode: yes
+      register: config
+      failed_when: config is changed

deployments/ansible/molecule/custom_vars/verify.yml

@@ -0,0 +1 @@
+../default/Dockerfile.j2

deployments/ansible/molecule/default/verify.yml

@@ -0,0 +1,12 @@
+---
+- name: Converge scenario with custom variables
+  hosts: all
+  become: yes
+  vars:
+    splunk_access_token: fake-token
+    splunk_realm: fake-realm
+    splunk_otel_auto_discovery: yes
+  tasks:
+    - name: "Include signalfx.splunk_otel_collector.collector role"
+      include_role:
+        name: "signalfx.splunk_otel_collector.collector"

deployments/ansible/molecule/default_discovery/Dockerfile.j2

@@ -0,0 +1 @@
+# no default config provided, make sure to set --base-config molecule argument instead