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.

Sign up for GitHub

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 missing documentation on role's vars #106

Merged
merged 1 commit into from
Nov 22, 2023
Merged

Add missing documentation on role's vars #106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
106 changes: 53 additions & 53 deletions roles/amq_streams_broker/meta/argument_specs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,317 +4,317 @@ argument_specs:
# line 2 of defaults/main.yml
amq_streams_broker_create_topic_script:
default: "{{ amq_streams_common_home }}/bin/kafka-topics.sh"
description: "TODO document argument"
description: "Provides path to the script used to manage topics."
type: "str"

# line 3 of defaults/main.yml
amq_streams_broker_enabled:
default: true
description: "TODO document argument"
description: "Whether or not Ansible should deploy and manage broker on target"
type: "bool"

# line 4 of defaults/main.yml
amq_streams_broker_server_start:
default: "{{ amq_streams_common_home }}/bin/kafka-server-start.sh"
description: "TODO document argument"
description: "Provides path to the script used to start the broker"
type: "str"

# line 5 of defaults/main.yml
amq_streams_broker_config:
default: "/etc/amq_streams_broker.properties"
description: "TODO document argument"
description: "Path to the broker properties configuration file"
type: "str"

# line 6 of defaults/main.yml
amq_streams_broker_service_name:
default: "amq_streams_broker"
description: "TODO document argument"
description: "Name of the systemd service associated to the broker"
type: "str"

# line 7 of defaults/main.yml
amq_streams_broker_user:
default: "amq_streams_broker"
description: "TODO document argument"
description: "Name of the user account running the broker"
type: "str"

# line 8 of defaults/main.yml
amq_streams_broker_listener_port:
default: 9092
description: "TODO document argument"
description: "Port used by the broker listener"
type: "int"

# line 9 of defaults/main.yml
amq_streams_broker_listener_internal_port:
default: 9091
description: "TODO document argument"
description: "Internal port used by the broker"
type: "int"

# line 10 of defaults/main.yml
amq_streams_broker_group:
default: "amq_streams"
description: "TODO document argument"
description: "Name of the system group used to run the broker"
type: "str"

# line 11 of defaults/main.yml
amq_streams_broker_service_config_template:
default: "templates/service.conf.j2"
description: "TODO document argument"
description: "relative path to the template used for the systemd service configuration for the broker"
type: "str"

# line 12 of defaults/main.yml
amq_streams_broker_service_config_file:
default: "/etc/broker.conf"
description: "TODO document argument"
description: "Path to the system service config on target"
type: "str"

# line 13 of defaults/main.yml
amq_streams_broker_data_dir:
default: "/var/lib/{{ amq_streams_broker_service_name }}"
description: "TODO document argument"
description: "Path to the broker's datadir on target"
type: "str"

# line 14 of defaults/main.yml
amq_streams_broker_logs_dir:
default: "/var/log/{{ amq_streams_broker_service_name }}/"
description: "TODO document argument"
description: "Path to the broker's logdir on target"
type: "str"

# line 15 of defaults/main.yml
amq_streams_broker_num_network_threads:
default: 3
description: "TODO document argument"
description: "Number of network threads for the broker"
type: "int"

# line 16 of defaults/main.yml
amq_streams_broker_num_io_threads:
default: 8
description: "TODO document argument"
description: "Number of i/o threads for the broker"
type: "int"

# line 17 of defaults/main.yml
amq_streams_broker_buffer_send_bytes:
default: 102400
description: "TODO document argument"
description: "Value of the buffer send bytes of the broker"
type: "int"

# line 18 of defaults/main.yml
amq_streams_broker_buffer_bytes:
default: 102400
description: "TODO document argument"
description: "Value of the buffer bytes of the broker"
type: "int"

# line 19 of defaults/main.yml
amq_streams_broker_socket_request_max_bytes:
default: 104857600
description: "TODO document argument"
description: "Value of the socket request max bytes"
type: "int"

# line 20 of defaults/main.yml
amq_streams_broker_num_partitions:
default: 1
description: "TODO document argument"
description: "Number of partitions"
type: "int"

# line 21 of defaults/main.yml
amq_streams_broker_num_recovery_threads_per_data_dir:
default: 1
description: "TODO document argument"
description: "Number of recovery threads per datadir"
type: "int"

# line 22 of defaults/main.yml
amq_streams_broker_offsets_topic_replication_factor:
default: 1
description: "TODO document argument"
description: "Broker's offeset topic replication factor"
type: "int"

# line 23 of defaults/main.yml
amq_streams_broker_transaction_state_log_replication_factor:
default: 1
description: "TODO document argument"
description: "Transaction state log replication factor"
type: "int"

# line 24 of defaults/main.yml
amq_streams_broker_transaction_state_log_min_isr:
default: 1
description: "TODO document argument"
description: "Transaction state log min isr"
type: "int"

# line 25 of defaults/main.yml
amq_streams_broker_log_retention_hours:
default: 168
description: "TODO document argument"
description: "Broker's log retention (in hours)"
type: "int"

# line 26 of defaults/main.yml
amq_streams_broker_log_retention_check_interval_ms:
default: 300000
description: "TODO document argument"
description: "Broker's log retention check interval (in milliseconds)"
type: "int"

# line 27 of defaults/main.yml
amq_streams_broker_zookeeper_connection_timeout_ms:
default: 30000
description: "TODO document argument"
description: "Zookeeper connection timeout (in milliseconds) for the broker"
type: "int"

# line 28 of defaults/main.yml
amq_streams_broker_zookeeper_session_timeout_ms:
default: 18000
description: "TODO document argument"
description: "Zookeeper session timeout (in milliseconds) for the broker"
type: "int"

# line 29 of defaults/main.yml
amq_streams_broker_group_initial_rebalance_delay_ms:
default: 0
description: "TODO document argument"
description: "Broker's group initial rebalance delay (in milliseconds)"
type: "int"

# line 30 of defaults/main.yml
amq_streams_broker_properties_template:
default: "templates/server.properties.j2"
description: "TODO document argument"
description: "Relative path to the template used for the broker's server.properties"
type: "str"

# line 31 of defaults/main.yml
amq_streams_broker_java_heap_opts:
default: "-Xmx1G -Xms1G"
description: "TODO document argument"
description: "Broker's Java heap's options"
type: "str"

# line 33 of defaults/main.yml
amq_streams_broker_bootstrap_server_host:
default: "localhost"
description: "TODO document argument"
description: "Broker boostrap's server host"
type: "str"

# line 34 of defaults/main.yml
amq_streams_broker_bootstrap_server_port:
default: 9092
description: "TODO document argument"
description: "Broker's boostrap server port"
type: "int"

# line 36 of defaults/main.yml
amq_streams_firewalld_package_name:
default: "['firewalld']"
description: "TODO document argument"
description: "List of packages required to install Firewalld"
type: "list"

# line 38 of defaults/main.yml
amq_streams_firewalld_enabled:
default: false
description: "TODO document argument"
description: "Whether or not firewalld should be managed by Ansible for the broker"
type: "bool"

# line 40 of defaults/main.yml
amq_streams_broker_instance_count_enabled:
default: true
description: "TODO document argument"
description: "Whether or not Ansible should count and keep track of the number of instances of broker deployed in the cluster"
type: "bool"

# line 41 of defaults/main.yml
amq_streams_broker_instance_count:
default: 0
description: "TODO document argument"
description: "Number of broker instances deployed by Ansible"
type: "int"

# line 43 of defaults/main.yml
amq_streams_deployment_balance_check_enabled:
default: true
description: "TODO document argument"
description: "Whether or not the zk/broker balance check is enabled"
type: "bool"

# line 45 of defaults/main.yml
amq_streams_broker_zookeeper_host_default_value:
default: "localhost"
description: "TODO document argument"
description: "Hostname of the Zookeeper instance to be used by the broker"
type: "str"

# line 46 of defaults/main.yml
amq_streams_broker_zookeeper_port_default_value:
default: 2181
description: "TODO document argument"
description: "Port of the Zookeeper used by the broker"
type: "int"

# line 47 of defaults/main.yml
amq_streams_broker_zookeeper_wait:
default: true
description: "TODO document argument"
description: "How long should the broker before attempting to connect to the Zk"
type: "bool"

# line 50 of defaults/main.yml
amq_streams_zookeeper_auth_enabled:
default: "false"
description: "TODO document argument"
description: "Whether or not authentification with Zk is enabled or not"
type: "str"

# line 51 of defaults/main.yml
amq_streams_broker_zookeeper_auth_config:
default: "/etc/broker-jaas.conf"
description: "TODO document argument"
description: "Path to the broker-jass.conf file on the target system"
type: "str"

# line 52 of defaults/main.yml
amq_streams_broker_zookeeper_auth_config_template:
default: "templates/broker-jaas.conf.j2"
description: "TODO document argument"
description: "Relative path to the templates used to generate the content of the broker-jaas.conf file"
type: "str"

# line 55 of defaults/main.yml
amq_streams_broker_listeners:
default: "['PLAINTEXT://:{{ amq_streams_broker_listener_port }}']"
description: "TODO document argument"
description: "Broker's listeners configuration"
type: "list"

# line 61 of defaults/main.yml
amq_streams_broker_auth_enabled:
default: "false"
description: "TODO document argument"
description: "Whether or not authentification between brokers"
type: "str"

# line 62 of defaults/main.yml
amq_streams_broker_auth_scram_enabled:
default: "false"
description: "TODO document argument"
description: "Whether or not scram authentification is enabled"
type: "str"

# line 63 of defaults/main.yml
amq_streams_connect_broker_auth_username:
default: "broker"
description: "TODO document argument"
description: "Broker's username for Connect"
type: "str"

# line 64 of defaults/main.yml
amq_streams_connect_broker_auth_password:
default: "PLEASE_CHANGEME_IAMNOTGOOD_FOR_PRODUCTION"
description: "TODO document argument"
description: "Value of the password used for Connect"
type: "str"

# line 66 of defaults/main.yml
amq_streams_broker_auth_listeners:
default: "['PLAINTEXT:PLAINTEXT']"
description: "TODO document argument"
description: "Broker authentification listeners configuration"
type: "list"

# line 71 of defaults/main.yml
amq_streams_broker_auth_sasl_mechanisms:
default: "['PLAIN']"
description: "TODO document argument"
description: "Broker's authentification sasl mechnisms used"
type: "list"

# line 75 of defaults/main.yml
amq_streams_broker_server_log_validation_min_size:
default: 20
description: "TODO document argument"
description: "Broker's serverl log validation minimal size (to consider the broker running and functionnal)"
type: "int"

# line 77 of defaults/main.yml
amq_streams_broker_inventory_group:
default: "{{ groups['brokers'] | default('') }}"
description: "TODO document argument"
description: "Broker inventory"
type: "str"

# line 78 of defaults/main.yml
amq_streams_zookeeper_inventory_group:
default: "{{ groups['zookeepers'] | default('') }}"
description: "TODO document argument"
description: "Zookeepers inventory"
type: "str"
4 changes: 4 additions & 0 deletions roles/amq_streams_common/meta/argument_specs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@ argument_specs:
default: 'templates/service_systemd.j2'
description: "Template use to create systemd service for Kafka components (Zookeeper, Broker)."
type: "str"
amq_streams_common_systctl_update_enabled:
default: false
description: "Whether or not to perform OS tuning using sysctl"
type: "bool"
amq_streams_common_firewalld_enabled:
default: false
description: "Whether to enable firewall configuration"
Expand Down
Loading
Loading