update docs for develop

RedHatSatellite · Sep 2, 2024 · 719e7a8 · 719e7a8
1 parent 49158f5
commit 719e7a8
Show file tree

Hide file tree

Showing 286 changed files with 1,679 additions and 1,941 deletions.
diff --git a/develop/CHANGELOG.html b/develop/CHANGELOG.html
diff --git a/develop/_sources/CHANGELOG.rst.txt b/develop/_sources/CHANGELOG.rst.txt
@@ -6,6 +6,22 @@ redhat.satellite Release Notes
 
 This changelog describes changes after version 0.8.1.
 
+v4.2.0
+======
+
+Minor Changes
+-------------
+
+- content_export_* - document that ``chunk_size_gb`` parameter is only applicable for ``importable`` exports (https://github.com/theforeman/foreman-ansible-modules/issues/1738)
+- lifecycle_environments role - allow setting ``state`` for the LCE, allowing deletion of existing ones
+- location, locations role - add ``description`` parameter to set the description
+
+Bugfixes
+--------
+
+- callback plugin - correctly catch facts with vault data and replace it with ``ENCRYPTED_VAULT_VALUE_NOT_REPORTED``, preventing ``Object of type AnsibleVaultEncryptedUnicode is not JSON serializable`` errors
+- redhat_manifest - do not send empty JSON bodies in GET requests which confuse the portal sometimes (https://github.com/theforeman/foreman-ansible-modules/issues/1768)
+
 v4.1.0
 ======
 

diff --git a/develop/_sources/plugins/activation_key_module.rst.txt b/develop/_sources/plugins/activation_key_module.rst.txt
@@ -1,4 +1,3 @@
-
 .. Document meta
 
 :orphan:
@@ -7,7 +6,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.12.0
+  :antsibull-docs: 2.13.1
 
 .. Anchors
 
@@ -23,7 +22,7 @@ redhat.satellite.activation_key module -- Manage Activation Keys
 .. Collection note
 
 .. note::
-    This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/ui/repo/published/redhat/satellite/>`_ (version 4.1.0).
+    This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/ui/repo/published/redhat/satellite/>`_ (version 4.2.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.
@@ -161,15 +160,15 @@ Parameters
 
       List of content overrides that include label and override state
 
-      Label refers to repository \ :literal:`content\_label`\ , e.g. rhel-7-server-rpms
+      Label refers to repository :literal:`content\_label`\ , e.g. rhel-7-server-rpms
 
       Override state ('enabled', 'disabled', or 'default') sets initial state of repository for newly registered hosts
 
 
       .. raw:: html
 
         </div>
-    
+
   * - .. raw:: html
 
         <div class="ansible-option-indent"></div><div class="ansible-option-cell">
@@ -205,7 +204,7 @@ Parameters
 
         <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
 
-      Repository \ :literal:`content\_label`\  to override when registering hosts with the activation key
+      Repository :literal:`content\_label` to override when registering hosts with the activation key
 
 
       .. raw:: html
@@ -429,7 +428,7 @@ Parameters
 
       Maximum number of registered content hosts.
 
-      Required if \ :emphasis:`unlimited\_hosts=false`\ 
+      Required if :emphasis:`unlimited\_hosts=false`
 
 
       .. raw:: html
@@ -567,7 +566,7 @@ Parameters
 
       Password of the user accessing the Foreman server.
 
-      If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_PASSWORD`\  will be used instead.
+      If the value is not specified in the task, the value of environment variable :literal:`SATELLITE\_PASSWORD` will be used instead.
 
 
       .. raw:: html
@@ -739,7 +738,7 @@ Parameters
 
       URL of the Foreman server.
 
-      If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_SERVER\_URL`\  will be used instead.
+      If the value is not specified in the task, the value of environment variable :literal:`SATELLITE\_SERVER\_URL` will be used instead.
 
 
       .. raw:: html
@@ -818,9 +817,9 @@ Parameters
 
       State of the Activation Key
 
-      If \ :literal:`copied`\  the key will be copied to a new one with \ :emphasis:`new\_name`\  as the name and all other fields left untouched
+      If :literal:`copied` the key will be copied to a new one with :emphasis:`new\_name` as the name and all other fields left untouched
 
-      \ :literal:`present\_with\_defaults`\  will ensure the entity exists, but won't update existing ones
+      :literal:`present\_with\_defaults` will ensure the entity exists, but won't update existing ones
 
 
       .. rst-class:: ansible-option-line
@@ -874,7 +873,7 @@ Parameters
       .. raw:: html
 
         </div>
-    
+
   * - .. raw:: html
 
         <div class="ansible-option-indent"></div><div class="ansible-option-cell">
@@ -912,7 +911,7 @@ Parameters
 
       Name of the Subscription to be added.
 
-      Mutually exclusive with \ :emphasis:`pool\_id`\  and \ :emphasis:`upstream\_pool\_id`\ .
+      Mutually exclusive with :emphasis:`pool\_id` and :emphasis:`upstream\_pool\_id`.
 
 
       .. raw:: html
@@ -956,11 +955,11 @@ Parameters
 
       Pool ID of the Subscription to be added.
 
-      Mutually exclusive with \ :emphasis:`name`\  and \ :emphasis:`upstream\_pool\_id`\ .
+      Mutually exclusive with :emphasis:`name` and :emphasis:`upstream\_pool\_id`.
 
-      Also named \ :literal:`Candlepin Id`\  in the CSV export of the subscriptions,
+      Also named :literal:`Candlepin Id` in the CSV export of the subscriptions,
 
-      it is as well the \ :literal:`UUID`\  as output by \ :literal:`hammer subscription list`\ .
+      it is as well the :literal:`UUID` as output by :literal:`hammer subscription list`.
 
 
       .. raw:: html
@@ -1004,9 +1003,9 @@ Parameters
 
       Upstream Pool ID of the Subscription to be added.
 
-      Mutually exclusive with \ :emphasis:`name`\  and \ :emphasis:`pool\_id`\ .
+      Mutually exclusive with :emphasis:`name` and :emphasis:`pool\_id`.
 
-      Also named \ :literal:`Master Pools`\  in the Red Hat Portal.
+      Also named :literal:`Master Pools` in the Red Hat Portal.
 
 
       .. raw:: html
@@ -1085,7 +1084,7 @@ Parameters
 
       Username accessing the Foreman server.
 
-      If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_USERNAME`\  will be used instead.
+      If the value is not specified in the task, the value of environment variable :literal:`SATELLITE\_USERNAME` will be used instead.
 
 
       .. raw:: html
@@ -1121,7 +1120,7 @@ Parameters
 
       Whether or not to verify the TLS certificates of the Foreman server.
 
-      If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_VALIDATE\_CERTS`\  will be used instead.
+      If the value is not specified in the task, the value of environment variable :literal:`SATELLITE\_VALIDATE\_CERTS` will be used instead.
 
 
       .. rst-class:: ansible-option-line
@@ -1253,7 +1252,6 @@ Examples
 
 .. code-block:: yaml+jinja
 
-
     - name: "Create client activation key"
       redhat.satellite.activation_key:
         username: "admin"
@@ -1275,7 +1273,6 @@ Examples
 
 
 
-
 .. Facts
 
 
@@ -1335,7 +1332,7 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
 
         </div>
 
-    
+
   * - .. raw:: html
 
         <div class="ansible-option-indent"></div><div class="ansible-option-cell">
@@ -1417,4 +1414,3 @@ Collection links
 
 
 .. Parsing errors
-
diff --git a/develop/_sources/plugins/architecture_module.rst.txt b/develop/_sources/plugins/architecture_module.rst.txt
@@ -1,4 +1,3 @@
-
 .. Document meta
 
 :orphan:
@@ -7,7 +6,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.12.0
+  :antsibull-docs: 2.13.1
 
 .. Anchors
 
@@ -23,7 +22,7 @@ redhat.satellite.architecture module -- Manage Architectures
 .. Collection note
 
 .. note::
-    This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/ui/repo/published/redhat/satellite/>`_ (version 4.1.0).
+    This module is part of the `redhat.satellite collection <https://galaxy.ansible.com/ui/repo/published/redhat/satellite/>`_ (version 4.2.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.
@@ -191,7 +190,7 @@ Parameters
 
       Password of the user accessing the Foreman server.
 
-      If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_PASSWORD`\  will be used instead.
+      If the value is not specified in the task, the value of environment variable :literal:`SATELLITE\_PASSWORD` will be used instead.
 
 
       .. raw:: html
@@ -227,7 +226,7 @@ Parameters
 
       URL of the Foreman server.
 
-      If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_SERVER\_URL`\  will be used instead.
+      If the value is not specified in the task, the value of environment variable :literal:`SATELLITE\_SERVER\_URL` will be used instead.
 
 
       .. raw:: html
@@ -339,7 +338,7 @@ Parameters
 
       Username accessing the Foreman server.
 
-      If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_USERNAME`\  will be used instead.
+      If the value is not specified in the task, the value of environment variable :literal:`SATELLITE\_USERNAME` will be used instead.
 
 
       .. raw:: html
@@ -375,7 +374,7 @@ Parameters
 
       Whether or not to verify the TLS certificates of the Foreman server.
 
-      If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_VALIDATE\_CERTS`\  will be used instead.
+      If the value is not specified in the task, the value of environment variable :literal:`SATELLITE\_VALIDATE\_CERTS` will be used instead.
 
 
       .. rst-class:: ansible-option-line
@@ -507,7 +506,6 @@ Examples
 
 .. code-block:: yaml+jinja
 
-
     - name: "Create an Architecture"
       redhat.satellite.architecture:
         name: "i386"
@@ -540,7 +538,6 @@ Examples
 
 
 
-
 .. Facts
 
 
@@ -600,7 +597,7 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
 
         </div>
 
-    
+
   * - .. raw:: html
 
         <div class="ansible-option-indent"></div><div class="ansible-option-cell">
@@ -648,7 +645,7 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
 
         </div>
 
-    
+
   * - .. raw:: html
 
         <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
@@ -827,4 +824,3 @@ Collection links
 
 
 .. Parsing errors
-