Warning
Until Role-Based Access Control is added to Pulp, REST API is not safe for multi-user use.
Sensitive credentials can be read by any user, e.g. Remote.password
, Remote.client_key
.
- Added two views to identify content which belongs to repository_version or publication. #4832
- Added repository field to repository version endpoints. #6068
- Added ability for users to limit how many repo versions Pulp retains by setting
retained_versions
on repository. #8368 - Added the
add-signing-service
management command. Notice that it is still in tech-preview and can change without further notice. #8609 - Added a
pulpcore-worker
entrypoint to simplify and unify the worker command. #8721 - Content app auto-distributes latest publication if distribution's
repository
field is set #8760
- Fixed cleanup of UploadChunks when their corresponding Upload is deleted. #7316
- Fixed an issue that caused the request's context to be ignored in the serializers. #8396
- Fixed missing
REDIS_SSL
parameter in RQ config. #8525 - Fixed bug where using forms submissions to create resources (e.g.
Remotes
) raised exception about the format ofpulp_labels
. #8541 - Fixed bug where publications sometimes fail with the error '[Errno 39] Directory not empty'. #8595
- Handled a tasking race condition where cleaning up resource reservations sometimes raised an IntegrityError. #8603
- Fixed on-demand sync/migration of repositories that don't have sha256 checksums. #8625
- Taught pulp-export to validate chunk-size to be <= 1TB. #8628
- Addressed a race-condition in PulpImport that could fail with unique-constraint violations. #8633
- Content app now properly lists all distributions present #8636
- Fixed ability to specify custom headers on a Remote. #8689
- Fixed compatibility with Django 2.2 LTS. Pulp now requires Django~=2.2.23 #8691
- Skip allowed content checks on collectstatic #8711
- Fixed a bug in the retained versions code where content wasn't being properly moved to newer repo versions when old versions were cleaned up. #8793
- Added docs on how to list the effective settings using
dynaconf list
. #6235 - Added anti-instructions, that users should never run pulpcore-manager makemigrations`, but file a bug instead. #6703
- Clarified repositories are typed in concepts page #6990
- Added UTF-8 character set encoding as a requirement for PostgreSQL #7019
- Fixed typo s/comtrol/control #7715
- Removed the PUP references from the docs. #7747
- Updated plugin writers' guide to not use settings directly in the model fields. #7776
- Make the reference to the Pulp installer documentation more explicit. #8477
- Removed example Ansible installer playbook from the pulpcore docs so that Pulp users would have a single source of truth in the pulp-installer docs. #8550
- Added security disclosures ref to homepage #8584
- Add sequential steps for storage docs #8597
- Updated signing service workflow. Removed old deprecation warning. #8609
- Add an example of how to specify an array value and a dict key in the auth methods section #8668
- Fixed docs build errors reported by autodoc. #8784
- Undeprecated the use of
uuid.UUID
in task arguments. With this, primary keys do not need to be explicitely cast tostr
. #8723
- Added RepositoryVersionRelatedField to the plugin API. #8578
- Fixed auto-distribute w/ retained_versions tests #8792
- Removed deprecated
pulpcore.plugin.tasking.WorkingDirectory
. #8354 - Removed
BaseDistribution
,PublicationDistribution
, andRepositoryVersionDistribution
models. RemovedBaseDistributionSerializer
,PublicationDistributionSerializer
, andRepositoryVersionDistributionSerializer
serializers. RemovedBaseDistributionViewSet
andDistributionFilter
. #8386 - Removed
pulpcore.plugin.tasking.enqueue_with_reservation
. #8497
- RepositoryVersion method "versions_containing_content" is deprecated now. #4832
- The usage of the pulpcore.plugin.stages.ContentUnassociation stage has been deprecated. A future update will remove it from the plugin API. #8635
- Backported a fix for on-demand sync/migration of repositories that don't have sha256 checksums. #8652
No significant changes.
No significant changes.
- Added RepositoryVersionRelatedField to the plugin API. #8580
- Add support for automatic publishing and distributing. #7626
- Add a warning at startup time if there are remote artifacts with checksums but no allowed checksums. #7985
- Added support in content app for properly handling unknown or forbidden digest errors. #7989
- Added sync check that raises error when only forbidden checksums are found for on-demand content. #8423
- Added ability for users to delete repo version 0 as long as they still have at least one repo version for their repo. #8454
- Added asynchronous tasking to the Update and Delete endpoints of PulpExporter to provide proper locking on resources. #7438
- Fixed a scenario where canceled tasks could be marked failed. #7980
- Taught
PulpImport
correct way to find and importRepositoryVersions
. Previous implementation only worked forRepositoryVersions
that were the 'current' version of the exportedRepository
. #8116 - Fixed a race condition that sometimes surfaced during handling of reserved resources. #8352
- Made digest and size sync erros more helpful by logging url of the requested files. #8357
- Fixed artifact-stage to handle an edge-case when multiple multi-artifact content, from different remotes, is in a single batch. #8377
- Fixed Azure artifacts download. #8427
- Fixed bug during sync where a unique constraint violation for
Content
would raise an "X matching query does not exist" error. #8430 - Fix artifact checksum check to not check on-demand content. #8445
- Fixed a bug where the existence of PublishedMetadata caused
LookupError
when querying/pulp/api/v3/content/
#8447 - Distributions are now viewable again at the base url of the content app #8475
- Fixed a path in artifact_stages that could lead to sync-failures in pulp_container. #8489
- Update docs with guide how to change 'ALLOWED_CONTENT_CHECKSUMS' setting using 'pulpcore-manager handle-artifact-checksums --report' if needed. #8325
- The Update and Delete endpoints of Exporters changed to now return 202 with tasks. #7438
- Deprecation warnings are now being logged by default if the log level includes WARNING. This can be
disabled by adjusting the log level of
pulpcore.deprecation
. See the deprecation docs for more information. #8499
Added a new callback method to
Repository
namedon_new_version()
, which runs when a new repository version has been created. This can be used for e.g. automatically publishing or distributing a new repository version after it has been created. #7626Added url as optional argument to
DigestValidationError
andSizeValidationError
exceptions to log urls in the exception message. #8357Added the following new objects related to a new
Distribution
MasterModel: *pulpcore.plugin.models.Distribution
- A new MasterModelDistribution
which replaces thepulpcore.plugin.models.BaseDistribution
. This now contains therepository
,repository_version
, andpublication
fields on the MasterModel instead of on the detail models as was done withpulpcore.plugin.models.BaseDistribution
.pulpcore.plugin.serializer.DistributionSerializer
- A serializer plugin writers should use with the newpulpcore.plugin.models.Distribution
.pulpcore.plugin.viewset.DistributionViewSet
- The viewset that replaces the deprecatedpulpcore.plugin.viewset.BaseDistributionViewSet
.pulpcore.plugin.viewset.NewDistributionFilter
- The filter that pairs with theDistribution
model.
Added checksum type enforcement to
pulpcore.plugin.download.BaseDownloader
. #8435Adds the
pulpcore.plugin.tasking.dispatch
interface which replaces thepulpcore.plugin.tasking.enqueue_with_reservation
interface. It is the same except: * It returns apulpcore.plugin.models.Task
instead of an RQ object * It does not support theoptions
keyword argumentAdditionally the
pulpcore.plugin.viewsets.OperationPostponedResponse
was updated to support both thedispatch
andenqueue_with_reservation
interfaces. #8496
- Allow plugins to unset the
queryset_filtering_required_permission
attribute inNamedModelViewSet
. #8438
- Removed checksum type filtering from
pulpcore.plugin.models.Remote.get_downloader
andpulpcore.plugin.stages.DeclarativeArtifact.download
. #8435
The following objects were deprecated: *
pulpcore.plugin.models.BaseDistribution
-- Instead usepulpcore.plugin.models.Distribution
.pulpcore.plugin.viewset.BaseDistributionViewSet
-- Instead usepulpcore.plugin.viewset.DistributionViewSet
.pulpcore.plugin.serializer.BaseDistributionSerializer
-- Instead usepulpcore.plugin.serializer.DistributionSerializer
.pulpcore.plugin.serializer.PublicationDistributionSerializer
-- Instead use define thepublication
field directly on your detail distribution object. See the docstring forpulpcore.plugin.serializer.DistributionSerializer
for an example.pulpcore.plugin.serializer.RepositoryVersionDistributionSerializer
-- Instead use define therepository_version
field directly on your detail distribution object. See the docstring forpulpcore.plugin.serializer.DistributionSerializer
for an example.pulpcore.plugin.viewset.DistributionFilter
-- Instead usepulpcore.plugin.viewset.NewDistributionFilter
.
Note
You will have to define a migration to move your data from
pulpcore.plugin.models.BaseDistribution
topulpcore.plugin.models.Distribution
. See the pulp_file migration 0009 as a reference example.Deprecated the
pulpcore.plugin.tasking.enqueue_with_reservation
. Instead use thepulpcore.plugin.tasking.dispatch
interface. #8496The usage of non-JSON serializable types of
args
andkwargs
to tasks is deprecated. Future releases of pulpcore may discontinue accepting complex argument types. Note, UUID objects are not JSON serializable. A deprecated warning is logged if a non-JSON serializable is used. #8505
- Skip allowed content checks on collectstatic (backported from #8711) #8712
- Fixed cleanup of UploadChunks when their corresponding Upload is deleted. (backported from #7316) #8757
- Fixed compatibility with Django 2.2 LTS. Pulp now requires Django~=2.2.23 (backported from #8691) #8758
- Pinned click~=7.1.2 to ensure RQ is compatible with it. #8767
No significant changes.
- Fixed a race condition that sometimes surfaced during handling of reserved resources. #8632
- Handled a tasking race condition where cleaning up resource reservations sometimes raised an IntegrityError. #8648
- Allow plugins to unset the
queryset_filtering_required_permission
attribute inNamedModelViewSet
. #8444
- Raise error when syncing content with a checksum not included in
ALLOWED_CONTENT_CHECKSUMS
. #7854 - User can evaluate how many content units are affected with checksum type change with 'pulpcore-manager handle-artifact-checksums --report'. #7986
- The fields
proxy_username
andproxy_password
have been added to remotes. Credentials can no longer be specified as part of theproxy_url
. A data migration will move the proxy auth information on existing remotes to the new fields. #8167 - Added the
WORKER_TTL
setting, that specifies the interval a worker is considered missing after its last heartbeat. #8291 - Due to the removal of
md5
andsha1
from theALLOWED_CONTENT_CHECKSUMS
setting, every system that had any Artifacts synced in in prior to 3.11 will have to run thepulpcore-manager handle-content-checksums
command. A data migration is provided with 3.11 that will run this automatically as part of thepulpcore-manager migrate
command all upgrades must run anyway. #8322
Fixed a bug experienced by the migration plugin where all content objects are assumed to have a remote associated with them. #7876
Restored inadvertently-changed content-guards API to its correct endpoint.
In the process of adding generic list-endpoints, the /pulp/api/v3/contentguards API was inadvertently rehomed to /pulp/api/v3/content_guards. This change restores it to its published value. #8283
Added headers field to the list of fields in the
RemoteSerializer
base class and marked it optional to make it accessible via the REST api. #8330Fixed AccessPolicy AttributeError. #8395
Removed correlation id feature from tech preview. #7927
Removed 'tech preview' label from
handle-artifact-checksums
command.handle-artifact-checksums
is now a fully-supported part of Pulp3. #7928Added a warning banner to the
ALLOWED_CONTENT_CHECKSUMS
setting section indicating the setting is not fully enforcing inpulpcore
code and various plugins. #8342
- The
component
field of theversions
section of the status API`/pulp/api/v3/status/
now lists the Django app name, not the Python package name. Similarly the OpenAPI schema at/pulp/api/v3
does also. #8198 - Removed sensitive fields
username
,password
, andclient_key
from Remote responses. These fields can still be set and updated but will no longer be readable. #8202 - Adjusted the
ALLOWED_CONTENT_CHECKSUMS
setting to removemd5
andsha1
since they are insecure. Now, by default, theALLOWED_CONTENT_CHECKSUMS
containsha224
,sha256
,sha384
, andsha512
. #8246
- Allow developers to use more than one WorkingDirectory() within a task, including nested calls. Tasks will also now use a temporary working directory by default. #7815
- Added the
pulpcore.app.pulp_hashlib
module which provides thenew
function and ensures only allowed hashers listed inALLOWED_CONTENT_CHECKSUMS
can be instantiated. Plugin writers should use this instead ofhashlib.new
to generate checksum hashers. #7984 - Add a
get_content
method topulpcore.plugin.models.RepositoryVersion
that accepts a queryset and returns a list of content in that repository using the given queryset. This allows for specific content type to be returned by executingrepo_version.get_content(content_qs=MyContentType.objects)
. #8375
- Added docs identifying plugin writers to use the
pulpcore.app.pulp_hashlib
module which provides thenew
function and ensures only allowed hashers can be instantiated. This should be used in place ofhashlib.new
. #7984 - The use of
tempdir.TemporaryDirectory
in tasks has been documented. #8231
- Adjusted the
ALLOWED_CONTENT_CHECKSUMS
setting to removemd5
andsha1
since they are insecure. Now, by default, theALLOWED_CONTENT_CHECKSUMS
containsha224
,sha256
,sha384
, andsha512
. #8246 - Removed unused get_plugin_storage_path method. #8343
- It is not longer possible to address AccessPolicy via the viewset's classname. Viewset's urlpattern should be used instead. #8397
- Removed deprecated key field returned by the signing service. Plugin writers must now refer directly to the public_key field on the signing service object. #8398
pulpcore.plugin.tasking.WorkingDirectory
has been deprecated. #8231
Change the default deployment layout
This changes the default deployment layout. The main change is that MEDIA_ROOT gets its own directory. This allows limiting the file permissions in a shared Pulp 2 + Pulp 3 deployment and the SELinux file contexts. Another benefit is compatibility with django_extensions' unreferenced_files command which lists all files in MEDIA_ROOT that are not in the database.
Other paths are kept on the same absolute paths. The documentation is updated to show the latest best practices. #7178
Added general endpoints to list
Content
,ContentGuards
, andRepositories
. #7204Added /importers/core/pulp/import-check/ to validate import-parameters. #7549
Added a new field called public_key to SigningService. This field preserves the value of the public key. In addition to that, the field fingerprint was introduced as well. This field identifies the public key. #7700
Added possibility to filter users and groups by various fields. #7975
Added pulp_labels to allow users to add key/value data to objects. #8065
Added
pulp_label_select
filter to allow users to filter by labels. #8067Added optional headers field to the aiohttp ClientSession. #8083
Allow querying names on the api using name__icontains, name__contains and name__startswith query parameters. #8094
Added RBAC to the endpoint for managing groups. #8159
Added RBAC to the endpoint for managing group users. #8160
Added the
AccessPolicy.customized
field which ifTrue
indicates a user has modified the default AccessPolicy. #8182Added filtering for access policies. #8189
As an authenticated user I can create and view artifacts. #8193
- Fixed bug where duplicate artifact error message was nondeterministic in displaying different error messages with different checksum types. Also, updated duplicate artifact error message to be more descriptive. #3387
- Fixed Pulp import/export bug that occurs when sha384 or sha512 is not in
ALLOWED_CONTENT_CHECKSUMS
. #7836 - X-CSRFToken is not sent through ajax requests (PUT) in api.html. Fixed by setting the right value in the JS code. #7888
- Provide a mechanism to automatically resolve issues and prevent deadlocks when Redis experiences data loss (such as a restart). #7912
- Silence unnecessary log messages from django_guid which were spamming up the logs. #7982
- Changed the default permission class to
IsAdminUser
to protect endpoints not yet guarded by an access policy from users without permission. #8018 - Fixed apidoc bug, where model and object permissions on groups overlapped. #8033
- Fixed the viewset_name used by access policy for the cases when parent_viewset is involved. #8152
- Made the viewset_name property of access policies read only. #8185
- Added a description of the common filesystem layout in the deployment section. #7750
- Updated the reference to the new location of pulplift at the installer repository in the development section. #7878
- Add links to plugin docs into docs.pulpproject.org. #8131
- Added documentation for labels. #8157
- Add
rate_limit
option toRemote
#7965 - Made DistributionFilter accessible to plugin writers. #8059
- Adding
Label
andLabelSerializer
to the plugin api. #8065 - Added
LabelSelectFilter
to filter resources by labels. #8067 - Added ReadOnlyRepositoryViewset to the plugin API. #8103
- Added NAME_FILTER_OPTIONS to the plugin API to gain more consistency across plugins when filter by name or similar CharFields. #8117
- Added has_repo_attr_obj_perms and has_repo_attr_model_or_obj_perms to the global access checks available to all plugins to use. #8161
- Plugins are required to define a
version
attribute on their subclass ofPulpPluginAppConfig
. Starting with pulpcore==3.10, if undefined while Pulp loads, Pulp will refuse to start. #7930 - Changed the default permission class to from
IsAuthenticated
toIsAdminUser
. Any endpoints that should be accessible by all known to the system users need to specify the permission_classes accordingly. #8018 pulpcore.plugin.models.UnsupportedDigestValidationError
has been removed. Plugins should look for this atpulpcore.plugin.exceptions.UnsupportedDigestValidationError
instead. #8169
- Access to the path of the public key of a signing service was deprecated. The value of the public
key is now expected to be saved in the model instance as
SigningService.public_key
. #7700 - The
pulpcore.plugin.storage.get_plugin_storage_path()
method has been deprecated. #7935
- CHUNKED_UPLOAD_DIR was converted to a relative path inside MEDIA_ROOT. #8099
No significant changes.
Made uploaded chunks to be stored as separate files in the default storage. This feature removes the need for a share storage of pulp api nodes, as the chunks are now stored individually in the shared storage and are therefore accessible by all nodes. #4498
Add support for logging messages with a correlation id that can either be autogenerated or passed in with a
Correlation-ID
header. This feature is provided as a tech preview in pulpcore 3.9. #4689Added progress reporting for pulp imports. #6559
Exposed
aiohttp.ClientTimeout
fields inRemote
asconnect_timeout
,sock_connect_timeout
,sock_read_timeout
, andtotal_timeout
.This replaces the previous hard-coded 600 second timeout for sock_connect and sock_read, giving per-
Remote
control of all fourClientTimeout
fields to the user. #7201Enabled users to add checksums to ALLOWED_CONTENT_CHECKSUMS by allowing them to populate checksums with handle-artifact-checksums command. #7561
Added version information to api docs. #7569
Made signing services to be immutable. This requires content signers to create a new signing service explicitly when a change occurs. #7701
Added support for repairing Pulp by detecting and redownloading missing or corrupted artifact files. Sending a POST request to
/pulp/api/v3/repair/
will trigger a task that scans all artifacts for missing and corrupted files in Pulp storage, and will attempt to redownload them from the original remote. Specifyingverify_checksums=False
when POSTing to the same endpoint will skip checking the hashes of the files (corruption detection) and will instead just look for missing files.The
verify_checksums
POST parameter was added to the existing "repository version repair" endpoint as well. #7755Added check to prevent Pulp to start if there are Artifacts with forbidden checksums. #7914
- Fixed a serious bug data integrity bug where some Artifact files could be silently deleted from storage in specific circumstances. #7676
- Moved the initial creation of access_policies to post_migrate signal. This enforces their existance both with migrate and flush. #7710
- Fixed incremental export to happen if start_version provided, even if last_export is null. #7716
- Fixed a file descriptor leak during repository version repair operations. #7735
- Fixed bug where exporter directory existed and was writable but not owned by worker process and thus not chmod-able. #7829
- Properly namespaced the viewset_name in AccessPolicy to avoid naming conflicts in plugins. #7845
- Update jquery version from 3.3.1 to 3.5.1 in API.html template. It is the version provided by djangorestframework~=3.12.2 #7850
- Prevented a Redis failure scenario from causing the tasking system to back up due to "tasking system locks" not being released, even on worker restart. #7907
- Use subclassed plugin downloaders during the pulp repair. #7909
- Added requirement to record a demo with PRs of substantial change. #7703
- Removed outdated reference stating Pulp did not have an SELinux policy. #7793
- The local file system directory used for uploaded chunks is specified by the setting CHUNKED_UPLOAD_DIR. Users are encouraged to remove all uncommitted uploaded files before applying this change. #4498
- Added pre_save hook to Artifact to enforce checksum rules implied by ALLOWED_CONTENT_CHECKSUMS. #7696
- Enabled plugin writers to retrieve a request object from a serializer when look ups are performed from within the task serializer. #7718
- Expose ProgressReportSerializer through pulpcore.plugin #7759
- Allowed plugin writers to access the models Upload and UploadChunk #7833
- Exposed
pulpcore.plugin.constants.ALL_KNOWN_CONTENT_CHECKSUMS
. #7897 - Added
UnsupportedDigestValidationError
topulpcore.plugins.exceptions
. Going forward, plugin authors can expect to find all unique exceptions underpulpcore.plugin.exceptions
. #7908
Plugins are encouraged to define a
version
attribute on their subclass ofPulpPluginAppConfig
. If undefined while Pulp loads a warning is now shown to encourage plugin writers to implement this attribute, which will be required starting in pulpcore==3.10. #6671Using the ViewSet's classname to identify its AccessPolicy has been deprecated and is slated for removal in 3.10. Instead the urlpattern is supposed to be used.
Plugins with existing AccessPolicies should add a data migration to rename their AccessPolicies:
- ::
access_policy = AccessPolicy.get(viewset_name="MyViewSet") access_policy.viewset_name = "objectclass/myplugin/myclass" access_policy.save()
The
pulpcore.plugin.models.UnsupportedDigestValidationError
is being deprecated and will be removed in 3.10.It can now be found at
pulpcore.plugin.exceptions.UnsupportedDigestValidationError
instead; please change any code that imports it to access it from its new location. #7908
- Fixed a serious bug data integrity bug where some Artifact files could be silently deleted from storage in specific circumstances. (Backported from https://pulp.plan.io/issues/7676) #7758
No significant changes.
- Added check to prevent users from adding checksums to
ALLOWED_CONTENT_CHECKSUMS
if there are Artifacts without those checksums. #7487 - Django admin site URL is configurable via ADMIN_SITE_URL settings parameter. #7637
- Always set a default for DJANGO_SETTINGS_MODULE. This means the services files don't need to. #7720
- Fix a warning inappropriately logged when cancelling a task. #4559
- When a task is canceled, we now set the state of all incomplete "progress reports" to canceled as well. #4921
- Properly handle duplicate content during synchronization and migration from Pulp 2 to 3. #7147
- Enable content streaming for RepositoryVersionDistribution #7568
- Change dropped DRF filter to django urlize. #7634
- Added some more files to MANIFEST.in. #7656
- Updated dynaconf requirement to prevent use of older buggy versions. #7682
- Updated examples of auto-distribution. #5247
- Improved testing section in Pulp contributor docs. Mentioned prestart, pminio, pfixtures and phelp. #7475
- Fix an erroneous API endpoint in the "upload and publish" workflow documentation. #7655
- Documented that we don't support backporting migrations. #7657
- Removed mentions of semver in the plugin API docs, and replaced them with a link to the deprecation policy where appropriate. #7555
- Backported a fix for on-demand sync/migration of repositories that don't have sha256 checksums. #8651
No significant changes.
- Backported fixes for artifact handling important for pulp-2to3-migration plugin use cases. #8485
- Allowed to use PyYAML 5.4 which contains a patch for CVE-2020-14343. #8540
No significant changes.
- No longer load .env files. They are not used by Pulp but potentially can break the setup. #8373
No significant changes.
- Fixed a serious bug data integrity bug where some Artifact files could be silently deleted from storage in specific circumstances. (Backported from https://pulp.plan.io/issues/7676) #7757
No significant changes.
- Properly handle duplicate content during synchronization and migration from Pulp 2 to 3. #7702
- Fixed incremental export to happen if start_version provided, even if last_export is null. #7725
No significant changes.
- Including functest_requirements.txt on MANIFEST.in #7610
No significant changes.
- Added setting ALLOWED_CONTENT_CHECKSUMS to support limiting the checksum-algorithms Pulp uses. #5216
- Added progress-reports to the PulpExport task. #6541
- Improve performance and memory consumption of orphan cleanup. #6581
- Extra require: s3, azure, prometheus and test #6844
- Added the toc_info attribute with filename/sha256sum to PulpExport, to enable direct access to the export-TOC. #7221
- Taught export-process to clean up broken files if the export fails. #7246
- Added the django-cleanup handlers for removing files stored within FileField #7316
- Added deprecations section to the changelog. #7415
- Address some problems with stuck tasks when connection to redis is interrupted. #6449
- Fixed a bug where creating an incomplete repository version (via canceled or failed task) could cause future operations to fail. #6463
- Added validation for unknown serializers' fields #7245
- Fixed: PulpTemporaryFile stored in the wrong location #7319
- Fixed an edge case where canceled tasks might sometimes be processed and marked completed. #7389
- Fixed pulp-export scenario where specifying full= could fail silently. #7403
- Fixed OpenAPI creation response status code to 201 #7444
- The
AccessPolicy.permissions_assignment
can now be null, which some viewset endpoints may require. #7448 - Taught export to insure export-dir was writeable by group as well as owner. #7459
- Fixed orphan cleanup for subrepositories (e.g. an add-on repository in RPM distribution tree repository). #7460
- Fixed issue with reserved resources not being displayed for waiting tasks. #7497
- Fixed broken bindings resulting from drf-spectacular 0.9.13 release. #7510
- Fix filesystem exports failing due to undefinied
validate_path
method. #7521 - Fix a bug that prevented users from adding permissions for models have conflicting names across different django apps. #7541
- Added pulp 2 obsolete concepts (consumers, applicability). #6255
- Enabled the automatic removal of files, which are stored in FileField, when a corresponding model's delete() method is invoked #7316
- Add add_and_remove task to pulpcore.plugin.tasking #7351
- Added deprecations section to the plugin api changelog. #7415
- The
AccessPolicy.permissions_assignment
can now be null, which some viewset endpoints may require. #7448
- Added an example how to use a serializer to create validated objects. #5927
- Document the URLField OpenAPI issue #6828
- Added all exported models to the autogenerated API reference. #7045
- Updated docs recommending plugins to rely on a 1-release deprecation process for backwards
incompatible changes in the
pulpcore.plugin
. #7413 - Adds plugin writer docs on how to ship snippets which override default webserver routes provided by the installer. #7471
- Revises the "installation plugin custom tasks" documentation to reflect that plugin writers can contribute their custom installation needs directly to the installer. #7523
- Fixed a bug where creating an incomplete repository version (via canceled or failed task) could cause future operations to fail. (Backported from https://pulp.plan.io/issues/6463) #7737
No significant changes.
- Fixed broken bindings resulting from drf-spectacular 0.9.13 release. #7510
No significant changes.
No significant changes.
No significant changes.
- Remove customized operation_id from OrphansView #7446
- Fixing groups API validation #7329
- Fix custom operation_id's from OpenAPI #7341
- OpenAPI: do not discard components without properties #7347
Added table-of-contents to export and gave import a toc= to find/reassemble pieces on import. #6737
Added ability to associate a Remote with a Repository so users no longer have to specify Remote when syncing. #7015
The /pulp/api/v3/access_policies/ endpoint is available for reading and modifying the AccessPolicy used for Role Based Access Control for all Pulp endpoints. This allows for complete customization of the Authorization policies.
NOTE: this endpoint is in tech-preview and may change in backwards incompatible ways in the future. #7160
The /pulp/api/v3/access_policies/ endpoint also includes a permissions_assignment section which customizes the permissions assigned to new objects. This allows for complete customization for how new objects work with custom define Authorization policies. #7210
The /pulp/api/v3/users/ endpoint is available for reading the Users, Group membership, and Permissions.
NOTE: this endpoint is in tech-preview and may change in backwards incompatible ways in the future. #7231
The /pulp/api/v3/groups/ endpoint is available for reading the Groups, membership, and Permissions.
NOTE: this endpoint is in tech-preview and may change in backwards incompatible ways in the future. #7232
The /pulp/api/v3/tasks/ endpoint now provides a user-isolation behavior for non-admin users. This policy is controllable at the /pulp/api/v3/access_policies/ endpoint.
NOTE: The user-isolation behavior is in "tech preview" and production systems are recommended to continue using the build-in
admin
user only. #7301Extended endpoint /pulp/api/v3/groups/:pk/users to add and remove users from a group.
NOTE: this endpoint is in tech-preview and may change in backwards incompatible ways in the future. #7310
Extended endpoints /pulp/api/v3/groups/:pk/model_permissions and /pulp/api/v3/groups/:pk/object_permissions to add and remove permissions from a group.
NOTE: this endpoint is in tech-preview and may change in backwards incompatible ways in the future. #7311
- WorkerDirectory.delete() no longer recursively trys to delete itself when encountering a permission error #6504
- Stopped preventing removal of PulpExport/Exporter when last-export existed. #6555
- First time on demand content requests appear in the access log. #7002
- Fixed denial of service caused by extra slashes in content urls. #7066
- Set a default DJANGO_SETTINGS_MODULE env var in content app #7179
- Added plugin namespace to openapi href identifier. #7209
- By default, html in field descriptions filtered out in REST API docs unless 'include_html' is set. #7299
- Fixed plugin filtering in bindings to work independently from "bindings" parameter. #7306
- Made password variable consistent with Ansible installer example playbook #7065
- Fixed various docs bugs in the pulpcore docs. #7090
- Adds documentation about SSL configuration requirements for reverse proxies. #7285
- Fixed REST API docs. #7292
- Removed unnecessary fields from the import/export transfer. #6515
- Upgrading the api documentation from OpenAPI v2 to OpenAPI v3. - Methods signatures for bindings may change. #7108
- Changed default
download_concurrency
on Remotes from 20 to 10 to avoid connection problems. Also updated existing Remotes withdownload_concurrency
of 20 to 10. #7212
Adding PulpTemporaryFile for handling temporary files between the viewset and triggered tasks #6749
RepositorySyncURLSerializer
will now check remote on the repository before it raises an exception if the remote param is not set. #7015Added a hook on
Repository
calledartifacts_for_version()
that plugins can override to modify the logic behindRepositoryVersion.artifacts
. For now, this is used when exporting artifacts. #7021Enabling plugin writers to have more control on HttpDownloader response codes 400+ by subclassing HttpDownloader and overwriting raise_for_status method #7117
BaseModel now inherits from LifecycleModel provided by django-lifecycle allowing any subclass to also use it instead of signals. #7151
A new pulpcore.plugin.models.AutoDeleteObjPermsMixin object can be added to models to automatically delete all user and group permissions for an object just before the object is deleted. This provides an easy cleanup mechanism and can be added to models as a mixin. Note that your model must support django-lifecycle to use this mixin. #7157
A new model pulpcore.plugin.models.AccessPolicy is available to store AccessPolicy statements in the database. The model's statements field stores the list of policy statements as a JSON field. The name field stores the name of the Viewset the AccessPolicy is protecting.
Additionally, the pulpcore.plugin.access_policy.AccessPolicyFromDB is a drf-access-policy which viewsets can use to protect their viewsets with. See the :ref:`viewset_enforcement` for more information on this. #7158
Adds the TaskViewSet and TaskGroupViewSet objects to the plugin api. #7187
Enabled plugin writers to create immutable repository ViewSets #7191
A new pulpcore.plugin.models.AutoAddObjPermsMixin object can be added to models to automatically add permissions for an object just after the object is created. This is controlled by data saved in the permissions_assignment attribute of the pulpcore.plugin.models.AccessPolicy allowing users to control what permissions are created. Note that your model must support django-lifecycle to use this mixin. #7210
Added ability for plugin writers to set a
content_mapping
property on content resources to provide a custom mapping of content to repositories. #7252Automatically excluding
pulp_id
,pulp_created
, andpulp_last_updated
forQueryModelResources
. #7277Viewsets that subclass
pulpcore.plugin.viewsets.NamedModelViewSet` can declare the ``queryset_filtering_required_permission
class attribute naming the permission required to view an object. See the :ref:`queryset_scoping` documentation for more information. #7300
- Making operation_id unique #7233
- Making ReDoc OpenAPI summary human readable #7237
- OpenAPI schema generation from CLI #7258
- Allow pulpcore.plugin.models.AutoAddObjPermsMixin.add_for_object_creator to skip assignment of permissions if there is no known user. This allows endpoints that do not use authorization but still create objects in the DB to execute without error. #7312
- Omit a view/viewset from the OpenAPI schema #7133
- Added plugin writer docs for
BaseContentResource
. #7296
- Newlines in certificate string (ca_cert, client_cert, client_key) on Remotes are not required to be escaped. #6735
- Replaced drf-yasg with drf-spectacular. - This updates the api documentation to openapi v3. - Plugins may require changes. - Methods signatures for bindings may change. #7108
- Moving containers from pulpcore to pulp-operator #7171
- Added start_versions= to export to allow for arbitrary incremental exports. #6763
- Added GroupProgressReport to track progress in a TaskGroup. #6858
- Provide a user agent string with all aiohttp requests by default. #6954
- Fixed 'integer out of range' error during sync by changing RemoteArtifact size field to BigIntegerField. #6717
- Added a more descriptive error message that is shown when CONTENT_ORIGIN is not properly configured #6771
- Including requirements.txt on MANIFEST.in #6888
- Corrected a number of filters to be django-filter-2.3.0-compliant. #6915
- Locked Content table to prevent import-deadlock. #7073
- Updating installation docs #6836
- Fixed a number of typos in the import/export workflow docs. #6919
- Fixed docs which claim that admin user has a default password. #6992
- Fixed broken link to content plugins web page #7017
- Removes the Write models from the OpenAPI schema. Brings back the models that were accidentally removed from the OpenAPI schema in 3.4.0 release. #7087
- Views can specify the tag name with pulp_tag_name #6832
- Added GroupProgressReport to track progress in a TaskGroup. #6858
- Exported the symbols serializers.SingleContentArtifactField and files.PulpTemporaryUploadedFile. #7088
- Implemented incremental-exporting for PulpExport. #6136
- Added support for S3 and other non-filesystem storage options to pulp import/export functionality. #6456
- Optimized imports by having repository versions processed using child tasks. #6484
- Added repository type check during Pulp imports. #6532
- Added version checking to import process. #6558
- Taught PulpExport to export by RepositoryVersions if specified. #6566
- Task groups now have an 'all_tasks_dispatched' field which denotes that no more tasks will spawn as part of this group. #6591
- Taught export how to split export-file into chunk_size bytes. #6736
- Remote fields username and password show up in: REST docs, API responses, and are available in the bindings. #6346
- Fixed a bug, where the attempt to cancel a completed task lead to a strange response. #6465
- Fixed KeyError during OpenAPI schema generation. #6468
- Added a missing trailing slash to distribution's base_url #6507
- Fixed a bug where the wrong kind of error was being raised for href parameters of mismatched types. #6521
- containers: Fix pulp_rpm 3.3.0 install by replacing the python3-createrepo_c RPM with its build-dependencies, so createrep_c gets installed & built from PyPI #6523
- Fixed OpenAPI schema for importer and export APIs. #6556
- Normalized export-file-path for PulpExports. #6564
- Changed repository viewset to use the general_update and general_delete tasks. This fixes a bug where updating specialized fields of a repository was impossible due to using the wrong serializer. #6569
- Only uses multipart OpenAPI Schema when dealing with file fields #6702
- Fixed a bug that prevented write_only fields from being present in the API docs and bindings #6775
- Added proper headers for index.html pages served by content app. #6802
- Removed Content-Encoding header from pulpcore-content responses. #6831
- Adding docs for importing and exporting from Pulp to Pulp. #6364
- Add some documentation around TaskGroups. #6641
- Introduced a brief explanation about pulp_installer #6674
- Added a warning that the REST API is not safe for multi-user use until RBAC is implemented. #6692
- Updated the required roles names #6758
- Changed repositories field on
/pulp/api/v3/exporters/core/pulp/
from UUIDs to hrefs. #6457 - Imports now spawn child tasks which can be fetched via the
child_tasks
field of the import task. #6484 - Content of ssl certificates and keys changed to be return their full value instead of sha256 through REST API. #6691
- Replaced PulpExport filename/sha256 fields, with output_info_file, a '<filename>': '<hash>' dictionary. #6736
- Added new NoArtifactContentUploadSerializer and NoArtifactContentUploadViewSet to enable plugin writers to upload content without storing an Artifact #6281
- Added view_name_pattern to DetailRelatedField and DetailIdentityField to properly identify wrong resource types. #6521
- Added support for Distributions to provide non-Artifact content via a content_handler. #6570
- Added constants to the plugin API at
pulpcore.plugin.constants
. #6579 - TaskGroups now have an 'all_tasks_dispatched' field that can be used to notify systems that no further tasks will be dispatched for a TaskGroup. Plugin writers should call ".finish()" on all TaskGroups created once they are done using them to set this field. #6591
- Added
RemoteFilter
to the plugin API as it was missing but used by plugin_template. #6563
- Fields: username and password will be returned to the rest API user requesting a Remote #6346
- Rehomed QueryModelResource to pulpcore.plugin.importexport. #6514
- The :meth:`pulpcore.content.handler.Handler.list_directory` function now returns a set of strings where it returned a string of HTML before. #6570
- Fixed partial and general update calls for SecretCharField on the Remote. #6565
- Fixed bug where
TaskGroup
was showing up as null forcreated_resources
in tasks. #6573
- Add TaskGroup to the plugin API. #6603
- Added support for repairing a RepositoryVersion by redownloading corrupted artifact files.
Sending a POST request to
/pulp/api/v3/repositories/<plugin>/<type>/<repository-uuid>/versions/<version-number>/repair/
will trigger a task that scans all associated artfacts and attempts to fetch missing or corrupted ones again. #5613 - Added support for exporting pulp-repo-versions. POSTing to an exporter using the
/pulp/api/v3/exporters/core/pulp/<exporter-uuid>/exports/
API will instantiate a PulpExport entity, which will generate an export-tar.gz file at<exporter.path>/export-<export-uuid>-YYYYMMDD_hhMM.tar.gz
#6135 - Added API for importing Pulp Exports at
POST /importers/core/pulp/<uuid>/imports/
. #6137 - Added the new setting CHUNKED_UPLOAD_DIR for configuring a default directory used for uploads #6253
- Exported SigningService in plugin api #6256
- Added name filter for SigningService #6257
- Relationships between tasks that spawn other tasks will be shown in the Task API. #6282
- Added a new APIs for PulpExporters and Exports at
/exporters/core/pulp/
and/exporters/core/pulp/<uuid>/exports/
. #6328 - Added PulpImporter API at
/pulp/api/v3/importers/core/pulp/
. PulpImporters are used for importing exports from Pulp. #6329 - Added an
ALLOWED_EXPORT_PATHS
setting with list of filesystem locations that exporters can export to. #6335 - Indroduced ordering keyword, which orders the results by specified field. Pulp objects will by default be ordered by pulp_created if that field exists. #6347
- Task Groups added -- Plugin writers can spawn tasks as part of a "task group", which facilitates easier monitoring of related tasks. #6414
- Improved the overall performance while syncing very large repositories #6121
- Made chunked uploads to be stored in a local file system instead of a default file storage #6253
- Fixed 500 error when calling modify on nonexistent repo. #6284
- Fixed bug where user could delete repository version 0 but not recreate it by preventing users from deleting repo version 0. #6308
- Fixed non unique content units on content list #6347
- Properly sort endpoints during generation of the OpenAPI schema. #6372
- Improved resync performance by up to 2x with a change to the content stages. #6373
- Fixed bug where 'secret' fields would be set to the sha256 checksum of the original value. #6402
- Fixed pulp containers not allowing commands to be run via absolute path. #6420
- Documented bindings installation for a dev environment #6221
- Added documentation for how to write changelog messages. #6336
- Cleared up a line in the database settings documentation that was ambiguous. #6384
- Updated docs to reflect that S3/Azure are supported and no longer tech preview. #6443
- Added tech preview note to docs for importers/exporters. #6454
- Renamed ansible-pulp to pulp_installer (to avoid confusion with pulp-ansible) #6461
- Fixed missing terms in documentation. #6485
- Changing STATIC_URL from /static/ to /assets/ for avoiding conflicts #6128
- Exporting now requires the configuration of the
ALLOWED_EXPORT_PATHS
setting. Without this configuration, Pulp will not export content to the filesystem. #6335
- Tasks can now be spawned from inside other tasks, and these relationships can be explored via the "parent_task" field and "child_tasks" related name on the Task model. #6282
- Added a new Export model, serializer, and viewset. #6328
- Added models Import and Importer (as well as serializers and viewsets) that can be used for importing data into Pulp. #6329
- NamedModelViewSet uses a default ordering of -pulp_created using the StableOrderingFilter. Users using the ordering keyword will be the primary ordering used when specified. #6347
- Added two new repo validation methods (validate_repo_version and validate_duplicate_content). #6362
- enqueue_with_reservation() provides a new optional argument for "task_group". #6414
- Fixed bug where RepositoryVersion.artifacts returns None. #6439
- Add plugin writer docs on adding MANIFEST.in entry to include
webserver_snippets
in the Python package. #6249 - Updated the metadata signing plugin writers documentation. #6342
- Changed master model from FileSystemExporter to Exporter. Plugins will still need to extend FileSystemExporter but the master table is now core_exporter. This will require that plugins drop and recreate their filesystem exporter tables. #6328
- RepositoryVersion add_content no longer checks for duplicate content. #6362
No significant changes.
- Added a
pulpcore-manager
script that isdjango-admin
only configured withDJANGO_SETTINGS_MODULE="pulpcore.app.settings"
. This can be used for things like applying database migrations or collecting static media. #5859 - Resolve DNS faster with aiodns #6190
- Considering base version when removing duplicates #5964
- Renames /var/lib/pulp/static/ to /var/lib/pulp/assets/. #5995
- Disabled the trimming of leading and trailing whitespace characters which led to a situation where a hash of a certificate computed in Pulp was not equal to a hash generated locally #6025
- Repository.latest_version() considering deleted versions #6147
- Stopped HttpDownloader sending basic auth credentials to redirect location if domains don't match. #6227
- Updated docs to suggest to use
pulpcore-manager
command instead ofdjango-admin
directly. #5859
- Renaming Repository.last_version to Repository.next_version #6147
- Adding not equal lookup to model field filters. #5868
- Adds plugin writer docs on adding custom url routes and having the installer configure the reverse proxy to route them. #6209
- Content with duplicate repo_key_fields raises an error #5567
- Resolve content app errors
django.db.utils.InterfaceError: connection already closed
. #6045 - Fix a bug that could cause an inability to detect an invalid signing script during the validation #6077
- Fixing broken S3 redirect #6154
- Pin idna==2.8` to avoid a version conflict caused by the idna 2.9 release. #6169
- A new method
_reset_db_connection
has been added tocontent.Handler
. It can be called before accessing the db to ensure that the db connection is alive. #6045
- Allow administrators to add a signing service #5943
- Adds
pulpcore.app.authentication.PulpDoNotCreateUsersRemoteUserBackend
which can be used to verify authentication in the webserver, but will not automatically create users likedjango.contrib.auth.backends.RemoteUserBackend
does. #5949 - Allow Azure blob storage to be used as DEFAULT_FILE_STORAGE for Pulp #5954
- Allow to filter publications by
repository_version
andpulp_created
#5968 - Adds the
ALLOWED_IMPORT_PATHS
setting which can specify the file path prefix thatfile:///
remote paths can import from. #5974 - Allow the same artifact to be published at multiple relative paths in the same publication. #6037
- Files stored on S3 and Azure now download with the correct filename. #4733
- Adds operation_summary to the OpenAPI schema definition of repository modify operation #6002
- Temporarily pinned redis-py version to avoid a task locking issue. #6038
- Rewrote the Authentication page for more clarity on how to configure Pulp's authentication. #5949
- Removed the
django.contrib.auth.backends.RemoteUserBackend
as a default configured backend insettings.AUTHENTICATION_BACKENDS
. Also removedpulpcore.app.authentication.PulpRemoteUserAuthentication
from the DRF configuration ofDEFAULT_AUTHENTICATION_CLASSES
. #5949 - Importing from file:/// now requires the configuration of the
ALLOWED_IMPORT_PATHS
setting. Without this configuration, Pulp will not import content fromfile:///
locations correctly. #5974
- Allow awaiting for resolution on DeclarativeContent. #5668
- Add a previous() method to RepositoryVersion. #5734
- Enable plugin writers to sign selected content with signing scripts provided by administrators #5946
- Add a batching content iterator
content_batch_qs()
toRepositoryVersion
. #6024
The
`Handler._handle_file_response` has been removed. It was renamed to ``_serve_content_artifact
and has the following signature:def _serve_content_artifact(self, content_artifact, headers):
Remove get_or_create_future and does_batch from DeclarativeContent. Replaced by awaiting for resolution on the DeclarativeContent itself. #5668
- Fix bug where content shows as being added and removed in the same version. #5707
- Fix bug where calling Repository new_version() outside of task raises exception. #5894
- Adjusts setup.py classifier to show 3.0 as Production/Stable. #5896
- Importing from file:/// paths no longer destroys the source repository. #5941
- Webserver auth no longer prompts for csrf incorrectly. #5955
- Removed
pulpcore.app.middleware.PulpRemoteUserMiddleware
from the default middleware section. Also replacedrest_framework.authentication.RemoteUserAuthentication
withpulpcore.app.authentication.PulpRemoteUserAuthentication
in the Django Rest Framework portion of the config. #5955
- Added an optional parameter base_version to RepositoryVersion add() and removed() methods. #5706
- Saving an Artifact from a source that is outside of settings.MEDIA_ROOT will copy the file instead of moving the file as it did in previous versions. This causes data imported from file:/// sources to be left in tact. #5941
Note
Task names, e.g. pulpcore.app.tasks.orphan.orphan_cleanup
, are subject to change in future
releases 3.y releases. These are represented in the Task API as the "name" attribute. Please
check future release notes to see when these names will be considered stable. Otherwise, the
REST API pulpcore provides is considered semantically versioned.
- Pulp will do validation that a new repository version contains only content which is supported by the Repository type. Using the same a-priori knowledge of content types, increase performance of duplicate removal. #5701
- Improve speed and memory performance. #5688
- Fix an incorrect license claim in the docs. Pulp is GPLv2+. #4592
- Labeling 3.0 features as tech preview. #5563
- Simplified docs index page. #5714
- Add text to Promotion page. #5721
- Fixes and updates to the glossry page. #5726
- Added a new required field called CONTENT_TYPES to the Repository model. #5701