changelog.yaml

ancestor: null
releases:
  0.1.0:
    changes:
      bugfixes:
      - Fixed an issue where tower_validate_certs and validate_certs were both used
        as vars. Now changed to tower_validate_certs
      major_changes:
      - Groups role - Added groups role to the collection
      - Labels role - Added labels role to the collection
      - Notifications role - Added many options to notifications role
      - Workflow Job Templates role - Added many options to WJT role
      minor_changes:
      - GitHub Workflows - Added workflows to run automated linting and integration
        tests against the codebase
      - Hosts role - Added new_name and enabled options to hosts role
      - Housekeeping - Added CONTRIBUTING guide and pull request template
      - Inventory Sources role - Added notification_templates_started, success, and
        error options. Also added verbosity and source_regions options.
      - Teams role - Added new_name option to teams role
      - Test Configs - Added full range of test objects for integration testing
    fragments:
    - housekeeping.yaml
    - new_roles.yaml
    - workflows.yaml
    release_date: '2020-08-04'
  0.2.0:
    changes:
      bugfixes:
      - Removed defaulted objects for all roles so that they were not always run if
        using a conditional against the variable. (see https://github.com/redhat-cop/tower_configuration/issues/68)
      minor_changes:
      - Added pre-commit hook for local development and automated testing purposes
      - Standardised and corrected all READMEs
    fragments:
    - 72-defaults.yaml
    - 73-readmes.yaml
    - 77-pre-commit.yaml
    release_date: '2020-09-09'
  0.2.1:
    changes:
      minor_changes:
      - Changelog release cycle
    fragments:
    - changelogs.yml
    release_date: '2020-09-22'
  1.0.0:
    changes:
      breaking_changes:
      - Removed depreciated options in inventory sources role (source_regions, instance_filters,
        group_by)
      - Renamed notifications role to notification_templates role as in awx.awx:15.0.
        The variable is not tower_notification_templates.
      major_changes:
      - Updated Roles to use the tower_export model from the awx command line.
      - credential_types Updated to use the tower_export model from the awx command
        line.
      - credentials Updated to use the tower_export model from the awx command line.
      - inventory Updated to use the tower_export model from the awx command line.
      - inventory_sources Updated to use the tower_export model from the awx command
        line.
      - job_templates Updated to use the tower_export model from the awx command line.
      - projects Updated to use the tower_export model from the awx command line.
      - teams Updated to use the tower_export model from the awx command line.
      - users Updated to use the tower_export model from the awx command line.
      minor_changes:
      - updated to allow vars in messages for notifications.
      - updated tower workflows related role `workflow_job_templates` to include `survey_enabled`
        defaulting to `false` which is a module default and `omit` the `survey_spec`
        if not passed.
      - updated various roles to include oauth token and tower config file.
    fragments:
    - 95-notification_templates.yml
    - auth_update.yml
    - fix_workflow_survey_defaults.yml
    - notif_update.yml
    - tower_export_update.yml
    release_date: '2020-10-22'
  1.0.2:
    changes:
      minor_changes:
      - added alias option for survey to survey_spec in workflows.
      - updated documentation on surveys for workflows and job templates
    fragments:
    - survey_spec.yml
    release_date: '2021-01-26'
  1.1.0:
    changes:
      breaking_changes:
      - Removed kind from to credentials role. This will be depreciated in a few months.
        Kind arguments are replaced by the credential_type and inputs fields.
      - Updated to allow use of either awx.awx or ansible.tower
      bugfixes:
      - Corrected README for tower_validate_certs variable defaults on all roles
      major_changes:
      - Added the following roles - ad_hoc_command, ad_hoc_command_cancel, inventory_source_update,
        job_launch, job_cancel, project_update, workflow_launch
      - Updated collection to use and comply with ansible-lint v5
      minor_changes:
      - Fixed default filters to use true when neccessary and changed a few defaults
        to omit rather then a value or empty string.
      - updated various Readmes to fix typos and missing information.
    fragments:
    - ansible_lint.yml
    - credential_kind_deprecated.yml
    - omit_changes.yml
    - update_roles.yml
    - validate_certs_readme_fix.yml
    release_date: '2021-02-18'
  1.2.0:
    changes:
      breaking_changes:
      - removed awx.awx implicit dependency, it will now be required to manually install
        awx.awx or ansible.tower collection
    fragments:
    - remove_dependency.yml
    release_date: '2021-03-09'
  1.3.0:
    changes:
      bugfixes:
      - Fixed an issue where certain roles were not taking in tower_validate_certs
    fragments:
    - validate-certs.yml
    release_date: '2021-03-15'
  1.4.1:
    changes:
      bugfixes:
      - Fix tower_templates default
      major_changes:
      - Added execution environments option for multiple roles.
      - Added execution environments role.
    fragments:
    - exec_env.yml
    - jt_bug_fix.yml
    release_date: '2021-04-21'
  1.5.0:
    changes:
      breaking_changes:
      - Examples can also be found in the playbooks/tower_configs_export_model/tower_workflows.yml
      - If you do not change the data model, change the variable 'workflow_nodes'
        to 'simplified_workflow_nodes'.
      - More information can be found either in the Workflow Job Template Readme or
        on the awx.awx.tower_workflow_job_template Documentation.
      - The Tower export model is now the default to use under workflow nodes. This
        is documented in the workflow job templates Readme.
      - Users using the tower export model previously, do not need to make any changes.
      - Workflow Schemas to describe Workflow nodes have changed.
      bugfixes:
      - Allow tower_hostname and tower_validate_certs to not be set in favour of environment
        variables being set as per module defaults.
      - Changes all boolean variables to have their default values omitted rather
        than using the value 'default(omit, true)' which prevents a falsy value being
        supplied.
      major_changes:
      - Removed testing via playbook install that was removed in awx 18.0.0.
      - Updated testing via playbook to use minikube + operator install.
    fragments:
    - add_workflow_schema.yml
    - bool_omit.yml
    - env_var.yml
    - update_testing.yml
    release_date: '2021-06-21'
  2.0.0:
    changes:
      breaking_changes:
      - All references to tower have been changed to Controller.
      - Changed all module names to be in line with changes to awx.awx as of 19.2.1.
      - Changed variable names for all objects from tower_* to controller_*.
      - Removed depreciated module options for notification Templates.
      minor_changes:
      - Additional module options have been added such as instance_groups and copy_from
        where applicable.
      - All role tests have been converted to use one format.
    fragments:
    - controller.yml
    release_date: '2021-07-15'
  2.0.0-1:
    changes:
      bugfixes:
      - Changed all references for ansible.tower to ansible.controller
      - Fixed issue where `credential` was not working for project and instead the
        old `scm_credential` option remained.
      major_changes:
      - Created awx and controller playbook that users can invoke for using the collection
      minor_changes:
      - Created Readme for playbook in the playbooks directory
      - Removed the playbook configs folder, it was previously moved to the .github/playbooks
        directory
    fragments:
    - bug-224.yml
    - playbook.yml
    release_date: '2021-09-01'
  2.1.0:
    changes:
      bugfixes:
      - Fixed readme's to point in right direction for workflows and the export model
        in examples
      - Moved Example playbooks to the example directory
      - Removes json_query which is not in a RH Certified collection so does not receive
        support and replaced with native ansible filters
      - Updated workflow inventory option to be able to use workflows from the export
        model.
      - added default to organization as null on project as it is not required for
        the module, but it is highly recommended.
      - added when to skip inventory source update when item is absent
      - added when to skip project update when item is absent
      major_changes:
      - added diff plugin and tests for diff plugin to aid in removal tasks
      minor_changes:
      - Added new options for adding manifest to Ansible Controller inc. from a URL
        and from b64 encoded content
      - added tests for the project and inventory source skips
    fragments:
    - doc_fix.yml
    - license.yml
    - removal_tasks.yml
    - remove_json_query.yml
    - update_fix.yml
    release_date: '2021-12-17'
  2.1.1:
    changes:
      bugfixes:
      - warn on default if the api list fed to controller_object_diff lookup is empty
      minor_changes:
      - Allows for using the roles for deletion to only use required fields.
      - Changed default to omit for several fields for notification templates and
        inventor sources.
      - These changes are in line with the modules required fields.
    fragments:
    - diff_empty_fix.yml
    - removal_fix.yml
    release_date: '2022-01-18'
  2.1.3:
    changes:
      breaking_changes:
      - galaxy credentials in the organization role now require assign_galaxy_organizations_to_org
        to be true.
      bugfixes:
      - Fixes option of `survey_spec` on job_templates role.
      minor_changes:
      - Added asynchronous to {organizations,credentials,credential_types,inventories,job_templates}
        task to speed up creation.
      - Allow setting the organization when creating users.
      - Update to controller_object_diff lookup plugin to better handle group, host,
        inventory, credential, workflow_job_template_node and user objects.
      - Update to controller_object_diff lookup plugin to better handle organizations.
    fragments:
    - playbook.yml
    - survey.yml
    - users.yml
    release_date: '2022-03-23'
  2.1.4:
    changes:
      bugfixes:
      - Fixes async to work on default execution enviroments.
      - Fixes inventories hardcoded 'no_log' true on the async job check task.
    fragments:
    - async.yml
    - inventories.yml
    release_date: '2022-03-31'
  2.1.5:
    changes:
      bugfixes:
      - Changed default interval for inventory_source_update, project_update and project
        to be the value of the role's async delay value. This still defaults to 1
        if the delay value is not set as previously.
      major_changes:
      - Adds dispatch role - A role to run all other roles.
    fragments:
    - dispatch.yml
    - interval_delay.yaml
    release_date: '2022-05-04'
  2.1.6:
    changes:
      bugfixes:
      - Fixed broken documentation for controller_object_diff plugin
    fragments:
    - object_diff_docs.yml
    release_date: '2022-06-06'
  2.1.7:
    changes:
      major_changes:
      - Adds Configuration as Code filetree_create - A role to export and convert
        all  Controller's objects configuration in yaml files to be consumed with
        previous roles.
      - Adds Configuration as Code filetree_read role - A role to load controller
        variables (objects) from a hierarchical and scalable directory structure.
      - Adds Configuration as Code object_diff role - A role to get differences between
        code and controller. It will give us the lists to remove absent objects in
        the controller which they are not in code.
      minor_changes:
      - Adds credential and organization options for schedule role.
      - inventory_sources - update ``source_vars`` to parse Jinja variables using
        the same workaround as inventories role.
    fragments:
    - casc_roles.yml
    - inventory_sources.yml
    - schedule_role.yml
    release_date: '2022-08-30'
  2.1.8:
    changes:
      bugfixes:
      - Fixed optional lists to default to omit if the list is empty.
      - Reduce the memory usage on the filetree_create role.
      minor_changes:
      - Add a way to detect which of `awx.awx` or `ansible.controller` collection
        is installed. Added to the playbooks and examples.
      - Add markdown linter
      - Add the current object ID to the corresponding output yaml filename.
      - Fix all linter reported errors
      - Move linter configurations to root directory
      - Organize the output in directories (one per each object type).
      - Remove json_query and jmespath dependency from filetree_create role.
      - Update linter versions
    fragments:
    - awx_awx-ansible_controller-independence.yml
    - default_list_changes.yml
    - reduce_memory_usage.yml
    - remove_json_query_dependency.yml
    - update_linting.yml
    release_date: '2022-11-02'
  2.1.9:
    changes:
      major_changes:
      - Added instance role to add instances using the new awx.awx.instance module.
      minor_changes:
      - Update options on inventories, job templates, liscence, projects, schedules,
        and workflow_job_templates roles to match latest awx.awx release
    fragments:
    - update_options.yml
    release_date: '2022-11-11'
  2.2.4:
    changes:
      breaking_changes:
      - infra.controller_configuration 2.2.3 is broken, it is aap_utilities release.
        We are bumping the version to minimize the issues.
      - rewrote playbooks/controller_configure.yml and removed all other playbooks
      minor_changes:
      - Update release process to avoid problems that have happened and automate it.
      - removed all examples from repo outside of readmes
      removed_features:
      - update_on_project_update in inventory_source as an option due to the awx module
        no longer supports this option.
    fragments:
    - release_fix.yml
    - remove_examples.yml
    - removed_ update_on_project_update.yml
    release_date: '2022-11-30'
  2.2.5:
    changes:
      bugfixes:
      - Enable the ability to define simple_workflow_nodes on workflow_job_templates
        without the need to set the `state` on a workflow_job_template (https://github.com/redhat-cop/controller_configuration/issues/297).
      minor_changes:
      - Add max_forks, max_concurrent_jobs as options to instance_groups role
      - Add no_log everywhere controller_api_plugin is used to avoid to expose sensitive
        information in case of crashes.
      - Add no_log everywhere controller_api_plugin is used to avoid to expose sensitive
        information in case of crashes.
      - Add or fix some variables or extra_vars exported from objects like notifications,
        inventory, inventory_source, hosts, groups, jt or wjt.
      - Add roles object to object_diff role and controller_object_diff lookup plugin.
      - Fix one query with controller_password to change it and set oauth_token=controller_oauthtoken.
      - Fixed typos in README.md.
      - Improve template to export settings with filetree_create role. Settings will
        be in yaml format.
      - Renamed the field `update` to `update_project` to avoid colliding with the
        Python dict update method
      - Renamed variable controller_workflow_job_templates to controller_workflows
        (the previos one was not used at all).
      - Renamed variable controller_workflow_job_templates to controller_workflows
        (the previos one was not used at all).
      - 'return_all: true has been added to return the maximum of max_objects=query_controller_api_max_objects
        objects.'
    fragments:
    - filetree_create.yml
    - instance_group.yml
    - object_diff.yml
    - object_diff_role_and_plugin.yml
    - project_updates.yml
    - typos.yml
    - workflow_job_template_state_and_nodes.yml
    release_date: '2023-01-26'
  2.3.0:
    changes:
      breaking_changes:
      - updated object_diff role to use the infra namespace, that means to use the
        role it requires the infra version of the collection. Previous version required
        the redhat_cop
      bugfixes:
      - Fixed name of task for inventory source update
      - Fixed variable definitions in readmes
      - Removed master_role_example as no longer required (this wasn't a functional
        role)
      minor_changes:
      - Adapt filetree_read role tests playbook config-controller-filetree.yml.
      - 'Add new type of objects for object_diff role:  applications, execution environments,
        instance groups, notifications and schedules'
      - Add no_log to all tasks that populates data to avoid exposing encrypted data
      - Add task to add Galaxy credentials and Execution Environments to Organization.
      - Added argument_spec for all roles
      - Set the variables to assign_galaxy_credentials_to_org and assign_default_ee_to_org
        to false in the task to run all roles at dispatch role.
      - avoid to create orgs during drop_diff
      - fixed an extra blank line in schedules readme that was breaking the table
      - removed references to redhat_cop as a collection namespace in the readme files.
    fragments:
    - arg_spec.yml
    - dispatch_creds_ee_orgs_creation.yml
    - filetree_read.yml
    - fixing_readme.yaml
    - i_s_u_title.yml
    - object_diff_role_and_plugin.yml
    - redhat_to_infra_conversion.yml
    release_date: '2023-03-16'
  2.3.1:
    changes:
      bugfixes:
      - Added argument_spec for all roles
      - Ensures vars get loaded properly by dispatch role
    fragments:
    - arg_spec.yml
    - dispatch_fix.yml
    release_date: '2023-03-24'
  2.4.0:
    changes:
      bugfixes:
      - Fixed defaults for values that are lists.
      - Fixed filetree read to error when organization not defined.
      - Fixed rrule in schedules to not be mandatory.
      minor_changes:
      - Added Roles bulk_host_create, bulk_job_launch.
      - Added new_name option to the roles applications, credential_types, execution_environments,
        inventories, projects, users.
      - Added new_username option to user role.
      - Added option to multiple roles to enforce defaults. This is described in each
        of the roles readmes and will slowly be rolled out to all applicable roles.
        This option enforces module/api defaults in order to prevent config drift.
        This makes it so if an option is NOT specified in a configuration it enforces
        the default value. It is not enabled by default.
      - Added scm_branch option to inventory_sources role.
      - Corrected various readmes.
      - Credentials role credential type set to mandatory. This would fail in the
        past if it was not set, this just codifies it.
      - If someone wants to have the old behavior, or only update projects with dispatch,
        the dispatch variable controller_configuration_dispatcher_roles can be overwritten
        and customized.
      - Instances role - changed default of node_type and node_state to omit, as generally
        these cannot be changed on existing instances unless deploying new instances.
      - Inventory role - added input_inventories option for constructed inventories.
      - Removed project_update from dispatch. This is because with bringing update_project
        option in line with the module options, it was running twice both in project
        and project update. Since both roles use the same variable controller_projects.
      - Set the default behavior of project_update to run the update as true, unless
        the user explicitly sets the variable update_project to overide the default
        behavior. This is because if the user is specifically calling project_update
        it should by default update the project.
      - Updated workflow job template options to use non depreciated names for options.
        This should not affect any operations.
      - added alias's for applicable roles to use the variables set by the awx cli
        export.
      - added get_stats.yml playbook in the playbook folder to get some basic info
        on a Tower/Controller instance
      - added option for using the export form of default execution environment.
      - added option to roles role to support upcoming change to allow lists of teams
        and users to be used in the module.
      - added options to license role to allow use of subcription lookup or pool_id.
    fragments:
    - enforce_defaults.yml
    - export_defaults.yml
    - filetree_inventory_org.yml
    - get_stats.yml
    - license.yml
    - list_default_fix.yml
    - org_ee.yml
    - project_update.yml
    - role_updates.yml
    - roles_update.yml
    - rrule_bugfix.yml
    release_date: '2023-06-09'
  2.4.1:
    changes:
      bugfixes:
      - Changes default value for `*_enforce_defaults` to false instead of the truthy
        value (due to the quotes), 'false'.
      - 'Fix addition of `state: present` when `with_present: true`'
      - Temporarily fixed an error when installing docker-compose using pip (see https://stackoverflow.com/questions/76708329/docker-compose-no-longer-building-image-attributeerror-cython-sources
        for more information)
      - When exporting job templates it was failing when missing some input information.
      - When exporting schedules, the diff_mode was not treated correctly
      - When importing the exported notification templates, the types of some values
        are not as expected.
      - 'When importing the exported settings, fields like `AUTOMATION_ANALYTICS_LAST_GATHER:
        2023-07-17T13:22:06.445818Z` caused problems with the multiple `:`.'
      - fix 'credentials' role ignoring 'update_secrets false' and forcing to default
        'true'
      - fixed an the users and teams field on the roles role to be correct and not
        singular.
      minor_changes:
      - Add option to change async directory, and set the default to null. /tmp/.ansible_async
        was a workaround while the default was broken previously.
      - Change from lookup to query in the object_diff task files
      - add organizations tag in a dispatch task which is in charge of applying galaxy
        credencitals in the organization.
      - added the instance_groups filed to the roles role.
      - added the possibility to export schedules through the filetree_create role
      - filetree_create now allows to export objects for the specified organization
      - remove depencency of CONTROLER_USERNAME variable for object_diff role by calling
        the API with api/me instead of calling the api/users and filtering by username
    fragments:
    - 610-filetree_create-now-allows-to-export-objects-for-the-specified-organization.yml
    - 630-enforce-defs.yml
    - add_organizations_tag.yml
    - add_schedules_to_filetree_create.yml
    - async.yml
    - change_from_lookup_to_query.yml
    - credentials_role_bugfix.yml
    - filetree_create_bugfix.yml
    - remove_username_dependency_objectdiff.yml
    - roles_bugfix.yml
    release_date: '2023-07-26'
  2.5.0:
    changes:
      bugfixes:
      - Added more attributes to be expanded and used by the comparison
      - Fixed lintering issues
      minor_changes:
      - Added roles option to roles role to allow setting multiple roles in one item
        rather than repeating entire sections of code
      - ansible.cfg removed from root and galaxy.yml added to enable install from
        source
    fragments:
    - object_diff.yml
    - roles.yml
    - source_build.yml
    release_date: '2023-08-03'
  2.5.1:
    changes:
      bugfixes:
      - Fixed issue with licence role not operating properly, when a controller never
        had credentials provided for subscription lookup. See Role Readme for proper
        usuage.
      - Fixed issue with organization role not acceppting default environments option
        correctly.
      minor_changes:
      - Adds request_timeout to controller_export_diff module, and roles
      - licence role now uses a boolean of controller_license.use_looup to determine
        whether to lookup subscriptions. A lookup is only needed to refresh the available
        pools, or if it has never been done. See Role Readme for details.
    fragments:
    - add_request_timeout.yml
    - licence_org.yml
    release_date: '2023-08-29'
  2.5.2:
    changes:
      bugfixes:
      - Fixed issue with organization creation with instance group. Execute instance
        and instance_group before organizations.
      - dispatch - Fixed the order and behavior to run as a single task with options
        for organization behavior.
      - filetree_create - Fixed the misspelled variable name that caused exported
        job_templates yaml files containing incorrect name.
      - filetree_create and object_diff- Subelement filter is executed before when
        and it was causing a failure when the list was not defined.
    fragments:
    - dispatch_bugfix.yml
    - filetree_create_job_templates.yml
    - fix_subelements_conditional.yml
    - instancegroups_org.yml
    release_date: '2023-10-14'
  2.6.0:
    changes:
      bugfixes:
      - Fixed an issue where the diff doesn't work correctly when explicitly setting
        state present
      - Fixed an issue where the usage access to instance_groups were removed
      - Fixed member removal of teams
      - The role 'credentials' have had the enforced defaults removed from team, user,
        and organization options. This was causing an error with these parameters
        were mutally exclusive.
      - The role 'inventory_sources' will now skip when the source parameter is `constructed`.
        These sources are auto created and not meant to be edited. However they can
        still be synced with the inventory_source_update.
      - The role 'workflow_job_templates' Default enforced value set for workflow
        templates limit was 0, was corrected to be an empty string.
      minor_changes:
      - The role 'filetree_create' will now allow to export all the objects of one
        kind into a single file, so it can be loaded by both ansible `group_vars`
        syntax and `filetree_read` tool.
      - added improvements to checkmod where it will run faster with the async tasks.
        In addition added an additional fail check at end of dispatch that will likely
        fail if dependencies are missing, as expected.
      - added mandatory check to workflow launch name option
      - filetree_create - Add the constructed inventory exportation fields from the
        API endpoint `api/v2/constructed_inventories`
    fragments:
    - checkmode.yml
    - constructed.yml
    - credential_owner.yml
    - diff_plugin.yml
    - filetree_create_export_constructed_inventories.yml
    - filtree_create_flatten_output.yml
    - workflow_limit_default.yml
    release_date: '2023-12-02'
  2.7.1:
    changes:
      bugfixes:
      - Constructed inventories can only be exported when AAP version is >= 4.5.0
      - Fixed roles diff when the role is set at the organization level for an user/team
      - Fixed roles diff when the roles are provided as a list, in a single entry
      - Organization not defined when exporting some inventory sources from Tower
        3.7.2
      minor_changes:
      - Add `assign_notification_templates_to_org` option to organization role to
        allow conditional assigning of notification templates
      - Updated dispatch role with `assign_notification_templates_to_org` option assigned
        to organization as False on first run and True on second run by default.
      - instance role - add missing arguments introduced in ansible.controller 4.5.0
        or awx.awx 23.0.0
    fragments:
    - 765-notif-temp-assign.yml
    - add_instance_arguments.yml
    - diff_roles_fix.yml
    - diff_roles_orga_wide.yml
    - issue_743.yml
    release_date: '2024-03-19'