Skip to content

Commit

Permalink
instructions.rst: Specify creating Pulp user
Browse files Browse the repository at this point in the history
  • Loading branch information
mikedep333 authored and asmacdo committed Jun 21, 2019
1 parent a1b91b9 commit 3f87376
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 14 deletions.
12 changes: 6 additions & 6 deletions docs/installation/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ This file should have permissions of:

* mode: 640
* owner: root
* group: pulp
* group: pulp (the group of the account that pulp runs under)
* SELinux context: system_u:object_r:etc_t:s0

If it is in its own directory like ``/etc/pulp``, the directory should have permissions of:

* mode: 750
* owner: root
* group: pulp
* group: pulp (the group of the account that pulp runs under)
* SELinux context: unconfined_u:object_r:etc_t:s0

By Environment Variables
Expand Down Expand Up @@ -101,8 +101,8 @@ MEDIA_ROOT
It should have permissions of:

* mode: 750
* owner: pulp
* group: pulp
* owner: pulp (the account that pulp runs under)
* group: pulp (the group of the account that pulp runs under)
* SELinux context: system_u:object_r:var_lib_t:s0

LOGGING
Expand Down Expand Up @@ -177,8 +177,8 @@ WORKING_DIRECTORY
It should have permissions of:

* mode: 755
* owner: pulp
* group: pulp
* owner: pulp (the account that pulp runs under)
* group: pulp (the group of the account that pulp runs under)
* SELinux context: unconfined_u:object_r:var_lib_t:s0

.. note::
Expand Down
24 changes: 16 additions & 8 deletions docs/installation/instructions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,17 @@ To use ansible roles to install Pulp 3 instead of manual setup refer to
PyPI Installation
-----------------

1. Install python3.6(+) and pip.
1. (Optional) Create a user account & group for Pulp 3 to run under, rather than using root. The following values are recommended:

2. Create a pulp venv::
* name: pulp
* shell: The path to the `nologin` executable
* home: ``MEDIA_ROOT``
* system account: yes
* create corresponding private group: yes

2. Install python3.6(+) and pip.

3. Create a pulp venv::

$ python3 -m venv pulpvenv
$ source pulpvenv/bin/activate
Expand All @@ -43,7 +51,7 @@ PyPI Installation

$ sudo apt-get install python3-venv

3. Install Pulp with the set of packages for the relational database you prefer to use. Right now we
4. Install Pulp with the set of packages for the relational database you prefer to use. Right now we
have extra sets for postgresql or MySQL/mariadb::

$ pip install pulpcore-plugin pulpcore[postgres]
Expand All @@ -59,9 +67,9 @@ PyPI Installation
$ pip install -e ./pulpcore-plugin


4. Follow the :ref:`configuration instructions <configuration>` to set the ``SECRET_KEY``.
5. Follow the :ref:`configuration instructions <configuration>` to set the ``SECRET_KEY``.

5. Go through the :ref:`database-install`, :ref:`redis-install`, and :ref:`systemd-setup` sections
6. Go through the :ref:`database-install`, :ref:`redis-install`, and :ref:`systemd-setup` sections

.. note::

Expand All @@ -72,16 +80,16 @@ PyPI Installation
$ /path/to/python/bin/rq worker -n 'reserved-resource-worker-1@%h' -w 'pulpcore.tasking.worker.PulpWorker' -c 'pulpcore.rqconfig'
$ /path/to/python/bin/rq worker -n 'reserved-resource-worker-2@%h' -w 'pulpcore.tasking.worker.PulpWorker' -c 'pulpcore.rqconfig'

8. Run Django Migrations::
7. Run Django Migrations::

$ django-admin migrate --noinput
$ django-admin reset-admin-password --password admin

9. Collect Static Media for live docs and browsable API::
8. Collect Static Media for live docs and browsable API::

$ django-admin collectstatic --noinput

10. Run Pulp::
9. Run Pulp::

$ pulp-content # The Pulp Content service (listening on port 24816)
$ django-admin runserver 24817 # The Pulp API service
Expand Down

0 comments on commit 3f87376

Please sign in to comment.