From 9eb07f70243a8a7d82864210baa90bff6ce80a19 Mon Sep 17 00:00:00 2001
From: Thomas Woerner <twoerner@redhat.com>
Date: Tue, 8 Nov 2022 16:36:51 +0100
Subject: [PATCH] ipaserver_setup_ca: 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`
- `default` 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
A call to ansible_ipa_server.check_imports has been added to check for import
errors.
The `copyright` date is extended with `-2022`.
---
roles/ipaserver/library/ipaserver_setup_ca.py | 171 ++++++++++++------
1 file changed, 113 insertions(+), 58 deletions(-)
diff --git a/roles/ipaserver/library/ipaserver_setup_ca.py b/roles/ipaserver/library/ipaserver_setup_ca.py
index 8c01e3c9..815edca7 100644
--- a/roles/ipaserver/library/ipaserver_setup_ca.py
+++ b/roles/ipaserver/library/ipaserver_setup_ca.py
@@ -5,7 +5,7 @@
#
# Based on ipa-client-install code
#
-# Copyright (C) 2017 Red Hat
+# Copyright (C) 2017-2022 Red Hat
# see file 'COPYING' for use and warranty information
#
# This program is free software; you can redistribute it and/or modify
@@ -39,119 +39,169 @@ description: Setup CA
options:
dm_password:
description: Directory Manager password
- required: no
+ type: str
+ required: yes
password:
description: Admin user kerberos password
- required: no
+ type: str
+ required: yes
master_password:
description: kerberos master password (normally autogenerated)
- required: no
+ type: str
+ required: yes
ip_addresses:
description: List of Master Server IP Addresses
- required: yes
+ type: list
+ elements: str
+ required: no
domain:
description: Primary DNS domain of the IPA deployment
- required: no
+ type: str
+ required: yes
realm:
description: Kerberos realm name of the IPA deployment
- required: no
+ type: str
+ required: yes
hostname:
description: Fully qualified name of this host
- required: yes
+ type: str
+ required: no
no_host_dns:
description: Do not use DNS for hostname lookup during installation
- required: yes
+ type: bool
+ default: no
+ required: no
pki_config_override:
description: Path to ini file with config overrides
- required: yes
+ type: str
+ required: no
setup_adtrust:
description: Configure AD trust capability
- required: yes
+ type: bool
+ default: no
+ required: no
setup_kra:
description: Configure a dogtag KRA
- required: yes
+ type: bool
+ default: no
+ required: no
setup_dns:
description: Configure bind with our zone
- required: yes
+ type: bool
+ default: no
+ required: no
setup_ca:
description: Configure a dogtag CA
- required: yes
+ type: bool
+ default: no
+ required: no
idstart:
description: The starting value for the IDs range (default random)
- required: no
+ type: int
+ required: yes
idmax:
description: The max value for the IDs range (default idstart+199999)
- required: no
+ type: int
+ required: yes
no_hbac_allow:
description: Don't install allow_all HBAC rule
- required: yes
+ type: bool
+ default: no
+ required: no
no_pkinit:
description: Disable pkinit setup steps
- required: yes
+ type: bool
+ default: no
+ required: no
dirsrv_config_file:
description:
The path to LDIF file that will be used to modify configuration of
dse.ldif during installation of the directory server instance
- required: yes
+ type: str
+ required: no
dirsrv_cert_files:
description:
Files containing the Directory Server SSL certificate and private key
- required: yes
+ type: list
+ elements: str
+ required: no
_dirsrv_pkcs12_info:
description: The installer _dirsrv_pkcs12_info setting
- required: yes
+ type: list
+ elements: str
+ required: no
external_ca:
description: External ca setting
- required: yes
+ type: bool
+ default: no
+ required: no
external_ca_type:
description: Type of the external CA
- required: yes
+ type: str
+ required: no
external_ca_profile:
description:
Specify the certificate profile/template to use at the external CA
- required: yes
+ type: str
+ required: no
external_cert_files:
description:
File containing the IPA CA certificate and the external CA certificate
chain
- required: yes
+ type: list
+ elements: str
+ required: no
subject_base:
description:
The certificate subject base (default O=<realm-name>).
RDNs are in LDAP order (most specific RDN first).
- required: yes
+ type: str
+ required: no
_subject_base:
description: The installer _subject_base setting
- required: yes
+ type: str
+ required: no
ca_subject:
description: The installer ca_subject setting
- required: yes
+ type: str
+ required: no
_ca_subject:
description: The installer _ca_subject setting
- required: yes
+ type: str
+ required: no
ca_signing_algorithm:
description: Signing algorithm of the IPA CA certificate
- required: yes
+ type: str
+ required: no
_random_serial_numbers:
description: The installer _random_serial_numbers setting
+ type: bool
required: yes
reverse_zones:
description: The reverse DNS zones to use
- required: yes
+ type: list
+ elements: str
+ required: no
no_reverse:
description: Do not create new reverse DNS zone
- required: yes
+ type: bool
+ default: no
+ required: no
auto_forwarders:
description: Use DNS forwarders configured in /etc/resolv.conf
- required: yes
+ type: bool
+ default: no
+ required: no
domainlevel:
description: The domain level
- required: yes
+ type: int
+ required: no
_http_ca_cert:
description: The installer _http_ca_cert setting
- required: yes
+ type: str
+ required: no
author:
- - Thomas Woerner
+ - Thomas Woerner (@t-woerner)
'''
EXAMPLES = '''
@@ -164,7 +214,7 @@ import os
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.ansible_ipa_server import (
- AnsibleModuleLog, setup_logging, options, sysrestore, paths,
+ check_imports, AnsibleModuleLog, setup_logging, options, sysrestore, paths,
ansible_module_get_parsed_ip_addresses,
api_Backend_ldap2, redirect_stdout, ca, installutils, ds_init_info,
custodiainstance, write_cache, x509, decode_certificate
@@ -175,15 +225,16 @@ def main():
ansible_module = AnsibleModule(
argument_spec=dict(
# basic
- dm_password=dict(required=True, no_log=True),
- password=dict(required=True, no_log=True),
- master_password=dict(required=True, no_log=True),
- ip_addresses=dict(required=False, type='list', default=[]),
- domain=dict(required=True),
- realm=dict(required=True),
- hostname=dict(required=False),
+ dm_password=dict(required=True, type='str', no_log=True),
+ password=dict(required=True, type='str', no_log=True),
+ master_password=dict(required=True, type='str', no_log=True),
+ ip_addresses=dict(required=False, type='list', elements='str',
+ default=[]),
+ domain=dict(required=True, type='str'),
+ realm=dict(required=True, type='str'),
+ hostname=dict(required=False, type='str'),
no_host_dns=dict(required=False, type='bool', default=False),
- pki_config_override=dict(required=False),
+ pki_config_override=dict(required=False, type='str'),
# server
setup_adtrust=dict(required=False, type='bool', default=False),
setup_kra=dict(required=False, type='bool', default=False),
@@ -193,32 +244,36 @@ def main():
idmax=dict(required=True, type='int'),
no_hbac_allow=dict(required=False, type='bool', default=False),
no_pkinit=dict(required=False, type='bool', default=False),
- dirsrv_config_file=dict(required=False),
- dirsrv_cert_files=dict(required=False, type='list'),
- _dirsrv_pkcs12_info=dict(required=False, type='list'),
+ dirsrv_config_file=dict(required=False, type='str'),
+ dirsrv_cert_files=dict(required=False, type='list',
+ elements='str'),
+ _dirsrv_pkcs12_info=dict(required=False, type='list',
+ elements='str'),
# certificate system
external_ca=dict(required=False, type='bool', default=False),
- external_ca_type=dict(required=False),
- external_ca_profile=dict(required=False),
+ external_ca_type=dict(required=False, type='str'),
+ external_ca_profile=dict(required=False, type='str'),
external_cert_files=dict(required=False, type='list',
- default=None),
- subject_base=dict(required=False),
- _subject_base=dict(required=False),
- ca_subject=dict(required=False),
- _ca_subject=dict(required=False),
- ca_signing_algorithm=dict(required=False),
+ elements='str', default=None),
+ subject_base=dict(required=False, type='str'),
+ _subject_base=dict(required=False, type='str'),
+ ca_subject=dict(required=False, type='str'),
+ _ca_subject=dict(required=False, type='str'),
+ ca_signing_algorithm=dict(required=False, type='str'),
_random_serial_numbers=dict(required=True, type='bool'),
# dns
- reverse_zones=dict(required=False, type='list', default=[]),
+ reverse_zones=dict(required=False, type='list', elements='str',
+ default=[]),
no_reverse=dict(required=False, type='bool', default=False),
auto_forwarders=dict(required=False, type='bool', default=False),
# additional
domainlevel=dict(required=False, type='int'),
- _http_ca_cert=dict(required=False),
+ _http_ca_cert=dict(required=False, type='str'),
),
)
ansible_module._ansible_debug = True
+ check_imports(ansible_module)
setup_logging()
ansible_log = AnsibleModuleLog(ansible_module)
--
GitLab