Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document auto-publish feature #497

Merged
merged 1 commit into from
Apr 13, 2021
Merged

Document auto-publish feature #497

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGES/8548.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Documented the auto-publication and auto-distribution feature.
24 changes: 22 additions & 2 deletions docs/workflows/publish-host.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Publish and Host
This section assumes that you have a repository with content in it (a repository version). To do
this, see the :doc:`sync` or :doc:`upload` documentation.

Create a Publication
--------------------
Create a Publication (manually)
-------------------------------

.. literalinclude:: ../_scripts/publication.sh
:language: bash
Expand Down Expand Up @@ -38,6 +38,7 @@ Distribution GET Response (after task is complete)::
"base_url": "localhost:24816/pulp/content/foo",
"content_guard": null,
"name": "baz",
"repository": null,
"publication": "/pulp/api/v3/publications/file/file/7d5440f6-202c-4e71-ace2-14c534f6df9e/"
}

Expand All @@ -55,3 +56,22 @@ If you created your repository version using the :doc:`upload` workflow:

.. literalinclude:: ../_scripts/download_after_upload.sh
:language: bash

Automate Publication and Distribution
-------------------------------------

With a little more initial setup, you can have publications and distributions for your repositories
updated automatically when new repository versions are created.

.. code-block:: bash

# This configures the repository to produce new publications when a new version is created
pulp file repository update --name $REPO_NAME --autopublish

# This configures the distribution to be track the latest repository version for a given repository
pulp file distribution update --name $DIST_NAME --repository $REPO_NAME

.. warning::
Support for automatic publication and distribution is provided as a tech preview in Pulp 3.
Functionality may not work or may be incomplete. Also, backwards compatibility when upgrading
is not guaranteed.