From 5c52318060697178d97a14f9cff3cae80b0ff41f Mon Sep 17 00:00:00 2001 From: Romain Pelisse Date: Wed, 22 Nov 2023 12:47:50 +0100 Subject: [PATCH] Add missing documentation on role's vars --- .../meta/argument_specs.yml | 106 +++++++++--------- .../meta/argument_specs.yml | 4 + .../meta/argument_specs.yml | 50 ++++----- .../meta/argument_specs.yml | 66 +++++------ 4 files changed, 115 insertions(+), 111 deletions(-) diff --git a/roles/amq_streams_broker/meta/argument_specs.yml b/roles/amq_streams_broker/meta/argument_specs.yml index a5f48b4..dcace88 100644 --- a/roles/amq_streams_broker/meta/argument_specs.yml +++ b/roles/amq_streams_broker/meta/argument_specs.yml @@ -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" diff --git a/roles/amq_streams_common/meta/argument_specs.yml b/roles/amq_streams_common/meta/argument_specs.yml index c2a8f60..1c60254 100644 --- a/roles/amq_streams_common/meta/argument_specs.yml +++ b/roles/amq_streams_common/meta/argument_specs.yml @@ -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" diff --git a/roles/amq_streams_connect/meta/argument_specs.yml b/roles/amq_streams_connect/meta/argument_specs.yml index 56aa601..8ebbcb6 100644 --- a/roles/amq_streams_connect/meta/argument_specs.yml +++ b/roles/amq_streams_connect/meta/argument_specs.yml @@ -4,149 +4,149 @@ argument_specs: # line 2 of defaults/main.yml amq_streams_connect_user: default: "amq_streams_connect" - description: "TODO document argument" + description: "Name of the user account, on the target system, used to run Connect" type: "str" # line 3 of defaults/main.yml amq_streams_connect_group: default: "amq_streams" - description: "TODO document argument" + description: "Name of the group, on the target system, used to run Connect" type: "str" # line 4 of defaults/main.yml amq_streams_connect_standalone_conf: default: "{{ amq_streams_common_home }}/config/connect-standalone.properties" - description: "TODO document argument" + description: "Path to the connect-standalone.properties used by Connect" type: "str" # line 5 of defaults/main.yml amq_streams_connect_file_connector_data: default: "['foo', 'bar']" - description: "TODO document argument" + description: "Connect's file connector data" type: "list" # line 9 of defaults/main.yml amq_streams_connect_file_source_conf: default: "{{ amq_streams_common_home }}/config/connect-file-source.properties" - description: "TODO document argument" + description: "Path to the connect-file-source properties file" type: "str" # line 10 of defaults/main.yml amq_streams_connect_file_sink: default: "{{ amq_streams_common_home }}/config/connect-file-sink.properties" - description: "TODO document argument" + description: "Path to the connect-file-sink properties file" type: "str" # line 12 of defaults/main.yml amq_streams_connect_service_name: default: "amq_streams_connect" - description: "TODO document argument" + description: "Systemd service name associated to Connect on the target" type: "str" # line 13 of defaults/main.yml amq_streams_connect_logs_dir: default: "/var/log/{{ amq_streams_connect_service_name }}/" - description: "TODO document argument" + description: "Path to Connect's logdir" type: "str" # line 14 of defaults/main.yml amq_streams_connect_server_start: default: "{{ amq_streams_common_home }}/bin/connect-standalone.sh" - description: "TODO document argument" + description: "Path to the script used to start Connect" type: "str" # line 15 of defaults/main.yml amq_streams_connect_server_config: default: "{{ amq_streams_connect_standalone_conf }}" - description: "TODO document argument" + description: "Path to Connect's standalone config" type: "str" # line 16 of defaults/main.yml amq_streams_connect_server_extra_args: default: "{{ amq_streams_connect_file_source_conf }} {{ amq_streams_connect_file_sink }}" - description: "TODO document argument" + description: "Connect's extra args passed to the start script" type: "str" # line 17 of defaults/main.yml amq_streams_connect_systemd_env_file: default: "/etc/amq_streams_connect.conf" - description: "TODO document argument" + description: "Path, on the target, to the Connect's config file for systemd" type: "str" # line 18 of defaults/main.yml amq_streams_connect_systemd_home: default: "/usr/lib/systemd/system" - description: "TODO document argument" + description: "Home of systemd scripts on the target system" type: "str" # line 19 of defaults/main.yml amq_streams_connect_service_description: default: "Kafka Connect server" - description: "TODO document argument" + description: "Systemd's description of the Connect service" type: "str" # line 20 of defaults/main.yml amq_streams_connect_java_heap_opts: default: "-Xms256M -Xmx2G" - description: "TODO document argument" + description: "Connect Java heap options" type: "str" # line 22 of defaults/main.yml amq_streams_connect_bootstrap_servers: default: "localhost:9092" - description: "TODO document argument" + description: "Connect's hostname and port for boostrap" type: "str" # line 25 of defaults/main.yml amq_streams_connect_broker_auth_enabled: default: false - description: "TODO document argument" + description: "Whether or not authentification between broker and Connect is enabled" type: "bool" # line 26 of defaults/main.yml amq_streams_connect_broker_auth_scram_enabled: default: false - description: "TODO document argument" + description: "Whether or not broker scram authentification is enabled" type: "bool" # line 27 of defaults/main.yml amq_streams_connect_broker_auth_username: default: "broker" - description: "TODO document argument" + description: "Broker's username used for Connect's auth" type: "str" # line 28 of defaults/main.yml amq_streams_connect_broker_auth_password: default: "PLEASE_CHANGEME_IAMNOTGOOD_FOR_PRODUCTION" - description: "TODO document argument" + description: "Broker's password used for Connect's auth" type: "str" # line 29 of defaults/main.yml amq_streams_connect_zookeeper_session_timeout_ms: default: 18000 - description: "TODO document argument" + description: "Connect's Zk session time (in milliseconds)" type: "int" # line 30 of defaults/main.yml amq_streams_connect_server_log_validation_min_size: default: 20 - description: "TODO document argument" + description: "Connect's server log minimal size (for the service to be considered functionnal)" type: "int" # line 32 of defaults/main.yml amq_streams_connect_config_template: default: "templates/connect-standalone.properties.j2" - description: "TODO document argument" + description: "Relative path to the template used for the Connect's standalone properties file" type: "str" # line 33 of defaults/main.yml amq_streams_connect_service_config_template: default: "templates/service.conf.j2" - description: "TODO document argument" + description: "Relative path to the template used for the systemd service associated to Connect" type: "str" # line 34 of defaults/main.yml amq_streams_connect_server_port: default: 8083 - description: "TODO document argument" + description: "Connect's server port" type: "int" diff --git a/roles/amq_streams_zookeeper/meta/argument_specs.yml b/roles/amq_streams_zookeeper/meta/argument_specs.yml index 743faed..3beb9ca 100644 --- a/roles/amq_streams_zookeeper/meta/argument_specs.yml +++ b/roles/amq_streams_zookeeper/meta/argument_specs.yml @@ -4,197 +4,197 @@ argument_specs: # line 2 of defaults/main.yml amq_streams_zookeeper_enabled: default: true - description: "TODO document argument" + description: "Whether or not Ansible should managed Zookeeper instances" type: "bool" # line 3 of defaults/main.yml amq_streams_zookeeper_config: default: "/etc/amq_streams_zookeeper.properties" - description: "TODO document argument" + description: "Path, on the target, to the Zk properties file" type: "str" # line 4 of defaults/main.yml amq_streams_zookeeper_config_template: default: "templates/zookeeper.properties.j2" - description: "TODO document argument" + description: "Relative path to the templates used for Zk properties file" type: "str" # line 5 of defaults/main.yml amq_streams_zookeeper_server_start: default: "{{ amq_streams_common_home }}/bin/zookeeper-server-start.sh" - description: "TODO document argument" + description: "Path to the script used to start the Zk server" type: "str" # line 6 of defaults/main.yml amq_streams_zookeeper_user: default: "amq_streams_zookeeper" - description: "TODO document argument" + description: "User account used, on the target, to run Zk" type: "str" # line 7 of defaults/main.yml amq_streams_zookeeper_group: default: "amq_streams" - description: "TODO document argument" + description: "Name of the system's group used to run Zk on the target" type: "str" # line 8 of defaults/main.yml amq_streams_zookeeper_service_name: default: "amq_streams_zookeeper" - description: "TODO document argument" + description: "Name of systemd service associated to Zk" type: "str" # line 9 of defaults/main.yml amq_streams_zookeeper_service_config_template: default: "templates/service.conf.j2" - description: "TODO document argument" + description: "Relative path to the template used to generate the systemd configuration for the Zk server" type: "str" # line 10 of defaults/main.yml amq_streams_zookeeper_service_env_file: default: "/etc/zookeeper.conf" - description: "TODO document argument" + description: "Path to the Zk systemd's configuration on the target" type: "str" # line 11 of defaults/main.yml amq_streams_zookeeper_data_dir: default: "/var/lib/{{ amq_streams_zookeeper_service_name }}/" - description: "TODO document argument" + description: "Path to the datadir used by Zk on the target system" type: "str" # line 12 of defaults/main.yml amq_streams_zookeeper_logs_dir: default: "/var/log/{{ amq_streams_zookeeper_service_name }}/" - description: "TODO document argument" + description: "Path to the logdir used by Zk on the target system" type: "str" # line 13 of defaults/main.yml amq_streams_zookeeper_max_client_cnxns: default: 0 - description: "TODO document argument" + description: "Number of max client connections for Zk" type: "int" # line 14 of defaults/main.yml amq_streams_zookeeper_admin_enable_server: default: "true" - description: "TODO document argument" + description: "Whether or not Zk admin server is enabled" type: "str" # line 15 of defaults/main.yml amq_streams_zookeeper_admin_server_port: default: 8080 - description: "TODO document argument" + description: "Zk admin server port" type: "int" # line 16 of defaults/main.yml amq_streams_zookeeper_instance_count_enabled: default: true - description: "TODO document argument" + description: "Whether or not Ansible should count and keep track of the number of Zk instances deployed" type: "bool" # line 17 of defaults/main.yml amq_streams_zookeeper_4wl_commands_whitelist: default: "stat,dump" - description: "TODO document argument" + description: "Zk 4wl commands whitelist" type: "str" # line 18 of defaults/main.yml amq_streams_zookeeper_instance_count: default: 0 - description: "TODO document argument" + description: "Zk instance count" type: "int" # line 19 of defaults/main.yml amq_streams_zookeeper_java_heap_opts: default: "-Xmx512M -Xms512M" - description: "TODO document argument" + description: "Zk Java heap options" type: "str" # line 21 of defaults/main.yml amq_streams_zookeeper_host: default: "localhost" - description: "TODO document argument" + description: "Zk hostname" type: "str" # line 22 of defaults/main.yml amq_streams_zookeeper_port: default: 2181 - description: "TODO document argument" + description: "Zk port used" type: "int" # line 23 of defaults/main.yml amq_streams_zookeeper_init_limit: default: 5 - description: "TODO document argument" + description: "Zk init limit" type: "int" # line 24 of defaults/main.yml amq_streams_zookeeper_sync_limit: default: 2 - description: "TODO document argument" + description: "Zk sync limit" type: "int" # line 25 of defaults/main.yml amq_streams_zookeeper_cluster_port_start: default: 2888 - description: "TODO document argument" + description: "Zk cluster port range start" type: "int" # line 26 of defaults/main.yml amq_streams_zookeeper_cluster_port_end: default: 3888 - description: "TODO document argument" + description: "Zk cluster port range end" type: "int" # line 28 of defaults/main.yml amq_streams_zookeeper_inventory_group: default: "{{ groups['zookeepers'] | default('') }}" - description: "TODO document argument" + description: "Zk inventory" type: "str" # line 30 of defaults/main.yml amq_streams_firewalld_package_name: default: "['firewalld']" - description: "TODO document argument" + description: "Packages required to install Firewalld" type: "list" # line 32 of defaults/main.yml amq_streams_firewalld_enabled: default: false - description: "TODO document argument" + description: "Whether or not Ansible should install and managed Firewalld for Zk" type: "bool" # line 35 of defaults/main.yml amq_streams_zookeeper_auth_enabled: default: "false" - description: "TODO document argument" + description: "Whether or not authenfication for Zk is enabled" type: "str" # line 36 of defaults/main.yml amq_streams_zookeeper_auth_config: default: "/etc/zookeeper-jaas.conf" - description: "TODO document argument" + description: "Path to the Zk JAAS conf file on the target system" type: "str" # line 37 of defaults/main.yml amq_streams_zookeeper_auth_config_template: default: "templates/zookeeper-jaas.conf.j2" - description: "TODO document argument" + description: "Relative path to the template used to generate the JAAS config" type: "str" # line 38 of defaults/main.yml amq_streams_zookeeper_auth_user: default: "zookeeper" - description: "TODO document argument" + description: "Zk username used for authentification" type: "str" # line 39 of defaults/main.yml amq_streams_zookeeper_auth_pass: default: "PLEASE_CHANGE_ME_I_AM_NO_GOOD_FOR_PRODUCTION" - description: "TODO document argument" + description: "Zk password used for authentification" type: "str" # line 41 of defaults/main.yml amq_streams_zookeeper_server_log_validation_min_size: default: 20 - description: "TODO document argument" + description: "Zk server log minimal size (to be considered functional)" type: "int"