Skip to main content

File plugin for the Pulp Project

Project description

This is the pulp_file Plugin for Pulp Project 3.0+. This plugin replaces the ISO support in the pulp_rpm plugin for Pulp 2. This plugin uses the ChangeSet API to add and remove content from a repository.

All REST API examples bellow use httpie to perform the requests. The httpie commands below assume that the user executing the commands has a .netrc file in the home directory. The .netrc should have the following configuration:

machine localhost
login admin
password admin

If you configured the admin user with a different password, adjust the configuration accordingly. If you prefer to specify the username and password with each request, please see httpie documentation on how to do that.

This documentation makes use of the jq library to parse the json received from requests, in order to get the unique urls generated when objects are created. To follow this documentation as-is please install the jq library with:

$ sudo dnf install jq

Install pulpcore

Follow the installation instructions provided with pulpcore.

Install pulp-file from source

  1. sudo -u pulp -i

  2. source ~/pulpvenv/bin/activate

  3. git clone

  4. cd pulp_file

  5. python develop

  6. pulp-manager makemigrations pulp_file

  7. pulp-manager migrate pulp_file

  8. django-admin runserver

  9. sudo systemctl restart pulp_resource_manager

  10. sudo systemctl restart pulp_worker@1

  11. sudo systemctl restart pulp_worker@2

Install pulp-file From PyPI

  1. sudo -u pulp -i

  2. source ~/pulpvenv/bin/activate

  3. pip install pulp-file

  4. pulp-manager makemigrations pulp_file

  5. pulp-manager migrate pulp_file

  6. django-admin runserver

  7. sudo systemctl restart pulp_resource_manager

  8. sudo systemctl restart pulp_worker@1

  9. sudo systemctl restart pulp_worker@2

Create a repository foo

$ http POST http://localhost:8000/pulp/api/v3/repositories/ name=foo

    "_href": "http://localhost:8000/pulp/api/v3/repositories/8d7cd67a-9421-461f-9106-2df8e4854f5f/",

$ export REPO_HREF=$(http :8000/pulp/api/v3/repositories/ | jq -r '.results[] | select(.name == "foo") | ._href')

Create a new remote bar

$ http POST http://localhost:8000/pulp/api/v3/remotes/file/ name='bar' url=''

    "_href": "http://localhost:8000/pulp/api/v3/remotes/file/13ac2d63-7b7b-401d-b71b-9a5af05aab3c/",

$ export REMOTE_HREF=$(http :8000/pulp/api/v3/remotes/file/ | jq -r '.results[] | select(.name == "bar") | ._href')

Sync repository foo using remote bar

$ http POST $REMOTE_HREF'sync/' repository=$REPO_HREF

Look at the new Repository Version created

$ http GET $REPO_HREF'versions/1/'

    "_added_href": "http://localhost:8000/pulp/api/v3/repositories/b787e6ad-d6b6-4e3d-ab12-73eba19b42fb/versions/1/added_content/",
    "_content_href": "http://localhost:8000/pulp/api/v3/repositories/b787e6ad-d6b6-4e3d-ab12-73eba19b42fb/versions/1/content/",
    "_href": "http://localhost:8000/pulp/api/v3/repositories/b787e6ad-d6b6-4e3d-ab12-73eba19b42fb/versions/1/",
    "_removed_href": "http://localhost:8000/pulp/api/v3/repositories/b787e6ad-d6b6-4e3d-ab12-73eba19b42fb/versions/1/removed_content/",
    "content_summary": {
        "file": 3
    "created": "2018-02-23T20:29:54.499055Z",
    "number": 1

Upload foo.tar.gz to Pulp

Create an Artifact by uploading the file to Pulp.

$ http --form POST http://localhost:8000/pulp/api/v3/artifacts/ file@./foo.tar.gz

    "_href": "http://localhost:8000/pulp/api/v3/artifacts/7d39e3f6-535a-4b6e-81e9-c83aa56aa19e/",

Create file content from an Artifact

Create a content unit and point it to your artifact

$ http POST http://localhost:8000/pulp/api/v3/content/file/ relative_path=foo.tar.gz artifact="http://localhost:8000/pulp/api/v3/artifacts/7d39e3f6-535a-4b6e-81e9-c83aa56aa19e/"

    "_href": "http://localhost:8000/pulp/api/v3/content/file/a9578a5f-c59f-4920-9497-8d1699c112ff/",
    "artifact": "http://localhost:8000/pulp/api/v3/artifacts/7d39e3f6-535a-4b6e-81e9-c83aa56aa19e/",
    "relative_path": "foo.tar.gz",
    "type": "file"

$ export CONTENT_HREF=$(http :8000/pulp/api/v3/content/file/ | jq -r '.results[] | select(.relative_path == "foo.tar.gz") | ._href')

Add content to repository foo

$ http POST $REPO_HREF'versions/' add_content_units:="[\"$CONTENT_HREF\"]"

Create a file Publisher

$ http POST http://localhost:8000/pulp/api/v3/publishers/file/ name=bar

    "_href": "http://localhost:8000/pulp/api/v3/publishers/file/fd4cbecd-6c6a-4197-9cbe-4e45b0516309/",

$ export PUBLISHER_HREF=$(http :8000/pulp/api/v3/publishers/file/ | jq -r '.results[] | select(.name == "bar") | ._href')

Use the bar Publisher to create a Publication

$ http POST $PUBLISHER_HREF'publish/' repository=$REPO_HREF

        "_href": "http://localhost:8000/pulp/api/v3/tasks/fd4cbecd-6c6a-4197-9cbe-4e45b0516309/",
        "task_id": "fd4cbecd-6c6a-4197-9cbe-4e45b0516309"

$ export PUBLICATION_HREF=$(http :8000/pulp/api/v3/publications/ | jq -r --arg PUBLISHER_HREF "$PUBLISHER_HREF" '.results[] | select(.publisher==$PUBLISHER_HREF) | ._href')

Create a Distribution for the Publication

$ http POST http://localhost:8000/pulp/api/v3/distributions/ name='baz' base_path='foo' publication=$PUBLICATION_HREF

    "_href": "http://localhost:8000/pulp/api/v3/distributions/9b29f1b2-6726-40a2-988a-273d3f009a41/",

Download test.iso from Pulp

$ http GET http://localhost:8000/pulp/content/foo/test.iso

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pulp-file-0.0.1b2.tar.gz (18.8 kB view hashes)

Uploaded source

Built Distribution

pulp_file-0.0.1b2-py3-none-any.whl (15.3 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page