Plugins¶
Plugins add support for a type of content to Pulp. For example, the file_plugin adds support for Pulp to manage files.
Each plugin has its own documentation that contains setup, workflow, and conceptual information:
And don’t hesitate to contact us with any questions during development. Let us know when the plugin is ready and we will be happy to add it to the list of available plugins for Pulp!
Note
Are we missing a plugin? Let us know via the pulp-dev@redhat.com mailing list.
Plugin API¶
The Pulp Plugin API is published and versioned with pulpcore
. It is governed by our deprecation
policy.
Plugin Writer’s Guide¶
- Plugin Writer’s Guide
- Plugin Planning Guide
- Plugin Concepts
- Plugin API Usage
- Subclassing
- Validating Models
- Tasks
- Sync Pipeline
- Role Based Access Control
- Overview
- Permissions
- Model-Level Permissions
- Object-Level Permissions
- Defining Custom Permissions
- Custom Permission for Repository Content Modification
- Permission Checking Machinery
has_group_model_or_obj_perms()
has_group_obj_perms()
has_model_or_obj_perms()
has_model_perms()
has_obj_perms()
has_remote_param_model_or_obj_perms()
has_remote_param_obj_perms()
has_repo_attr_model_or_obj_perms()
has_repo_attr_obj_perms()
has_repository_model_or_obj_perms()
has_repository_obj_perms()
- Users and Groups
- Defining an Access Policy
- 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
- Installation
- Custom Installation Tasks
- Checksum Use In Plugins
- Plugin Walkthrough
Plugin Writer’s Reference¶
Plugin API Reference¶
- Plugin API Reference
- pulpcore.plugin.models
- pulpcore.plugin.exceptions
- pulpcore.plugin.serializers
AlternateContentSourcePathSerializer
AlternateContentSourceSerializer
ArtifactSerializer
AsyncOperationResponseSerializer
ContentChecksumSerializer
ContentGuardSerializer
ContentRedirectContentGuardSerializer
DetailRelatedField
DistributionSerializer
ExportSerializer
ExporterSerializer
GetOrCreateSerializerMixin
IdentityField
ImportSerializer
ImporterSerializer
LabelsField
ModelSerializer
MultipleArtifactContentSerializer
NestedRelatedField
NoArtifactContentSerializer
NoArtifactContentUploadSerializer
ProgressReportSerializer
PublicationSerializer
RelatedField
RemoteSerializer
RepositoryAddRemoveContentSerializer
RepositorySerializer
RepositorySyncURLSerializer
RepositoryVersionRelatedField
SingleArtifactContentSerializer
SingleArtifactContentUploadSerializer
SingleContentArtifactField
TaskGroupOperationResponseSerializer
ValidateFieldsMixin
validate_unknown_fields()
- pulpcore.plugin.storage
- pulpcore.plugin.viewsets
AlternateContentSourceViewSet
AsyncUpdateMixin
BaseFilterSet
CharInFilter
ContentFilter
ContentGuardFilter
ContentGuardViewSet
ContentViewSet
DistributionFilter
DistributionViewSet
ExportViewSet
ExporterViewSet
HyperlinkRelatedFilter
ImmutableRepositoryViewSet
ImportViewSet
ImporterViewSet
LabelSelectFilter
NamedModelViewSet
NoArtifactContentUploadViewSet
OperationPostponedResponse
PublicationFilter
PublicationViewSet
ReadOnlyContentViewSet
ReadOnlyRepositoryViewSet
RemoteFilter
RemoteViewSet
RepositoryVersionFilter
RepositoryVersionViewSet
RepositoryViewSet
SingleArtifactContentUploadViewSet
TaskGroupOperationResponse
TaskGroupViewSet
TaskViewSet
- pulpcore.plugin.tasking
- pulpcore.plugin.download
- pulpcore.plugin.stages
- Profiling the Stages API Performance
- pulpcore.plugin.content
PulpPluginAppConfig