Topics
This changelog describes changes after version 0.8.1.
- templates_import - Support configuring HTTP Proxy behaviour for template import
- inventory - Drop fallback to Host API when Reports API fails, as this leads to possibly wrong data being used
- host, hostgroup, domain, operatingsystem, subnet, organization, location - support setting hidden parameters
- Drop support for Ansible 2.9.
- Drop support for Python 2.7 and 3.5.
- content_export_* - document that
chunk_size_gb
parameter is only applicable forimportable
exports (#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
- callback plugin - correctly catch facts with vault data and replace it with
ENCRYPTED_VAULT_VALUE_NOT_REPORTED
, preventingObject of type AnsibleVaultEncryptedUnicode is not JSON serializable
errors - redhat_manifest - do not send empty JSON bodies in GET requests which confuse the portal sometimes (#1768)
- redhat_manifest - report
changed
when manifest is regenerated and downloaded (#1473)
- theforeman.foreman.content_import_info - List content imports
- theforeman.foreman.content_import_library - Manage library content imports
- theforeman.foreman.content_import_repository - Manage repository content imports
- theforeman.foreman.content_import_version - Manage content view version content imports
- content_view_filter - stop managing rules from this module,
content_view_filter_rule
should be used for that - inventory plugin - do not default to
http://localhost:3000
as the Foreman URL, providing a URL is now mandatory
- compute_profile, host - refer to VMware storage pods by name, not id (#1247)
- theforeman.foreman.registration_command - Manage Registration Command
- theforeman.foreman.webhook - Manage Webhooks
- content_view_publish role - allow passing
async
andpoll
to the module (#1676) - convert2rhel role - install
convert2rhel
fromcdn-public.redhat.com
, dropping the requirement of a custom CA cert
- content_view_filter_rule - handle multiple rules for the same package but different architectures and versions correctly (https://bugzilla.redhat.com/show_bug.cgi?id=2189687)
- content_view_publish role - correctly pass
version
notdescription
to the module (https://bugzilla.redhat.com/show_bug.cgi?id=2234444)
- theforeman.foreman.smart_class_parameter_override_value - Manage Smart Class Parameter Override Values
- compute_resource - add support for OpenStack
- repositories role - allow disabling/removing of repositories by setting the
state
parameter
- repository - don't fail when removing a content credential from a repository (https://bugzilla.redhat.com/show_bug.cgi?id=2224122)
- smart_class_parameter - correctly allow setting
override
tofalse
(#1644)
- theforeman.foreman.wait_for_task - Wait for a task
- content_view_filter - add deb filter type
- content_view_filter_rule - add spec for deb filter rules
- locations role - New role to manage locations
- convert2rhel role - Sync repos before CV publish (https://bugzilla.redhat.com/show_bug.cgi?id=2216907)
- content_view_promote role - also accept all parameters of the content_view_version module (#1591)
- content_view_version - include information about the published version in the return value of the module
- job-invocation - add
recurrence purpose
anddescription_format
parameters - organizations role - accept
parameters
andignore_types
like the module does
- compute_profile, host - properly support nested VMware clusters (https://bugzilla.redhat.com/show_bug.cgi?id=2211394)
- content_credential - don't require
content_type
andcontent
parameters when removing credentials (#1588) - content_credentials role - don't require
content_type
andcontent
parameters when removing credentials - content_view_filter - don't fail when creating a modulemd filter (#1608, https://bugzilla.redhat.com/show_bug.cgi?id=2208557)
- repositories role - don't log repository information when creating products (https://bugzilla.redhat.com/show_bug.cgi?id=2183357)
- 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 (#1436) - setting - document how to obtain valid setting names (https://bugzilla.redhat.com/show_bug.cgi?id=2174367)
- auth_sources_ldap role - don't assume
account
andaccount_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)
- content_export_* - increase task timeout to 12h as export tasks can be time intensive (https://bugzilla.redhat.com/show_bug.cgi?id=2162678)
- theforeman.foreman.content_view_filter_info - Fetch information about a Content View Filter
- theforeman.foreman.content_view_filter_rule - Manage content view filter rules
- theforeman.foreman.content_view_filter_rule_info - Fetch information about a Content View Filter Rule
- theforeman.foreman.hostgroup_info - Get information about hostgroup(s)
- job_template - add
default
option to thetemplate_inputs
parameter - location, organization - add
ignore_types
parameter to adjust automatic association of resources - redhat_manifest - Search by UUID on the server side if UUID is known. This is faster and allows fetching of manifest in big accounts (>1000 allocations).
- redhat_manifest - return the UUID of the manifest so it can be reused later
- redhat_manifest - set default
quantity
to 1 (#1499)
- activation_key - properly fetch all repositories when managing content overrides (https://bugzilla.redhat.com/show_bug.cgi?id=2134605)
- redhat_manifest - properly report http errors (#1497)
- repository_sync - report an error instead of syncing the whole product when the repository could not be found
- theforeman.foreman.snapshot_info - Fetch information about Foreman Snapshots
- repository - add support for
include_tags
andexclude_tags
parameters for Katello 4.4+ - subscription_manifest - increase the import timeout to 10 minutes (#1474)
- sync_plans role - document the
enabled
parameter (#1477) - sync_plans role - expose the
state
parameter of the underlying module, thus allowing to delete plans (#1477)
- Properly use FQCN notation when redirecting the old
foreman_*
andkatello_*
module names. (#1484) - convert2rhel role - Content views for activation keys (https://bugzilla.redhat.com/2118790)
- theforeman.foreman.content_export_repository - Manage repository content exports
- theforeman.foreman.content_export_version - Manage content view version content exports
- add execution environment metadata
- installation_medium, operatingsystem, partition_table - add
Fcos
,Rhcos
,VRP
OS families - job_template - add
hidden_value
totemplate_inputs
parameters - job_template - allow
value_type
to beresource
- operatingsystems role - make
provisioning_template
parameter optional - repositories role - add
ansible_collection_requirements
- repositories role - add
arch
andos_versions
parameters - repositories role - support
mirroring_policy
- repository, smart_proxy - document deprecation/removal status of
download_policy=background
- setting - the
foreman_setting
return entry is deprecated and kept for backwards compatibility, please useentity
as with any other module - smart_proxy - add
inherit
to possible values ofdownload_policy
(#1438) - smart_proxy - add
streamed
download policy - snapshot - add include_ram option when creating VMWare snapshot
- theforeman.foreman.content_export_info - List pulp3 content exports
- theforeman.foreman.content_export_library - Manage content exports
- theforeman.foreman.discovery_rule - Manage Host Discovery Rules
- add support for module defaults groups for Ansible core 2.12 (#1015)
- all modules - report smaller diffs by dropping
null
values. This should result in not showing fields that were unset to begin with, and mark fields that were explicitly removed as "deleted" instead of "replaced bynull
" - compute_resource - update libvirt examples (https://bugzilla.redhat.com/show_bug.cgi?id=1990119)
- content_view - add support to set label during creation.
- repository - add
rhel-9
to os version filter choices - repository - add support for
mirroring_policy
for Katello 4.4+ (#1388)
- content_upload - properly detect SRPMs and ensure idempotency during uploads (#1274)
- inventory plugin - fix caching for Report API (#1246)
- operatingsystem - find operatingsystems by title or full (name,major,minor) tuple (#1401)
- os_default_template, provisioning_template - don't document invalid template kind
ptable
(https://bugzilla.redhat.com/show_bug.cgi?id=1970132)
- content_upload - add support for OSTree content uploads (#628, https://projects.theforeman.org/issues/33299)
- os_default_template, provisioning_template - add
host_init_config
to list of possible template types
- new
auth_sources_ldap
role to manage LDAP authentication sources
- content_upload - clarify that
src
refers to a remote file (https://bugzilla.redhat.com/show_bug.cgi?id=2055416)
- Warn if the user tries to use a plain HTTP server URL and fail if the URL is neither HTTPS nor HTTP.
- new
compute_profiles
role to manage compute profiles - new
compute_resources
role to manage compute resources - new
content_view_publish
role to publish a list of content views (#1209) - new
domains
role to manage domains - new
operatingsystems
role to manage operating systems - new
provisioning_templates
role to manage provisioning templates - new
settings
role to manage settings - new
subnets
role to manage subnets - repository - new
download_concurrency
parameter (#1273)
- callback plugin - include timezone information in the callback reported data (#1171)
- hostgroup, location - don't fail when trying to delete a Hostgroup or Location where the parent is already absent
- inventory plugin - fetch all facts, not only the first 250, when using the old Hosts API
- Add a role convert2rhel to perform setup for converting systems to RHEL
- inventory plugin - enable certificate validation by default
- repository - add
arch
parameter to limit architectures of the repository (#1265)
- Set use_reports_api default value to true for the inventory plugin
- Support for Ansible 2.8 is removed
- host, hostgroup - fix updating puppetclasses while also updating description (or other string-like attributes) (#1231)
- repository - add support for filtering repositories by OS version based on API feature apidoc/v2/repositories/create.html
- host, hostgroup - don't accidentally duplicate
kt_activation_keys
param (#1268)
- activation_key - submit organization_id when querying subs, required for Katello 4.1
- content_view_version_cleanup - sort content view versions before deleting (https://github.com/RedHatSatellite/satellite-ansible-collection/issues/30, https://bugzilla.redhat.com/show_bug.cgi?id=1980274)
- content_view_version_cleanup role - properly clean up when users set keep=0 (https://bugzilla.redhat.com/show_bug.cgi?id=1974314)
- host, compute_profile - when resolving cluster and other values in vm_attrs, compare them as strings (#1245)
- subscription_info - mark
organization
parameter as required, to match Katello
- external_usergroup - always lookup the ID of the usergroup, instead of passing the name to the API (https://bugzilla.redhat.com/show_bug.cgi?id=1967649)
- host, hostgroup - don't override already set parameters when passing an activation key only (and vice versa) (https://bugzilla.redhat.com/show_bug.cgi?id=1967904)
- Add a domain_info module
- Add a hostgroups role (#1116)
- Add a role content_rhel to perform basic setup for registering and syncing RHEL content hosts
- Add content credentials role
- callback plugin - collect facts during the run, merge them correctly and upload them once at the end
- compute_resource - add
cloud
param for the AzureRm provider, to select which Azure cloud to use - compute_resource - add
sub_id
parameter for handling the Azure Subscription ID instead of theuser
parameter - host - Add
Redfish
to list of possible BMC providers of an interface - host, compute_profile - look up the correct id for storage pods and domains given as part of
volumes_attributes
(https://bugzilla.redhat.com/show_bug.cgi?id=1885234) - hostgroup - add a
ansible_roles
parameter (#1123) - new
content_views
role to manage content views (#1111) - new
organizations
role to manage organizations (#1109) - subnet - add
bmc_proxy
parameter to configure BMC proxies for subnets
- host - pass the right image id to the compute resource when creating a host (#1160, https://bugzilla.redhat.com/show_bug.cgi?id=1911670)
- theforeman.foreman.content_view_info - Fetch information about Content Views
- theforeman.foreman.content_view_version_info - Fetch information about Content Views
- theforeman.foreman.domain_info - Fetch information about Domains
- theforeman.foreman.host_errata_info - Fetch information about Host Errata
- theforeman.foreman.repository_set_info - Fetch information about Red Hat Repositories
- theforeman.foreman.setting_info - Fetch information about Settings
- theforeman.foreman.subnet_info - Fetch information about Subnets
- theforeman.foreman.subscription_info - Fetch information about Subscriptions
- host - don't filter
false
values forinterfaces_attributes
(#1148) - host_info, repository_info - correctly fetch all entities when neither
name
norsearch
is set - host_info, repository_info - enforce mutual exclusivity of
name
andsearch
- Add a role activation_keys to manage activation keys
- Add a role lifecycle_environments to manage lifecycle environments
- Add a role repositories to manage products, repositories, and repository_sets
- Add a role sync_plans to manage sync plans
- activation_key - add support for selecting subscriptions by
upstream_pool_id
- compute_resource - add
set_console_password
,keyboard_layout
andpublic_key
parameters (#1052) - host - clarify that
owner
refers to a users login, not their full name (#1045) - host - look up the correct network id for a network given as part of
interfaces_attributes
(#1104) - host, hostgroup - add
activation_keys
parameter to ease configuring activation keys for deploments
- All role variables are now prefixed with
foreman_
to avoid clashes with similarly named variables from roles outside this collection.
- content_view_version - make the
version
parameter not fail when the version was entered without a minor part (#1087) - host - allow moving hosts between Organizations and Locations (https://bugzilla.redhat.com/show_bug.cgi?id=1901716)
- host - fix subnet/domain assignment when multiple interfaces are defined (#1095)
- host, hostgroup - select kickstart_repository based on lifecycle_environment and content_view if those are set (#1090, https://bugzilla.redhat.com/1915872)
- resource_info - correctly show the exact resource when passing
id
inparams
- theforeman.foreman.host_info - Fetch information about Hosts
- theforeman.foreman.puppetclasses_import - Import Puppet Classes from a Proxy
- theforeman.foreman.repository_info - Fetch information about Repositories
- content_upload - use
to_native
to decode RPM headers if needed (RPM 4.15+ returns strings) - content_view_version - provide examples how to obtain detailed information about content view versions (https://bugzilla.redhat.com/show_bug.cgi?id=1868145)
- content_view_version_cleanup - new role for cleaning up unused content view versions (#497)
- host - allow management of interfaces (#757)
- inventory plugin - add support for the Report API present in Foreman 1.24 and later
- inventory plugin - allow to compose the
inventory_hostname
(#1070) - manifest - new role for easier handling of subscription manifest workflows
- subnet - add new
externalipam_group
parameter - update vendored
apypie
to 0.3.2
- content_upload - Fix upload of files bigger than 2MB in Pulp3-based setups (#1043)
- job_invocation - properly submit
ssh
,recurrence
,scheduling
andconcurrency_control
to the server - repository - don't emit a false warning about
organization_id
not being supported by the server (#1055) - repository_set, repository - clarify documentation which module should be used for Red Hat Repositories (#1059)
- global_parameter - allow to set hidden flag (#1024)
- job_template - stricter validation of
template_inputs
sub-options - redhat_manifest - allow configuring content access mode (#820)
- subnet - verify the server has the
remote_execution
plugin when specifyingremote_execution_proxies
- the
apypie
library is vendored inside the collection, so users only have to installrequests
manually now.
- Don't try to update an entity, if only parameters that aren't supported by the server are detected as changed. (#975)
- allow to pass an empty string when refering to entities, thus unsetting the value (#969)
- compute_profile - don't fail when trying to update compute attributes of a profile (#997)
- host, hostgroup - support
None
as thepxe_loader
(#971) - job_template - don't fail when trying to update template_inputs
- os_default_template - document possible template kind choices (https://bugzilla.redhat.com/show_bug.cgi?id=1889952)
- smart_class_parameters - don't fail when trying to update override_values
- theforeman.foreman.job_invocation - Invoke Remote Execution Jobs
- theforeman.foreman.smart_proxy - Manage Smart Proxies
- external_usergroup - rename the
auth_source_ldap
parameter toauth_source
(auth_source_ldap
is still supported via an alias) - server URL and credentials can now also be specified using environment variables (#837)
- subnet - add support for external IPAM (#966)
- content_view - remove CVs from lifecycle environments before deleting them (https://bugzilla.redhat.com/show_bug.cgi?id=1875314)
- external_usergroup - support non-LDAP external groups (#956)
- host - properly scope image lookups by the compute resource (https://bugzilla.redhat.com/show_bug.cgi?id=1878693)
- inventory plugin - include empty parent groups in the inventory (#919)
- theforeman.foreman.status_info - Get status info
- compute_resource - added
caching_enabled
option for VMware compute resources - domain, host, hostgroup, operatingsystem, subnet - manage parameters in a single API call (https://bugzilla.redhat.com/show_bug.cgi?id=1855008)
- host - add
compute_attributes
parameter to module (https://bugzilla.redhat.com/show_bug.cgi?id=1871815) - provisioning_template - update list of possible template kinds (https://bugzilla.redhat.com/show_bug.cgi?id=1871978)
- repository - update supported parameters (#935)
- image - fix quoting of search values (#927)
- activation_key - add
description
parameter (#915) - callback plugin - add reporter to report logs sent to Foreman (#836)
- document return values of modules (#901)
- inventory plugin - allow to control batch size when pulling hosts from Foreman (#865)
- subnet - Require mask/cidr only on ipv4 (#878)
- inventory plugin - fix want_params handling (#847)
- theforeman.foreman.http_proxy - Manage HTTP Proxies
Documentation fixes to reflect the correct module names.
This is the first stable release of the theforeman.foreman
collection.
- All modules were renamed to drop the
foreman_
andkatello_
prefixes. Additionally to the prefix removal, the following modules were further ranamed:- katello_upload to content_upload
- katello_sync to repository_sync
- katello_manifest to subscription_manifest
- foreman_search_facts to resource_info
- foreman_ptable to partition_table
- foreman_model to hardware_model
- foreman_environment to puppet_environment
- theforeman.foreman.activation_key - Manage Activation Keys
- theforeman.foreman.architecture - Manage Architectures
- theforeman.foreman.auth_source_ldap - Manage LDAP Authentication Sources
- theforeman.foreman.bookmark - Manage Bookmarks
- theforeman.foreman.compute_attribute - Manage Compute Attributes
- theforeman.foreman.compute_profile - Manage Compute Profiles
- theforeman.foreman.compute_resource - Manage Compute Resources
- theforeman.foreman.config_group - Manage (Puppet) Config Groups
- theforeman.foreman.content_credential - Manage Content Credentials
- theforeman.foreman.content_upload - Upload content to a repository
- theforeman.foreman.content_view - Manage Content Views
- theforeman.foreman.content_view_filter - Manage Content View Filters
- theforeman.foreman.content_view_version - Manage Content View Versions
- theforeman.foreman.domain - Manage Domains
- theforeman.foreman.external_usergroup - Manage External User Groups
- theforeman.foreman.global_parameter - Manage Global Parameters
- theforeman.foreman.hardware_model - Manage Hardware Models
- theforeman.foreman.host - Manage Hosts
- theforeman.foreman.host_collection - Manage Host Collections
- theforeman.foreman.host_power - Manage Power State of Hosts
- theforeman.foreman.hostgroup - Manage Hostgroups
- theforeman.foreman.image - Manage Images
- theforeman.foreman.installation_medium - Manage Installation Media
- theforeman.foreman.job_template - Manage Job Templates
- theforeman.foreman.lifecycle_environment - Manage Lifecycle Environments
- theforeman.foreman.location - Manage Locations
- theforeman.foreman.operatingsystem - Manage Operating Systems
- theforeman.foreman.organization - Manage Organizations
- theforeman.foreman.os_default_template - Manage Default Template Associations To Operating Systems
- theforeman.foreman.partition_table - Manage Partition Table Templates
- theforeman.foreman.product - Manage Products
- theforeman.foreman.provisioning_template - Manage Provisioning Templates
- theforeman.foreman.puppet_environment - Manage Puppet Environments
- theforeman.foreman.realm - Manage Realms
- theforeman.foreman.redhat_manifest - Interact with a Red Hat Satellite Subscription Manifest
- theforeman.foreman.repository - Manage Repositories
- theforeman.foreman.repository_set - Enable/disable Repositories in Repository Sets
- theforeman.foreman.repository_sync - Sync a Repository or Product
- theforeman.foreman.resource_info - Gather information about resources
- theforeman.foreman.role - Manage Roles
- theforeman.foreman.scap_content - Manage SCAP content
- theforeman.foreman.scap_tailoring_file - Manage SCAP Tailoring Files
- theforeman.foreman.scc_account - Manage SUSE Customer Center Accounts
- theforeman.foreman.scc_product - Subscribe SUSE Customer Center Account Products
- theforeman.foreman.setting - Manage Settings
- theforeman.foreman.smart_class_parameter - Manage Smart Class Parameters
- theforeman.foreman.snapshot - Manage Snapshots
- theforeman.foreman.subnet - Manage Subnets
- theforeman.foreman.subscription_manifest - Manage Subscription Manifests
- theforeman.foreman.sync_plan - Manage Sync Plans
- theforeman.foreman.templates_import - Sync Templates from a repository
- theforeman.foreman.user - Manage Users
- theforeman.foreman.usergroup - Manage User Groups