Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add exporter role vars documentation #114

Merged
merged 2 commits into from
Dec 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions roles/amq_streams_broker/defaults/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ amq_streams_broker_listener_port: 9092
amq_streams_broker_listener_internal_port: 9091
amq_streams_broker_listener_tls_port: 9093
amq_streams_broker_listener_port_delay: 0
amq_streams_broker_listener_port_skip_wait: False
amq_streams_broker_group: 'amq_streams'
amq_streams_broker_service_config_template: 'templates/service.conf.j2'
amq_streams_broker_service_config_file: '/etc/broker.conf'
Expand Down
2 changes: 1 addition & 1 deletion roles/amq_streams_broker/tasks/service.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
server_java_jmx_opts: "{{ amq_streams_broker_java_jmx_opts | default('') }}"
server_start_sleep: "{{ amq_streams_broker_zookeeper_session_timeout_ms }}"
server_port: "{{ amq_streams_broker_listener_port }}"
skip_wait_for_server_port: False
skip_wait_for_server_port: "{{ amq_streams_broker_listener_port_skip_wait | default(False) }}"
delay_before_server_port_check: "{{ amq_streams_broker_listener_port_delay }}"
server_prometheus_enabled: "{{ amq_streams_broker_prometheus_enabled }}"
server_prometheus_config_file: "{{ amq_streams_broker_prometheus_config_file | default('') }}"
Expand Down
1 change: 1 addition & 0 deletions roles/amq_streams_connect/defaults/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ amq_streams_connect_config_template: templates/connect-standalone.properties.j2
amq_streams_connect_service_config_template: templates/service.conf.j2
amq_streams_connect_server_port: 8083
amq_streams_connect_server_port_delay: 0
amq_streams_connect_server_port_skip_wait: False

# SSL/TLS Connections
amq_streams_connect_broker_tls_enabled: false
Expand Down
2 changes: 1 addition & 1 deletion roles/amq_streams_connect/tasks/service.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,5 +32,5 @@
server_java_gc_log_opts: "{{ amq_streams_connect_java_java_gc_log_opts | default('') }}"
server_start_sleep: "{{ amq_streams_connect_zookeeper_session_timeout_ms }}"
server_port: "{{ amq_streams_connect_server_port }}"
skip_wait_for_server_port: False
skip_wait_for_server_port: "{{ amq_streams_connect_server_port_skip_wait | default(False) }}"
delay_before_server_port_check: "{{ amq_streams_connect_server_port_delay }}"
28 changes: 28 additions & 0 deletions roles/amq_streams_exporter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,31 @@
Perform installation and configuration of Kafka Export.

## Role Defaults

| Variable | Description | Default |
|:---------|:------------|:--------|
|`amq_streams_exporter_target_arch`| TODO document argument | `{{ ansible_architecture }}` |
|`amq_streams_exporter_version`| TODO document argument | `1.7.0` |
|`amq_streams_exporter_download_base_url`| TODO document argument | `https://github.com/danielqsj/kafka_exporter/releases/download/` |
|`amq_streams_exporter_download_url`| TODO document argument | `{{ amq_streams_exporter_download_base_url }}v{{ amq_streams_exporter_version }}/kafka_exporter-{{ amq_streams_exporter_version }}.{{ amq_streams_exporter_target_system }}-{{ amq_streams_exporter_target_arch }}.tar.gz` |
|`amq_streams_exporter_archive_folder`| TODO document argument | `kafka_exporter-{{ amq_streams_exporter_version }}.{{ amq_streams_exporter_target_system }}-{{ amq_streams_exporter_target_arch }}` |
|`amq_streams_exporter_archive_name`| TODO document argument | `{{ amq_streams_exporter_archive_folder }}.tar.gz` |
|`amq_streams_exporter_download_dir`| TODO document argument | `{{ lookup('env','PWD') | default('/opt') }}` |
|`amq_streams_exporter_download_path`| TODO document argument | `{{ amq_streams_exporter_download_dir }}/{{ amq_streams_exporter_archive_name }}` |
|`amq_streams_exporter_download_host`| TODO document argument | `localhost` |
|`amq_streams_exporter_home`| TODO document argument | `{{ amq_streams_common_home }}` |
|`amq_streams_exporter_server_start`| TODO document argument | `{{ amq_streams_common_home }}/{{ amq_streams_exporter_archive_folder }}/{{ amq_streams_exporter_server_start_script }}` |
|`amq_streams_exporter_dependencies`| TODO document argument | `['tar', 'unzip']` |
|`amq_streams_exporter_service_name`| TODO document argument | `amq_streams_exporter` |
|`amq_streams_exporter_server_port`| TODO document argument | `9308` |
|`amq_streams_exporter_server_start_script`| TODO document argument | `kafka_exporter` |
|`amq_streams_exporter_systemd_env_file`| TODO document argument | `/etc/amq_streams_exporter.conf` |
|`amq_streams_exporter_service_config_template`| TODO document argument | `templates/service.conf.j2` |
|`amq_streams_exporter_user`| TODO document argument | `amq_streams_exporter` |
|`amq_streams_exporter_group`| TODO document argument | `amq_streams` |
|`amq_streams_exporter_java_opts`| TODO document argument | `` |
|`amq_streams_exporter_server_port_delay`| TODO document argument | `0` |
|`amq_streams_exporter_server_port_skip_wait`| TODO document argument | `False` |
|`amq_streams_exporter_broker_server_host`| TODO document argument | `{{ groups['brokers'][0] | default('localhost') }}` |
|`amq_streams_exporter_broker_server_port`| TODO document argument | `9092` |
|`amq_streams_exporter_server_extra_args`| TODO document argument | `--group.filter='.*' --topic.filter='.*' --offset.show-all --verbosity=0 --kafka.version='{{ amq_streams_common_product_version }}' --kafka.server={{ amq_streams_exporter_broker_server_host }}:{{ amq_streams_exporter_broker_server_port }}` |
152 changes: 152 additions & 0 deletions roles/amq_streams_exporter/meta/argument_specs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,152 @@
argument_specs:
main:
options:
# line 3 of defaults/main.yml
amq_streams_exporter_target_arch:
default: "{{ ansible_architecture }}"
description: "TODO document argument"
type: "str"

# line 4 of defaults/main.yml
amq_streams_exporter_version:
default: "1.7.0"
description: "TODO document argument"
type: "str"

# line 5 of defaults/main.yml
amq_streams_exporter_download_base_url:
default: "https://github.com/danielqsj/kafka_exporter/releases/download/"
description: "TODO document argument"
type: "str"

# line 6 of defaults/main.yml
amq_streams_exporter_download_url:
default: "{{ amq_streams_exporter_download_base_url }}v{{ amq_streams_exporter_version }}/kafka_exporter-{{ amq_streams_exporter_version }}.{{ amq_streams_exporter_target_system }}-{{ amq_streams_exporter_target_arch }}.tar.gz"
description: "TODO document argument"
type: "str"

# line 7 of defaults/main.yml
amq_streams_exporter_archive_folder:
default: "kafka_exporter-{{ amq_streams_exporter_version }}.{{ amq_streams_exporter_target_system }}-{{ amq_streams_exporter_target_arch }}"
description: "TODO document argument"
type: "str"

# line 8 of defaults/main.yml
amq_streams_exporter_archive_name:
default: "{{ amq_streams_exporter_archive_folder }}.tar.gz"
description: "TODO document argument"
type: "str"

# line 9 of defaults/main.yml
amq_streams_exporter_download_dir:
default: "{{ lookup('env','PWD') | default('/opt') }}"
description: "TODO document argument"
type: "str"

# line 10 of defaults/main.yml
amq_streams_exporter_download_path:
default: "{{ amq_streams_exporter_download_dir }}/{{ amq_streams_exporter_archive_name }}"
description: "TODO document argument"
type: "str"

# line 11 of defaults/main.yml
amq_streams_exporter_download_host:
default: "localhost"
description: "TODO document argument"
type: "str"

# line 12 of defaults/main.yml
amq_streams_exporter_home:
default: "{{ amq_streams_common_home }}"
description: "TODO document argument"
type: "str"

# line 13 of defaults/main.yml
amq_streams_exporter_server_start:
default: "{{ amq_streams_common_home }}/{{ amq_streams_exporter_archive_folder }}/{{ amq_streams_exporter_server_start_script }}"
description: "TODO document argument"
type: "str"

# line 14 of defaults/main.yml
amq_streams_exporter_dependencies:
default: "['tar', 'unzip']"
description: "TODO document argument"
type: "list"

# line 17 of defaults/main.yml
amq_streams_exporter_service_name:
default: "amq_streams_exporter"
description: "TODO document argument"
type: "str"

# line 18 of defaults/main.yml
amq_streams_exporter_server_port:
default: 9308
description: "TODO document argument"
type: "int"

# line 19 of defaults/main.yml
amq_streams_exporter_server_start_script:
default: "kafka_exporter"
description: "TODO document argument"
type: "str"

# line 23 of defaults/main.yml
amq_streams_exporter_systemd_env_file:
default: "/etc/amq_streams_exporter.conf"
description: "TODO document argument"
type: "str"

# line 24 of defaults/main.yml
amq_streams_exporter_service_config_template:
default: "templates/service.conf.j2"
description: "TODO document argument"
type: "str"

# line 26 of defaults/main.yml
amq_streams_exporter_user:
default: "amq_streams_exporter"
description: "TODO document argument"
type: "str"

# line 27 of defaults/main.yml
amq_streams_exporter_group:
default: "amq_streams"
description: "TODO document argument"
type: "str"

# line 28 of defaults/main.yml
amq_streams_exporter_java_opts:
default: ""
description: "TODO document argument"
type: "str"

# line 29 of defaults/main.yml
amq_streams_exporter_server_port_delay:
default: 0
description: "TODO document argument"
type: "int"

# line 30 of defaults/main.yml
amq_streams_exporter_server_port_skip_wait:
default: false
description: "TODO document argument"
type: "bool"

# line 31 of defaults/main.yml
amq_streams_exporter_broker_server_host:
default: "{{ groups['brokers'][0] | default('localhost') }}"
description: "TODO document argument"
type: "str"

# line 32 of defaults/main.yml
amq_streams_exporter_broker_server_port:
default: 9092
description: "TODO document argument"
type: "int"

# line 33 of defaults/main.yml
amq_streams_exporter_server_extra_args:
default: "--group.filter='.*' --topic.filter='.*' --offset.show-all --verbosity=0 --kafka.version='{{ amq_streams_common_product_version }}' --kafka.server={{ amq_streams_exporter_broker_server_host }}:{{ amq_streams_exporter_broker_server_port }}"
description: "TODO document argument"
type: "str"
1 change: 1 addition & 0 deletions roles/amq_streams_zookeeper/defaults/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ amq_streams_zookeeper_max_client_cnxns: 0
amq_streams_zookeeper_admin_enable_server: 'true'
amq_streams_zookeeper_admin_server_port: 8080
amq_streams_zookeeper_admin_server_port_delay: 0
amq_streams_zookeeper_admin_server_skip_wait: False
amq_streams_zookeeper_instance_count_enabled: true
amq_streams_zookeeper_inventory_group_name: 'zookeepers'
amq_streams_zookeeper_instance_count: "{{ groups[amq_streams_zookeeper_inventory_group_name] | length }}"
Expand Down
2 changes: 1 addition & 1 deletion roles/amq_streams_zookeeper/tasks/service.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
server_prometheus_enabled: "{{ amq_streams_zookeeper_prometheus_enabled }}"
server_prometheus_config_file: "{{ amq_streams_zookeeper_prometheus_config_file | default('') }}"
server_port: "{{ amq_streams_zookeeper_admin_server_port | default('') }}"
skip_wait_for_server_port: False
skip_wait_for_server_port: "{{ amq_streams_zookeeper_admin_server_skip_wait | default(False) }}"
delay_before_server_port_check: "{{ amq_streams_zookeeper_admin_server_port_delay }}"
amq_streams_common_prometheus_port: "{{ amq_streams_zookeeper_prometheus_port }}"
amq_streams_common_prometheus_bind_addr: "{{ amq_streams_zookeeper_prometheus_bind_addr }}"
Loading