From 513c2fd5a0691254ff3f4d087953ac8ddee64ecf Mon Sep 17 00:00:00 2001 From: "patchback[bot]" <45432694+patchback[bot]@users.noreply.github.com> Date: Wed, 25 Jun 2025 22:52:26 +0200 Subject: [PATCH] [PR #921/bd070e85 backport][stable-2] Docs: use :ansplugin: (#922) * Use :ansplugin:. (#921) (cherry picked from commit bd070e85a3d6befe86d0b28619c5ab8e182bc105) * Add ignore.txt entries. --------- Co-authored-by: Felix Fontein --- docs/docsite/rst/guide_ownca.rst | 4 ++-- docs/docsite/rst/guide_selfsigned.rst | 6 +++--- tests/sanity/ignore-2.10.txt | 1 + tests/sanity/ignore-2.9.txt | 1 + 4 files changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/docsite/rst/guide_ownca.rst b/docs/docsite/rst/guide_ownca.rst index 79c224a4..f3817fce 100644 --- a/docs/docsite/rst/guide_ownca.rst +++ b/docs/docsite/rst/guide_ownca.rst @@ -51,7 +51,7 @@ The following instructions show how to set up a simple self-signed CA certificat Use the CA to sign a certificate -------------------------------- -To sign a certificate, you must pass a CSR to the :ref:`community.crypto.x509_certificate module ` or :ref:`community.crypto.x509_certificate_pipe module `. +To sign a certificate, you must pass a CSR to the :ansplugin:`community.crypto.x509_certificate module ` or :ansplugin:`community.crypto.x509_certificate_pipe module `. In the following example, we assume that the certificate to sign (including its private key) are on ``server_1``, while our CA certificate is on ``server_2``. We do not want any key material to leave each respective server. @@ -94,7 +94,7 @@ In the following example, we assume that the certificate to sign (including its delegate_to: server_1 run_once: true -Please note that the above procedure is **not idempotent**. The following extended example reads the existing certificate from ``server_1`` (if exists) and provides it to the :ref:`community.crypto.x509_certificate_pipe module `, and only writes the result back if it was changed: +Please note that the above procedure is **not idempotent**. The following extended example reads the existing certificate from ``server_1`` (if exists) and provides it to the :ansplugin:`community.crypto.x509_certificate_pipe module `, and only writes the result back if it was changed: .. code-block:: yaml+jinja diff --git a/docs/docsite/rst/guide_selfsigned.rst b/docs/docsite/rst/guide_selfsigned.rst index fda4911d..a259f0b4 100644 --- a/docs/docsite/rst/guide_selfsigned.rst +++ b/docs/docsite/rst/guide_selfsigned.rst @@ -10,7 +10,7 @@ How to create self-signed certificates The `community.crypto collection `_ offers multiple modules that create private keys, certificate signing requests, and certificates. This guide shows how to create self-signed certificates. -For creating any kind of certificate, you always have to start with a private key. You can use the :ref:`community.crypto.openssl_privatekey module ` to create a private key. If you only specify :ansopt:`community.crypto.openssl_privatekey#module:path`, the default parameters will be used. This will result in a 4096 bit RSA private key: +For creating any kind of certificate, you always have to start with a private key. You can use the :ansplugin:`community.crypto.openssl_privatekey module ` to create a private key. If you only specify :ansopt:`community.crypto.openssl_privatekey#module:path`, the default parameters will be used. This will result in a 4096 bit RSA private key: .. code-block:: yaml+jinja @@ -28,7 +28,7 @@ You can specify :ansopt:`community.crypto.openssl_privatekey#module:type` to sel type: X25519 passphrase: changeme -To create a very simple self-signed certificate with no specific information, you can proceed directly with the :ref:`community.crypto.x509_certificate module `: +To create a very simple self-signed certificate with no specific information, you can proceed directly with the :ansplugin:`community.crypto.x509_certificate module `: .. code-block:: yaml+jinja @@ -42,7 +42,7 @@ To create a very simple self-signed certificate with no specific information, yo You can use :ansopt:`community.crypto.x509_certificate#module:selfsigned_not_after` to define when the certificate expires (default: in roughly 10 years), and :ansopt:`community.crypto.x509_certificate#module:selfsigned_not_before` to define from when the certificate is valid (default: now). -To define further properties of the certificate, like the subject, Subject Alternative Names (SANs), key usages, name constraints, etc., you need to first create a Certificate Signing Request (CSR) and provide it to the :ref:`community.crypto.x509_certificate module `. If you do not need the CSR file, you can use the :ref:`community.crypto.openssl_csr_pipe module ` as in the example below. (To store it to disk, use the :ref:`community.crypto.openssl_csr module ` instead.) +To define further properties of the certificate, like the subject, Subject Alternative Names (SANs), key usages, name constraints, etc., you need to first create a Certificate Signing Request (CSR) and provide it to the :ansplugin:`community.crypto.x509_certificate module `. If you do not need the CSR file, you can use the :ansplugin:`community.crypto.openssl_csr_pipe module ` as in the example below. (To store it to disk, use the :ansplugin:`community.crypto.openssl_csr module ` instead.) .. code-block:: yaml+jinja diff --git a/tests/sanity/ignore-2.10.txt b/tests/sanity/ignore-2.10.txt index c0a33ea1..e86b8bac 100644 --- a/tests/sanity/ignore-2.10.txt +++ b/tests/sanity/ignore-2.10.txt @@ -4,6 +4,7 @@ .azure-pipelines/scripts/publish-codecov.py compile-3.5!skip # Uses Python 3.6+ syntax .azure-pipelines/scripts/publish-codecov.py future-import-boilerplate .azure-pipelines/scripts/publish-codecov.py metaclass-boilerplate +docs/docsite/rst/guide_ownca.rst rstcheck docs/docsite/rst/guide_selfsigned.rst rstcheck noxfile.py compile-2.6!skip # Uses Python 3.6+ syntax noxfile.py compile-2.7!skip # Uses Python 3.6+ syntax diff --git a/tests/sanity/ignore-2.9.txt b/tests/sanity/ignore-2.9.txt index a6a9cd6e..83175ea2 100644 --- a/tests/sanity/ignore-2.9.txt +++ b/tests/sanity/ignore-2.9.txt @@ -4,6 +4,7 @@ .azure-pipelines/scripts/publish-codecov.py compile-3.5!skip # Uses Python 3.6+ syntax .azure-pipelines/scripts/publish-codecov.py future-import-boilerplate .azure-pipelines/scripts/publish-codecov.py metaclass-boilerplate +docs/docsite/rst/guide_ownca.rst rstcheck docs/docsite/rst/guide_selfsigned.rst rstcheck noxfile.py compile-2.6!skip # Uses Python 3.6+ syntax noxfile.py compile-2.7!skip # Uses Python 3.6+ syntax