From ddbcf49868a687f5ee03d5e66002bdae3c23b7b9 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Sat, 28 Dec 2024 17:02:42 +0100 Subject: [PATCH] Improve formulations. --- plugins/modules/acme_certificate.py | 2 +- plugins/modules/openssl_privatekey.py | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/plugins/modules/acme_certificate.py b/plugins/modules/acme_certificate.py index 97c85a052..838e7ae9b 100644 --- a/plugins/modules/acme_certificate.py +++ b/plugins/modules/acme_certificate.py @@ -21,7 +21,7 @@ that the output of the first run needs to be recorded and passed to the second run as the module argument O(data). - Between these two tasks you have to fulfill the required steps for the chosen challenge by whatever means necessary. For V(http-01) that means creating the necessary challenge file on the destination webserver. For V(dns-01) the necessary - dns record has to be created. For V(tls-alpn-01) the necessary certificate has to be created and served. It is I(not) + DNS record has to be created. For V(tls-alpn-01) the necessary certificate has to be created and served. It is I(not) the responsibility of this module to perform these steps. - For details on how to fulfill these challenges, you might have to read through L(the main ACME specification,https://tools.ietf.org/html/rfc8555#section-8) and the L(TLS-ALPN-01 specification,https://www.rfc-editor.org/rfc/rfc8737.html#section-3). Also, consider the examples diff --git a/plugins/modules/openssl_privatekey.py b/plugins/modules/openssl_privatekey.py index 32f6d820b..e7c8bde09 100644 --- a/plugins/modules/openssl_privatekey.py +++ b/plugins/modules/openssl_privatekey.py @@ -16,8 +16,8 @@ - This module allows one to (re)generate OpenSSL private keys. - The default mode for the private key file will be V(0600) if O(mode) is not explicitly set. - Please note that the module regenerates private keys if they do not match the module's options. In particular, if you - provide another passphrase (or specify none), change the keysize, etc., the private key will be regenerated. If you are - concerned that this could B(overwrite your private key), consider using the O(backup) option. + provide another passphrase (or specify none), change the keysize, and so on, the private key will be regenerated. + If you are concerned that this could B(overwrite your private key), consider using the O(backup) option. author: - Yanis Guenane (@Spredzy) - Felix Fontein (@felixfontein) @@ -65,7 +65,7 @@ description: - If set to V(true), will return the (current or generated) private key's content as RV(privatekey). - Note that especially if the private key is not encrypted, you have to make sure that the returned value is treated - appropriately and not accidentally written to logs etc.! Use with care! + appropriately and not accidentally written to logs, and so on! Use with care! - Use Ansible's C(no_log) task option to avoid the output being shown. See also U(https://docs.ansible.com/ansible/latest/reference_appendices/faq.html#how-do-i-keep-secret-data-in-my-playbook). type: bool