Plugins

Plugins add support for a type of content to Pulp. For example, the file_plugin adds support for Pulp to manage files.

For a list of plugins check out our list of plugins for Pulp 3.

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
    • What APIs are available from remote repositories?
    • What does the metadata look like?
    • Which data should be modeled as Content Units?
  • Plugin Concepts
    • Plugin API Usage
    • Subclassing
      • Models
        • Adding Model Fields
        • Uniqueness
        • ForeignKey Gotchas
      • Serializers
        • Adding Fields
          • Help Text
      • Viewsets
        • Endpoint Namespacing
        • Detail Routes (Extra Endpoints)
          • Kick off Tasks
          • Content Upload ViewSet
      • Pulp Import/Export
        • QueryModelResource
        • BaseContentResource
        • modelresource.py
        • content_mapping
    • Validating Models
    • Tasks
      • Adding and Removing Content
        • Repository Versions
        • Synchronizing
      • Publish
      • Export Task
    • Sync Pipeline
      • Synchronizing Repositories with the async-Pipeline
        • On-demand synchronizing
        • Multiple level discovery
    • Role Based Access Control
      • Overview
        • Architecture
        • Getting Started
      • Permissions
        • Model-Level Permissions
        • Object-Level Permissions
        • Defining Custom Permissions
        • Custom Permission for Repository Content Modification
        • Permission Checking Machinery
      • Users and Groups
        • Viewing Users and Groups via a UI
        • Model-level Permissions via a UI
        • Enabling Object Views in django-admin
        • Object-level Permissions via a UI
      • Defining an Access Policy
        • Example Policy
        • Authorization Conditions
        • Custom ViewSet Actions
        • Storing an Access Policy in the DB
        • Shipping a Default Access Policy
        • Handling Objects created prior to RBAC
        • Viewset Enforcement
      • Adding Automatic Permissions for New Objects
        • Defining New Object Permission Behaviors
        • Enabling New Object Permission Creation
        • Shipping a Default New Object Policy
        • Defining Custom New Object Permission Callables
        • Auto Removing Permissions On Object Deletion
      • Restricting Viewable Objects
        • Enabling QuerySet Scoping
        • Manually Implementing QuerySet Scoping
    • 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
  • Plugin Walkthrough
    • Bootstrap your plugin
    • Define your plugin Content type
    • Define your plugin Remote
    • Define your Tasks
    • Plugin Completeness Checklist

Plugin Writer’s Reference

• Plugin Writing Reference Material

Plugin API Reference

• Plugin API Reference
  • pulpcore.plugin.models
  • pulpcore.plugin.exceptions
  • pulpcore.plugin.serializers
  • pulpcore.plugin.storage
  • pulpcore.plugin.viewsets
  • pulpcore.plugin.tasking
  • pulpcore.plugin.download
    • Basic Downloading
    • Parallel Downloading
    • Download Results
    • Configuring from a Remote
    • Automatic Retry
    • Exception Handling
    • Custom Download Behavior
    • Adding New Protocol Support
    • Download Factory
    • HttpDownloader
    • FileDownloader
    • BaseDownloader
    • Validation Exceptions
  • pulpcore.plugin.stages
    • DeclarativeVersion
    • Stages API
    • Artifact Related Stages
    • Content Related Stages
    • Content Association and Unassociation Stages
  • Profiling the Stages API Performance
    • Summarizing Performance Data
    • Profiling API Machinery
  • pulpcore.plugin.content
    • Creating your Handler
    • Registering your Handler
    • Restricting which detail Distributions Match
    • pulpcore.plugin.content.Handler