updates for icinga doc

hooks/doc

@@ -2,7 +2,7 @@
 
 . hooks/molecule.rc
 
-set -x
+# set -x
 
 if [ -z "${COLLECTION_DIR}" ]
 then
@@ -17,7 +17,7 @@ then
   # ansible-doc --list --list_files -t module ${COLLECTION_NAMESPACE}.${COLLECTION_NAME}
 
   ansible_modules=$(
-    ansible-doc --list ${COLLECTION_NAMESPACE}.${COLLECTION_NAME} --json | jq -r 'keys[]'
+    ansible-doc --list ${COLLECTION_NAMESPACE}.${COLLECTION_NAME} --type module --json | jq -r 'keys[]'
   )
 
   for i in ${ansible_modules}
@@ -26,6 +26,19 @@ then
     PAGER='cat' ansible-doc --type module ${i}
     echo ""
   done
+
+  # -------------------------------------------------
+  ansible_filter=$(
+    ansible-doc --list ${COLLECTION_NAMESPACE}.${COLLECTION_NAME} --type filter --json | jq -r 'keys[]'
+  )
+
+  # for i in ${ansible_filter}
+  # do
+  #   # echo " - ${i}"
+  #   PAGER='cat' ansible-doc --type filter ${i}
+  #   echo ""
+  # done
+
 fi
 
 exit 0

hooks/install

@@ -11,7 +11,10 @@ rsync \
   --verbose \
   --recursive \
   --exclude hooks \
+  --exclude *OBSOLETE* \
+  --exclude *obsolete* \
   --exclude __pycache__ \
   --delete \
+  --delete-excluded \
   ../ansible-collection-${COLLECTION_NAME}/* \
   "${COLLECTION_DIR}/"

plugins/filter/append_checksum.yml

@@ -0,0 +1,29 @@
+
+DOCUMENTATION:
+  name: append_checksum
+  author: Bodo Schulz (@bodsch)
+  version_added: 1.0.0
+  short_description: create a list from list
+  description:
+    - create a list from list.
+  positional: _input
+  options:
+    _input:
+      description: a dictionary with some icingaweb modules or themes.
+      type: dict
+      required: true
+    checksums:
+      description: A dictionary mit checksums.
+      type: dict
+      required: true
+  notes:
+
+EXAMPLES: |
+  icingaweb_modules: "{{ icingaweb_modules | bodsch.icinga.append_checksum(_module_checksum) }}"
+
+  icingaweb_themes: "{{ icingaweb_themes | bodsch.icinga.append_checksum(_theme_checksum) }}"
+
+RETURN:
+  _value:
+    description: The original dictionary, in which each entry was extended with a checksum for the corresponding archive.
+    type: dict

plugins/filter/apply_notification.yml

@@ -0,0 +1,27 @@
+
+DOCUMENTATION:
+  name: apply_notification
+  author: Bodo Schulz (@bodsch)
+  version_added: 1.0.0
+  short_description: TBD
+  description:
+    - TBD
+  positional: _input
+  options:
+    _input:
+      description: A directories of ...
+      type: dict
+      required: true
+    name:
+      description: TBD.
+      type: string
+      required: true
+  notes:
+
+EXAMPLES: |
+  data, _type, valid_data = icinga2_notification_apply_rules | bodsch.icinga.apply_notification(n)
+
+RETURN:
+  _value:
+    description: TBD
+    type: tuple

plugins/filter/apply_service_name.yml

@@ -0,0 +1,27 @@
+
+DOCUMENTATION:
+  name: apply_service_name
+  author: Bodo Schulz (@bodsch)
+  version_added: 1.0.0
+  short_description: TBD
+  description:
+    - TBD
+  positional: _input
+  options:
+    _input:
+      description: A directories of ...
+      type: dict
+      required: true
+    default:
+      description: TBD.
+      type: string
+      required: true
+  notes:
+
+EXAMPLES: |
+  v, _name = v | bodsch.icinga.apply_service_name(c)
+
+RETURN:
+  _value:
+    description: TBD
+    type: tuple

plugins/filter/database_schema.yml

@@ -0,0 +1,27 @@
+
+DOCUMENTATION:
+  name: database_schema
+  author: Bodo Schulz (@bodsch)
+  version_added: 1.0.0
+  short_description: Defines a database schema file to be imported.
+  description:
+    - Defines a database schema file to be imported.
+  positional: _input
+  options:
+    _input:
+      description: A dictionary with found files.
+      type: dict
+      required: true
+    database_type:
+      description: A string with database types to be searched for in the dictionary. The default is ‘mysql’
+      type: string
+      required: false
+  notes:
+
+EXAMPLES: |
+  icingadb_database_schema: "{{ found_schema | bodsch.icinga.database_schema('mysql') | first }}"
+
+RETURN:
+  _value:
+    description: A list of the files found.
+    type: list

plugins/filter/database_upgrade_directory.yml

@@ -0,0 +1,27 @@
+
+DOCUMENTATION:
+  name: database_upgrade_directory
+  author: Bodo Schulz (@bodsch)
+  version_added: 1.0.0
+  short_description: Defines a directory from which update files are to be obtained.
+  description:
+    - Defines a directory from which update files are to be obtained.
+  positional: _input
+  options:
+    _input:
+      description: A dictionary with found directories.
+      type: dict
+      required: true
+    database_type:
+      description: A string with database types to be searched for in the dictionary. The default is ‘mysql’
+      type: string
+      required: false
+  notes:
+
+EXAMPLES: |
+  icingadb_upgrade_directory: "{{ found_directory | bodsch.icinga.database_upgrade_directory('mysql')}}"
+
+RETURN:
+  _value:
+    description: A string with the found directories.
+    type: string

plugins/filter/dict_from_list.yml

@@ -0,0 +1,27 @@
+
+DOCUMENTATION:
+  name: dict_from_list
+  author: Bodo Schulz (@bodsch)
+  version_added: 1.0.0
+  short_description: create a dictionary from list
+  description:
+    - create a dictionary from list.
+  positional: _input
+  options:
+    _input:
+      description: A list of elements.
+      type: list
+      required: true
+    search:
+      description: An string to search entries in (c(_input)) list.
+      type: string
+      required: true
+  notes:
+
+EXAMPLES: |
+  _icingaweb_module_grafana: "{{ icingaweb_modules | bodsch.icinga.dict_from_list('grafana') }}"
+
+RETURN:
+  _value:
+    description: The element you are looking for as a dictionary.
+    type: dict

plugins/filter/dns_icinga_primary.yml

@@ -0,0 +1,35 @@
+
+DOCUMENTATION:
+  name: dns_icinga_primary
+  author: Bodo Schulz (@bodsch)
+  version_added: 1.0.0
+  short_description: TBD
+  description:
+    - TBD
+  positional: _input
+  options:
+    _input:
+      description: A directories of ...
+      type: dict
+      required: true
+    object_name:
+      description: TBD.
+      type: bool
+      required: true
+    object_data:
+      description: TBD.
+      type: string
+      required: true
+    alternatives:
+      description: TBD.
+      type: list
+      required: true
+  notes:
+
+EXAMPLES: |
+  address = icinga2_masters | bodsch.icinga.dns_icinga_primary(object_name=key, object_data=values, alternatives=[key, ansible_fqdn])
+
+RETURN:
+  _value:
+    description: TBD
+    type: string

plugins/filter/dns_icinga_satellite.yml

@@ -0,0 +1,39 @@
+
+DOCUMENTATION:
+  name: dns_icinga_satellite
+  author: Bodo Schulz (@bodsch)
+  version_added: 1.0.0
+  short_description: TBD
+  description:
+    - TBD
+  positional: _input
+  options:
+    _input:
+      description: A directories of ...
+      type: dict
+      required: true
+    object_name:
+      description: TBD.
+      type: bool
+      required: true
+    object_data:
+      description: TBD.
+      type: string
+      required: true
+    satellite_zone:
+      description: TBD.
+      type: dict
+      required: true
+    alternatives:
+      description: TBD.
+      type: list
+      required: true
+  notes:
+
+EXAMPLES: |
+  address = icinga2_masters | bodsch.icinga.dns_icinga_satellite(object_name=key, object_data=values, satellite_zone=icinga2_satellite_zone, alternatives=[key, ansible_fqdn])
+
+RETURN:
+  _value:
+    description: TBD
+    type: string

plugins/filter/host_object_values.yml

@@ -0,0 +1,38 @@
+
+DOCUMENTATION:
+  name: host_object_values
+  author: Bodo Schulz (@bodsch)
+  version_added: 1.0.0
+  short_description: TBD
+  description:
+    - TBD
+  positional: _input
+  options:
+    _input:
+      description: A directories of ...
+      type: dict
+      required: true
+    primary:
+      description: TBD.
+      type: bool
+      required: true
+    key:
+      description: TBD.
+      type: string
+      required: true
+    ansible_fqdn:
+      description: TBD.
+      type: string
+      required: true
+  notes:
+
+EXAMPLES: |
+  values, endpoint, endpoint_name, zone_name, display_name, check_command, _ = values | bodsch.icinga.host_object_values(True, key, None)
+
+  values, _, object_name, zone_name, display_name, check_command, address = values | bodsch.icinga.host_object_values(False, key, ansible_fqdn)
+
+
+RETURN:
+  _value:
+    description: TBD
+    type: tuple

plugins/filter/icinga_satellite_zone.yml

@@ -0,0 +1,27 @@
+
+DOCUMENTATION:
+  name: icinga_satellite_zone
+  author: Bodo Schulz (@bodsch)
+  version_added: 1.0.0
+  short_description: Defines a satellite zone if icinga2_satellites is configured.
+  description:
+    - Defines a satellite zone if icinga2_satellites is configured.
+  positional: _input
+  options:
+    _input:
+      description: A directories of icinga satellites.
+      type: dict
+      required: true
+    ansible_fqdn:
+      description: The ansible_fqdn to search for in the dictionary to define the zone.
+      type: string
+      required: true
+  notes:
+
+EXAMPLES: |
+  icinga2_satellite_zone: "{{ icinga2_satellites | bodsch.icinga.icinga_satellite_zone(ansible_fqdn) }}"
+
+RETURN:
+  _value:
+    description: The zone name for the ansible_fqdn.
+    type: string

plugins/filter/icingadb.py

@@ -10,6 +10,7 @@
 class FilterModule(object):
     """
     """
+
     def filters(self):
         return {
             'database_schema': self.database_schema,

plugins/filter/icingaweb.py

@@ -1,14 +1,14 @@
 # python 3 headers, required if submitting to Ansible
+
 from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
 
 from ansible.utils.display import Display
 
 import json
 import crypt
 
-# https://docs.ansible.com/ansible/latest/dev_guide/developing_plugins.html
-# https://blog.oddbit.com/post/2019-04-25-writing-ansible-filter-plugins/
+__metaclass__ = type
+
 
 display = Display()
 
@@ -21,7 +21,7 @@ class FilterModule(object):
     def filters(self):
         return {
             # 'type': self.var_type,
-            'create_password_hash': self.password_hash,
+            # 'create_password_hash': self.password_hash,
             'dict_from_list': self.dict_from_list,
             'module_version': self.module_version,
         }