Validation of icingaweb2 ressource entries could be more expansive

[RincewindsHat]

I just experienced an error where the database name for a Icinga Web 2 SQL ressource was missing and
since it is pretty pointless to try that, I wondered whether it would be possible to sanity check
this beforehand.

[mkayontour]

I think you mean this parameter to define the icingaweb2_db resource, right?

icingaweb2_db:
  host: localhost

https://github.com/NETWAYS/ansible-collection-icinga/blob/main/roles/icingaweb2/tasks/manage_icingaweb_config.yml#L63

A mandatory filter could be appropriate in this case.

"{{ icingaweb2_db['host'] | mandatory(msg='This variable is required.') }}" 

[RincewindsHat]

no, explicitely the name of the database to target in a specific DBMS, so in psql fooo fooo is the database.

[mkayontour]

Sorry, I misread, then this is the right one.

dbname: "{{ icingaweb2_db['name'] | mandatory(msg='This variable is required.') }}"

[Donien]

I think the following will already take care of it (once ready and merged of course).
It's an argument spec for the icingaweb2 role which does the validation on role entry.

ansible-collection-icinga/roles/icingaweb2/meta/argument_specs.yml

Lines 13 to 91 in 6222f62

	icingaweb2_db:
	description:
	- Defines Icinga Web's own database resource for storing its configuration.
	type: dict
	required: false
	options:
	type:
	description:
	- The type of database to be used.
	type: str
	required: false
	default: mysql
	choices: [ mysql, pgsql ]
	name:
	description:
	- The name of the database to be used.
	type: str
	required: true
	host:
	description:
	- The database host to be used.
	type: str
	required: false
	default: localhost
	port:
	description:
	- The database port to be used.
	type: int
	required: false
	default: 3306
	user:
	description:
	- The database user to be used.
	- If O(icingaweb2_priv_db_user) is set, it will be used instead when interacting with the database.
	This is useful if the normal O(icingaweb2_db.user) cannot apply a database schema.
	- O(icingaweb2_priv_db_user) works in conjunction with O(icingaweb2_priv_db_password).
	type: str
	required: true
	password:
	description:
	- The database password to be used.
	- If O(icingaweb2_priv_db_password) is set, it will be used instead when interacting with the database.
	This is useful if the normal O(icingaweb2_db.user) cannot apply a database schema.
	- O(icingaweb2_priv_db_password) works in conjunction with O(icingaweb2_priv_db_user).
	type: str
	required: true
	ssl_mode:
	description:
	- If O(icingaweb2_db.type=mysql), the value for C(--ssl-mode) to be passed to the C(mysql) command when interacting with the database.
	- If O(icingaweb2_db.type=pgsql), the value for C(ssl-mode) to be passed to the C(psql) command when interacting with the database.
	type: str
	required: false
	ssl_ca:
	description:
	- If O(icingaweb2_db.type=mysql), the for value for C(--ssl-ca) to be passed to the C(mysql) command when interacting with the database.
	type: str
	required: false
	ssl_cert:
	description:
	- If O(icingaweb2_db.type=mysql), the for value for C(--ssl-cert) to be passed to the C(mysql) command when interacting with the database.
	- If O(icingaweb2_db.type=pgsql), the for value for C(sslcert) to be passed to the C(psql) command when interacting with the database.
	type: str
	required: false
	ssl_key:
	description:
	- If O(icingaweb2_db.type=mysql), the for value for C(--ssl-key) to be passed to the C(mysql) command when interacting with the database.
	- If O(icingaweb2_db.type=pgsql), the for value for C(sslkey) to be passed to the C(psql) command when interacting with the database.
	type: str
	required: false
	ssl_cipher:
	description:
	- If O(icingaweb2_db.type=mysql), the for value for C(--ssl-cipher) to be passed to the C(mysql) command when interacting with the database.
	type: str
	required: false
	ssl_extra_options:
	description:
	- Any arbitrary extra options to be passed to the C(mysql)/C(psql) command when interacting with the database.
	type: str
	required: false

Line 17 should probably be required: true instead of required: false, now that I look at it.