Skip to content

Commit

Permalink
Rework the installation docs to stop being harmfull
Browse files Browse the repository at this point in the history
Closes #9186
https://pulp.plan.io/issues/9186

Also capitalized several instances of "Pulp".
  • Loading branch information
quba42 committed Jul 30, 2021
1 parent 8d0e656 commit fd6f10d
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 51 deletions.
1 change: 1 addition & 0 deletions CHANGES/9186.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Reworked the plugin installation docs to be helpful to new users.
2 changes: 1 addition & 1 deletion docs/bindings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Generating a client is a two step process:
Generating a Client on dev Environment
--------------------------------------------------------------------------------

The easiest way to set up a Pulp development environment is to use a Vagrant box from the `pulp installer`_ repo.
The easiest way to set up a Pulp development environment is to use a Vagrant box from the `pulp Ansible installer`_ repo.
These development boxes provide the ``pbindings`` alias for generating bindings (aka clients):

For example, use the following for generating Python bindings for ``pulp_deb``:
Expand Down
12 changes: 8 additions & 4 deletions docs/external_references.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
https://docs.pulpproject.org/workflows/signed-metadata.html
.. _pulpcore upload documentation:
https://docs.pulpproject.org/workflows/upload-publish.html
.. _pulpcore installation:
.. _pulpcore installation options:
https://docs.pulpproject.org/installation/index.html
.. _pulpcore configuration documentation:
https://docs.pulpproject.org/pulpcore/installation/configuration.html
Expand All @@ -28,6 +28,8 @@
https://github.com/pulp/community/discussions/71
.. _Pulp project:
https://pulpproject.org
.. _Pulp project help page:
https://pulpproject.org/help/
.. _Pulp project mailing list:
https://www.redhat.com/mailman/listinfo/pulp-list
.. _Pulp project development mailing list:
Expand All @@ -54,12 +56,14 @@
https://github.com/pulp/pulp_deb/blob/main/pulp_deb/tests/functional/setup_signing_service.py
.. _signing service script example:
https://github.com/pulp/pulp_deb/blob/main/pulp_deb/tests/functional/sign_deb_release.sh
.. _pulp plugin template:
.. _Pulp plugin template:
https://github.com/pulp/plugin_template
.. _pulp plugin template README:
.. _Pulp plugin template README:
https://github.com/pulp/plugin_template/blob/master/README.md
.. _pulp installer:
.. _Pulp Ansible installer:
https://github.com/pulp/pulp_installer
.. _Pulp Ansible installer documentation:
https://docs.pulpproject.org/pulp_installer/
.. _pulp_deb GitHub actions pipelines:
https://github.com/pulp/pulp_deb/actions
.. _httpie:
Expand Down
51 changes: 7 additions & 44 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,51 +2,14 @@ Installation
================================================================================

.. include:: external_references.rst
.. include:: httpie_usage.rst


Install ``pulpcore``
--------------------------------------------------------------------------------
As with all Pulp plugins, the installation method for ``pulp_deb`` depends on your chosen ``pulpcore`` installation method.
There are multiple `pulpcore installation options`_.
The default recommendation is to use the `Pulp Ansible installer`_, which is documented via the `Pulp Ansible installer documentation`_.

Please see the `pulpcore installation`_ instructions.
Using the Pulp Ansible installer as our example, adding the ``pulp_deb`` plugin to your installation is as easy as uncommenting ``# pulp-deb: {}`` in the example playbook, and then re-running that playbook.
This will both work for entirely new Pulp installations, as well as to add the ``pulp_deb`` plugin to a already completed Pulp installation.


Install ``pulp_deb`` Plugin
--------------------------------------------------------------------------------

This document assumes that you have used the `pulpcore installation`_ to install pulpcore into a the virtual environment ``pulpvenv``.

Users should install from **either** PyPI or source.


From Source
********************************************************************************

.. code-block:: bash
sudo -u pulp -i
source ~/pulpvenv/bin/activate
cd pulp_deb
pip install -e .
django-admin runserver 24817
Make and Run Migrations
--------------------------------------------------------------------------------

.. code-block:: bash
pulpcore-manager makemigrations deb
pulpcore-manager migrate deb
Run Services
--------------------------------------------------------------------------------

.. code-block:: bash
pulp-manager runserver
gunicorn pulpcore.content:server --bind 'localhost:24816' --worker-class 'aiohttp.GunicornWebWorker' -w 2
sudo systemctl restart pulpcore-resource-manager
sudo systemctl restart pulpcore-worker@1
sudo systemctl restart pulpcore-worker@2
If you need more help with advanced installation scenarios you can either consult the documentation referenced above, or else join the ``pulp`` Matrix/IRC channel for interactive help.
See the `Pulp project help page`_ for more information and additional ways on how to get in contact with the Pulp community.
4 changes: 2 additions & 2 deletions docs/plugin_maintenance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ A ``Z`` version release, signifies the following:
Using the Plugin Template
--------------------------------------------------------------------------------

The `pulp plugin template`_ is used to collect changes relevant to all Pulp plugins.
The `Pulp plugin template`_ is used to collect changes relevant to all Pulp plugins.
When there are new changes, the plugin template can then be used to automatically apply those changes to plugins that do not yet include them.

To use the plugin template, make sure you have cloned the Git repository to the same folder as the ``pulp_deb`` repository.
Expand All @@ -66,7 +66,7 @@ To generate an up to date ``template_config.yml`` file in the base of the ``pulp
./plugin-template --generate-config pulp_deb
You can adjust this configuration to affect the other plugin template commands.
For documentation on each parameter, see the `pulp plugin template README`_.
For documentation on each parameter, see the `Pulp plugin template README`_.

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

Expand Down

0 comments on commit fd6f10d

Please sign in to comment.