Pulp

https://pulpproject.org/
Admin
Pulp is a platform for managing repositories of content such as software packages and pushing that...
Tokens:849,391
Snippets:8,122
Trust Score:9.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### Quick Start Installation

Source: https://pulpproject.org/pulp-cli/docs/user/guides/installation

Fast installation commands for uv, pip, and pipx to get pulp-cli running immediately.

```bash
uv tool install pulp-cli[pygments]
pulp config create -e
# insert your server configuration here
pulp status
```

```bash
pip install pulp-cli[pygments]
pulp config create -e
# insert your server configuration here
pulp status
```

```bash
pipx install pulp-cli[pygments]
pulp config create -e
# insert your server configuration here
pulp status
```

--------------------------------

### Setup Pulp Development Environment

Source: https://pulpproject.org/pulpcore/docs/dev/tutorials/quickstart

Use oci-env to clone repositories, install the client, configure the environment, build images, and start the Pulp service. Ensure pulpcore is added to DEV_SOURCE_PATH.

```bash
# 1. clone required repos to the same basedir
git clone https://github.com/pulp/oci_env.git
git clone https://github.com/pulp/pulpcore.git
git clone https://github.com/pulp/pulp-openapi-generator.git # required for 'generate-client' below

# 1.1 add more repos as necessary to the same basedir
git clone https://github.com/pulp/pulp_rpm.git

# 2. install oci-env client
cd oci_env
pip3 install -e client

# 3. use minimal compose.env
# At least add pulpcore to DEV_SOURCE_PATH like this: DEV_SOURCE_PATH=pulpcore
cp compose.env.example compose.env

# 4. build the images and start the service
oci-env compose build
oci-env compose up

# 5. do basic setup
oci-env generate-client -i
oci-env generate-client -i pulp_file

```

--------------------------------

### Install with pip

Source: https://pulpproject.org/pulp-cli/docs/user/guides/installation

Standard pip installation commands for minimal, feature-rich, or plugin-based setups.

```bash
pip install pulp-cli  # minimal dependencies
```

```bash
pip install pulp-cli[pygments]  # colorized output
pip install pulp-cli[shell]  # with interactive shell mode
```

```bash
pip install pulp-cli-deb
```

--------------------------------

### Install and Run with docker-compose

Source: https://pulpproject.org/pulp-oci-images/docs/admin/tutorials/quickstart

This sequence installs docker-compose, clones the Pulp OCI images repository, and then starts the containers using docker-compose. It also demonstrates how to scale specific services.

```bash
pip install docker-compose
git clone git@github.com:pulp/pulp-oci-images.git
cd images/compose
docker-compose up
docker-compose scale pulp_api=4 pulp_content=4
```

--------------------------------

### Install and Run Pulp UI Frontend

Source: https://pulpproject.org/pulp-ui

Installs frontend dependencies using npm and starts the development server. The UI will be accessible at http://localhost:8002/.

```bash
npm install
npm run start
```

--------------------------------

### Install and Run Pulp Smash

Source: https://pulpproject.org/blog/2016/07/01/pulp-smash-introduction

Install the pulp-smash library using pip and then run it from the command line. Follow the on-screen instructions for further setup.

```bash
pip install pulp-smash
python -m pulp_smash  # follow the instructions

```

--------------------------------

### Install and Run with podman-compose

Source: https://pulpproject.org/pulp-oci-images/docs/admin/tutorials/quickstart

This sequence installs podman-compose, clones the Pulp OCI images repository, and then starts the containers using podman-compose. This is suitable for local development and testing.

```bash
pip install podman-compose
git clone git@github.com:pulp/pulp-oci-images.git
cd images/compose
podman-compose up
```

--------------------------------

### Automate Maven repository setup and content upload

Source: https://pulpproject.org/pulp_maven/docs/user/guides/metadata

Example using curl to create a repository, a distribution, and upload an artifact.

```bash
# 1. Create repository
curl -s -u user:password -X POST \
    https://pulp-hostname/pulp/my-domain/api/v3/repositories/maven/maven/ \
    -H "Content-Type: application/json" \
    -d '{"name": "my-repo"}' | jq .

# 2. Create distribution
REPO_HREF=$(curl -s -u user:password \
    https://pulp-hostname/pulp/my-domain/api/v3/repositories/maven/maven/ \
    | jq -r '.results[] | select(.name=="my-repo") | .pulp_href')

curl -s -u user:password -X POST \
    https://pulp-hostname/pulp/my-domain/api/v3/distributions/maven/maven/ \
    -H "Content-Type: application/json" \
    -d "{\"name\": \"my-repo\", \"base_path\": \"my-repo\", \"repository\": \"$REPO_HREF\"}" | jq .

# 3. Upload content (metadata is generated automatically)
curl -s -u user:password -X POST \
    https://pulp-hostname/pulp/my-domain/api/v3/content/maven/artifact/ \
    -F "file=@my-library-1.0.0.jar" \
    -F "relative_path=org/example/my-library/1.0.0/my-library-1.0.0.jar" \
    -F "repository=$REPO_HREF"

# 4. Content and metadata are served at:
#    https://pulp-hostname/pulp/content/my-domain/my-repo/
```

--------------------------------

### Create and Sync Quickstart Repository

Source: https://pulpproject.org/pulp_deb/docs/user/guides/sync

This example demonstrates the basic steps to create a remote, a repository, sync content, create a publication, and a distribution for APT content.

```bash
NAME='quickstart-nginx-bookworm-amd64'
REMOTE_OPTIONS=(
  --url=http://nginx.org/packages/debian/
  --distribution=bookworm
  --component=nginx
  --architecture=amd64
)
pulp deb remote create --name=${NAME} ${REMOTE_OPTIONS[@]}
pulp deb repository create --name=${NAME} --remote=${NAME}
pulp deb repository sync --name=${NAME}
pulp deb publication create --repository=${NAME}
pulp deb distribution create --name=${NAME} --base-path=${NAME} --repository=${NAME}
```

--------------------------------

### Quickstart: Upload a Debian Package using Pulp CLI

Source: https://pulpproject.org/pulp_deb/docs/user/guides/upload

This example demonstrates the basic steps to create a repository, download a package, upload it, and publish it using the Pulp CLI.

```bash
NAME='quickstart-upload-vim-amd64'
pulp deb repository create --name=${NAME}
wget ftp.de.debian.org/debian/pool/main/v/vim/vim_9.0.1378-2_amd64.deb
pulp deb content upload --repository=${NAME} --file=vim_9.0.1378-2_amd64.deb
pulp deb publication create --repository=${NAME}
pulp deb distribution create --name=${NAME} --base-path=${NAME} --repository=${NAME}
```

```shell
deb http://<your_pulp_host>/pulp/content/quickstart-uploaded-vim-amd64/ pulp upload
```

--------------------------------

### DEB Installer Packages API Response

Source: https://pulpproject.org/pulp_deb/restapi

Example JSON response structure for the GET /pulp/api/v3/content/deb/installer_packages/ endpoint.

```json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "pulp_href": "http://example.com",
      "prn": "string",
      "pulp_created": "2019-08-24T14:15:22Z",
      "pulp_last_updated": "2019-08-24T14:15:22Z",
      "pulp_labels": {
        "property1": "string",
        "property2": "string"
},
      "vuln_report": "http://example.com",
      "artifact": "http://example.com",
      "relative_path": "string",
      "md5": "string",
      "sha1": "string",
      "sha224": "string",
      "sha256": "string",
      "sha384": "string",
      "sha512": "string",
      "package": "string",
      "source": "string",
      "version": "string",
      "architecture": "string",
      "section": "string",
      "priority": "string",
      "origin": "string",
      "tag": "string",
      "bugs": "string",
      "essential": "string",
      "build_essential": "string",
      "installed_size": "string",
      "maintainer": "string",
      "original_maintainer": "string",
      "description": "string",
      "description_md5": "string",
      "homepage": "string",
      "built_using": "string",
      "auto_built_package": "string",
      "multi_arch": "string",
      "breaks": "string",
      "conflicts": "string",
      "depends": "string",
      "recommends": "string",
      "suggests": "string",
      "enhances": "string",
      "pre_depends": "string",
      "provides": "string",
      "replaces": "string",
      "signing_keys": [
        "string"
],
      "metadata_sha256": "string"
}
]

}
```

--------------------------------

### Create and Sync Example Repository

Source: https://pulpproject.org/pulp_deb/docs/user/guides/advanced_copy

Sets up a source repository with test content from a remote URL. This is the initial step before copying packages.

```bash
NAME='advanced-copy-example'
REMOTE_OPTIONS=(
  --url=https://fixtures.pulpproject.org/debian/
  --distribution=ragnarok
  --distribution=ginnungagap
  --architecture=ppc64
  --architecture=armeb
  --policy=on_demand
)
pulp deb remote create --name=${NAME} ${REMOTE_OPTIONS[@]}
pulp deb repository create --name=${NAME}-src --remote=${NAME}
pulp deb repository sync --name=${NAME}-src
```

--------------------------------

### Setup Repository Environment

Source: https://pulpproject.org/pulp_rpm/docs/user/guides/modify

Initializes repositories and syncs content to prepare for modification operations.

```bash
pulp rpm repository create --name modify_test_repo
pulp rpm repository create --name fixture_repo
pulp rpm remote create --name fixture_remote --url https://fixtures.pulpproject.org/rpm-unsigned/
pulp rpm repository sync --repository fixture_repo --remote fixture_remote
```

--------------------------------

### Create Plugin Overview Files

Source: https://pulpproject.org/pulp-docs/docs/dev/guides/create-plugin-overviews

Use the `touch` command to create the `index.md` files for the User Manual and Developer Manual overviews.

```bash
# "User Manual" Overview
touch docs/index.md

# "Dev Manual" Overview
touch docs/dev/index.md

```

--------------------------------

### GET {deb_installer_file_index_href}

Source: https://pulpproject.org/pulp_deb/api.json

Inspects an installer file index, which represents the indices for a set of installer files.

```APIDOC
## GET {deb_installer_file_index_href}

### Description
An InstallerFileIndex represents the indices for a set of installer files. Each index is associated with a single component-architecture combination within a single Release.

### Method
GET

### Endpoint
{deb_installer_file_index_href}

### Parameters
#### Path Parameters
- **deb_installer_file_index_href** (string) - Required - The href of the installer file index.

#### Query Parameters
- **fields** (array) - Optional - A list of fields to include in the response.
- **exclude_fields** (array) - Optional - A list of fields to exclude from the response.

### Response
#### Success Response (200)
- **deb.InstallerFileIndexResponse** (object) - The installer file index details.
```

--------------------------------

### GET /pulp/api/v3/content/deb/installer_packages/

Source: https://pulpproject.org/pulp_deb/api.json

List all available .udeb installer packages. Installer packages are used for verbatim publications.

```APIDOC
## GET /pulp/api/v3/content/deb/installer_packages/

### Description
An InstallerPackage represents a '.udeb' installer package. Note that installer packages are currently used exclusively for verbatim publications.

### Method
GET

### Endpoint
/pulp/api/v3/content/deb/installer_packages/

### Parameters
#### Query Parameters
- **architecture** (string) - Optional - Filter results where architecture matches value
- **auto_built_package** (string) - Optional - Filter results where auto_built_package matches value
- **build_essential** (boolean) - Optional - Filter results where build_essential matches value
- **built_using** (string) - Optional - Filter results where built_using matches value
- **essential** (boolean) - Optional - Filter results where essential matches value
- **installed_size** (integer) - Optional - Filter results where installed_size matches value
- **limit** (integer) - Optional - Number of results to return per page.
```

--------------------------------

### Install from Source

Source: https://pulpproject.org/pulp-cli/docs/user/guides/installation

Development installation commands using uv or pip for local source checkouts.

```bash
# Upon entering the source directory, uv handles the virtual environment on the fly.

git clone git@github.com:pulp/pulp-cli.git
cd pulp-cli
uv run pulp status

# Alternatively run in plugin development:
git clone git@github.com:pulp/pulp-cli-gem.git
cd pulp-cli-gem
uv run pulp status
```

```bash
# The matching glue development version is automatically taken from the same workspace.

git clone git@github.com:pulp/pulp-cli.git
uv tool install --editable pulp-cli

# Alternatively install plugins from source:
git clone git@github.com:pulp/pulp-cli-gem.git
uv tool install pulp-cli --with-editable pulp-cli-gem
```

```bash
# The matching glue development version must be installed from the same source.

git clone git@github.com:pulp/pulp-cli.git
pip install -e ./pulp-cli -e ./pulp-cli/pulp-glue

# Alternatively install plugins from source:
git clone git@github.com:pulp/pulp-cli-deb.git
pip install -e ./pulp-cli-deb

git clone git@github.com:pulp/pulp-cli-maven.git
pip install -e ./pulp-cli-maven -e ./pulp-cli-maven/pulp-glue-maven
```

--------------------------------

### Set up 'isofile' repository

Source: https://pulpproject.org/pulpcore/docs/admin/guides/import-export-repos

Creates a file repository named 'isofile', adds a remote to it, and syncs content. This prepares another repository with data for export.

```bash
# create the repository
ISOFILE_HREF=$(http POST :/pulp/api/v3/repositories/file/file/ name=isofile | jq -r '.pulp_href')

# add remote
http POST :/pulp/api/v3/remotes/file/file/ name=isofile url=https://fixtures.pulpproject.org/file/PULP_MANIFEST

# find remote's href
REMOTE_HREF=$(http :/pulp/api/v3/remotes/file/file/ | jq -r ".results[] | select(.name == \"isofile\") | .pulp_href")

# sync the repository to give us some content
http POST :$ISOFILE_HREF'sync/' remote=$REMOTE_HREF

```

--------------------------------

### GET {deb_installer_package_href}

Source: https://pulpproject.org/pulp_deb/api.json

Inspects a specific DEB installer package. Installer packages are '.udeb' files used for verbatim publications.

```APIDOC
## GET {deb_installer_package_href}

### Description
An InstallerPackage represents a '.udeb' installer package. Note that installer packages are currently used exclusively for verbatim publications.

### Method
GET

### Endpoint
{deb_installer_package_href}

### Parameters
#### Path Parameters
- **deb_installer_package_href** (string) - Required - The href of the installer package.

#### Query Parameters
- **fields** (array) - Optional - A list of fields to include in the response.
- **exclude_fields** (array) - Optional - A list of fields to exclude from the response.

### Response
#### Success Response (200)
- **deb.InstallerPackageResponse** (object) - The installer package details.
```

--------------------------------

### Retrieve OSTree Remotes Response Example

Source: https://pulpproject.org/pulp_ostree/restapi

Example JSON response structure for a GET request to the OSTree remotes endpoint.

```json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "pulp_href": "http://example.com",
      "prn": "string",
      "pulp_created": "2019-08-24T14:15:22Z",
      "pulp_last_updated": "2019-08-24T14:15:22Z",
      "name": "string",
      "url": "string",
      "pulp_labels": {
        "property1": "string",
        "property2": "string"
},
      "policy": "immediate",
      "hidden_fields": [
        {
          "name": "string",
          "is_set": true
}
],
      "ca_cert": "string",
      "client_cert": "string",
      "tls_validation": true,
      "proxy_url": "string",
      "max_retries": 0,
      "total_timeout": 0,
      "connect_timeout": 0,
      "sock_connect_timeout": 0,
      "sock_read_timeout": 0,
      "headers": [
        { }
],
      "download_concurrency": 1,
      "rate_limit": 0,
      "depth": 0,
      "include_refs": [
        "string"
],
      "exclude_refs": [
        "string"
]
}
]

}
```

--------------------------------

### Create Installer File Index Response Sample

Source: https://pulpproject.org/pulp_deb/restapi

Example of the JSON response returned upon successfully creating an installer file index.

```json
{
  "pulp_href": "http://example.com",
  "prn": "string",
  "pulp_created": "2019-08-24T14:15:22Z",
  "pulp_last_updated": "2019-08-24T14:15:22Z",
  "pulp_labels": {
    "property1": "string",
    "property2": "string"
},
  "vuln_report": "http://example.com",
  "artifacts": { },
  "component": "string",
  "architecture": "string",
  "relative_path": "string"

}
```

--------------------------------

### Implement init_from_artifact_and_relative_path

Source: https://pulpproject.org/pulpcore/docs/dev/learn/subclassing/pull-through

Example implementation for initializing content from an artifact and relative path.

```python
if path.isabs(relative_path):
    raise ValueError(_("Relative path can't start with '/'."))
return FileContent(relative_path=relative_path, digest=artifact.sha256)
```

--------------------------------

### Serve local documentation preview

Source: https://pulpproject.org/pulpcore/docs/dev/tutorials/quickstart-docs

Starts a local web server to preview documentation changes made with `pulp-docs`.

```bash
pulp-docs serve

```

--------------------------------

### Setup and Sync Repository

Source: https://pulpproject.org/pulp_rpm/docs/user/guides/prune

Before pruning, set up a remote, create a repository, and sync it. This ensures you have content to prune.

```bash
pulp rpm remote create --name zoo --policy on_demand --url https://fixtures.pulpproject.org/rpm-signed/
```

```bash
pulp rpm repository create --name zoo --remote zoo
```

```bash
pulp rpm repository sync --name zoo
```

--------------------------------

### GET {deb_installer_package_href}

Source: https://pulpproject.org/pulp_deb/restapi

Retrieves the details of a specific Debian installer package.

```APIDOC
## GET {deb_installer_package_href}

### Description
Inspects an installer package ('.udeb') by its href. This resource is used for verbatim publications.

### Method
GET

### Endpoint
{deb_installer_package_href}

### Parameters
#### Path Parameters
- **deb_installer_package_href** (string) - Required - The href of the installer package.

#### Query Parameters
- **fields** (Array of strings) - Optional - A list of fields to include in the response.
- **exclude_fields** (Array of strings) - Optional - A list of fields to exclude from the response.

#### Header Parameters
- **X-Task-Diagnostics** (Array of strings) - Optional - List of profilers to use on tasks.

### Response
#### Success Response (200)
- **pulp_href** (string) - The URL of the resource.
- **package** (string) - The package name.
- **version** (string) - The package version.
- **architecture** (string) - The package architecture.
- **artifact** (string) - The associated artifact URL.

#### Response Example
{
  "pulp_href": "http://example.com",
  "package": "string",
  "version": "string",
  "architecture": "string",
  "artifact": "http://example.com"
}
```

--------------------------------

### GET /pulp/api/v3/content/deb/installer_packages/

Source: https://pulpproject.org/pulp_deb/api.json

List DEB installer packages with various filtering options.

```APIDOC
## GET /pulp/api/v3/content/deb/installer_packages/

### Description
Retrieve a paginated list of DEB installer packages. Supports filtering by various attributes such as section, sha256, source, tag, and version.

### Method
GET

### Endpoint
/pulp/api/v3/content/deb/installer_packages/

### Parameters
#### Query Parameters
- **pulp_id__in** (array) - Optional - Filter by multiple UUIDs.
- **pulp_label_select** (string) - Optional - Filter labels by search string.
- **q** (string) - Optional - Filter results using NOT, AND, and OR operations.
- **section** (string) - Optional - Filter results where section matches value.
- **sha256** (string) - Optional - Filter results where sha256 matches value.
- **source** (string) - Optional - Filter results where source matches value.
- **tag** (string) - Optional - Filter results where tag matches value.
- **version** (string) - Optional - Filter results where version matches value.
- **fields** (array) - Optional - A list of fields to include in the response.
- **exclude_fields** (array) - Optional - A list of fields to exclude from the response.

### Response
#### Success Response (200)
- **Paginateddeb.InstallerPackageResponseList** (object) - A paginated list of installer packages.
```

--------------------------------

### Re-sync and Re-publish Quickstart Repository

Source: https://pulpproject.org/pulp_deb/docs/user/guides/sync

Use this to re-synchronize an existing repository and create a new publication. The distribution is automatically updated if it was initially created with the --repository flag.

```bash
pulp deb repository sync --name=${NAME}
pulp deb publication create --repository=${NAME}
```

--------------------------------

### Create Repository and Set Labels

Source: https://pulpproject.org/pulpcore/docs/user/guides/manage-labels

Use these commands to create a new repository and then assign key/value labels to it. The `show` command verifies the labels.

```bash
# create a new repository
pulp file repository create --name myrepo

# set some labels
pulp file repository label set --name myrepo --key environment --value production
pulp file repository label set --name myrepo --key reviewed --value true

# call show to view the repo's labels
pulp file repository show --name myrepo
```

--------------------------------

### Download Pulp Docker Setup Script

Source: https://pulpproject.org/blog/2015/05/21/use-docker-to-try-pulp

Download the start.sh script to set up a Pulp Docker environment. This script is used to configure and run the Pulp deployment.

```bash
$ wget https://raw.githubusercontent.com/pulp/packaging/docker/dockerfiles/centos/start.sh
$ sudo source start.sh /path/to/lots/of/storage/

```

--------------------------------

### Get Namespace Avatar Response

Source: https://pulpproject.org/pulp_ansible/restapi

Example response body for the avatar retrieval endpoint.

```json
{ }
```

--------------------------------

### RPM Distributions Response JSON

Source: https://pulpproject.org/pulp_rpm/restapi

Example of the JSON structure returned by the GET /pulp/api/v3/distributions/rpm/rpm/ endpoint.

```json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "pulp_href": "http://example.com",
      "prn": "string",
      "pulp_created": "2019-08-24T14:15:22Z",
      "pulp_last_updated": "2019-08-24T14:15:22Z",
      "base_path": "string",
      "base_url": "string",
      "content_guard": "http://example.com",
      "content_guard_prn": "string",
      "no_content_change_since": "string",
      "hidden": false,
      "pulp_labels": {
        "property1": "string",
        "property2": "string"
      },
      "name": "string",
      "repository": "http://example.com",
      "repository_version": "http://example.com",
      "publication": "http://example.com",
      "generate_repo_config": false,
      "checkpoint": true
    }
  ]
}
```

--------------------------------

### Set up 'zoo' repository

Source: https://pulpproject.org/pulpcore/docs/admin/guides/import-export-repos

Creates a repository named 'zoo', adds a remote to it, and syncs content from the remote. This prepares a repository with data for export.

```bash
# Create the repository
export ZOO_HREF=$(http POST :/pulp/api/v3/repositories/rpm/rpm/ name=zoo | jq -r '.pulp_href')

# add a remote
http POST :/pulp/api/v3/remotes/rpm/rpm/ name=zoo url=https://fixtures.pulpproject.org/rpm-signed/  policy='immediate'

# find remote's href
export REMOTE_HREF=$(http :/pulp/api/v3/remotes/rpm/rpm/ | jq -r ".results[] | select(.name == \"zoo\") | .pulp_href")

# sync the repository to give us some content
http POST :$ZOO_HREF'sync/' remote=$REMOTE_HREF

```

--------------------------------

### Retrieve Uploads Response Structure

Source: https://pulpproject.org/pulpcore/restapi

Example JSON response for a successful GET request to the uploads endpoint.

```json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "pulp_href": "http://example.com",
      "prn": "string",
      "pulp_created": "2019-08-24T14:15:22Z",
      "pulp_last_updated": "2019-08-24T14:15:22Z",
      "size": 0,
      "completed": "2019-08-24T14:15:22Z"
    }
  ]
}
```

--------------------------------

### Instantiate and use DownloaderFactory

Source: https://pulpproject.org/pulpcore/docs/dev/reference/code-api/plugins-api/download

Demonstrates how to initialize a DownloaderFactory with a remote and build a downloader to fetch content.

```python
the_factory = DownloaderFactory(remote)
downloader = the_factory.build(url_a)
result = downloader.fetch()  # 'result' is a DownloadResult
```

--------------------------------

### Get index summary response sample

Source: https://pulpproject.org/pulp_python/restapi

Example JSON response structure for the index summary endpoint.

```json
{
  * "projects": 0,
  * "releases": 0,
  * "files": 0

}
```

--------------------------------

### Retrieve DEB Releases JSON Response

Source: https://pulpproject.org/pulp_deb/restapi

Example of the JSON structure returned by the GET /pulp/api/v3/content/deb/releases/ endpoint.

```json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "pulp_href": "http://example.com",
      "prn": "string",
      "pulp_created": "2019-08-24T14:15:22Z",
      "pulp_last_updated": "2019-08-24T14:15:22Z",
      "pulp_labels": {
        "property1": "string",
        "property2": "string"
},
      "vuln_report": "http://example.com",
      "codename": "string",
      "suite": "string",
      "distribution": "string",
      "version": "string",
      "origin": "string",
      "label": "string",
      "description": "string",
      "architectures": [
        "string"
],
      "components": [
        "string"
]
}
]

}
```

--------------------------------

### Set Up Queryset and Content Mapping

Source: https://pulpproject.org/pulpcore/docs/dev/learn/subclassing/import-export

Implement `set_up_queryset` to define the content associated with the main repository and any sub-repositories. This method populates the `content_mapping` dictionary, ensuring correct association during import/export.

```python
    def set_up_queryset(self):
        """Set up the queryset and our content_mapping."""
        content = MyContent.objects.filter(pk__in=self.repo_version.content)
        self.content_mapping[self.repository_version.repository.name] = content

        for repo in self.subrepos(self.repo_version):
            subrepo_content = repo.latest_repository_version.content
            self.content_mapping[repo.name] = subrepo_content
            content |= subrepo_content

        return content

    class Meta:
        model = MyContent
```

--------------------------------

### Create Maven repository and distribution

Source: https://pulpproject.org/pulp_maven/docs/user/guides/upload

Initial setup to create a Maven repository and a corresponding distribution for serving content.

```bash
pulp maven repository create --name maven-releases
pulp maven distribution create --name maven-releases --repository maven-releases --base-path maven-releases
```

--------------------------------

### Ansible Git Remote Response JSON

Source: https://pulpproject.org/pulp_ansible/restapi

Example JSON response structure for the GET /pulp/api/v3/remotes/ansible/git/ endpoint.

```json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "headers": [
        { }
],
      "client_cert": "string",
      "tls_validation": true,
      "sock_connect_timeout": 0,
      "pulp_created": "2019-08-24T14:15:22Z",
      "prn": "string",
      "max_retries": 0,
      "sock_read_timeout": 0,
      "download_concurrency": 1,
      "url": "string",
      "hidden_fields": [
        {
          "name": "string",
          "is_set": true
}
],
      "proxy_url": "string",
      "pulp_labels": {
        "property1": "string",
        "property2": "string"
},
      "total_timeout": 0,
      "name": "string",
      "pulp_last_updated": "2019-08-24T14:15:22Z",
      "pulp_href": "http://example.com",
      "ca_cert": "string",
      "connect_timeout": 0,
      "rate_limit": 0,
      "metadata_only": true,
      "git_ref": "string"
}
]

}
```

--------------------------------

### Inspect a release architecture response

Source: https://pulpproject.org/pulp_deb/restapi

Example JSON response for a GET request to a release architecture endpoint.

```json
{
  "pulp_href": "http://example.com",
  "prn": "string",
  "pulp_created": "2019-08-24T14:15:22Z",
  "pulp_last_updated": "2019-08-24T14:15:22Z",
  "pulp_labels": {
    "property1": "string",
    "property2": "string"
},
  "vuln_report": "http://example.com",
  "architecture": "string",
  "distribution": "string",
  "base_architecture": "string",
  "variant_architecture": "string"

}
```

--------------------------------

### DEB Packages API Response Sample

Source: https://pulpproject.org/pulp_deb/restapi

Example JSON response structure for the GET /pulp/api/v3/content/deb/packages/ endpoint.

```json
{
  * "count": 123,
  * "next": "http://api.example.org/accounts/?offset=400&limit=100",
  * "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  * "results": [
    * {
      * "pulp_href": "http://example.com",
      * "prn": "string",
      * "pulp_created": "2019-08-24T14:15:22Z",
      * "pulp_last_updated": "2019-08-24T14:15:22Z",
      * "pulp_labels": {
        * "property1": "string",
        * "property2": "string"
},
      * "vuln_report": "http://example.com",
      * "artifact": "http://example.com",
      * "relative_path": "string",
      * "distribution": "string",
      * "component": "string",
      * "md5": "string",
      * "sha1": "string",
      * "sha224": "string",
      * "sha256": "string",
      * "sha384": "string",
      * "sha512": "string",
      * "package": "string",
      * "source": "string",
      * "version": "string",
      * "architecture": "string",
      * "section": "string",
      * "priority": "string",
      * "origin": "string",
      * "tag": "string",
      * "bugs": "string",
      * "essential": "string",
      * "build_essential": "string",
      * "installed_size": "string",
      * "maintainer": "string",
      * "original_maintainer": "string",
      * "description": "string",
      * "description_md5": "string",
      * "homepage": "string",
      * "built_using": "string",
      * "auto_built_package": "string",
      * "multi_arch": "string",
      * "breaks": "string",
      * "conflicts": "string",
      * "depends": "string",
      * "recommends": "string",
      * "suggests": "string",
      * "enhances": "string",
      * "pre_depends": "string",
      * "provides": "string",
      * "replaces": "string",
      * "signing_keys": [
        * "string"
],
      * "metadata_sha256": "string"
}
]

}
```

--------------------------------

### Setup and Run Linting Tools

Source: https://pulpproject.org/pulp-cli/docs/dev/guides/contributing

Install necessary linting tools and run formatting and static analysis checks. These commands should be run before committing code.

```bash
pip install -r lint_requirements.txt  # setup, needed only once
```

```bash
make format  # reformatting with ruff
```

```bash
make lint  # checking with shellcheck, ruff and mypy
```

```bash
make format lint  # both in one command
```

--------------------------------

### Register Plugin via setup.py Entry Points

Source: https://pulpproject.org/pulpcore/docs/dev/learn/other/how-plugins-work

Register your plugin's app config in setup.py using the 'pulpcore.plugin' entry point.

```python
entry_points={
    'pulpcore.plugin': [
        'pulp_myplugin = pulp_myplugin:default_app_config',
    ]
}
```

--------------------------------

### Inspect OSTree Distribution Response

Source: https://pulpproject.org/pulp_ostree/restapi

Example JSON response structure for a GET request to an OSTree distribution.

```json
{
  "pulp_href": "http://example.com",
  "prn": "string",
  "pulp_created": "2019-08-24T14:15:22Z",
  "pulp_last_updated": "2019-08-24T14:15:22Z",
  "base_path": "string",
  "base_url": "string",
  "content_guard": "http://example.com",
  "content_guard_prn": "string",
  "no_content_change_since": "string",
  "hidden": false,
  "pulp_labels": {
    "property1": "string",
    "property2": "string"
},
  "name": "string",
  "repository": "http://example.com",
  "repository_version": "http://example.com"

}
```

--------------------------------

### Retrieve File Remote Git Response Structure

Source: https://pulpproject.org/pulp_file/restapi

Example JSON response for the GET /pulp/api/v3/remotes/file/git/ endpoint.

```json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "pulp_href": "http://example.com",
      "prn": "string",
      "pulp_created": "2019-08-24T14:15:22Z",
      "pulp_last_updated": "2019-08-24T14:15:22Z",
      "name": "string",
      "url": "string",
      "pulp_labels": {
        "property1": "string",
        "property2": "string"
      },
      "hidden_fields": [
        {
          "name": "string",
          "is_set": true
        }
      ],
      "ca_cert": "string",
      "client_cert": "string",
      "tls_validation": true,
      "proxy_url": "string",
      "max_retries": 0,
      "total_timeout": 0,
      "connect_timeout": 0,
      "sock_connect_timeout": 0,
      "sock_read_timeout": 0,
      "headers": [
        {}
      ],
      "download_concurrency": 1,
      "rate_limit": 0,
      "git_ref": "HEAD"
    }
  ]
}
```

--------------------------------

### Create Maven Repositories

Source: https://pulpproject.org/pulp_maven/docs/user/guides/promote

Initialize the source and destination repositories required for the promotion workflow.

```bash
pulp maven repository create --name landing
pulp maven repository create --name validated
```

--------------------------------

### Filesystem Exporter Response JSON

Source: https://pulpproject.org/pulpcore/restapi

Example JSON response structure for a GET request to the filesystem exporters endpoint.

```json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "pulp_href": "http://example.com",
      "prn": "string",
      "pulp_created": "2019-08-24T14:15:22Z",
      "pulp_last_updated": "2019-08-24T14:15:22Z",
      "name": "string",
      "path": "string",
      "method": "write"
    }
  ]
}
```

--------------------------------

### Create Domain with FileSystem Storage

Source: https://pulpproject.org/pulpcore/docs/user/guides/create-domains

Example of creating a domain using the FileSystem storage backend. Ensure the MEDIA_ROOT path is correctly configured.

```bash
pulp domain create \
  --name foo \
  --description foo \
  --storage-class pulpcore.app.models.storage.FileSystem \
  --storage-settings "{\"MEDIA_ROOT\": \"/var/lib/pulp/media/\"}"
```

--------------------------------

### Inspect OpenPGP Distribution Response

Source: https://pulpproject.org/pulpcore/restapi

Example JSON response structure for a successful GET request to an OpenPGP distribution.

```json
{
  * "pulp_href": "http://example.com",
  * "prn": "string",
  * "pulp_created": "2019-08-24T14:15:22Z",
  * "pulp_last_updated": "2019-08-24T14:15:22Z",
  * "base_path": "string",
  * "base_url": "string",
  * "content_guard": "http://example.com",
  * "content_guard_prn": "string",
  * "no_content_change_since": "string",
  * "hidden": false,
  * "pulp_labels": {
    * "property1": "string",
    * "property2": "string"
},
  * "name": "string",
  * "repository": "http://example.com",
  * "repository_version": "http://example.com"

}
```

--------------------------------

### Setup Pulp Backend Directory

Source: https://pulpproject.org/pulp-ui

Creates necessary directories for Pulp backend configuration and storage.

```bash
mkdir -p ~/pulp-backend-oci/{settings/certs,pulp_storage,pgsql,containers}
cd ~/pulp-backend-oci/
echo "
CONTENT_ORIGIN='http://$(hostname):8080'
ANSIBLE_API_HOSTNAME='http://$(hostname):8080'
ANSIBLE_CONTENT_HOSTNAME='http://$(hostname):8080/pulp/content'
" >> settings/settings.py
```

--------------------------------

### Install with uv

Source: https://pulpproject.org/pulp-cli/docs/user/guides/installation

Installation commands using the uv tool, including optional dependencies and plugins.

```bash
uv tool install pulp-cli
```

```bash
uv tool install pulp-cli[pygments,shell]
```

```bash
uv tool install --with pulp-cli-deb pulp-cli
```

--------------------------------

### Repo Metadata Files Response Structure

Source: https://pulpproject.org/pulp_rpm/restapi

Example JSON response returned by the GET request to the repo_metadata_files endpoint.

```json
{
  * "count": 123,
  * "next": "http://api.example.org/accounts/?offset=400&limit=100",
  * "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  * "results": [
    * {
      * "pulp_href": "http://example.com",
      * "prn": "string",
      * "pulp_created": "2019-08-24T14:15:22Z",
      * "pulp_last_updated": "2019-08-24T14:15:22Z",
      * "md5": "string",
      * "sha1": "string",
      * "sha224": "string",
      * "sha256": "string",
      * "sha384": "string",
      * "sha512": "string",
      * "pulp_labels": {
        * "property1": "string",
        * "property2": "string"
},
      * "vuln_report": "http://example.com",
      * "artifact": "http://example.com",
      * "relative_path": "string",
      * "data_type": "string",
      * "checksum_type": "string",
      * "checksum": "string"
}
]

}
```

--------------------------------

### Create and Sync NVIDIA CUDA Flat Repository

Source: https://pulpproject.org/pulp_deb/docs/user/guides/sync

This example demonstrates the workflow for synchronizing an NVIDIA CUDA flat APT repository. It includes creating a remote, a repository, syncing the data, and setting up publication and distribution.

```bash
NAME='nvidia-cuda-flat-amd64'
REMOTE_OPTIONS=(
  --url=http://developer.download.nvidia.com/compute/cuda/repos/debian11/x86_64/
  --distribution=/
  --architecture=amd64
)
pulp deb remote create --name=${NAME} ${REMOTE_OPTIONS[@]}
pulp deb repository create --name=${NAME} --remote=${NAME}
pulp deb repository sync --name=${NAME}
pulp deb publication create --repository=${NAME}
pulp deb distribution create --name=${NAME} --base-path=${NAME}

```

--------------------------------

### Inspect a package environment response

Source: https://pulpproject.org/pulp_rpm/restapi

Example JSON response structure for a successful GET request to a package environment.

```json
{
  "pulp_href": "http://example.com",
  "prn": "string",
  "pulp_created": "2019-08-24T14:15:22Z",
  "pulp_last_updated": "2019-08-24T14:15:22Z",
  "pulp_labels": {
    "property1": "string",
    "property2": "string"
},
  "vuln_report": "http://example.com",
  "id": "string",
  "name": "string",
  "description": "string",
  "display_order": 0,
  "group_ids": null,
  "option_ids": null,
  "desc_by_lang": null,
  "name_by_lang": null,
  "digest": "string"

}
```

--------------------------------

### Pulp Repository and Distribution Setup

Source: https://pulpproject.org/pulp_certguard/docs/user/tutorials/yum-howto

Configures a Pulp repository, remote, syncs content, creates a publication, and sets up a distribution. It includes steps for creating a repository, a remote for content, syncing the repository, creating a publication, and finally, a distribution. Task progress should be monitored via the Pulp API.

```bash
# create repo
http POST http://localhost:24817/pulp/api/v3/repositories/ name=boomi-epel

# Lookup the thing we just made
export REPO_HREF=$(http http://localhost:24817/pulp/api/v3/repositories/ | jq -r '.results[] | select(.name == "boomi-epel") | .pulp_href')

# create new remote
http POST http://localhost:24817/pulp/api/v3/remotes/rpm/rpm/ name='boomi-epel-remote' url='file:///usr/local/lib/pulp/staging/epel/' policy='immediate'

export REMOTE_HREF=$(http :24817/pulp/api/v3/remotes/rpm/rpm/ | jq -r '.results[] | select(.name == "boomi-epel-remote") | .pulp_href')

# Sync the repo
http POST http:/localhost:24817${REMOTE_HREF}sync/ repository=$REPO_HREF
# {
#     "task": "/pulp/api/v3/tasks/abb42ba7-77f9-49c4-af05-3af407ab8596/"
# }

# Inspect the new thingy....
http GET http://localhost:24817${REPO_HREF}versions/1/

# Create a publication
http POST http://localhost:24817/pulp/api/v3/publications/rpm/rpm/ repository=$REPO_HREF

# get repo-version (display/informational)
export PUBLICATION_HREF=$(http :24817/pulp/api/v3/publications/rpm/rpm/ | jq -r '.results[] | select(.repository_version|test("'"$REPO_HREF"'.")) | .pulp_href')

http POST http://localhost:24817/pulp/api/v3/distributions/rpm/rpm/ name='boomi-epel-distro' base_path='boomi-epel' publication=$PUBLICATION_HREF

#Follow the task progress here:
http GET http://localhost:24817/pulp/api/v3/tasks/
http GET http://localhost:24817/pulp/api/v3/tasks/uuid-of-single-task-for-reasonable-responses

# THe CONTENT_HOST setting is super important for this. Set it to something valid.

# View all the published stats
http GET http://localhost:24817/pulp/api/v3/distributions/rpm/rpm/

# Get the repo metadata from the published end point on the yum side
http GET  http://localhost:24816/pulp/content/boomi-epel-2/repodata/repomd.xml
```
Tokens:
Raw