0.16.3

This is a stable release of ARA, 0.16.3.

***
WARNING: Please note that the next major version of ARA, 1.0, will contain
         backwards incompatible changes due to significant refactor work
         involving core back end code as well as the SQL database schema.
***

Changelog:
- Update integration tests to target latest versions of Ansible (2.7.6,
2.6.12 and 2.5.14)
- Adjust how CLI options are saved to support the upcoming release of
  Ansible, 2.8.

0.16.3rc1

This is a release candidate for the newest release of ARA, 0.16.3.

***
WARNING: Please note that the next major version of ARA, 1.0, will contain
         backwards incompatible changes due to significant refactor work
         involving core back end code as well as the SQL database schema.
***

Changelog:
- Update integration tests to target latest versions of Ansible (2.7.6,
2.6.12 and 2.5.14)
- Adjust how CLI options are saved to support the upcoming release of
  Ansible, 2.8.

0.16.2

This is the newest stable release of ARA, 0.16.2.

***
WARNING: Please note that the next major version of ARA, 1.0, will contain
         backwards incompatible changes due to significant refactor work
         involving core back end code as well as the SQL database schema.
***

This release comes thanks to bug fixes contributed by the community:

- Jonathan Herlin fixed the deprecation notice "Call to deprecated
  function CreateFile. Use create_file instead." when generating HTML
  reports.
- Sorin Sbarnea addressed testing warnings and made it so future
  warnings would be considered as errors
- Sorin Sbarnea removed integration testing for the "static: no"
  argument from Ansible includes since this parameter has been removed
  from Ansible after being deprecated.

old-flask-1.0

This is the tip of the feature/1.0 branch for openstack/ara.
This is tagged for historical purposes as the development of that branch
has been abandoned in favor of a complete rewrite with django instead.

0.16.1

This is the newest stable release of ARA, 0.16.1.

***
WARNING: Please note that the next major version of ARA, 1.0, will contain
         backwards incompatible changes due to significant refactor work
         involving core back end code as well as the SQL database schema.
***

This is a hotfix release to address a bug in host facts sanitization
with the introduction of the "ARA_IGNORE_FACTS" feature in 0.16.0.
While task results were properly sanitized, host facts were not.

0.16.1 addresses the issue by sanitizing both host facts and task
results.

0.16.0

This is the newest stable release of ARA, 0.16.0.

***
WARNING: Please note that the next major version of ARA, 1.0, will contain
         backwards incompatible changes due to significant refactor work
         involving core back end code as well as the SQL database schema.
***

This release of ARA is made possible thanks to the following contributions:

- Tristan de Cacqueray from Red Hat resolved an issue where under certain
  circumstances, an empty ARA_LOG_FILE configuration could raise an exception.
- Artem Goncharov from Open Telekom Cloud resolved an issue where configuration
  parameters through environment variables could not taken into account
  properly when using the ara-wsgi and ara-wsgi-sqlite scripts.
- Joshua Harlow from GoDaddy submitted several improvements to performance and
  RAM usage when browsing large reports.
- Sorin Sbarnea from Red Hat contributed documentation on serving static ARA
  reports with nginx and improved the junit export to allow for overrides
- Haikel Guemar from Red Hat identified and fixed usage of reserved key words
  in Python 3.7
- Robert de Bock for suggesting a security improvement around host facts
  and the ansible_env fact.

Other improvements include:

- Improve self-healing when running into a race condition where the playbook
  run is interrupted early enough for the playbook to be created in the
  database but before it's file was saved.
- Prevent ARA's logging configuration from "leaking" into the configuration
  of other python modules at runtime.
- Add a trailing slash to file links in the file tab, resolving an issue
  where reverse proxies might get confused when doing SSL termination.

Security:

Robert de Bock from ING Bank reported that sensitive information might
be stored in environment variables from the Ansible control node and
that as such, there should be a way to prevent the 'ansible_env' host
fact from being recorded by ARA.

As such, we have added a new configuration parameter: ARA_IGNORE_FACTS [1].
ARA_IGNORE_FACTS is a comma-separated list of host facts that ARA will not
record in it's database.
ARA will also sanitize the output of gather_facts and setup tasks to prevent
these facts from displaying in the task results.
By default, only the "ansible_env" fact is ignored due to the high likelihood
of it containing sensitive information.

Maintenance:

- Dropped backwards compatibility layer for supporting Ansible 2.3
- Updated integration jobs to test against the latest versions of Ansible 2.4,
  2.5 and 2.6

[1]: https://ara.readthedocs.io/en/latest/configuration.html#ara-ignore-facts

0.16.0rc1

This is a release candidate for the newest stable release of ARA, 0.16.0.

***
WARNING: Please note that the next major version of ARA, 1.0, will contain
         backwards incompatible changes due to significant refactor work
         involving core back end code as well as the SQL database schema.
***

This release of ARA is made possible thanks to the following contributions:

- Tristan de Cacqueray from Red Hat resolved an issue where under certain
  circumstances, an empty ARA_LOG_FILE configuration could raise an exception.
- Artem Goncharov from Open Telekom Cloud resolved an issue where configuration
  parameters through environment variables could not taken into account
  properly when using the ara-wsgi and ara-wsgi-sqlite scripts.
- Joshua Harlow from GoDaddy submitted several improvements to performance and
  RAM usage when browsing large reports.
- Sorin Sbarnea from Red Hat contributed documentation on serving static ARA
  reports with nginx and improved the junit export to allow for overrides
- Haikel Guemar from Red Hat identified and fixed usage of reserved key words
  in Python 3.7

Other improvements include:

- Improve self-healing when running into a race condition where the playbook
  run is interrupted early enough for the playbook to be created in the
  database but before it's file was saved.
- Prevent ARA's logging configuration from "leaking" into the configuration
  of other python modules at runtime.
- Add a trailing slash to file links in the file tab, resolving an issue
  where reverse proxies might get confused when doing SSL termination.

New feature:

- A new configuration parameter, ARA_IGNORE_FACTS [1], is a comma-separated
  list of host facts that ARA will not record in it's database.
  ARA will also sanitize the output of gather_facts and setup tasks to prevent
  these facts from displaying in the task results.
  By default, only the "ansible_env" fact is ignored due to the high likelihood
  of it containing sensitive information.

Maintenance:

- Dropped backwards compatibility layer for supporting Ansible 2.3
- Updated integration jobs to test against the latest versions of Ansible 2.4,
  2.5 and 2.6

[1]: https://ara.readthedocs.io/en/latest/configuration.html#ara-ignore-facts

0.15.0

This is the newest stable release of ARA, 0.15.0.

***
WARNING: Please note that the next major version of ARA, 1.0, will contain
         backwards incompatible changes due to significant refactor work
         involving core back end code as well as the SQL database schema.
***

Changelog:

- ARA: Ansible Run Analysis has been "rebranded" to ARA Records Ansible
  (Another Recursive Acronym)
- Significant improvements to memory usage and performance when running ARA as
  a WSGI application with 'ara-wsgi' or 'ara-wsgi-sqlite'.
- Resolved an issue where the 'ara-wsgi-sqlite' middleware could serve a
  cached report instead of the requested one
- Added support for configuring the 'SQLALCHEMY_POOL_SIZE',
  'SQLALCHEMY_POOL_TIMEOUT' and 'SQLALCHEMY_POOL_RECYCLE' parameters.
  See the configuration documentation [1] for more details.
- Logging was fixed and improved to provide better insight when in DEBUG level.
- Vastly improved the default logging configuration.
  ARA will create a default logging configuration file in '~/.ara/logging.yml'
  that you can customize, if need be. Deleting this file will make ARA create
  a new one with updated defaults.
- Added python modules to help configure Ansible to use ARA, for example,
  'python -m ara.setup.callback_plugins' will print the path to ARA's callback
  plugins.
  You can find more examples in the configuration documentation. [1]
- Implemented a workaround for fixing a race condition where an
  'ansible-playbook' command may be interrupted after the playbook was recorded
  in the database but before playbook file was saved.
- Flask 0.12.3 was blacklisted from ARA's requirements [2], this was a broken
  release.
- The ARA CLI can now be called with "python -m ara" if you need to specify a
  specific python interpreter, for example.
- Updated and improved integration tests across different operating systems,
  python2 and python3 with different versions of Ansible. The full test matrix
  is available in the README. [3].

[1]: https://ara.readthedocs.io/en/stable/configuration.html
[2]: https://github.com/openstack/ara/commit/87272840bfc8b4c5db10593e47884e33a0f4af40
[3]: https://github.com/openstack/ara#contributing-testing-issues-and-bugs

0.15.0.0rc1

This is a release candidate for the newest stable release of ARA, 0.15.0.

***
WARNING: Please note that the next major version of ARA, 1.0, will contain
         backwards incompatible changes due to significant refactor work
         involving core back end code as well as the SQL database schema.
***

Changelog:

- ARA: Ansible Run Analysis has been "rebranded" to ARA Records Ansible
  (Another Recursive Acronym)
- Significant improvements to memory usage and performance when running ARA as
  a WSGI application with 'ara-wsgi' or 'ara-wsgi-sqlite'.
- Resolved an issue where the 'ara-wsgi-sqlite' middleware could serve a
  cached report instead of the requested one
- Added support for configuring the 'SQLALCHEMY_POOL_SIZE',
  'SQLALCHEMY_POOL_TIMEOUT' and 'SQLALCHEMY_POOL_RECYCLE' parameters.
  See the configuration documentation [1] for more details.
- Logging was fixed and improved to provide better insight when in DEBUG level.
- Vastly improved the default logging configuration.
  ARA will create a default logging configuration file in '~/.ara/logging.yml'
  that you can customize, if need be. Deleting this file will make ARA create
  a new one with updated defaults.
- Added python modules to help configure Ansible to use ARA, for example,
  'python -m ara.setup.callback_plugins' will print the path to ARA's callback
  plugins.
  You can find more examples in the configuration documentation. [1]
- Implemented a workaround for fixing a race condition where an
  'ansible-playbook' command may be interrupted after the playbook was recorded
  in the database but before playbook file was saved.
- Flask 0.12.3 was blacklisted from ARA's requirements [2], this was a broken
  release.
- The ARA CLI can now be called with "python -m ara" if you need to specify a
  specific python interpreter, for example.
- Updated and improved integration tests across different operating systems,
  python2 and python3 with different versions of Ansible. The full test matrix
  is available in the README. [3].

[1]: https://ara.readthedocs.io/en/stable/configuration.html
[2]: https://github.com/openstack/ara/commit/87272840bfc8b4c5db10593e47884e33a0f4af40
[3]: https://github.com/openstack/ara#contributing-testing-issues-and-bugs

0.14.6

This is a maintenance release for the stable version of ARA.

***
WARNING: Please note that the next major version of ARA, 1.0, will contain
         backwards incompatible changes due to significant refactor work
         involving core back end code as well as the SQL schema.
         Please see this blog post [1] for details.
***

Changelog:
- Unit and integration changes improvements
- Workaround an issue where Ansible could sometimes return a non-boolean
  value for the "ignore_errors" field.

[1]: https://dmsimard.com/2017/11/22/status-update-ara-1.0/

0.14.6.0rc1

This is a maintenance release for the stable version of ARA.

***
WARNING: Please note that the next major version of ARA, 1.0, will contain
         backwards incompatible changes due to significant refactor work
         involving core back end code as well as the SQL schema.
         Please see this blog post [1] for details.
***

Changelog:
- Unit and integration changes improvements
- Workaround an issue where Ansible could sometimes return a non-boolean
  value for the "ignore_errors" field.

[1]: https://dmsimard.com/2017/11/22/status-update-ara-1.0/

0.14.5

This is a release for the version 0.14.5 of ARA.

***
WARNING: Please note that the next major version of ARA, 1.0, will contain
         backwards incompatible changes due to significant refactor work
         involving core back end code as well as the SQL schema.
         Please see this blog post [1] for details.
***

This version notably fixes an issue when using ansible.cfg to
configure ARA when using Ansible 2.4.0.
0.14.5 is meant to be used with Ansible 2.4.1 and using it with Ansible
2.4.0 is not recommended because it does not contain a necessary bugfix [2].

Changelog:
- ARA can be configured through an ansible.cfg file with Ansible 2.4.1.
- Ansible 2.4.0 is blacklisted in requirements.txt
- Added a WSGI middleware to load sqlite databases at variable locations
  for advanced large-scale usage. See documentation [1] for details.
- Resolved an issue when clicking on permalink icons (blue chain links)
  on Firefox. (Thanks Mohammed Naser)

[1]: http://ara.readthedocs.io/en/latest/advanced.html#serving-ara-sqlite-databases-over-http
[2]: https://github.com/ansible/ansible/pull/31200

0.14.5.0rc2

This is release candidate for the 0.14.5 release of ARA.

***
WARNING: Please note that the next major version of ARA, 1.0, will contain
         backwards incompatible changes due to significant refactor work
         involving core back end code as well as the SQL schema.
         Please see this blog post [1] for details.
***

This version notably fixes an issue when using ansible.cfg to
configure ARA when using Ansible 2.4.0.
0.14.5 is meant to be used with Ansible 2.4.1 and does not
support Ansible 2.4.0.

Changelog:
- ARA can be configured through an ansible.cfg file with Ansible 2.4.1.
- Ansible 2.4.0 is blacklisted in requirements.txt
- Added a WSGI middleware to load sqlite databases at variable locations
  for advanced large-scale usage. See documentation [1] for details.
- Resolved an issue when clicking on permalink icons (blue chain links)
  on Firefox. (Thanks Mohammed Naser)

[1]: http://ara.readthedocs.io/en/latest/advanced.html#serving-ara-sqlite-databases-over-http

0.14.5.0rc1

This is release candidate for the 0.14.5 release of ARA.

***
WARNING: Please note that the next major version of ARA, 1.0, will contain
         backwards incompatible changes due to significant refactor work
         involving core back end code as well as the SQL schema.
         Please see this blog post [1] for details.
***

This version notably fixes an issue when using ansible.cfg to
configure ARA when using Ansible 2.4.0.
0.14.5 is meant to be used with Ansible 2.4.1 and does not
support Ansible 2.4.0.

Changelog:
- ARA can be configured through an ansible.cfg file with Ansible 2.4.1.
- Ansible 2.4.0 is blacklisted in requirements.txt
- Added a WSGI middleware to load sqlite databases at variable locations
  for advanced large-scale usage. See documentation [1] for details.
- Resolved an issue when clicking on permalink icons (blue chain links)
  on Firefox. (Thanks Mohammed Naser)

[1]: http://ara.readthedocs.io/en/latest/advanced.html#serving-ara-sqlite-databases-over-http

0.14.4

0.14.4 adds Ansible 2.4 support for ARA.

***
WARNING: Please note that the next major version of ARA, 1.0, will contain
         backwards incompatible changes due to significant refactor work
         involving core back end code as well as the SQL schema.
         Please see this blog post [1] for details.
***

Changelog:
- Add support for Ansible 2.4

0.14.4.0rc1

0.14.4 adds Ansible 2.4 support for ARA.

***
WARNING: Please note that the next major version of ARA, 1.0, will contain
         backwards incompatible changes due to significant refactor work
         involving core back end code as well as the SQL schema.
         Please see this blog post [1] for details.
***

Changelog:
- Add support for Ansible 2.4

0.14.3

0.14.3 is a minor bugfix release for ARA.
Note that ARA does not yet support Ansible 2.4.

***
WARNING: Please note that the next major version of ARA, 1.0, will contain
         backwards incompatible changes due to significant refactor work
         involving core back end code as well as the SQL schema.
         Please see this blog post [1] for details.
***

Changelog:
- Bugfix: 'include_role' tasks with 'static: no' are now handled properly
  (See Ansible issue: https://github.com/ansible/ansible/issues/30385 )
- Backport from 1.0: 404 not found errors when generating static reports will
  now be ignored as they are non-fatal.
- Ansible was pinned to <2.4, ARA does not yet support Ansible 2.4.
- Pygments was pinned to >=1.6, prior versions did not have the required
  JSONLexer methods.
- Flask was pinned to >=0.11, prior versions did not provide the
  flask_logging.DEBUG_LOG_OUTPUT variable. The version prior to 0.11 was released
  in 2013.

0.14.3.0rc1

0.14.3 is a minor bugfix release for ARA.
Note that ARA does not yet support Ansible 2.4.

***
WARNING: Please note that the next major version of ARA, 1.0, will contain
         backwards incompatible changes due to significant refactor work
         involving core back end code as well as the SQL schema.
         Please see this blog post [1] for details.
***

Changelog:
- Bugfix: 'include_role' tasks with 'static: no' are now handled properly
  (See Ansible issue: https://github.com/ansible/ansible/issues/30385 )
- Backport from 1.0: 404 not found errors when generating static reports will
  now be ignored as they are non-fatal.
- Ansible was pinned to <2.4, ARA does not yet support Ansible 2.4.
- Pygments was pinned to >=1.6, prior versions did not have the required
  JSONLexer methods.
- Flask was pinned to >=0.11, prior versions did not provide the
  flask_logging.DEBUG_LOG_OUTPUT variable. The version prior to 0.11 was released
  in 2013.

0.14.2

Bugfix: "logging.config" also needed to be imported for
        the new file configuration option to work properly.

0.14.1

0.14.1 is a minor bugfix release for ARA.

***
WARNING: Please note that the next major version of ARA, 1.0, will contain
         backwards incompatible changes due to significant refactor work
         involving core back end code as well as the SQL schema.
         Please see this blog post [1] for details.
***

Changelog:
- Bugfix: Implicit tasks with no specific file and task
  information provided by Ansible (such as "gather_facts")
  now resolve back to the playbook file by default. See upstream
  Ansible bug [2] for details.

- Feature: Logging for ARA and it's components can now be done
  through a logging configuration file [3].

- Integration tests on Fedora 26 with python3.6 were
  added to the existing tests under CentOS 7 and
  Ubuntu 16.04.

[1]: https://dmsimard.com/2017/08/16/whats-coming-in-ara-1.0/
[2]: https://github.com/ansible/ansible/issues/28451
[3]: https://ara.readthedocs.io/en/latest/configuration.html#ara-log-config