Added environment variables support (#13)

* WIP adding environment variable option

* Added loop for Jaeger environment variables

* Jaeger environment variabels for cortex sevices

* Fixed environment file for not all in one usecase

* Added correct loop for the multiple services

* Added services test to circleci

* Added back default test port

* fix for ci

* Added tests for checking content of environment files

* fixed linting

* changed variable and added more tests

* Added backslash n for checking new lines

* Updated the README with environment variable option

Author: matthiasantierens

.circleci/config.yml

@@ -35,6 +35,12 @@ jobs:
          else
            echo 'No alternative test'
          fi
+      - run: |
+         if [[ -d 'molecule/services' ]]; then
+           molecule test -s services --destroy never
+         else
+           echo 'No services test'
+         fi
       - run: |
          if [[ -z "${CIRCLE_PULL_REQUEST}" ]]; then
            molecule test -s latest --destroy never

README.md

@@ -31,6 +31,7 @@ All variables which can be overridden are stored in [defaults/main.yml](defaults
 | `cortex_system_group` | "cortex" | Default Cortex group |
 | `cortex_version` | "1.6.0" | The cortex package version |
 | `cortex_auth_enabled` | "false" | Enables of disables the Cortex authentication |
+| `cortex_env_variables` | `{}` | Configure Cortex environment variables. |
 | `cortex_alertmanager` | `{}` | Cortex alertmanager. Compatible with [official configuration](https://cortexmetrics.io/docs/configuration/configuration-file/#alertmanager_config) |
 | `cortex_api` | `{}` | Cortex api. Compatible with [official configuration](https://cortexmetrics.io/docs/configuration/configuration-file/) |
 | `cortex_blocks_storage` | [From block storage example][bse] | Cortex blocks storage. Compatible with [official configuration](https://cortexmetrics.io/docs/configuration/configuration-file/#blocks_storage_config) |
@@ -95,6 +96,11 @@ You can run the different Cortex modules as separate services by setting
                 kvstore:
                   store: inmemory
                   replication_factor: 1
+    cortex_env_variables:
+      ingester:
+        JAEGER_AGENT_HOST: localhost
+        JAEGER_SAMPLER_PARAM: 0
+        JAEGER_SAMPLER_TYPE: const
 ```
 
 ## Local Testing

defaults/main.yml

@@ -20,6 +20,9 @@ cortex_system_group: "cortex"
 
 cortex_auth_enabled: false
 
+cortex_environment_location: /etc/default
+cortex_env_variables: {}
+
 cortex_server:
   http_listen_port: 9009
 

molecule/alternative/playbook.yml

@@ -9,3 +9,7 @@
     cortex_db_dir: /cortexdb
     cortex_system_user: "vortex"
     cortex_system_group: "vortex"
+    cortex_env_variables:
+      KAEGER_AGENT_HOST: localhost
+      KAEGER_SAMPLER_PARAM: 0
+      KAEGER_SAMPLER_TYPE: const

molecule/alternative/tests/test_alternative.py

@@ -29,6 +29,7 @@ def test_directories(host, dirs):
     "/cortex/cortex.yml",
     "/etc/systemd/system/cortex.service",
     "/usr/local/bin/cortex-linux-amd64",
+    "/etc/default/cortex",
 ])
 def test_files(host, files):
     f = host.file(files)
@@ -50,3 +51,10 @@ def test_service(host):
 def test_socket(host):
     s = host.socket("tcp://0.0.0.0:9009")
     assert s.is_listening
+
+
+def test_string(host):
+    f = host.file("/etc/default/cortex")
+    assert "KAEGER_AGENT_HOST=localhost\n" in f.content_string
+    assert "KAEGER_SAMPLER_PARAM=0\n" in f.content_string
+    assert "KAEGER_SAMPLER_TYPE=const\n" in f.content_string

molecule/services/molecule.yml

@@ -3,43 +3,44 @@ dependency:
   name: galaxy
 driver:
   name: docker
-lint: |
-  set -e
-  yamllint .
-  ansible-lint
-  flake8
 platforms:
   - name: bionic
+    pre_build_image: true
     image: quay.io/paulfantom/molecule-systemd:ubuntu-18.04
     docker_host: "${DOCKER_HOST:-unix://var/run/docker.sock}"
     privileged: true
     volumes:
       - /sys/fs/cgroup:/sys/fs/cgroup:ro
   - name: xenial
+    pre_build_image: true
     image: quay.io/paulfantom/molecule-systemd:ubuntu-16.04
     docker_host: "${DOCKER_HOST:-unix://var/run/docker.sock}"
     privileged: true
     volumes:
       - /sys/fs/cgroup:/sys/fs/cgroup:ro
   - name: stretch
+    pre_build_image: true
     image: quay.io/paulfantom/molecule-systemd:debian-9
     docker_host: "${DOCKER_HOST:-unix://var/run/docker.sock}"
     privileged: true
     volumes:
       - /sys/fs/cgroup:/sys/fs/cgroup:ro
   - name: buster
+    pre_build_image: true
     image: quay.io/paulfantom/molecule-systemd:debian-10
     docker_host: "${DOCKER_HOST:-unix://var/run/docker.sock}"
     privileged: true
     volumes:
       - /sys/fs/cgroup:/sys/fs/cgroup:ro
   - name: centos7
+    pre_build_image: true
     image: quay.io/paulfantom/molecule-systemd:centos-7
     docker_host: "${DOCKER_HOST:-unix://var/run/docker.sock}"
     privileged: true
     volumes:
       - /sys/fs/cgroup:/sys/fs/cgroup:ro
   - name: centos8
+    pre_build_image: true
     image: quay.io/paulfantom/molecule-systemd:centos-8
     docker_host: "${DOCKER_HOST:-unix://var/run/docker.sock}"
     privileged: true
@@ -48,6 +49,7 @@ platforms:
     groups:
       - python3
   - name: fedora
+    pre_build_image: true
     image: quay.io/paulfantom/molecule-systemd:fedora-30
     docker_host: "${DOCKER_HOST:-unix://var/run/docker.sock}"
     privileged: true

molecule/services/playbook.yml

@@ -42,3 +42,12 @@
           backend: filesystem
           filesystem:
             dir: /tmp/blocks
+    cortex_env_variables:
+      ingester:
+        KAEGER_AGENT_HOST: localhost
+        KAEGER_SAMPLER_PARAM: 0
+        KAEGER_SAMPLER_TYPE: const
+      readpath:
+        KAEGER_AGENT_HOST: localhost
+        KAEGER_SAMPLER_PARAM: 0.1
+        KAEGER_SAMPLER_TYPE: probabilistic

molecule/services/tests/test_services.py

@@ -29,6 +29,7 @@ def test_directories(host, dirs):
     "/cortex/cortex-ingester.yml",
     "/etc/systemd/system/[email protected]",
     "/usr/local/bin/cortex-linux-amd64",
+    "/etc/default/cortex-ingester",
 ])
 def test_files(host, files):
     f = host.file(files)
@@ -63,3 +64,17 @@ def test_config_file_explicit_target(host):
     f = host.file("/cortex/cortex-readpath.yml")
     config = yaml.load(f.content_string, Loader=yaml.SafeLoader)
     assert config["target"] == "querier,store-gateway"
+
+
+def test_string(host):
+    f = host.file("/etc/default/cortex-ingester")
+    assert "KAEGER_AGENT_HOST=localhost\n" in f.content_string
+    assert "KAEGER_SAMPLER_PARAM=0\n" in f.content_string
+    assert "KAEGER_SAMPLER_TYPE=const\n" in f.content_string
+
+
+def test_string2(host):
+    f = host.file("/etc/default/cortex-readpath")
+    assert "KAEGER_SAMPLER_TYPE=probabilistic\n" in f.content_string
+    assert "KAEGER_SAMPLER_PARAM=0.1\n" in f.content_string
+    assert "KAEGER_SAMPLER_TYPE=probabilistic\n" in f.content_string

tasks/configure.yml

@@ -32,3 +32,20 @@
   notify:
     - reload cortex
   loop: "{{ cortex_services | dict2items }}"
+
+- name: Configure cortex environment file
+  template:
+    src: "cortex.environment.j2"
+    dest: "{{ cortex_environment_location }}/cortex"
+    mode: 0644
+  notify: reload cortex
+  when: cortex_all_in_one
+
+- name: Configure cortex environment file for services
+  template:
+    src: "[email protected]"
+    dest: "{{ cortex_environment_location }}/cortex-{{ item.key }}"
+    mode: 0644
+  notify: reload cortex
+  loop: "{{ cortex_env_variables | dict2items }}"
+  when: not cortex_all_in_one

tasks/preflight.yml

@@ -73,3 +73,10 @@
   when:
     - cortex_binary_local_dir | length == 0
     - not cortex_skip_install
+
+- name: Assert that environment variables are asserted with services
+  assert:
+    that:
+      - "item in cortex_services"
+  with_items: "{{ cortex_env_variables }}"
+  when: not cortex_all_in_one