Attention
This documentation will be deactivated in the near future. Learn More or go to the New Pulp Docs (beta).
Plugin Development¶
Plugin Writer’s Guide¶
- Plugin Writer’s Guide
- Plugin Planning Guide
- Plugin Concepts
- Plugin API Usage
- Subclassing
- Master/Detail Models
- Validating Models
- Tasks
- Sync Pipeline
- Domain Multi-tenancy
- Adding Domain Compatibility to a Plugin
- Add Domain Relation to Plugin Models
- Ensure any Custom Action Serializer Prevents Cross-Domain Parameters
- Update each Task that uses Objects to include the Domain field
- Add the Appropriate has_domain_perms Checks to the ViewSets’ AccessPolicies
- Update any extra URL Routes to include {pulp_domain}
- Add
domain_compatible = TruetoPluginAppConfig - Add Tests
- Add Documentation
- Adding Domain Compatibility to a Plugin
- Role Based Access Control
- Overview
- Permissions and Roles
- Users and Groups
- Defining an Access Policy
- Example Policy
- Authorization Conditions
- Custom ViewSet Actions
- Storing an Access Policy in the DB
- Shipping a Default Access Policy
- Allow Granting Permissions by the Object Owners
- Handling Objects created prior to RBAC
- Viewset Enforcement
- Permission Checking Machinery
has_domain_perms()has_group_model_or_obj_perms()has_group_obj_perms()has_model_or_domain_or_obj_perms()has_model_or_domain_perms()has_model_or_obj_perms()has_model_perms()has_obj_perms()has_publication_param_model_or_domain_or_obj_perms()has_publication_param_model_or_obj_perms()has_remote_param_model_or_domain_or_obj_perms()has_remote_param_model_or_obj_perms()has_remote_param_obj_perms()has_repo_attr_model_or_domain_or_obj_perms()has_repo_attr_model_or_obj_perms()has_repo_attr_obj_perms()has_repo_or_repo_ver_param_model_or_domain_or_obj_perms()has_repo_or_repo_ver_param_model_or_obj_perms()has_repository_model_or_domain_or_obj_perms()has_repository_model_or_obj_perms()has_repository_obj_perms()has_required_repo_perms_on_upload()has_upload_param_model_or_domain_or_obj_perms()has_upload_param_model_or_obj_perms()
- Custom Permission Checks
- Adding Automatic Permissions for New Objects
- Restricting Viewable Objects
- Content Protection
- Plugin Settings
- Custom API URL Routes
- Custom Content App Routes
- Configuring Reverse Proxy with Custom URLs
- Overriding the Reverse Proxy Route Configuration
- Plugin API Stability and Deprecation Policy
- Declaring Dependencies
- Checksum Use In Plugins
- Internationalization Expectations
- Zero-Downtime Upgrades
- Zero-Downtime Migrations
- Data Migrations
- Tasking System
- Plugin Walkthrough
Plugin Writer’s Reference¶
Plugin API Reference¶
- Plugin API Reference
- pulpcore.plugin.models
- pulpcore.plugin.exceptions
- pulpcore.plugin.serializers
AlternateContentSourcePathSerializerAlternateContentSourceSerializerArtifactSerializerAsyncOperationResponseSerializerContentChecksumSerializerContentGuardSerializerContentRedirectContentGuardSerializerDetailRelatedFieldDistributionSerializerDomainUniqueValidatorExportSerializerExporterSerializerGetOrCreateSerializerMixinHiddenFieldsMixinIdentityFieldImportSerializerImporterSerializerModelSerializerMultipleArtifactContentSerializerNestedRelatedFieldNoArtifactContentSerializerNoArtifactContentUploadSerializerProgressReportSerializerPublicationSerializerRelatedFieldRemoteSerializerRepositoryAddRemoveContentSerializerRepositorySerializerRepositorySyncURLSerializerRepositoryVersionRelatedFieldSingleArtifactContentSerializerSingleArtifactContentUploadSerializerSingleContentArtifactFieldTaskGroupOperationResponseSerializerTaskSerializerValidateFieldsMixinvalidate_unknown_fields()
- pulpcore.plugin.storage
- pulpcore.plugin.viewsets
AlternateContentSourceViewSetAsyncUpdateMixinBaseFilterSetCharInFilterContentFilterContentGuardFilterContentGuardViewSetContentViewSetDistributionFilterDistributionViewSetExportViewSetExporterViewSetHyperlinkRelatedFilterImmutableRepositoryViewSetImportViewSetImporterViewSetLabelFilterNamedModelViewSetNoArtifactContentUploadViewSetNoArtifactContentViewSetOperationPostponedResponsePublicationFilterPublicationViewSetReadOnlyContentViewSetReadOnlyRepositoryViewSetRemoteFilterRemoteViewSetRepositoryVersionFilterRepositoryVersionViewSetRepositoryViewSetSingleArtifactContentUploadViewSetTaskGroupOperationResponseTaskGroupViewSetTaskViewSet
- pulpcore.plugin.tasking
- pulpcore.plugin.download
- pulpcore.plugin.stages
- pulpcore.plugin.content
- pulpcore.plugin.util
PulpPluginAppConfig