===================
REST API
--------
Features
~~~~~~~~
- Introduce new worker style. (tech-preview)
:redmine:`8501`
- Added new endpoint ``/pulp/api/v3/orphans/cleanup/``. When called with ``POST`` and no parameters
it is equivalent to calling ``DELETE /pulp/api/v3/orphans/``. Additionally the optional parameter
``content_hrefs`` can be specified and must contain a list of content hrefs. When ``content_hrefs``
is specified, only those content units will be considered to be removed by orphan cleanup.
:redmine:`8658`
- Content app responses are now smartly cached in Redis.
:redmine:`8805`
- Downloads from remote sources will now be retried on more kinds of errors, such as HTTP 500 or socket errors.
:redmine:`8881`
- Add a correlation id filter to the task list endpoint.
:redmine:`8891`
- Where before ``download_concurrency`` would previously be set to a default value upon creation, it will now be set NULL (but a default value will still be used).
:redmine:`8897`
- Added graceful shutdown to pulpcore workers.
:redmine:`8930`
- Activate the new task worker type by default.
.. warning::
If you intend to stick with the old tasking system, you should configure the
``USE_NEW_WORKER_TYPE`` setting to false before upgrade
:redmine:`8948`
Bugfixes
~~~~~~~~
- Fixed race condition where a task could clean up reserved resources shared with another task.
:redmine:`8637`
- Altered redirect URL escaping, preventing invalidation of signed URLs for artifacts using cloud storage.
:redmine:`8670`
- Add an update row lock on in task dispatching for ``ReservedResource`` to prevent a race where an
object was deleted that was supposed to be reused. This prevents a condition where tasks ended up in
waiting state forever.
:redmine:`8708`
- Retry downloads on ``ClientConnectorSSLError``, which appears to be spuriously returned by some CDNs.
:redmine:`8867`
- Fixed OpenAPI schema tag generation for resources that are nested more than 2 levels.
This change is most evident in client libraries generated from the OpenAPI schema.
Prior to this change, the API client for a resource located at
`/api/v3/pulp/exporters/core/pulp/<uuid>/exports/` was named `ExportersCoreExportsApi`.
After this change, the API client for a resource located at
`/api/v3/pulp/exporters/core/pulp/<uuid>/exports/` is named `ExportersPulpExportsApi`.
:redmine:`8868`
- Fixed request schema for ``/pulp/api/v3/repair/``, which did identify any arguments. This also fixes
the bindings.
:redmine:`8869`
- Update default access policies in the database if they were unmodified by the administrator.
:redmine:`8883`
- Pinning to psycopg2 < 2.9 as psycopg 2.9 doesn't work with django 2.2. More info at
https://github.com/django/django/commit/837ffcfa681d0f65f444d881ee3d69aec23770be.
:redmine:`8926`
- Fixed bug where artifacts and content were not always saved in Pulp with each
on_demand request serviced by content app.
:redmine:`8980`
Improved Documentation
~~~~~~~~~~~~~~~~~~~~~~
- Fixed a number of link-problems in the installation/ section of docs.
:redmine:`6837`
- Added a troubleshooting section to the docs explaining how to find stuck tasks.
:redmine:`8774`
- Moved existing basic auth docs to a new top-level section named Authentication.
:redmine:`8800`
- Moved ``Webserver Authentication`` docs under the top-level ``Authentication`` section.
:redmine:`8801`
- Provide instructions to use Keycloak authenication using Python Social Aauth
:redmine:`8803`
- Updated the docs.pulpproject.org to provide some immediate direction for better user orientation.
:redmine:`8946`
- Separated hardware and Filesystem information from the Architecture section and added them to the Installation section.
:redmine:`8947`
- Added sub-headings and simplified language of Pulp concept section.
:redmine:`8949`
Deprecations
~~~~~~~~~~~~
- Deprecated the ``DELETE /pulp/api/v3/orphans/`` call. Instead use the
``POST /pulp/api/v3/orphans/cleanup/`` call.
:redmine:`8876`
Misc
~~~~
- :redmine:`8821`, :redmine:`8827`, :redmine:`8975`
Plugin API
----------
Features
~~~~~~~~
- Added the ``pulpcore.plugin.viewsets.DistributionFilter``. This should be used instead of
``pulpcore.plugin.viewsets.NewDistributionFilter``.
:redmine:`8480`
- Added ``user_hidden`` field to ``Repository`` to hide repositories from users.
:redmine:`8487`
- Added a ``timestamp_of_interest`` field to Content and Artifacts. This field can be updated by
calling a new method ``touch()`` on Artifacts and Content. Plugin writers should call this method
whenever they deal with Content or Artifacts. For example, this includes places where Content is
uploaded or added to Repository Versions. This will prevent Content and Artifacts from being cleaned
up when orphan cleanup becomes a non-blocking task in pulpcore 3.15.
:redmine:`8823`
- Exposed ``AsyncUpdateMixin`` through ``pulpcore.plugin.viewsets``.
:redmine:`8844`
- Added a field ``DEFAULT_MAX_RETRIES`` to the ``Remote`` base class - plugin writers can override the default number of retries attempted when file downloads failed for each type of remote. The default value is 3.
:redmine:`8881`
- Added a field ``DEFAULT_DOWNLOAD_CONCURRENCY`` to the Remote base class - plugin writers can override the number of concurrent downloads for each type of remote. The default value is 10.
:redmine:`8897`
Bugfixes
~~~~~~~~
- Fixed OpenAPI schema tag generation for resources that are nested more than 2 levels.
This change is most evident in client libraries generated from the OpenAPI schema.
Prior to this change, the API client for a resource located at
`/api/v3/pulp/exporters/core/pulp/<uuid>/exports/` was named `ExportersCoreExportsApi`.
After this change, the API client for a resource located at
`/api/v3/pulp/exporters/core/pulp/<uuid>/exports/` is named `ExportersPulpExportsApi`.
:redmine:`8868`
Removals
~~~~~~~~
- The usage of non-JSON serializable types of ``args`` and ``kwargs`` to tasks is no longer supported.
``uuid.UUID`` objects however will silently be converted to ``str``.
:redmine:`8501`
- Removed the ``versions_containing_content`` method from the
`pulpcore.plugin.models.RepositoryVersion`` object. Instead use
``RepositoryVersion.objects.with_content()``.
:redmine:`8729`
- Removed `pulpcore.plugin.stages.ContentUnassociation` from the plugin API.
:redmine:`8827`
Deprecations
~~~~~~~~~~~~
- The ``pulpcore.plugin.viewsets.NewDistributionFilter`` is deprecated and will be removed from a
future release. Instead use ``pulpcore.plugin.viewsets.DistributionFilter``.
:redmine:`8480`
- Deprecate the use of the `reserved_resources_record__resource` in favor of `reserved_resources_record__contains`.
Tentative removal release is pulpcore==3.15.
:redmine:`8501`
- Plugin writers who create custom downloaders by subclassing ``HttpDownloader`` no longer need to wrap the ``_run()`` method with a ``backoff`` decorator. Consequntly the ``http_giveup`` handler the sake of the ``backoff`` decorator is no longer needed and has been deprecated. It is likely to be removed in pulpcore 3.15.
:redmine:`8881`