Merge pull request #61 from RedHatSatellite/rel3100

Release 3.10.0

CHANGELOG.rst

@@ -6,6 +6,23 @@ redhat.satellite Release Notes
 
 This changelog describes changes after version 0.8.1.
 
+v3.10.0
+=======
+
+Minor Changes
+-------------
+
+- content_export_library, content_export_repository, content_export_version - add ``format`` option to control the export format
+- content_view_filter - add support for creating modulemd filters
+- content_view_publish role - also accept a list of dicts as the ``content_views`` role for publishing (https://github.com/theforeman/foreman-ansible-modules/issues/1436)
+- setting - document how to obtain valid setting names (https://bugzilla.redhat.com/show_bug.cgi?id=2174367)
+
+Bugfixes
+--------
+
+- auth_sources_ldap role - don't assume ``account`` and ``account_password`` are set, they are documented as optional
+- auth_sources_ldap role, compute_resources role, repositories role - do not log loop data when it contains sensitive data (https://bugzilla.redhat.com/show_bug.cgi?id=2183357)
+
 v3.9.0
 ======
 

LICENSE

@@ -617,58 +617,3 @@ reviewing courts shall apply local law that most closely approximates
 an absolute waiver of all civil liability in connection with the
 Program, unless a warranty or assumption of liability accompanies a
 copy of the Program in return for a fee.
-
-                     END OF TERMS AND CONDITIONS
-
-            How to Apply These Terms to Your New Programs
-
-  If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
-  To do so, attach the following notices to the program.  It is safest
-to attach them to the start of each source file to most effectively
-state the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
-
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-Also add information on how to contact you by electronic and paper mail.
-
-  If the program does terminal interaction, make it output a short
-notice like this when it starts in an interactive mode:
-
-    <program>  Copyright (C) <year>  <name of author>
-    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
-    This is free software, and you are welcome to redistribute it
-    under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License.  Of course, your program's commands
-might be different; for a GUI interface, you would use an "about box".
-
-  You should also get your employer (if you work as a programmer) or school,
-if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU GPL, see
-<http://www.gnu.org/licenses/>.
-
-  The GNU General Public License does not permit incorporating your program
-into proprietary programs.  If your program is a subroutine library, you
-may consider it more useful to permit linking proprietary applications with
-the library.  If this is what you want to do, use the GNU Lesser General
-Public License instead of this License.  But first, please read
-<http://www.gnu.org/philosophy/why-not-lgpl.html>.

changelogs/changelog.yaml

@@ -550,6 +550,28 @@ releases:
     - explicit-http-warning.yml
     - inventory-facts-batch-size.yml
     release_date: '2022-01-14'
+  3.10.0:
+    changes:
+      bugfixes:
+      - auth_sources_ldap role - don't assume ``account`` and ``account_password``
+        are set, they are documented as optional
+      - auth_sources_ldap role, compute_resources role, repositories role - do not
+        log loop data when it contains sensitive data (https://bugzilla.redhat.com/show_bug.cgi?id=2183357)
+      minor_changes:
+      - content_export_library, content_export_repository, content_export_version
+        - add ``format`` option to control the export format
+      - content_view_filter - add support for creating modulemd filters
+      - content_view_publish role - also accept a list of dicts as the ``content_views``
+        role for publishing (https://github.com/theforeman/foreman-ansible-modules/issues/1436)
+      - setting - document how to obtain valid setting names (https://bugzilla.redhat.com/show_bug.cgi?id=2174367)
+    fragments:
+    - 1436-cv-publish-vars.yml
+    - 1573-cv-filter-modulemd.yml
+    - auth_sources_ldap_role-dont_force_account.yml
+    - bz2174367.yml
+    - bz2183357-role-log.yml
+    - content-export-format.yml
+    release_date: '2023-04-04'
   3.2.0:
     changes:
       bugfixes:

galaxy.yml

@@ -41,6 +41,7 @@ authors:
   - "Kenny Tordeurs <[email protected]>"
   - "Kirill Shirinkin <[email protected]>"
   - "Leos Stejskal <[email protected]>"
+  - "Lester Cheung <[email protected]>"
   - "Lester Claudio <[email protected]>"
   - "Lucas Bickel <[email protected]>"
   - "Lukáš Zapletal <[email protected]>"
@@ -71,6 +72,7 @@ authors:
   - "Samir Jha <[email protected]>"
   - "Sean O'Keeffe <[email protected]>"
   - "Sorin Sbarnea <[email protected]>"
+  - "Steffen Frömer <[email protected]>"
   - "Stoned Elipot <[email protected]>"
   - "TTherouanne <[email protected]>"
   - "Thomas Mueller <[email protected]>"
@@ -88,7 +90,7 @@ authors:
   - "metalcated <[email protected]>"
   - "russianguppie <[email protected]>"
   - "willtome <[email protected]>"
-version: "3.9.0"
+version: "3.10.0"
 license:
   - "GPL-3.0-or-later"
 tags:

plugins/callback/foreman.py

@@ -35,7 +35,7 @@
           - name: FOREMAN_URL
           - name: FOREMAN_SERVER_URL
           - name: FOREMAN_SERVER
-        required: True
+        required: true
         ini:
           - section: callback_foreman
             key: url

plugins/doc_fragments/foreman.py

@@ -49,6 +49,13 @@ class ModuleDocFragment(object):
       - If the value is not specified in the task, the value of environment variable C(SATELLITE_VALIDATE_CERTS) will be used instead.
     default: true
     type: bool
+attributes:
+  check_mode:
+    description: Can run in check_mode and return changed status prediction without modifying the entity
+    support: full
+  diff_mode:
+    description: Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode
+    support: full
 '''
 
     NESTED_PARAMETERS = '''
@@ -186,14 +193,14 @@ class ModuleDocFragment(object):
     type: str
   architecture:
     description: Architecture name
-    required: False
+    required: false
     type: str
   medium:
     aliases: [ media ]
     description:
       - Medium name
       - Mutually exclusive with I(kickstart_repository).
-    required: False
+    required: false
     type: str
   pxe_loader:
     description: PXE Bootloader
@@ -217,7 +224,7 @@ class ModuleDocFragment(object):
     type: str
   ptable:
     description: Partition table name
-    required: False
+    required: false
     type: str
   environment:
     description: Puppet environment name
@@ -326,7 +333,7 @@ class ModuleDocFragment(object):
       - Operating systems are looked up by their title which is composed as "<name> <major>.<minor>".
       - You can omit the version part as long as you only have one operating system by that name.
     type: str
-    required: False
+    required: false
 '''
 
     INFOMODULE = '''

plugins/inventory/foreman.py

@@ -23,7 +23,7 @@
     options:
       plugin:
         description: token that ensures this is a source file for the C(foreman) plugin.
-        required: True
+        required: true
         choices: ['redhat.satellite.foreman']
       url:
         description:
@@ -36,21 +36,21 @@
       user:
         description:
           - Username accessing the Foreman server.
-        required: True
+        required: true
         env:
             - name: FOREMAN_USER
             - name: FOREMAN_USERNAME
       password:
         description:
           - Password of the user accessing the Foreman server.
-        required: True
+        required: true
         env:
             - name: FOREMAN_PASSWORD
       validate_certs:
         description:
           - Whether or not to verify the TLS certificates of the Foreman server.
         type: boolean
-        default: True
+        default: true
         env:
             - name: FOREMAN_VALIDATE_CERTS
       group_prefix:
@@ -62,21 +62,21 @@
       want_facts:
         description: Toggle, if True the plugin will retrieve host facts from the server
         type: boolean
-        default: False
+        default: false
       want_params:
         description: Toggle, if true the inventory will retrieve 'all_parameters' information as host vars
         type: boolean
-        default: False
+        default: false
       want_hostcollections:
         description: Toggle, if true the plugin will create Ansible groups for host collections
         type: boolean
-        default: False
+        default: false
       legacy_hostvars:
         description:
             - Toggle, if true the plugin will build legacy hostvars present in the foreman script
             - Places hostvars in a dictionary with keys `foreman`, `foreman_facts`, and `foreman_params`
         type: boolean
-        default: False
+        default: false
       host_filters:
         description: This can be used to restrict the list of returned host
         type: string
@@ -87,7 +87,7 @@
       use_reports_api:
         description: Use Reporting API.
         type: boolean
-        default: True
+        default: true
       foreman:
         description:
           - Foreman server related configuration, deprecated.
@@ -110,39 +110,39 @@
       want_organization:
         description: Toggle, if true the inventory will fetch organization the host belongs to and create groupings for the same.
         type: boolean
-        default: True
+        default: true
       want_location:
         description: Toggle, if true the inventory will fetch location the host belongs to and create groupings for the same.
         type: boolean
-        default: True
+        default: true
       want_ipv4:
         description: Toggle, if true the inventory will fetch ipv4 address of the host.
         type: boolean
-        default: True
+        default: true
       want_ipv6:
         description: Toggle, if true the inventory will fetch ipv6 address of the host.
         type: boolean
-        default: True
+        default: true
       want_host_group:
         description: Toggle, if true the inventory will fetch host_groups and create groupings for the same.
         type: boolean
-        default: True
+        default: true
       want_subnet:
         description: Toggle, if true the inventory will fetch subnet.
         type: boolean
-        default: True
+        default: true
       want_subnet_v6:
         description:  Toggle, if true the inventory will fetch ipv6 subnet.
         type: boolean
-        default: True
+        default: true
       want_smart_proxies:
         description: Toggle, if true the inventory will fetch smart proxy that the host is registered to.
         type: boolean
-        default: True
+        default: true
       want_content_facet_attributes:
         description: Toggle, if true the inventory will fetch content view details that the host is tied to.
         type: boolean
-        default: True
+        default: true
       hostnames:
         description:
           - A list of templates in order of precedence to compose inventory_hostname.

plugins/module_utils/foreman_helper.py

@@ -423,8 +423,9 @@ def _patch_host_update(self):
 
         _host_update = next(x for x in _host_methods if x['name'] == 'update')
         for param in ['location_id', 'organization_id']:
-            _host_update_taxonomy_param = next(x for x in _host_update['params'] if x['name'] == param)
-            _host_update['params'].remove(_host_update_taxonomy_param)
+            _host_update_taxonomy_param = next((x for x in _host_update['params'] if x['name'] == param), None)
+            if _host_update_taxonomy_param is not None:
+                _host_update['params'].remove(_host_update_taxonomy_param)
 
     @_check_patch_needed(fixed_version='2.2.0', plugins=['remote_execution'])
     def _patch_subnet_rex_api(self):

plugins/modules/activation_key.py

@@ -179,7 +179,7 @@
     content_overrides:
         - label: rhel-7-server-optional-rpms
           override: enabled
-    auto_attach: False
+    auto_attach: false
     release_version: 7Server
     service_level: Standard
 '''

plugins/modules/auth_source_ldap.py

@@ -138,7 +138,7 @@
   redhat.satellite.auth_source_ldap:
     name: "Example LDAP"
     host: "ldap.example.org"
-    onthefly_register: True
+    onthefly_register: true
     account: uid=ansible,cn=sysaccounts,cn=etc,dc=example,dc=com
     account_password: secret
     base_dn: dc=example,dc=com
@@ -158,7 +158,7 @@
   redhat.satellite.auth_source_ldap:
     name: "Example AD"
     host: "ad.example.org"
-    onthefly_register: True
+    onthefly_register: true
     account: EXAMPLE\\ansible
     account_password: secret
     base_dn: cn=Users,dc=example,dc=com

plugins/modules/content_export_library.py

@@ -39,6 +39,16 @@
       - Split the exported content into archives no greater than the specified size in gigabytes.
     required: false
     type: int
+  format:
+    description:
+      - Export format.
+      - Choose C(syncable) if the exported content needs to be in a yum format.
+    required: false
+    type: str
+    choices:
+      - syncable
+      - importable
+    version_added: 3.10.0
   fail_on_missing_content:
     description:
       - Fails if any of the repositories belonging to this organization are unexportable.
@@ -118,6 +128,7 @@ def main():
         foreman_spec=dict(
             destination_server=dict(required=False, type='str'),
             chunk_size_gb=dict(required=False, type='int'),
+            format=dict(required=False, type='str', choices=['syncable', 'importable']),
             fail_on_missing_content=dict(required=False, type='bool'),
             from_history_id=dict(required=False, type='int'),
         ),