Tags: arpitjain799/ara
Tags
1.6.1
This is the 1.6.1 stable release of ara.
This is a minor release with two changes:
- callback: Changed how ANSIBLE_TMP is found to work around a behavior
change in ansible-core 2.14 that ended up creating a directory named
{{ ANSIBLE_HOME ~ "
For more information: ansible-community#469
- Added a mysql extra to the python packaging for installing the
mysqlclient library. This is in addition to the existing server and
postgresql extra. They are used like this:
pip install ara[server,mysql,postgresql]
1.6.1rc1
This is the first release candidate for the 1.6.1 stable release of ara.
This is a minor release with two changes:
- callback: Changed how ANSIBLE_TMP is found to work around a behavior
change in ansible-core 2.14 that ended up creating a directory named
{{ ANSIBLE_HOME ~ "
For more information: ansible-community#469
- Added a mysql extra to the python packaging for installing the
mysqlclient library. This is in addition to the existing server and
postgresql extra. They are used like this:
pip install ara[server,mysql,postgresql]
1.6.0
This is the 1.6.0 stable release of ara.
It features a new "tasks" page to browse and search for tasks across playbook runs
as well as many updates, fixes and improvements.
Instructions for upgrading are included in the upgrade notes.
Changes since 1.5.8:
UI
--
- Added a new "Tasks" page similar to the existing pages for Playbooks and Hosts.
It provides a browseable and searchable overview of tasks across playbook runs.
- Refreshed the host index page:
- Added a column as well as search arguments for playbook name (or path)
- Replaced the playbook status by a concise summary of task status for the host
- Updated the playbook summary card to include the playbook id, the version of ara as
well as the version of python.
- Re-ordered and resized columns in tables to optimize width and improve consistency
- Resized and aligned fields in search forms to use the full width available
- Improved how task tags are displayed
- Updated HTML page titles to be consistent across pages
- Replaced fields for searching by task ID and host ID by task name and host name
- Truncate name fields to prevent exceedinly large names to distort entire tables
- Corrected card header font sizes in the host report page
callback plugin
---------------
- Added support for recording the user who ran the playbook
- Added support for recording the version of ara as well as the version of
python used when running the playbook
- Added options ARA_RECORD_USER and ARA_RECORD_CONTROLLER that can be
set to false to avoid recording the user and controller hostname
- Added support for specifying a SSL key, certificate and certificate
authority for authenticating with a remote ara API server using
ARA_API_KEY, ARA_API_CERT and ARA_API_CA respectively.
- Fixed host fact recording to ensure it works when using FQCN-style tasks
(ex: setup & ansible.builtin.setup)
- Increased reliability and accuracy when recording results that can arrive
out of order when using multi-threading or the free strategy by using the
task uuid provided by Ansible
- Truncate playbook, play, host and label names in circumstances where their
length exceeds 255 characters
- Ignore and don't record files in ~/.ansible/tmp by default
API Server
----------
- Bumped django requirement from 2.2 LTS to 3.2 LTS and removed the pin
on the version of psycopg2 accordingly
- Added a new configuration option, ARA_BASE_PATH, to let the server
listen on an alternate path. It will continue to default to "/" but it
could, for example, be set to "/ara/".
- Lifted requirement on tzlocal, improve timezone detection and mitigate
when the timezone can't be found by defaulting to UTC
- Several new database model and API fields:
- Added client_version and server_version fields to playbooks, meant to
represent the version of the ara callback and server used in recording
the playbook
- Added python_version field to playbooks to save the version of python
used by Ansible and the callback plugin when recording a playbook
- Added a new "failed" status for tasks that is used by the callback plugin
when there is at least one failed result for a given task
- Added a new "uuid" field for tasks which is the uuid provided by Ansible
for a task. It is used by the callback plugin to increase the reliability
and accuracy when recording results even if they arrive out of order.
- Several fixes and improvements for the distributed sqlite database backend:
- Added a new index page for listing and linking to available databases.
This is a work in progress that is intended to be improved in the future.
- Return a HTTP 405 error when trying to write to read-only endpoints
- Fixed the /healthcheck/ endpoint to make sure it is routed properly
- Improved database engine settings and WSGI application configuration
The WSGI application should now always be "ara.server.wsgi" instead of
needing to specify "ara.server.wsgi.distributed_sqlite"
API client
----------
- Added support for specifying a SSL key, certificate and certificate
authority for authenticating with a remote ara API server
- Remove InsecureRequestWarning for insecure requests when SSL verification
is not enabled.
CLI
---
- Fixed wrong parsing of durations longer than 24 hours
- Added support for searching playbooks by user
- Added support for specifying a SSL key, certificate and certificate
authority for authenticating with a remote ara API server using
ARA_API_KEY, ARA_API_CERT and ARA_API_CA respectively.
Docs
----
- Refreshed and improved the README, reformatted it from rst to markdown
- Added a CONTRIBUTING.md file and refreshed contribution documentation
- Explicitly call out and recommend setting up authentication for production
use in order to prevent leaking sensitive information
- Improved troubleshooting documentation and tips to improve playbook recording
performance
Tests and miscellaneous
-----------------------
- Bumped the black linter to the latest version and reformatted bits
of code accordingly
- Updated isort to version 5 and reformatted bits of code accordingly
- Reformatted bits of code using pyupgrade in consideration of dropping
support for python3.5
- Updated versions of ansible(-core) we run integration tests with to include
2.9, 2.11, 2.12, 2.13, 2.14 and 6.4.0.
Although 2.9 is EOL, we will keep it for a while longer.
container-images (contrib)
--------------------------
- The 'latest' tag of container images are now tagged from the latest
PyPI release instead of the latest git source
- Container images have been updated to the latest distribution images:
CentOS 8 to CentOS 9 and Fedora 35 to Fedora 36
- Add a centos-source.sh script so we can test from source in addition
to PyPI
- Install everything from PyPI (except ara when from source) in order
to avoid mixing distribution packages with PyPI packages
Upgrade notes
-------------
- ara 1.5.8 was the last version to support python3.5.
Starting with ara 1.6.0, python3.6 or later is required.
- ara 1.6.0 includes several database migrations and it is highly recommended
to take a backup of the server database before updating.
Database migrations are run automatically in many circumstances and can be run
manually using "ara-manage migrate".
- There are a few backwards incompatible changes introduced in ara 1.6.0 which
makes it important to run the same version of ara everywhere to avoid running
into problems if the version of the callback plugin and server do not match.
- There is a database migration which grows the maximum length of the name fields
for plays and labels which was later reverted due to potential issues when using
the MySQL database backend.
1.6.0rc2
This is the second release candidate for the 1.6.0 stable release of ara.
It features a new "tasks" page to browse and search for tasks across playbook runs
as well as many updates, fixes and improvements.
Instructions for upgrading are included in the upgrade notes.
Changes since 1.5.8:
UI
--
- Added a new "Tasks" page similar to the existing pages for Playbooks and Hosts.
It provides a browseable and searchable overview of tasks across playbook runs.
- Refreshed the host index page:
- Added a column as well as search arguments for playbook name (or path)
- Replaced the playbook status by a concise summary of task status for the host
- Updated the playbook summary card to include the playbook id, the version of ara as
well as the version of python.
- Re-ordered and resized columns in tables to optimize width and improve consistency
- Resized and aligned fields in search forms to use the full width available
- Improved how task tags are displayed
- Updated HTML page titles to be consistent across pages
- Replaced fields for searching by task ID and host ID by task name and host name
- Truncate name fields to prevent exceedinly large names to distort entire tables
- Corrected card header font sizes in the host report page
callback plugin
---------------
- Added support for recording the user who ran the playbook
- Added support for recording the version of ara as well as the version of
python used when running the playbook
- Added options ARA_RECORD_USER and ARA_RECORD_CONTROLLER that can be
set to false to avoid recording the user and controller hostname
- Added support for specifying a SSL key, certificate and certificate
authority for authenticating with a remote ara API server using
ARA_API_KEY, ARA_API_CERT and ARA_API_CA respectively.
- Fixed host fact recording to ensure it works when using FQCN-style tasks
(ex: setup & ansible.builtin.setup)
- Increased reliability and accuracy when recording results that can arrive
out of order when using multi-threading or the free strategy by using the
task uuid provided by Ansible
- Truncate playbook, play, host and label names in circumstances where their
length exceeds 255 characters
- Ignore and don't record files in ~/.ansible/tmp by default
API Server
----------
- Bumped django requirement from 2.2 LTS to 3.2 LTS and removed the pin
on the version of psycopg2 accordingly
- Added a new configuration option, ARA_BASE_PATH, to let the server
listen on an alternate path. It will continue to default to "/" but it
could, for example, be set to "/ara/".
- Lifted requirement on tzlocal, improve timezone detection and mitigate
when the timezone can't be found by defaulting to UTC
- Several new database model and API fields:
- Added client_version and server_version fields to playbooks, meant to
represent the version of the ara callback and server used in recording
the playbook
- Added python_version field to playbooks to save the version of python
used by Ansible and the callback plugin when recording a playbook
- Added a new "failed" status for tasks that is used by the callback plugin
when there is at least one failed result for a given task
- Added a new "uuid" field for tasks which is the uuid provided by Ansible
for a task. It is used by the callback plugin to increase the reliability
and accuracy when recording results even if they arrive out of order.
- Several fixes and improvements for the distributed sqlite database backend:
- Added a new index page for listing and linking to available databases.
This is a work in progress that is intended to be improved in the future.
- Return a HTTP 405 error when trying to write to read-only endpoints
- Fixed the /healthcheck/ endpoint to make sure it is routed properly
- Improved database engine settings and WSGI application configuration
The WSGI application should now always be "ara.server.wsgi" instead of
needing to specify "ara.server.wsgi.distributed_sqlite"
API client
----------
- Added support for specifying a SSL key, certificate and certificate
authority for authenticating with a remote ara API server
- Remove InsecureRequestWarning for insecure requests when SSL verification
is not enabled.
CLI
---
- Fixed wrong parsing of durations longer than 24 hours
- Added support for searching playbooks by user
- Added support for specifying a SSL key, certificate and certificate
authority for authenticating with a remote ara API server using
ARA_API_KEY, ARA_API_CERT and ARA_API_CA respectively.
Docs
----
- Refreshed and improved the README, reformatted it from rst to markdown
- Added a CONTRIBUTING.md file and refreshed contribution documentation
- Explicitly call out and recommend setting up authentication for production
use in order to prevent leaking sensitive information
- Improved troubleshooting documentation and tips to improve playbook recording
performance
Tests and miscellaneous
-----------------------
- Bumped the black linter to the latest version and reformatted bits
of code accordingly
- Updated isort to version 5 and reformatted bits of code accordingly
- Reformatted bits of code using pyupgrade in consideration of dropping
support for python3.5
- Updated versions of ansible(-core) we run integration tests with to include
2.9, 2.11, 2.12, 2.13, 2.14 and 6.4.0.
Although 2.9 is EOL, we will keep it for a while longer.
container-images (contrib)
--------------------------
- The 'latest' tag of container images are now tagged from the latest
PyPI release instead of the latest git source
- Container images have been updated to the latest distribution images:
CentOS 8 to CentOS 9 and Fedora 35 to Fedora 36
- Add a centos-source.sh script so we can test from source in addition
to PyPI
- Install everything from PyPI (except ara when from source) in order
to avoid mixing distribution packages with PyPI packages
Upgrade notes
-------------
- ara 1.5.8 was the last version to support python3.5.
Starting with ara 1.6.0, python3.6 or later is required.
- ara 1.6.0 includes several database migrations and it is highly recommended
to take a backup of the server database before updating.
Database migrations are run automatically in many circumstances and can be run
manually using "ara-manage migrate".
- There are a few backwards incompatible changes introduced in ara 1.6.0 which
makes it important to run the same version of ara everywhere to avoid running
into problems if the version of the callback plugin and server do not match.
- There is a database migration which grows the maximum length of the name fields
for plays and labels which was later reverted due to potential issues when using
the MySQL database backend.
1.6.0rc1
This is the first release candidate for the 1.6.0 stable release of ara.
It features a new "tasks" page to browse and search for tasks across playbook runs
as well as many updates, fixes and improvements.
Instructions for upgrading are included in the upgrade notes.
UI
--
- Added a new "Tasks" page similar to the existing pages for Playbooks and Hosts.
It provides a browseable and searchable overview of tasks across playbook runs.
- Refreshed the host index page:
- Added a column as well as search arguments for playbook name (or path)
- Replaced the playbook status by a concise summary of task status for the host
- Updated the playbook summary card to include the playbook id, the version of ara as
well as the version of python.
- Re-ordered and resized columns in tables to optimize width and improve consistency
- Resized and aligned fields in search forms to use the full width available
- Improved how task tags are displayed
- Updated HTML page titles to be consistent across pages
- Replaced fields for searching by task ID and host ID by task name and host name
- Truncate name fields to prevent exceedinly large names to distort entire tables
- Corrected card header font sizes in the host report page
callback plugin
---------------
- Added support for recording the user who ran the playbook
- Added support for recording the version of ara as well as the version of
python used when running the playbook
- Added options ARA_RECORD_USER and ARA_RECORD_CONTROLLER that can be
set to false to avoid recording the user and controller hostname
- Added support for specifying a SSL key, certificate and certificate
authority for authenticating with a remote ara API server using
ARA_API_KEY, ARA_API_CERT and ARA_API_CA respectively.
- Fixed host fact recording to ensure it works when using FQCN-style tasks
(ex: setup & ansible.builtin.setup)
- Increased reliability and accuracy when recording results that can arrive
out of order when using multi-threading or the free strategy by using the
task uuid provided by Ansible
- Truncate playbook, play, host and label names in circumstances where their
length exceeds 255 characters
- Ignore and don't record files in ~/.ansible/tmp by default
API Server
----------
- Bumped django requirement from 2.2 LTS to 3.2 LTS and removed the pin
on the version of psycopg2 accordingly
- Lifted requirement on tzlocal, improve timezone detection and mitigate
when the timezone can't be found by defaulting to UTC
- Several new database model and API fields:
- Added client_version and server_version fields to playbooks, meant to
represent the version of the ara callback and server used in recording
the playbook
- Added python_version field to playbooks to save the version of python
used by Ansible and the callback plugin when recording a playbook
- Added a new "failed" status for tasks that is used by the callback plugin
when there is at least one failed result for a given task
- Added a new "uuid" field for tasks which is the uuid provided by Ansible
for a task. It is used by the callback plugin to increase the reliability
and accuracy when recording results even if they arrive out of order.
- Several fixes and improvements for the distributed sqlite database backend:
- Added a new index page for listing and linking to available databases.
This is a work in progress that is intended to be improved in the future.
- Return a HTTP 405 error when trying to write to read-only endpoints
- Fixed the /healthcheck/ endpoint to make sure it is routed properly
- Improved database engine settings and WSGI application configuration
The WSGI application should now always be "ara.server.wsgi" instead of
needing to specify "ara.server.wsgi.distributed_sqlite"
API client
----------
- Added support for specifying a SSL key, certificate and certificate
authority for authenticating with a remote ara API server
- Remove InsecureRequestWarning for insecure requests when SSL verification
is not enabled.
CLI
---
- Fixed wrong parsing of durations longer than 24 hours
- Added support for searching playbooks by user
- Added support for specifying a SSL key, certificate and certificate
authority for authenticating with a remote ara API server using
ARA_API_KEY, ARA_API_CERT and ARA_API_CA respectively.
Docs
----
- Refreshed and improved the README, reformatted it from rst to markdown
- Added a CONTRIBUTING.md file and refreshed contribution documentation
- Explicitly call out and recommend setting up authentication for production
use in order to prevent leaking sensitive information
- Improved troubleshooting documentation and tips to improve playbook recording
performance
Tests and miscellaneous
-----------------------
- Bumped the black linter to the latest version and reformatted bits
of code accordingly
- Updated isort to version 5 and reformatted bits of code accordingly
- Reformatted bits of code using pyupgrade in consideration of dropping
support for python3.5
- Updated versions of ansible(-core) we run integration tests with to include
2.9, 2.11, 2.12, 2.13, 2.14 and 6.4.0.
Although 2.9 is EOL, we will keep it for a while longer.
container-images (contrib)
--------------------------
- The 'latest' tag of container images are now tagged from the latest
PyPI release instead of the latest git source
- Container images have been updated to the latest distribution images:
CentOS 8 to CentOS 9 and Fedora 35 to Fedora 36
- Add a centos-source.sh script so we can test from source in addition
to PyPI
- Install everything from PyPI (except ara when from source) in order
to avoid mixing distribution packages with PyPI packages
Upgrade notes
-------------
- ara 1.5.8 was the last version to support python3.5.
Starting with ara 1.6.0, python3.6 or later is required.
- ara 1.6.0 includes several database migrations and it is highly recommended
to take a backup of the server database before updating.
Database migrations are run automatically in many circumstances and can be run
manually using "ara-manage migrate".
- There are a few backwards incompatible changes introduced in ara 1.6.0 which
makes it important to run the same version of ara everywhere to avoid running
into problems if the version of the callback plugin and server do not match.
- There is a database migration which grows the maximum length of the name fields
for plays and labels which was later reverted due to potential issues when using
the MySQL database backend.
1.5.8 This is the 1.5.8 stable release of ara. It features new callback and server settings as well as fixes and maintenance. Instructions for upgrading are included in the upgrade notes. Callback plugin --------------- - Improved debug logging to include some hooks that were missing (ansible-community#374) - Added a localhost_to_hostname toggle in the callback (ansible-community#336) This adds two configuration parameters to the callback: - ARA_LOCALHOST_AS_HOSTNAME - ARA_LOCALHOST_AS_HOSTNAME_FORMAT These are useful in use cases where playbooks are run against localhost, whether directly (with ansible-playbook) or indirectly (via ansible-pull). When enabled, ara will save results under the hostname (or fqdn) of 'localhost' instead of associating every result to localhost. This is meant to make it easier to distinguish results between different hosts even though the playbooks may have all run against 'localhost'. Server ------ - Added a setting for CSRF_TRUSTED_ORIGINS (ansible-community#345) - Fixed logging configuration to avoid conflicting with ansible (ansible-community#367) See upgrade notes for changes to the server's settings.yaml. UI -- - API browser: disable forms to improve performance (ansible-community#323) - Include the version of ara when generating static reports (ansible-community#318) - Add a column in task results for displaying the task's tags (ansible-community#281,ansible-community#375) CLI --- - Added "--latest" to "ara host list" to show only the latest playbook (ansible-community#327) Docs ---- - Refreshed authentication docs and recommend using EXTERNAL_AUTH with nginx or apache in front (ansible-community#319) - Add database and authentication tips to troubleshooting (ansible-community#355) Packaging and dependencies -------------------------- - API Server container images have been bumped to fedora35 and centos8-stream - Updated setup.cfg to fix a deprecation warning for python 3.10 (ansible-community#371) - Fixed distutils.sysconfig deprecation warning on python 3.10 (ansible-community#369) - Fixed dynaconf deprecation warning when loading settings (ansible-community#369) - psycopg2 has been pinned to <2.9 due to incompatibility with django 2.2 (ansible-community#321,ansible-community#326) - dynaconf has been pinned to <3.0 when using python3.5 (ansible-community#372) dynaconf>=3.0 supports python>=3.6. Misc ---- - General CI maintenance - Updated Zuul to test the latest versions of ansible and ansible-core - Re-enabled container image updates on DockerHub and Quay.io - Added an example script with ansible-runner (ansible-community#343) Upgrade notes ------------- - There have been fixes to logging which requires changes to the server's settings.yaml or LOGGING configuration. (ansible-community#367) A warning will be printed if the configuration file must be updated and it can be updated manually or by generating a new configuration file. - ara 1.5.8 is the last release that will support python3.5. Python 3.5 reached the end of its life on September 13th, 2020. An upcoming release will update the version of django to the next LTS (2.2 to 3.2) which will bump the requirement to python>=3.6.
1.5.8rc1 Callback plugin --------------- - Improved debug logging to include some hooks that were missing (ansible-community#374) - Added a localhost_to_hostname toggle in the callback (ansible-community#336) This adds two configuration parameters to the callback: - ARA_LOCALHOST_AS_HOSTNAME - ARA_LOCALHOST_AS_HOSTNAME_FORMAT These are useful in use cases where playbooks are run against localhost, whether directly (with ansible-playbook) or indirectly (via ansible-pull). When enabled, ara will save results under the hostname (or fqdn) of 'localhost' instead of associating every result to localhost. This is meant to make it easier to distinguish results between different hosts even though the playbooks may have all run against 'localhost'. Server ------ - Added a setting for CSRF_TRUSTED_ORIGINS (ansible-community#345) - Fixed logging configuration to avoid conflicting with ansible (ansible-community#367) See upgrade notes for changes to the server's settings.yaml. UI -- - API browser: disable forms to improve performance (ansible-community#323) - Include the version of ara when generating static reports (ansible-community#318) - Add a column in task results for displaying the task's tags (ansible-community#281,ansible-community#375) CLI --- - Added "--latest" to "ara host list" to show only the latest playbook (ansible-community#327) Docs ---- - Refreshed authentication docs and recommend using EXTERNAL_AUTH with nginx or apache in front (ansible-community#319) - Add database and authentication tips to troubleshooting (ansible-community#355) Packaging and dependencies -------------------------- - API Server container images have been bumped to fedora35 and centos8-stream - Updated setup.cfg to fix a deprecation warning for python 3.10 (ansible-community#371) - Fixed distutils.sysconfig deprecation warning on python 3.10 (ansible-community#369) - Fixed dynaconf deprecation warning when loading settings (ansible-community#369) - psycopg2 has been pinned to <2.9 due to incompatibility with django 2.2 (ansible-community#321,ansible-community#326) - dynaconf has been pinned to <3.0 when using python3.5 (ansible-community#372) dynaconf>=3.0 supports python>=3.6. Misc ---- - General CI maintenance - Updated Zuul to test the latest versions of ansible and ansible-core - Re-enabled container image updates on DockerHub and Quay.io - Added an example script with ansible-runner (ansible-community#343) Upgrade notes ------------- - There have been fixes to logging which requires changes to the server's settings.yaml or LOGGING configuration. (ansible-community#367) A warning will be printed if the configuration file must be updated and it can be updated manually or by generating a new configuration file. - ara 1.5.8 is the last release that will support python3.5. Python 3.5 reached the end of its life on September 13th, 2020. An upcoming release will update the version of django to the next LTS (2.2 to 3.2) which will bump the requirement to python>=3.6.
1.5.7 This is the 1.5.7 stable release of ara. It features a new "hosts" page to browse and search playbook reports by host as well as fixes and improvements. Instructions for upgrading are included in the upgrade notes. Changes since 1.5.6: UI -- - Added a new "hosts" page to browse and search reports by host name - Improved page HTML titles to be dynamic based on the context - Added a note highlighting if a task has been delegated to another host (ansible-community#282) - Improved how long file paths or playbook names are truncated and displayed API --- - Added a new read-only API endpoint: /api/v1/latesthosts It provides the latest playbook result for each host name. Under the hood, it implements the machinery for updating the latest host every time a host is created or deleted and includes a SQL migration to initially populate a new database table with the latest hosts. - Added a `delegated_to` field to results in order to record a host id to which a task has been delegated. - Added support for finding results delegated to a specific host: /api/v1/results?delegated_to=<host_id> Callback plugin --------------- - Fixed tasks and results being recorded out of order when using "strategy: free" (ansible-community#260) - Added support for recording 'delegate_to' on tasks Documentation ------------- - Removed an unused sphinx lexer to allow recent versions of sphinx>=4 - Created a new troubleshooting guide with common issues: https://ara.readthedocs.io/en/latest/troubleshooting.html - Added a database relationship graph to the endpoint documentation: https://ara.readthedocs.io/en/latest/api-documentation.html#relationship-between-objects Upgrade notes ------------- It is always recommended to take a backup of your database before upgrading. This release includes two database migrations that must be run: - One for populating the data for the new /api/v1/latesthosts endpoint as well as the new 'hosts' page - One for adding a `delegated_to` field in the results. Note that delegated tasks will only be recorded as such from 1.5.7 on. After upgrading to 1.5.7, database migrations can be run manually with the `ara-manage migrate` command if they are not taken care of automatically by the callback plugin. Known issues ------------ ara will not record task delegation for tasks that are skipped or for items in a loop that are skipped because Ansible doesn't provide the necessary information in those cases.
1.5.7rc5 This is the fifth release candidate for the 1.5.7 stable release of ara. It features a new "hosts" page to browse and search playbook reports by host as well as fixes and improvements. Instructions for upgrading are included in the upgrade notes. Changes since 1.5.7rc4: - Removed source files that were not intended to be packaged in the release tarball - Made delegated_to field optional to provide backwards compatibility with the ara callback plugin from previous versions. - Added a title with explanations over 'Include all playbook reports' Changes since 1.5.6: UI -- - Added a new "hosts" page to browse and search reports by host name - Improved page HTML titles to be dynamic based on the context - Added a note highlighting if a task has been delegated to another host (ansible-community#282) - Improved how long file paths or playbook names are truncated and displayed API --- - Added a new read-only API endpoint: /api/v1/latesthosts It provides the latest playbook result for each host name. Under the hood, it implements the machinery for updating the latest host every time a host is created or deleted and includes a SQL migration to initially populate a new database table with the latest hosts. - Added a `delegated_to` field to results in order to record a host id to which a task has been delegated. - Added support for finding results delegated to a specific host: /api/v1/results?delegated_to=<host_id> Callback plugin --------------- - Fixed tasks and results being recorded out of order when using "strategy: free" (ansible-community#260) Documentation ------------- - Removed an unused sphinx lexer to allow recent versions of sphinx>=4 - Created a new troubleshooting guide with common issues: https://ara.readthedocs.io/en/latest/troubleshooting.html - Added a database relationship graph to the endpoint documentation: https://ara.readthedocs.io/en/latest/api-documentation.html#relationship-between-objects Upgrade notes ------------- It is always recommended to take a backup of your database before upgrading. This release includes two database migrations that must be run: - One for populating the data for the new /api/v1/latesthosts endpoint as well as the new 'hosts' page - One for adding a `delegated_to` field in the results. Note that delegated tasks will only be recorded as such from 1.5.7 on. After upgrading to 1.5.7, database migrations can be run manually with the `ara-manage migrate` command if they are not taken care of automatically by the callback plugin.
1.5.7rc4 This is the fourth release candidate for the 1.5.7 stable release of ara. It features a new "hosts" page to browse and search playbook reports by host as well as fixes and improvements. Instructions for upgrading are included in the upgrade notes. Changes since 1.5.7rc3: - Skip recording delegated_to for skipped items in task loops, the value of delegated_to can erroneously be returned as a variable due to an Ansible bug. Changes since 1.5.6: UI -- - Added a new "hosts" page to browse and search reports by host name - Improved page HTML titles to be dynamic based on the context - Added a note highlighting if a task has been delegated to another host (ansible-community#282) - Improved how long file paths or playbook names are truncated and displayed API --- - Added a new read-only API endpoint: /api/v1/latesthosts It provides the latest playbook result for each host name. Under the hood, it implements the machinery for updating the latest host every time a host is created or deleted and includes a SQL migration to initially populate a new database table with the latest hosts. - Added a `delegated_to` field to results in order to record a host id to which a task has been delegated. - Added support for finding results delegated to a specific host: /api/v1/results?delegated_to=<host_id> Callback plugin --------------- - Fixed tasks and results being recorded out of order when using "strategy: free" (ansible-community#260) Documentation ------------- - Removed an unused sphinx lexer to allow recent versions of sphinx>=4 - Created a new troubleshooting guide with common issues: https://ara.readthedocs.io/en/latest/troubleshooting.html - Added a database relationship graph to the endpoint documentation: https://ara.readthedocs.io/en/latest/api-documentation.html#relationship-between-objects Upgrade notes ------------- It is always recommended to take a backup of your database before upgrading. This release includes two database migrations that must be run: - One for populating the data for the new /api/v1/latesthosts endpoint as well as the new 'hosts' page - One for adding a `delegated_to` field in the results. Note that delegated tasks will only be recorded as such from 1.5.7 on. After upgrading to 1.5.7, database migrations can be run manually with the `ara-manage migrate` command if they are not taken care of automatically by the callback plugin.
PreviousNext