From 109edecd7829c5220cb708299f048fecf3715fd6 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Mon, 29 Jun 2020 15:21:35 +0200 Subject: [PATCH] Add version_added: 1.0.0 for all new features. (#37) --- plugins/modules/acme_certificate.py | 1 + plugins/modules/ecs_domain.py | 1 + plugins/modules/luks_device.py | 9 +++++++-- plugins/modules/openssh_keypair.py | 1 + plugins/modules/openssl_csr.py | 3 +++ plugins/modules/openssl_csr_info.py | 1 + plugins/modules/openssl_dhparam.py | 3 +++ plugins/modules/openssl_pkcs12.py | 2 ++ plugins/modules/openssl_privatekey.py | 5 +++++ plugins/modules/openssl_privatekey_info.py | 1 + plugins/modules/openssl_publickey.py | 3 +++ plugins/modules/x509_certificate.py | 7 +++++++ plugins/modules/x509_certificate_info.py | 1 + plugins/modules/x509_crl.py | 1 + plugins/modules/x509_crl_info.py | 1 + 15 files changed, 38 insertions(+), 2 deletions(-) diff --git a/plugins/modules/acme_certificate.py b/plugins/modules/acme_certificate.py index 2e2e480a..b9f77f99 100644 --- a/plugins/modules/acme_certificate.py +++ b/plugins/modules/acme_certificate.py @@ -212,6 +212,7 @@ options: to the same certificate in the chain." - "This option can only be used with the C(cryptography) backend." type: list + version_added: '1.0.0' suboptions: test_certificates: description: diff --git a/plugins/modules/ecs_domain.py b/plugins/modules/ecs_domain.py index 566ec2df..60ea7781 100644 --- a/plugins/modules/ecs_domain.py +++ b/plugins/modules/ecs_domain.py @@ -13,6 +13,7 @@ DOCUMENTATION = ''' module: ecs_domain author: - Chris Trufan (@ctrufan) +version_added: '1.0.0' short_description: Request validation of a domain with the Entrust Certificate Services (ECS) API description: - Request validation or re-validation of a domain with the Entrust Certificate Services (ECS) API. diff --git a/plugins/modules/luks_device.py b/plugins/modules/luks_device.py index f74e16e9..bcba986d 100644 --- a/plugins/modules/luks_device.py +++ b/plugins/modules/luks_device.py @@ -69,10 +69,12 @@ options: I(keyfile) is needed for most of the operations. Parameter value is a string with the passphrase." type: str + version_added: '1.0.0' keysize: description: - "Sets the key size only if LUKS container does not exist." type: int + version_added: '1.0.0' new_keyfile: description: - "Adds additional key to given container on I(device). @@ -95,6 +97,7 @@ options: new keyslot will be used even if another keyslot already exists for this passphrase." type: str + version_added: '1.0.0' remove_keyfile: description: - "Removes given key from the container on I(device). Does not @@ -118,6 +121,7 @@ options: container, the I(force_remove_last_key) option must be set to C(yes)." type: str + version_added: '1.0.0' force_remove_last_key: description: - "If set to C(yes), allows removing the last key from a container." @@ -134,19 +138,20 @@ options: not specified." - "This cannot be specified if I(type) is set to C(luks1)." type: str + version_added: '1.0.0' uuid: description: - "With this option user can identify the LUKS container by UUID." - "Will only be used when I(device) and I(label) are not specified." type: str + version_added: '1.0.0' type: description: - "This option allow the user explicit define the format of LUKS container that wants to work with. Options are C(luks1) or C(luks2)" type: str choices: [luks1, luks2] - - + version_added: '1.0.0' requirements: - "cryptsetup" diff --git a/plugins/modules/openssh_keypair.py b/plugins/modules/openssh_keypair.py index b237c0ef..8affbb1b 100644 --- a/plugins/modules/openssh_keypair.py +++ b/plugins/modules/openssh_keypair.py @@ -87,6 +87,7 @@ options: - full_idempotence - always default: partial_idempotence + version_added: '1.0.0' notes: - In case the ssh key is broken or password protected, the module will fail. Set the I(force) option to C(yes) if you want to regenerate the keypair. diff --git a/plugins/modules/openssl_csr.py b/plugins/modules/openssl_csr.py index c32fe572..582d6579 100644 --- a/plugins/modules/openssl_csr.py +++ b/plugins/modules/openssl_csr.py @@ -51,6 +51,7 @@ options: - The content of the private key to use when signing the certificate signing request. - Either I(privatekey_path) or I(privatekey_content) must be specified if I(state) is C(present), but not both. type: str + version_added: "1.0.0" privatekey_passphrase: description: - The passphrase for the private key. @@ -267,6 +268,7 @@ options: - If set to C(yes), will return the (current or generated) CSR's content as I(csr). type: bool default: no + version_added: "1.0.0" extends_documentation_fragment: - files notes: @@ -419,6 +421,7 @@ csr: description: The (current or generated) CSR's content. returned: if I(state) is C(present) and I(return_content) is C(yes) type: str + version_added: "1.0.0" ''' import abc diff --git a/plugins/modules/openssl_csr_info.py b/plugins/modules/openssl_csr_info.py index 2a2eeff1..759985a6 100644 --- a/plugins/modules/openssl_csr_info.py +++ b/plugins/modules/openssl_csr_info.py @@ -38,6 +38,7 @@ options: - Content of the CSR file. - Either I(path) or I(content) must be specified, but not both. type: str + version_added: "1.0.0" select_crypto_backend: description: - Determines which crypto backend to use. diff --git a/plugins/modules/openssl_dhparam.py b/plugins/modules/openssl_dhparam.py index 6d683f2d..a02161b4 100644 --- a/plugins/modules/openssl_dhparam.py +++ b/plugins/modules/openssl_dhparam.py @@ -64,11 +64,13 @@ options: type: str default: auto choices: [ auto, cryptography, openssl ] + version_added: "1.0.0" return_content: description: - If set to C(yes), will return the (current or generated) DH params' content as I(dhparams). type: bool default: no + version_added: "1.0.0" extends_documentation_fragment: - files seealso: @@ -115,6 +117,7 @@ dhparams: description: The (current or generated) DH params' content. returned: if I(state) is C(present) and I(return_content) is C(yes) type: str + version_added: "1.0.0" ''' import abc diff --git a/plugins/modules/openssl_pkcs12.py b/plugins/modules/openssl_pkcs12.py index 2b7bb298..94e2929e 100644 --- a/plugins/modules/openssl_pkcs12.py +++ b/plugins/modules/openssl_pkcs12.py @@ -95,6 +95,7 @@ options: - If set to C(yes), will return the (current or generated) PKCS#12's content as I(pkcs12). type: bool default: no + version_added: "1.0.0" extends_documentation_fragment: - files seealso: @@ -173,6 +174,7 @@ pkcs12: description: The (current or generated) PKCS#12's content Base64 encoded. returned: if I(state) is C(present) and I(return_content) is C(yes) type: str + version_added: "1.0.0" ''' import base64 diff --git a/plugins/modules/openssl_privatekey.py b/plugins/modules/openssl_privatekey.py index 58391f93..95419ca6 100644 --- a/plugins/modules/openssl_privatekey.py +++ b/plugins/modules/openssl_privatekey.py @@ -129,6 +129,7 @@ options: type: str default: auto_ignore choices: [ pkcs1, pkcs8, raw, auto, auto_ignore ] + version_added: '1.0.0' format_mismatch: description: - Determines behavior of the module if the format of a private key does not match the expected format, but all @@ -139,6 +140,7 @@ options: type: str default: regenerate choices: [ regenerate, convert ] + version_added: '1.0.0' backup: description: - Create a backup file including a timestamp so you can get @@ -152,6 +154,7 @@ options: value is treated appropriately and not accidentally written to logs etc.! Use with care! type: bool default: no + version_added: '1.0.0' regenerate: description: - Allows to configure in which situations the module is allowed to regenerate private keys. @@ -184,6 +187,7 @@ options: - full_idempotence - always default: full_idempotence + version_added: '1.0.0' extends_documentation_fragment: - files seealso: @@ -266,6 +270,7 @@ privatekey: - Will be Base64-encoded if the key is in raw format. returned: if I(state) is C(present) and I(return_content) is C(yes) type: str + version_added: '1.0.0' ''' import abc diff --git a/plugins/modules/openssl_privatekey_info.py b/plugins/modules/openssl_privatekey_info.py index 3190fa6d..72d69527 100644 --- a/plugins/modules/openssl_privatekey_info.py +++ b/plugins/modules/openssl_privatekey_info.py @@ -39,6 +39,7 @@ options: - Content of the private key file. - Either I(path) or I(content) must be specified, but not both. type: str + version_added: '1.0.0' passphrase: description: - The passphrase for the private key. diff --git a/plugins/modules/openssl_publickey.py b/plugins/modules/openssl_publickey.py index 1bcd48de..ee2a1b29 100644 --- a/plugins/modules/openssl_publickey.py +++ b/plugins/modules/openssl_publickey.py @@ -62,6 +62,7 @@ options: - Either I(privatekey_path) or I(privatekey_content) must be specified, but not both. If I(state) is C(present), one of them is required. type: str + version_added: '1.0.0' privatekey_passphrase: description: - The passphrase for the private key. @@ -86,6 +87,7 @@ options: - If set to C(yes), will return the (current or generated) public key's content as I(publickey). type: bool default: no + version_added: '1.0.0' extends_documentation_fragment: - files seealso: @@ -171,6 +173,7 @@ publickey: description: The (current or generated) public key's content. returned: if I(state) is C(present) and I(return_content) is C(yes) type: str + version_added: '1.0.0' ''' import os diff --git a/plugins/modules/x509_certificate.py b/plugins/modules/x509_certificate.py index 95d51265..d760eb2c 100644 --- a/plugins/modules/x509_certificate.py +++ b/plugins/modules/x509_certificate.py @@ -96,6 +96,7 @@ options: - This is not required in C(assertonly) mode. - This is mutually exclusive with I(csr_path). type: str + version_added: '1.0.0' privatekey_path: description: @@ -107,6 +108,7 @@ options: - Path to the private key to use when signing the certificate. - This is mutually exclusive with I(privatekey_path). type: str + version_added: '1.0.0' privatekey_passphrase: description: @@ -183,6 +185,7 @@ options: - This is only used by the C(ownca) provider. - This is mutually exclusive with I(ownca_path). type: str + version_added: '1.0.0' ownca_privatekey_path: description: @@ -196,6 +199,7 @@ options: - This is only used by the C(ownca) provider. - This is mutually exclusive with I(ownca_privatekey_path). type: str + version_added: '1.0.0' ownca_privatekey_passphrase: description: @@ -296,6 +300,7 @@ options: - "Let's Encrypt recommends using their staging server while developing jobs. U(https://letsencrypt.org/docs/staging-environment/)." type: str default: https://acme-v02.api.letsencrypt.org/directory + version_added: '1.0.0' signature_algorithms: description: @@ -578,6 +583,7 @@ options: - If set to C(yes), will return the (current or generated) certificate's content as I(certificate). type: bool default: no + version_added: '1.0.0' extends_documentation_fragment: files notes: @@ -846,6 +852,7 @@ certificate: description: The (current or generated) certificate's content. returned: if I(state) is C(present) and I(return_content) is C(yes) type: str + version_added: '1.0.0' ''' diff --git a/plugins/modules/x509_certificate_info.py b/plugins/modules/x509_certificate_info.py index 4cc44e1d..8a8ba9f8 100644 --- a/plugins/modules/x509_certificate_info.py +++ b/plugins/modules/x509_certificate_info.py @@ -45,6 +45,7 @@ options: - Content of the X.509 certificate in PEM format. - Either I(path) or I(content) must be specified, but not both. type: str + version_added: '1.0.0' valid_at: description: - A dict of names mapping to time specifications. Every time specified here diff --git a/plugins/modules/x509_crl.py b/plugins/modules/x509_crl.py index b6c13599..2e719956 100644 --- a/plugins/modules/x509_crl.py +++ b/plugins/modules/x509_crl.py @@ -11,6 +11,7 @@ __metaclass__ = type DOCUMENTATION = r''' --- module: x509_crl +version_added: '1.0.0' short_description: Generate Certificate Revocation Lists (CRLs) description: - This module allows one to (re)generate or update Certificate Revocation Lists (CRLs). diff --git a/plugins/modules/x509_crl_info.py b/plugins/modules/x509_crl_info.py index 4b2b568f..e7e60cfb 100644 --- a/plugins/modules/x509_crl_info.py +++ b/plugins/modules/x509_crl_info.py @@ -11,6 +11,7 @@ __metaclass__ = type DOCUMENTATION = r''' --- module: x509_crl_info +version_added: '1.0.0' short_description: Retrieve information on Certificate Revocation Lists (CRLs) description: - This module allows one to retrieve information on Certificate Revocation Lists (CRLs).