Pulp Glue DEB

0.4.3 · active · verified Thu Apr 16

pulp-glue-deb is a Python glue library designed to provide a version-agnostic interface for interacting with the Pulpcore REST API, specifically for managing Debian (DEB) content. It abstracts away version-specific API changes, allowing developers to write more resilient code. The current version is 0.4.3, and it receives regular updates, typically a few releases per year, indicating active maintenance.

Common errors

```
PulpConnectionError: Failed to connect to Pulp at '...' with HTTP status: 401 Unauthorized
```
cause Incorrect Pulp API URL, wrong username/password, or the Pulp server is not running or accessible with the provided credentials.

fix Verify that `PULP_API_URL`, `PULP_USERNAME`, and `PULP_PASSWORD` environment variables (or direct parameters) are correctly set. Ensure the Pulpcore server is running and reachable from where the client code is executed.
```
pulp_glue_core.connection.PulpConnectionError: Received 404 Not Found when trying to access /pulp/api/v3/deb/
```
cause The `pulp_deb` content plugin is likely not installed, not enabled, or not properly configured on your Pulpcore server instance.

fix Log into your Pulpcore server and confirm that the `pulp_deb` plugin is installed, enabled, and its API endpoints are available. Consult the Pulp documentation for proper plugin installation and troubleshooting.
```
AttributeError: 'DebClient' object has no attribute 'create_repository'
```
cause This error typically indicates that the `pulp-glue-deb` library version is significantly outdated compared to the Pulpcore server's API, or you are attempting to call a function that does not exist in the current API schema.

fix Upgrade `pulp-glue-deb` to the latest stable version using `pip install --upgrade pulp-glue-deb`. Review the `pulp-glue-deb` documentation or source code for the correct method signatures for your desired operation.

Warnings

gotcha Pulpcore content plugins (e.g., `pulp_deb`) must be installed and enabled on the target Pulpcore server for pulp-glue-deb functionality to work. Without it, you'll encounter 404 or 400 errors when trying to use DEB-specific APIs.
Fix: Ensure `pulp_deb` is installed and enabled on your Pulpcore server instance. Refer to the Pulp documentation for plugin installation instructions.
gotcha While `pulp-glue` aims to be version-agnostic, significant breaking changes in the underlying Pulpcore REST API can still lead to incompatibility. Always check the release notes for `pulp-glue-deb` and `pulpcore` when performing major upgrades.
Fix: Review the release notes for `pulp-glue-deb` and `pulpcore` before upgrading. Test compatibility in a non-production environment.
gotcha The `PulpConnection` often uses `verify_ssl=False` in quickstarts for local development. This is insecure and should NEVER be used in production with untrusted certificate authorities. Always verify SSL certificates.
Fix: For production, set `verify_ssl=True` and ensure your Python environment trusts the certificate authority that signed your Pulpcore server's SSL certificate.

Install

pip install pulp-glue-deb Install stable version

Imports

PulpConnection
wrong:
```
from pulp_glue_deb.connection import PulpConnection
```
correct:
```
from pulp_glue_core.connection import PulpConnection
```
PulpConnection is part of the core glue library, not specific content plugins like deb.
api
```
from pulp_glue_deb.app.deb import api as deb_api
```
This provides access to DEB-specific API clients and functions.
DebClient
```
from pulp_glue_deb.app.deb.api import DebClient
```
Direct import for the DEB client if you prefer not to use the 'api' alias.

Quickstart

This quickstart demonstrates how to establish a connection to a Pulpcore server and create a new Debian repository using `pulp-glue-deb`. It uses environment variables for Pulp API credentials and gracefully handles pre-existing repositories.

import os
from pulp_glue_core.connection import PulpConnection
from pulp_glue_deb.app.deb import api as deb_api

# Get Pulp API URL and credentials from environment variables
PULP_API_URL = os.environ.get('PULP_API_URL', 'http://localhost:8080/pulp/api/v3/')
PULP_USERNAME = os.environ.get('PULP_USERNAME', 'admin')
PULP_PASSWORD = os.environ.get('PULP_PASSWORD', 'password')

try:
    # 1. Establish connection to Pulp
    # Set verify_ssl=True in production and ensure valid certificates
    connection = PulpConnection(
        PULP_API_URL,
        username=PULP_USERNAME,
        password=PULP_PASSWORD,
        verify_ssl=False # WARNING: Do not use False in production with untrusted CAs
    )
    print(f"Connected to Pulp at {PULP_API_URL}")

    # 2. Get the DEB API client
    deb_client = deb_api.DebClient(connection)

    # 3. Create a DEB repository
    repo_name = "my-test-deb-repo"
    repo_description = "A test Debian repository created via pulp-glue-deb."

    # Check if repository already exists to avoid creation error
    existing_repos = deb_client.list_repositories(name=repo_name)
    if existing_repos:
        repo = existing_repos[0]
        print(f"Repository '{repo_name}' already exists (Pulp Href: {repo['pulp_href']}).")
    else:
        repo = deb_client.create_repository(
            name=repo_name,
            description=repo_description
        )
        print(f"Successfully created DEB repository: {repo['name']} (Pulp Href: {repo['pulp_href']})")

    # Optional: Delete the created repository
    # deb_client.delete_repository(repo['pulp_href'])
    # print(f"Deleted repository '{repo_name}'.")

except Exception as e:
    print(f"An error occurred: {e}")
    print("Ensure Pulpcore with the 'deb' plugin is running and accessible. Also verify environment variables PULP_API_URL, PULP_USERNAME, PULP_PASSWORD are set correctly.")

view raw JSON →