mirror of
https://github.com/freeipa/ansible-freeipa.git
synced 2026-07-31 20:04:45 +00:00
ipareplica_setup_dns: Fix documentation sections and agument spec
ansible-test with ansible-2.14 is adding a lot of new tests to ensure that the documentation section and the agument spec is complete. Needed changes: DOCUMENTATION section - `type: str` needs to be set for string parameters - `type: list` needs to be set for list parameters - `elements: str` needs to be given for list of string parameters - `required` tags need to be fixed according to the `argument_spec` - `type` tag needs to match `argument_spec` - `author` needs to be given with the github user also: `Name (@user)` argument_spec - `type='str'` needs to be set for string parameters - `elements='str'` needs to be added to all list of string parameters supports_check_mode is turned off as it is not supported. A call to ansible_ipa_replica.check_imports has been added to check for import errors. The `copyright` date is extended with `-2022`.
This commit is contained in:
@@ -5,7 +5,7 @@
|
|||||||
#
|
#
|
||||||
# Based on ipa-replica-install code
|
# Based on ipa-replica-install code
|
||||||
#
|
#
|
||||||
# Copyright (C) 2018 Red Hat
|
# Copyright (C) 2018-2022 Red Hat
|
||||||
# see file 'COPYING' for use and warranty information
|
# see file 'COPYING' for use and warranty information
|
||||||
#
|
#
|
||||||
# This program is free software; you can redistribute it and/or modify
|
# This program is free software; you can redistribute it and/or modify
|
||||||
@@ -40,47 +40,65 @@ description:
|
|||||||
options:
|
options:
|
||||||
setup_kra:
|
setup_kra:
|
||||||
description: Configure a dogtag KRA
|
description: Configure a dogtag KRA
|
||||||
required: yes
|
type: bool
|
||||||
|
required: no
|
||||||
setup_dns:
|
setup_dns:
|
||||||
description: Configure bind with our zone
|
description: Configure bind with our zone
|
||||||
required: yes
|
type: bool
|
||||||
|
required: no
|
||||||
subject_base:
|
subject_base:
|
||||||
description:
|
description:
|
||||||
The certificate subject base (default O=<realm-name>).
|
The certificate subject base (default O=<realm-name>).
|
||||||
RDNs are in LDAP order (most specific RDN first).
|
RDNs are in LDAP order (most specific RDN first).
|
||||||
required: no
|
type: str
|
||||||
|
required: yes
|
||||||
zonemgr:
|
zonemgr:
|
||||||
description: DNS zone manager e-mail address. Defaults to hostmaster@DOMAIN
|
description: DNS zone manager e-mail address. Defaults to hostmaster@DOMAIN
|
||||||
required: yes
|
type: str
|
||||||
|
required: no
|
||||||
forwarders:
|
forwarders:
|
||||||
description: Add DNS forwarders
|
description: Add DNS forwarders
|
||||||
required: yes
|
type: list
|
||||||
|
elements: str
|
||||||
|
required: no
|
||||||
forward_policy:
|
forward_policy:
|
||||||
description: DNS forwarding policy for global forwarders
|
description: DNS forwarding policy for global forwarders
|
||||||
required: yes
|
type: str
|
||||||
|
choices: ['first', 'only']
|
||||||
|
required: no
|
||||||
no_dnssec_validation:
|
no_dnssec_validation:
|
||||||
description: Disable DNSSEC validation
|
description: Disable DNSSEC validation
|
||||||
required: yes
|
type: bool
|
||||||
|
default: no
|
||||||
|
required: no
|
||||||
dns_ip_addresses:
|
dns_ip_addresses:
|
||||||
description: The dns ip_addresses setting
|
description: The dns ip_addresses setting
|
||||||
required: no
|
type: list
|
||||||
|
elements: str
|
||||||
|
required: yes
|
||||||
dns_reverse_zones:
|
dns_reverse_zones:
|
||||||
description: The dns reverse_zones setting
|
description: The dns reverse_zones setting
|
||||||
required: no
|
type: list
|
||||||
|
elements: str
|
||||||
|
required: yes
|
||||||
ccache:
|
ccache:
|
||||||
description: The local ccache
|
description: The local ccache
|
||||||
required: no
|
type: str
|
||||||
|
required: yes
|
||||||
_top_dir:
|
_top_dir:
|
||||||
description: The installer _top_dir setting
|
description: The installer _top_dir setting
|
||||||
required: no
|
type: str
|
||||||
|
required: yes
|
||||||
setup_ca:
|
setup_ca:
|
||||||
description: Configure a dogtag CA
|
description: Configure a dogtag CA
|
||||||
required: no
|
type: bool
|
||||||
|
required: yes
|
||||||
config_master_host_name:
|
config_master_host_name:
|
||||||
description: The config master_host_name setting
|
description: The config master_host_name setting
|
||||||
required: no
|
type: str
|
||||||
|
required: yes
|
||||||
author:
|
author:
|
||||||
- Thomas Woerner
|
- Thomas Woerner (@t-woerner)
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
@@ -93,7 +111,7 @@ import os
|
|||||||
|
|
||||||
from ansible.module_utils.basic import AnsibleModule
|
from ansible.module_utils.basic import AnsibleModule
|
||||||
from ansible.module_utils.ansible_ipa_replica import (
|
from ansible.module_utils.ansible_ipa_replica import (
|
||||||
AnsibleModuleLog, setup_logging, installer, DN, paths,
|
check_imports, AnsibleModuleLog, setup_logging, installer, DN, paths,
|
||||||
gen_env_boostrap_finalize_core, constants, api_bootstrap_finalize,
|
gen_env_boostrap_finalize_core, constants, api_bootstrap_finalize,
|
||||||
gen_ReplicaConfig, gen_remote_api, api, redirect_stdout, dns,
|
gen_ReplicaConfig, gen_remote_api, api, redirect_stdout, dns,
|
||||||
ansible_module_get_parsed_ip_addresses
|
ansible_module_get_parsed_ip_addresses
|
||||||
@@ -107,25 +125,28 @@ def main():
|
|||||||
setup_kra=dict(required=False, type='bool'),
|
setup_kra=dict(required=False, type='bool'),
|
||||||
setup_dns=dict(required=False, type='bool'),
|
setup_dns=dict(required=False, type='bool'),
|
||||||
# certificate system
|
# certificate system
|
||||||
subject_base=dict(required=True),
|
subject_base=dict(required=True, type='str'),
|
||||||
# dns
|
# dns
|
||||||
zonemgr=dict(required=False),
|
zonemgr=dict(required=False, type='str'),
|
||||||
forwarders=dict(required=False, type='list', default=[]),
|
forwarders=dict(required=False, type='list', elements='str',
|
||||||
forward_policy=dict(default=None, choices=['first', 'only']),
|
default=[]),
|
||||||
|
forward_policy=dict(required=False, type='str',
|
||||||
|
choices=['first', 'only'], default=None),
|
||||||
no_dnssec_validation=dict(required=False, type='bool',
|
no_dnssec_validation=dict(required=False, type='bool',
|
||||||
default=False),
|
default=False),
|
||||||
# additional
|
# additional
|
||||||
dns_ip_addresses=dict(required=True, type='list'),
|
dns_ip_addresses=dict(required=True, type='list', elements='str'),
|
||||||
dns_reverse_zones=dict(required=True, type='list'),
|
dns_reverse_zones=dict(required=True, type='list', elements='str'),
|
||||||
ccache=dict(required=True),
|
ccache=dict(required=True, type='str'),
|
||||||
_top_dir=dict(required=True),
|
_top_dir=dict(required=True, type='str'),
|
||||||
setup_ca=dict(required=True, type='bool'),
|
setup_ca=dict(required=True, type='bool'),
|
||||||
config_master_host_name=dict(required=True),
|
config_master_host_name=dict(required=True, type='str'),
|
||||||
),
|
),
|
||||||
supports_check_mode=True,
|
supports_check_mode=False,
|
||||||
)
|
)
|
||||||
|
|
||||||
ansible_module._ansible_debug = True
|
ansible_module._ansible_debug = True
|
||||||
|
check_imports(ansible_module)
|
||||||
setup_logging()
|
setup_logging()
|
||||||
ansible_log = AnsibleModuleLog(ansible_module)
|
ansible_log = AnsibleModuleLog(ansible_module)
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user